Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write e2e test for VolumeAttachmentStatus Endpoints +3 Endpoints #126826

Open
5 of 7 tasks
heyste opened this issue Aug 20, 2024 · 4 comments · Fixed by #126827 · May be fixed by #127458
Open
5 of 7 tasks

Write e2e test for VolumeAttachmentStatus Endpoints +3 Endpoints #126826

heyste opened this issue Aug 20, 2024 · 4 comments · Fixed by #126827 · May be fixed by #127458
Labels
area/conformance Issues or PRs related to kubernetes conformance tests sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/storage Categorizes an issue or PR as relevant to SIG Storage. sig/testing Categorizes an issue or PR as relevant to SIG Testing. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@heyste
Copy link
Member

heyste commented Aug 20, 2024 •
edited
Loading

Progress [5/7]

Identifying an untested feature Using APISnoop

Untested Endpoints

According to following APIsnoop query, there are three VolumeAttachmentStatus endpoints that are untested.

select   endpoint,
         path,
         kind
from     testing.untested_stable_endpoint
where    eligible is true
and      endpoint ilike '%VolumeAttachmentStatus'
order by kind, endpoint
limit    20;

                endpoint                |                          path                           |       kind
----------------------------------------+---------------------------------------------------------+------------------
 patchStorageV1VolumeAttachmentStatus   | /apis/storage.k8s.io/v1/volumeattachments/{name}/status | VolumeAttachment
 readStorageV1VolumeAttachmentStatus    | /apis/storage.k8s.io/v1/volumeattachments/{name}/status | VolumeAttachment
 replaceStorageV1VolumeAttachmentStatus | /apis/storage.k8s.io/v1/volumeattachments/{name}/status | VolumeAttachment
(3 rows)

API Reference and feature documentation

Test outline

Scenario: Apply changes to a VolumeAttachment Status

  Given the e2e test has created the settings for a VolumeAttachment
  When the test creates the VolumeAttachment
  Then the requested action is accepted without any error
  And the test confirms the name of the created VolumeAttachment

  Given the e2e test has created a VolumeAttachment
  When the test patches the VolumeAttachment with a label
  Then the requested action is accepted without any error
  And the test confirms that the "patched" label is found

  Given the e2e test has patched a VolumeAttachment
  When the test reads the VolumeAttachment status
  Then the requested action is accepted without any error
  And the test confirms the status of the VolumeAttachment

  Given the e2e test has read a VolumeAttachment status
  When the test patches the VolumeAttachment status
  Then the requested action is accepted without any error
  And the test confirms the new status

  Given the e2e test has patched the VolumeAttachment status
  When the test updates the VolumeAttachment status
  Then the requested action is accepted without any error
  And the test confirms the new status

  Given the e2e test has updated the VolumeAttachment status
  When the test deletes the VolumeAttachment
  Then the requested action is accepted without any error

  Given the e2e test has deleted the VolumeAttachment
  When the test lists for the VolumeAttachment with a "patched" labelSelector
  Then the requested action is accepted without any error
  And the deletion of the VolumeAttachment is confirmed

E2E Test

Using a number of existing e2e test practices a new ginkgo test has been created to provide future Conformance coverage for the 3 endpoints. The e2e logs for this test are listed below.

[sig-storage] VolumeAttachment Conformance should apply changes to a volumeattachment status [sig-storage]
/home/ii/go/src/k8s.io/kubernetes/test/e2e/storage/volume_attachment.go:170
  STEP: Creating a kubernetes client @ 07/31/24 12:27:23.94
  I0731 12:27:23.940415 361258 util.go:499] >>> kubeConfig: /home/ii/.kube/config
  STEP: Building a namespace api object, basename volumeattachment @ 07/31/24 12:27:23.941
  STEP: Waiting for a default service account to be provisioned in namespace @ 07/31/24 12:27:23.983
  STEP: Waiting for kube-root-ca.crt to be provisioned in namespace @ 07/31/24 12:27:23.987
  STEP: Create VolumeAttachment "va-e2e-f9xpk" on node "kind-control-plane" @ 07/31/24 12:27:23.994
  STEP: Patch VolumeAttachment "va-e2e-f9xpk" on node "kind-control-plane" @ 07/31/24 12:27:24.003
  STEP: Reading "va-e2e-f9xpk" Status @ 07/31/24 12:27:24.012
  STEP: Patching "va-e2e-f9xpk" Status @ 07/31/24 12:27:24.016
  I0731 12:27:24.025849 361258 volume_attachment.go:214] "va-e2e-f9xpk" Status.Attached: true
  STEP: Updating "va-e2e-f9xpk" Status @ 07/31/24 12:27:24.025
  I0731 12:27:24.042866 361258 volume_attachment.go:230] "va-e2e-f9xpk" Status.Attached: false
  STEP: Delete VolumeAttachment "va-e2e-f9xpk" on node "kind-control-plane" @ 07/31/24 12:27:24.042
  STEP: Confirm deletion of VolumeAttachment "va-e2e-f9xpk" on node "kind-control-plane" @ 07/31/24 12:27:24.052
  I0731 12:27:24.055592 361258 helper.go:122] Waiting up to 7m0s for all (but 0) nodes to be ready
  STEP: Destroying namespace "volumeattachment-2781" for this suite. @ 07/31/24 12:27:24.059

Verifying increase in coverage with APISnoop

Listing endpoints hit by the new e2e test

This query shows the following VolumeAttachmentStatus endpoints are hit within a short period of running this e2e test.

select distinct substring(endpoint from '\w+') AS endpoint,
                right(useragent,49) AS useragent
from  testing.audit_event
where useragent like 'e2e%should%'
  and release_date::BIGINT > round(((EXTRACT(EPOCH FROM NOW()))::numeric)*1000,0) - 20000
  and endpoint ilike '%VolumeAttachmentStatus%'
order by endpoint
limit 10;

                endpoint                |                     useragent
----------------------------------------+---------------------------------------------------
 patchStorageV1VolumeAttachmentStatus   | should apply changes to a volumeattachment status
 readStorageV1VolumeAttachmentStatus    | should apply changes to a volumeattachment status
 replaceStorageV1VolumeAttachmentStatus | should apply changes to a volumeattachment status
(3 rows)

Final notes

If a test with these calls gets merged, test coverage will go up by 3 points

This test is also created with the goal of conformance promotion.

/sig testing
/sig architecture
/area conformance
@k8s-ci-robot k8s-ci-robot added sig/testing Categorizes an issue or PR as relevant to SIG Testing. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. area/conformance Issues or PRs related to kubernetes conformance tests needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 20, 2024
@heyste heyste mentioned this issue Aug 20, 2024
Merged
@heyste
Copy link
Member Author

heyste commented Aug 20, 2024

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 20, 2024
@heyste
Copy link
Member Author

heyste commented Aug 20, 2024

/sig storage

@k8s-ci-robot k8s-ci-robot added the sig/storage Categorizes an issue or PR as relevant to SIG Storage. label Aug 20, 2024
@heyste heyste linked a pull request Sep 18, 2024 that will close this issue
Open
@heyste
Copy link
Member Author

heyste commented Sep 18, 2024

/reopen
Tracking the next steps to conformance

@k8s-ci-robot k8s-ci-robot reopened this Sep 18, 2024
@k8s-ci-robot
Copy link
Contributor

@heyste: Reopened this issue.

In response to this:

/reopen
Tracking the next steps to conformance

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/conformance Issues or PRs related to kubernetes conformance tests sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/storage Categorizes an issue or PR as relevant to SIG Storage. sig/testing Categorizes an issue or PR as relevant to SIG Testing. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
2 participants
@heyste @k8s-ci-robot