test suite reorganization #93

pohly · 2018-07-11T13:55:27Z

This fixes issue #89 (deleting volumes on test failure, unique volume names) and simplifies the code a bit.

msau42 · 2018-07-11T17:40:18Z

pkg/sanity/sanity.go

+// bytes, empty string in case of error.
+func pseudoUUID() string {
+	b := make([]byte, 8)
+	if _, err := rand.Read(b); err != nil {


Do you need to seed the random generator at the beginning?

This is crypto/rand, which doesn't need to be seeded.

One could argue that the normal rand is good enough, but then it would need to be seeded. I don't care either way.

msau42 · 2018-07-11T17:59:11Z

pkg/sanity/controller.go

@@ -265,6 +279,7 @@ var _ = DescribeSanity("Controller Service", func(sc *SanityContext) {
 				Expect(vol.GetVolume().GetId()).NotTo(BeEmpty())
 				Expect(vol.GetVolume().GetCapacityBytes()).To(BeNumerically(">=", TestVolumeSize(sc)))
 			}
+			cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetId()})


Should this go after L279

Yes, will change that.

msau42 · 2018-07-11T18:01:28Z

pkg/sanity/controller.go

@@ -210,6 +222,7 @@ var _ = DescribeSanity("Controller Service", func(sc *SanityContext) {
 				},
 			)
 			Expect(err).NotTo(HaveOccurred())
+			cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetId()})


Should this go after L228 because it requires vol.GetVolume().GetId()?

Yes, will change that.

msau42 · 2018-07-11T18:03:41Z

pkg/sanity/controller.go

@@ -210,6 +222,7 @@ var _ = DescribeSanity("Controller Service", func(sc *SanityContext) {
 				},
 			)
 			Expect(err).NotTo(HaveOccurred())
+			cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetId()})
 			Expect(vol).NotTo(BeNil())


All of the test cases are validating these same things. Can the validation be put into a common function?

I was wondering the same about the full test and ended up moving that to a single test and then again here after making the same change over and over again.

I guess some more tests could be eliminated, but I haven't looked too closely and would prefer to get this PR merged first before doing further simplifications.

I don't mean eliminating tests, but consolidating the 4 checks about create volume return values into a common function

The downside of putting the checks into a common function is that line information in case of a failure isn't useful anymore:

• Failure [0.017 seconds] Controller Service /fast/work/gopath/src/github.com/intel/open-infrastructure-offload/vendor/github.com/kubernetes-csi/csi-test/pkg/sanity/tests.go:44 CreateVolume /fast/work/gopath/src/github.com/intel/open-infrastructure-offload/vendor/github.com/kubernetes-csi/csi-test/pkg/sanity/controller.go:173 should return appropriate values SingleNodeWriter WithCapacity 1Gi Type:Mount [It] /fast/work/gopath/src/github.com/intel/open-infrastructure-offload/vendor/github.com/kubernetes-csi/csi-test/pkg/sanity/controller.go:250 Expected an error to have occurred. Got: <nil>: nil /fast/work/gopath/src/github.com/intel/open-infrastructure-offload/vendor/github.com/kubernetes-csi/csi-test/pkg/sanity/controller.go:73

This line 73 is in a new helper function where I intentionally inverted the error check to trigger a test failure.

I think this needs further discussion, so I'll leave it as it is.

pohly · 2018-07-12T13:40:17Z

@msau42 I've force-pushed a version where the RegisterVolume calls are after verifying the volume ID. The odd control flow around the OutOfRange error detection confused me, so I simplified that a bit. Please have another look.

msau42 · 2018-07-12T20:28:10Z

pkg/sanity/controller.go

+					ControllerCreateSecrets: sc.Secrets.CreateVolumeSecret,
+				},
+			)
+			Expect(err).To(HaveOccurred())


If CreateVolume actually succeeded, then you still need to cleanup the volume. Same for all negative tests.

Yes, I had asked myself about that too, but then dismissed it as unlikely. Will add it.

Done, see d34fca7.

msau42 · 2018-07-17T00:49:40Z

pkg/sanity/controller.go

 				context.Background(),
 				&csi.CreateVolumeRequest{
 					ControllerCreateSecrets: sc.Secrets.CreateVolumeSecret,
 				},
 			)
+			cl.MaybeRegisterVolume("", vol, err)


This volume doesn't have a name?

No, the test intentionally omits the name. Volume tracking doesn't need a name, it's mostly just informational there, so passing an empty name is okay.

msau42 · 2018-07-17T14:30:45Z

/lgtm

lpabon · 2018-07-18T17:07:52Z

@pohly Could you squash your changes when you resolve the conflict?

Within the test suite, each name is now unique. That simplifies debugging and when one test fails to remove its volume, the other tests are not affected. It also allows running tests in parallel. In addition, a random suffix gets added to also prevent collisions between different test runs. The random suffix gets reused for tests running inside the same process, but will be different for a single test run when running with "gingko -p". Related-to: kubernetes-csi#89.

Instead of testing individual functions of each service, the reorganized suite tests three services and for each service the functions that it provides. This allows removing code duplication in the common BeforeEach functions and enables further enhancements (common cleanup code, not duplicating the same test multiple times). While at it, the term "services" is now used consistently instead of "server", because that is what the CSI spec describes.

The full workflow test was done four times under different names. That's unnecessary and potentially confusing. Now it gets run once alongside the more specific function tests.

GetPublishInfo returns nil when called for a nil ControllerPublishVolumeResponse, therefore the if check is redundant. Always setting PublishInfo is another step towards inlining the parameter constructions.

By ensuring that we always have a valid CSISecrets, even if it only contains nil pointers, we can get rid of all the "if != nil" checks and the separate construction of the parameter structure.

There's no need to rename the csi spec, the package name already is "csi". Same for "gmock". The "context" module has been part of the Go standard library for quite a while now, we should use that directly.

Ginkgo invokes AfterEach in the order in which they are defined, therefore we should define the AfterEach where the connection is closed as late as possible. That way the tests can have their own AfterEach where they can still use the connection.

When a test fails, any volume operations that I may have done should be reversed. To achieve this, tests can register volumes for cleanup. To avoid unnecessary operations, volumes also get unregistered after a successful removal inside the test itself. Whether ControllerUnpublishVolume has to be called also gets tracked. For the sake of simplicity, NodeUnpublishVolume and (if supported) NodeUnstageVolume always get called. This is okay because they have to be idempotent and won't fail when called unnecessarily. testFullWorkflowSuccess gets inlined because that's easier than passing yet another parameter. Fixes: kubernetes-csi#89.

The tests previously defined only for Travis CI are now invoked with "make test". e2e.sh assumed that the binaries are in the regular search path. This is no longer necessary and in addition, mock is no longer placed in the developers $GOPATH/bin by the script.

"go fmt" always fixes code in place. As a result, running it again to report formatting errors doesn't do anything. The original intention probably was to check for errors and then report them. This is what is done now, using gofmt directly and it's diff output mode.

pohly · 2018-07-20T07:49:51Z

Luis Pabón <notifications@github.com> writes:

@pohly Could you squash your changes when you resolve the conflict?

Okay, done. Please note that I included another fix that wasn't part of the PR before: 275a086 - "Makefile: fix format error reporting"

msau42 · 2018-08-01T00:52:18Z

@pohly @lpabon can we get this merged?

pohly · 2018-08-01T06:29:50Z

It's ready as far as I'm concerned. @lpabon, please merge.

test suite reorganization

filter-junit: Fix gofmt error

a0f195c Merge pull request kubernetes-csi#106 from msau42/fix-canary 7100c12 Only set staging registry when running canary job b3c65f9 Merge pull request kubernetes-csi#99 from msau42/add-release-process e53f3e8 Merge pull request kubernetes-csi#103 from msau42/fix-canary d129462 Document new method for adding CI jobs are new K8s versions e73c2ce Use staging registry for canary tests 2c09846 Add cleanup instructions to release-notes generation 60e1cd3 Merge pull request kubernetes-csi#98 from pohly/kubernetes-1-19-fixes 0979c09 prow.sh: fix E2E suite for Kubernetes >= 1.18 3b4a2f1 prow.sh: fix installing Go for Kubernetes 1.19.0 1fbb636 Merge pull request kubernetes-csi#97 from pohly/go-1.15 82d108a switch to Go 1.15 d8a2530 Merge pull request kubernetes-csi#95 from msau42/add-release-process 843bddc Add steps on promoting release images 0345a83 Merge pull request kubernetes-csi#94 from linux-on-ibm-z/bump-timeout 1fdf2d5 cloud build: bump timeout in Prow job 41ec6d1 Merge pull request kubernetes-csi#93 from animeshk08/patch-1 5a54e67 filter-junit: Fix gofmt error 0676fcb Merge pull request kubernetes-csi#92 from animeshk08/patch-1 36ea4ff filter-junit: Fix golint error f5a4203 Merge pull request kubernetes-csi#91 from cyb70289/arm64 43e50d6 prow.sh: enable building arm64 image 0d5bd84 Merge pull request kubernetes-csi#90 from pohly/k8s-staging-sig-storage 3df86b7 cloud build: k8s-staging-sig-storage c5fd961 Merge pull request kubernetes-csi#89 from pohly/cloud-build-binfmt db0c2a7 cloud build: initialize support for running commands in Dockerfile be902f4 Merge pull request kubernetes-csi#88 from pohly/multiarch-windows-fix 340e082 build.make: optional inclusion of Windows in multiarch images 5231f05 build.make: properly declare push-multiarch 4569f27 build.make: fix push-multiarch ambiguity 17dde9e Merge pull request kubernetes-csi#87 from pohly/cloud-build bd41690 cloud build: initial set of shared files 9084fec Merge pull request kubernetes-csi#81 from msau42/add-release-process 6f2322e Update patch release notes generation command 0fcc3b1 Merge pull request kubernetes-csi#78 from ggriffiths/fix_csi_snapshotter_rbac_version_set d8c76fe Support local snapshot RBAC for pull jobs c1bdf5b Merge pull request kubernetes-csi#80 from msau42/add-release-process ea1f94a update release tools instructions 152396e Merge pull request kubernetes-csi#77 from ggriffiths/snapshotter201_update 7edc146 Update snapshotter to version 2.0.1 4cf843f Merge pull request kubernetes-csi#76 from pohly/build-targets 3863a0f build for multiple platforms only in CI, add s390x 8322a7d Merge pull request kubernetes-csi#72 from pohly/hostpath-update 7c5a89c prow.sh: use 1.3.0 hostpath driver for testing b8587b2 Merge pull request kubernetes-csi#71 from wozniakjan/test-vet fdb3218 Change 'make test-vet' to call 'go vet' d717c8c Merge pull request kubernetes-csi#69 from pohly/test-driver-config a1432bc Merge pull request kubernetes-csi#70 from pohly/kubelet-feature-gates 5f74333 prow.sh: also configure feature gates for kubelet 84f78b1 prow.sh: generic driver installation 3c34b4f Merge pull request kubernetes-csi#67 from windayski/fix-link fa90abd fix incorrect link ff3cc3f Merge pull request kubernetes-csi#54 from msau42/add-release-process ac8a021 Document the process for releasing a new sidecar 23be652 Merge pull request kubernetes-csi#65 from msau42/update-hostpath 6582f2f Update hostpath driver version to get fix for connection-timeout 4cc9174 Merge pull request kubernetes-csi#64 from ggriffiths/snapshotter_2_version_update 8191eab Update snapshotter to version v2.0.0 3c463fb Merge pull request kubernetes-csi#61 from msau42/enable-snapshots 8b0316c Fix overriding of junit results by using unique names for each e2e run 5f444b8 Merge pull request kubernetes-csi#60 from saad-ali/updateHostpathVersion af9549b Update prow hostpath driver version to 1.3.0-rc2 f6c74b3 Merge pull request kubernetes-csi#57 from ggriffiths/version_gt_kubernetes_fix fc80975 Fix version_gt to work with kubernetes prefix 9f1f3dd Merge pull request kubernetes-csi#56 from msau42/enable-snapshots b98b2ae Enable snapshot tests in 1.17 to be run in non-alpha jobs. 9ace020 Merge pull request kubernetes-csi#52 from msau42/update-readme 540599b Merge pull request kubernetes-csi#53 from msau42/fix-make a4e6299 fix syntax for ppc64le build 771ca6f Merge pull request kubernetes-csi#49 from ggriffiths/prowsh_improve_version_gt d7c69d2 Merge pull request kubernetes-csi#51 from msau42/enable-multinode 4ad6949 Improve snapshot pod running checks and improve version_gt 53888ae Improve README by adding an explicit Kubernetes dependency section 9a7a685 Create a kind cluster with two worker nodes so that the topology feature can be tested. Test cases that test accessing volumes from multiple nodes need to be skipped 4ff2f5f Merge pull request kubernetes-csi#50 from darkowlzz/kind-0.6.0 80bba1f Use kind v0.6.0 6d674a7 Merge pull request kubernetes-csi#47 from Pensu/multi-arch 8adde49 Merge pull request kubernetes-csi#45 from ggriffiths/snapshot_beta_crds 003c14b Add snapshotter CRDs after cluster setup a41f386 Merge pull request kubernetes-csi#46 from mucahitkurt/kind-cluster-cleanup 1eaaaa1 Delete kind cluster after tests run. 83a4ef1 Adding build for ppc64le 4fcafec Merge pull request kubernetes-csi#43 from pohly/system-pod-logging f41c135 prow.sh: also log output of system containers ee22a9c Merge pull request kubernetes-csi#42 from pohly/use-vendor-dir 8067845 travis.yml: also use vendor directory 23df4ae prow.sh: use vendor directory if available a53bd4c Merge pull request kubernetes-csi#41 from pohly/go-version c8a1c4a better handling of Go version 5e773d2 update CI to use Go 1.13.3 f419d74 Merge pull request kubernetes-csi#40 from msau42/add-1.16 e0fde8c Add new variables for 1.16 and remove 1.13 adf00fe Merge pull request kubernetes-csi#36 from msau42/full-clone f1697d2 Do full git clones in travis. Shallow clones are causing test-subtree errors when the depth is exactly 50. 2c81919 Merge pull request kubernetes-csi#34 from pohly/go-mod-tidy 518d6af Merge pull request kubernetes-csi#35 from ddebroy/winbld2 2d6b3ce Build Windows only for amd64 c1078a6 go-get-kubernetes.sh: automate Kubernetes dependency handling 194289a update Go mod support 0affdf9 Merge pull request kubernetes-csi#33 from gnufied/enable-hostpath-expansion 6208f6a Enable hostpath expansion 6ecaa76 Merge pull request kubernetes-csi#30 from msau42/fix-windows ea2f1b5 build windows binaries with .exe suffix 2d33550 Merge pull request kubernetes-csi#29 from mucahitkurt/create-2-node-kind-cluster a8ea8bc create 2-node kind cluster since topology support is added to hostpath driver df8530d Merge pull request kubernetes-csi#27 from pohly/dep-vendor-check 35ceaed prow.sh: install dep if needed f85ab5a Merge pull request kubernetes-csi#26 from ddebroy/windows1 9fba09b Add rule for building Windows binaries 0400867 Merge pull request kubernetes-csi#25 from msau42/fix-master-jobs dc0a5d8 Update kind to v0.5.0 aa85b82 Merge pull request kubernetes-csi#23 from msau42/fix-master-jobs f46191d Kubernetes master changed the way that releases are tagged, which needed changes to kind. There are 3 changes made to prow.sh: 1cac3af Merge pull request kubernetes-csi#22 from msau42/add-1.15-jobs 0c0dc30 prow.sh: tag master images with a large version number f4f73ce Merge pull request kubernetes-csi#21 from msau42/add-1.15-jobs 4e31f07 Change default hostpath driver name to hostpath.csi.k8s.io 4b6fa4a Update hostpath version for sidecar testing to v1.2.0-rc2 ecc7918 Update kind to v0.4.0. This requires overriding Kubernetes versions with specific patch versions that kind 0.4.0 supports. Also, feature gate setting is only supported on 1.15+ due to kind.sigs.k8s.io/v1alpha3 and kubeadm.k8s.io/v1beta2 dependencies. a6f21d4 Add variables for 1.15 db8abb6 Merge pull request kubernetes-csi#20 from pohly/test-driver-config b2f4e05 prow.sh: flexible test driver config 0399988 Merge pull request kubernetes-csi#19 from pohly/go-mod-vendor 066143d build.make: allow repos to use 'go mod' for vendoring 0bee749 Merge pull request kubernetes-csi#18 from pohly/go-version e157b6b update to Go 1.12.4 88dc9a4 Merge pull request kubernetes-csi#17 from pohly/prow 0fafc66 prow.sh: skip sanity testing if component doesn't support it bcac1c1 Merge pull request kubernetes-csi#16 from pohly/prow 0b10f6a prow.sh: update csi-driver-host-path 0c2677e Merge pull request kubernetes-csi#15 from pengzhisun/master ff9bce4 Replace 'return' to 'exit' to fix shellcheck error c60f382 Merge pull request kubernetes-csi#14 from pohly/prow 7aaac22 prow.sh: remove AllAlpha=all, part II 6617773 Merge pull request kubernetes-csi#13 from pohly/prow cda2fc5 prow.sh: avoid AllAlpha=true 546d550 prow.sh: debug failing KinD cluster creation 9b0d9cd build.make: skip shellcheck if Docker is not available aa45a1c prow.sh: more efficient execution of individual tests f3d1d2d prow.sh: fix hostpath driver version check 31dfaf3 prow.sh: fix running of just "alpha" tests f501443 prow.sh: AllAlpha=true for unknown Kubernetes versions 95ae9de Merge pull request kubernetes-csi#9 from pohly/prow d87eccb prow.sh: switch back to upstream csi-driver-host-path 6602d38 prow.sh: different E2E suite depending on Kubernetes version 741319b prow.sh: improve building Kubernetes from source 29545bb prow.sh: take Go version from Kubernetes source 429581c prow.sh: pull Go version from travis.yml 0a0fd49 prow.sh: comment clarification 2069a0a Merge pull request kubernetes-csi#11 from pohly/verify-shellcheck 55212ff initial Prow test job 6c7ba1b build.make: integrate shellcheck into "make test" b2d25d4 verify-shellcheck.sh: make it usable in csi-release-tools 3b6af7b Merge pull request kubernetes-csi#12 from pohly/local-e2e-suite 104a1ac build.make: avoid unit-testing E2E test suite 34010e7 Merge pull request kubernetes-csi#10 from pohly/vendor-check e6db50d check vendor directory fb13c51 verify-shellcheck.sh: import from Kubernetes 94fc1e3 build.make: avoid unit-testing E2E test suite 849db0a Merge pull request kubernetes-csi#8 from pohly/subtree-check-relax cc564f9 verify-subtree.sh: relax check and ignore old content git-subtree-dir: release-tools git-subtree-split: a0f195cc2ddc2a1f07d4d3e46fc08187db358f94

msau42 reviewed Jul 11, 2018

View reviewed changes

pohly force-pushed the test-suite branch 2 times, most recently from 3dc7fae to b6016b3 Compare July 12, 2018 13:13

msau42 reviewed Jul 12, 2018

View reviewed changes

pohly mentioned this pull request Jul 13, 2018

pkg/sanity: support sanity testing in another Ginkgo suite #90

Merged

msau42 reviewed Jul 17, 2018

View reviewed changes

pohly added 10 commits July 20, 2018 09:37

pkg/sanity: avoid running the same test four times

e67e163

The full workflow test was done four times under different names. That's unnecessary and potentially confusing. Now it gets run once alongside the more specific function tests.

pkg/sanity: avoid if check around GetPublishInfo

2fdc9c8

GetPublishInfo returns nil when called for a nil ControllerPublishVolumeResponse, therefore the if check is redundant. Always setting PublishInfo is another step towards inlining the parameter constructions.

pkg/sanity: avoid if checks around secrets

8108500

By ensuring that we always have a valid CSISecrets, even if it only contains nil pointers, we can get rid of all the "if != nil" checks and the separate construction of the parameter structure.

simplify imports

183e16e

There's no need to rename the csi spec, the package name already is "csi". Same for "gmock". The "context" module has been part of the Go standard library for quite a while now, we should use that directly.

pkg/sanity: close connection last

7d3ced6

Ginkgo invokes AfterEach in the order in which they are defined, therefore we should define the AfterEach where the connection is closed as late as possible. That way the tests can have their own AfterEach where they can still use the connection.

move testing to Makefile

1a22b17

The tests previously defined only for Travis CI are now invoked with "make test". e2e.sh assumed that the binaries are in the regular search path. This is no longer necessary and in addition, mock is no longer placed in the developers $GOPATH/bin by the script.

pohly force-pushed the test-suite branch from e2e872d to 275a086 Compare July 20, 2018 07:47

lpabon merged commit f272f52 into kubernetes-csi:master Aug 1, 2018

suneeth51 pushed a commit to suneeth51/csi-test that referenced this pull request Sep 11, 2019

Merge pull request kubernetes-csi#93 from pohly/test-suite

249d8e6

test suite reorganization

pohly pushed a commit to pohly/csi-test that referenced this pull request Jul 9, 2020

Merge pull request kubernetes-csi#93 from animeshk08/patch-1

41ec6d1

filter-junit: Fix gofmt error

pohly mentioned this pull request Oct 12, 2020

master: update release-tools #299

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test suite reorganization #93

test suite reorganization #93

pohly commented Jul 11, 2018 •

edited

msau42 Jul 11, 2018

pohly Jul 11, 2018

msau42 Jul 11, 2018

pohly Jul 11, 2018

msau42 Jul 11, 2018

pohly Jul 11, 2018

msau42 Jul 11, 2018

pohly Jul 11, 2018

msau42 Jul 11, 2018

pohly Jul 12, 2018

pohly commented Jul 12, 2018

msau42 Jul 12, 2018

pohly Jul 13, 2018

pohly Jul 13, 2018

msau42 Jul 17, 2018

pohly Jul 17, 2018

msau42 commented Jul 17, 2018

lpabon commented Jul 18, 2018

pohly commented Jul 20, 2018 via email

msau42 commented Aug 1, 2018

pohly commented Aug 1, 2018

test suite reorganization #93

test suite reorganization #93

Conversation

pohly commented Jul 11, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pohly commented Jul 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msau42 commented Jul 17, 2018

lpabon commented Jul 18, 2018

pohly commented Jul 20, 2018 via email

msau42 commented Aug 1, 2018

pohly commented Aug 1, 2018

pohly commented Jul 11, 2018 •

edited