clean up configuration handling #233

pohly · 2019-10-29T15:44:32Z

What type of PR is this?

/kind api-change

What this PR does / why we need it:

As discussed in #220, the current API makes it hard to introduce new config fields which don't have the nul value as default. The new NewTestConfig addresses that.

As were are breaking the API with that already, several other shortcomings can also be addressed.

Special notes for your reviewer:

This is meant to go into v3.0.0 together with PR #232 .

/cc @misterikkit @davidz627

Does this PR introduce a user-facing change?:

revised sanity API: more consistent naming, NewTestConfig must be used

k8s-ci-robot · 2019-10-29T15:45:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pohly

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [pohly]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pohly · 2019-10-29T15:46:08Z

cmd/csi-sanity/sanity_test.go

+	os.Exit(m.Run())
+}
+
+func TestSanity(t *testing.T) {


I am wondering whether we need this special hack with csi-sanity being a go test program. It prevents using "go get" to build it. I might still change that as part of this PR...

Yes, that was pretty simple.

msau42 · 2019-10-29T15:57:29Z

/assign @misterikkit

misterikkit

Oops! I forgot to send these draft comments. If they no longer make sense, feel free to ignore. I will take another pass at reviewing this soon.

misterikkit · 2019-10-29T17:46:20Z

pkg/sanity/sanity.go

+		CreatePathCmdTimeout: 10,
+		RemovePathCmdTimeout: 10,


Are these values in seconds? Any reason it's not time.Duration type?

Historic reasons. I can change it.

misterikkit · 2019-10-29T17:46:50Z

pkg/sanity/sanity.go

+		StagingPath:          os.TempDir() + "/csi-staging",
+		CreatePathCmdTimeout: 10,
+		RemovePathCmdTimeout: 10,
+		TestVolumeSize:       10 * 1024 * 1024 * 1024, // 10 GB


This is 10 GiB. Could you update the comment?

misterikkit · 2019-10-29T17:48:15Z

pkg/sanity/sanity.go

+// the instance to [Ginkgo]Test and/or (when using GinkgoTest) in a
+// BeforeEach. For example, the BeforeEach could set up the CSI driver
+// and then set the Address field differently for each test.
+type TestConfig struct {


Why change the struct name?

I know, this is GitHub, so no-one reads commit messages, but I write them anyway... 😬

In the commit message, I usually explain the "why" for a change ("why do we need it, why this way") if it doesn't fit into a comment. In this case, the explanation is: "To ensure that callers adapt to the
new semantic, the struct gets renamed. ... SanityContext gets renamed to TestContext for consistency."

Another reason (not called out specifically) is that sanity.SanityConfig stuttered. sanity.TestConfig is a better name.

Thanks for taking the time to answer this twice. 😄

misterikkit · 2019-10-29T17:50:05Z

pkg/sanity/sanity.go

+// BeforeEach. For example, the BeforeEach could set up the CSI driver
+// and then set the Address field differently for each test.


We could add a godoc example of how one would use this struct. That's enough of a change that it doesn't need to be in this PR.

I think that's overkill. I find it more likely that someone starts using this package based on some existing CSI driver, i.e. with a working example, than starting just with the godocs. I could be wrong, of course.

pohly · 2019-11-05T09:27:37Z

@misterikkit : PR updated, please have another look.

NewTestConfig now must be used to initialize the struct with defaults. This makes it easier to introduce new fields where the empty value isn't a suitable default. To ensure that callers adapt to the new semantic, the struct gets renamed. This also allows removing replicated default values all over the source code. SanityContext gets renamed to TestContext for consistency. Its new Finalize method should be used to clean up. To allow that, GinkgoTest returns the context pointer.

This is cleaner. This also changes the values of the command line timeout parameters from plain int (10) to durations (10s), but this is okay as we are preparing a major new release.

pohly · 2019-11-06T16:46:58Z

@misterikkit: rebased on top of the recently merged #236.

@wnxn: perhaps you can have a look at this PR and verify that I didn't break anything?

wnxn · 2019-11-07T08:14:30Z

@misterikkit: rebased on top of the recently merged #236.

@wnxn: perhaps you can have a look at this PR and verify that I didn't break anything?

I verified it. It didn't break anything.

misterikkit

/lgtm

misterikkit · 2019-11-13T23:21:33Z

hack/_embedded/embedded_test.go

 	"testing"

 	"github.com/kubernetes-csi/csi-test/pkg/sanity"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )

+var context *sanity.TestContext


It seems like a global is the best way to do this within Ginkgo. Oh well.

misterikkit · 2019-11-13T23:23:43Z

pkg/sanity/sanity.go

+// the instance to [Ginkgo]Test and/or (when using GinkgoTest) in a
+// BeforeEach. For example, the BeforeEach could set up the CSI driver
+// and then set the Address field differently for each test.
+type TestConfig struct {


Thanks for taking the time to answer this twice. 😄

misterikkit · 2019-11-13T23:29:10Z

pkg/sanity/sanity.go

+// GinkgoTest for use when the tests run. Therefore its content can
+// still be modified in a BeforeEach. The sanity package itself treats
+// it as read-only.
+func GinkgoTest(config *TestConfig) *TestContext {


Maybe RegisterGinkgoTests would be a good name for this, but we seem to have enough breaking changes on our hands.

remove windows 20H2 build since it's EOL long time ago

227577e Merge pull request kubernetes-csi#258 from gnufied/enable-race-detection e1ceee2 Always enable race detection while running tests 988496a Merge pull request kubernetes-csi#257 from jakobmoellerdev/csi-prow-sidecar-e2e-path 028f8c6 chore: bump to Go 1.22.5 69bd71e chore: add CSI_PROW_SIDECAR_E2E_PATH f40f0cc Merge pull request kubernetes-csi#256 from solumath/master cfa9210 Instruction update 379a1bb Merge pull request kubernetes-csi#255 from humblec/sidecar-md a5667bb fix typo in sidecar release process 4967685 Merge pull request kubernetes-csi#254 from bells17/add-github-actions d9bd160 Update skip list in codespell GitHub Action adb3af9 Merge pull request kubernetes-csi#252 from bells17/update-go-version f5aebfc Add GitHub Actions workflows b82ee38 Merge pull request kubernetes-csi#253 from bells17/fix-typo c317456 Fix typo 0a78505 Bump to Go 1.22.3 edd89ad Merge pull request kubernetes-csi#251 from jsafrane/add-logcheck 043fd09 Add test-logcheck target d7535ae Merge pull request kubernetes-csi#250 from jsafrane/go-1.22 b52e7ad Update go to 1.22.2 14fdb6f Merge pull request kubernetes-csi#247 from msau42/prow dc4d0ae Merge pull request kubernetes-csi#249 from jsafrane/use-go-version e681b17 Use .go-version to get Kubernetes go version 9b4352e Update release playbook c7bb972 Fix release notes script to use fixed tags 463a0e9 Add script to update specific go modules b54c1ba Merge pull request kubernetes-csi#246 from xing-yang/go_1.21 5436c81 Change go version to 1.21.5 267b40e Merge pull request kubernetes-csi#244 from carlory/sig-storage b42e5a2 nominate self (carlory) as kubernetes-csi reviewer a17f536 Merge pull request kubernetes-csi#210 from sunnylovestiramisu/sidecar 011033d Use set -x instead of die 5deaf66 Add wrapper script for sidecar release f8c8cc4 Merge pull request kubernetes-csi#237 from msau42/prow b36b5bf Merge pull request kubernetes-csi#240 from dannawang0221/upgrade-go-version adfddcc Merge pull request kubernetes-csi#243 from pohly/git-subtree-pull-fix c465088 pull-test.sh: avoid "git subtree pull" error 7b175a1 Update csi-test version to v5.2.0 987c90c Update go version to 1.21 to match k/k 2c625d4 Add script to generate patch release notes f9d5b9c Merge pull request kubernetes-csi#236 from mowangdk/feature/bump_csi-driver-host-path_version b01fd53 Bump csi-driver-host-path version up to v1.12.0 984feec Merge pull request kubernetes-csi#234 from siddhikhapare/csi-tools 1f7e605 fixed broken links of testgrid dashboard de2fba8 Merge pull request kubernetes-csi#233 from andyzhangx/andyzhangx-patch-1 cee895e remove windows 20H2 build since it's EOL long time ago 670bb0e Merge pull request kubernetes-csi#229 from marosset/fix-codespell-errors 35d5e78 Merge pull request kubernetes-csi#219 from yashsingh74/update-registry 63473cc Merge pull request kubernetes-csi#231 from coulof/bump-go-version-1.20.5 29a5c76 Merge pull request kubernetes-csi#228 from mowangdk/chore/adopt_kubernetes_recommand_labels 8dd2821 Update cloudbuild image with go 1.20.5 1df23db Merge pull request kubernetes-csi#230 from msau42/prow 1f92b7e Add ginkgo timeout to e2e tests to help catch any stuck tests 2b8b80e fixing some codespell errors c10b678 Merge pull request kubernetes-csi#227 from coulof/check-sidecar-supported-versions 72984ec chore: adopt kubernetes recommand label b055535 Header bd0a10b typo c39d73c Add comments f6491af Script to verify EOL sidecar version 4133d1d Merge pull request kubernetes-csi#226 from msau42/cloudbuild 8d519d2 Pin buildkit to v0.10.6 to workaround v0.11 bug with docker manifest 6e04a03 Merge pull request kubernetes-csi#224 from msau42/cloudbuild 26fdfff Update cloudbuild image 6613c39 Merge pull request kubernetes-csi#223 from sunnylovestiramisu/update 0e7ae99 Update k8s image repo url 77e47cc Merge pull request kubernetes-csi#222 from xinydev/fix-dep-version 155854b Fix dep version mismatch 8f83905 Merge pull request kubernetes-csi#221 from sunnylovestiramisu/go-update 1d3f94d Update go version to 1.20 to match k/k v1.27 e322ce5 Merge pull request kubernetes-csi#220 from andyzhangx/fix-golint-error b74a512 test: fix golint error 901bcb5 Update registry k8s.gcr.io -> registry.k8s.io git-subtree-dir: release-tools git-subtree-split: 227577e

k8s-ci-robot requested review from davidz627 and misterikkit October 29, 2019 15:44

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 29, 2019

pohly commented Oct 29, 2019

View reviewed changes

k8s-ci-robot assigned misterikkit Oct 29, 2019

pohly force-pushed the config-defaults branch 2 times, most recently from d53f998 to d5badbb Compare October 29, 2019 16:15

pohly mentioned this pull request Oct 29, 2019

csi-sanity binary #234

Merged

misterikkit reviewed Nov 4, 2019

View reviewed changes

pohly added 2 commits November 6, 2019 17:19

sanity: specify timeouts as durations

90f9d07

This is cleaner. This also changes the values of the command line timeout parameters from plain int (10) to durations (10s), but this is okay as we are preparing a major new release.

pohly force-pushed the config-defaults branch from 81bc939 to 90f9d07 Compare November 6, 2019 16:21

This was referenced Nov 7, 2019

Release v3.0.0 to make the new major release importable #237

Closed

Disable gRPC keepalive dial option on default #238

Closed

keepalive API #239

Merged

misterikkit reviewed Nov 13, 2019

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 13, 2019

k8s-ci-robot merged commit 769a246 into kubernetes-csi:master Nov 13, 2019

stmcginnis pushed a commit to stmcginnis/csi-test that referenced this pull request Oct 9, 2024

Merge pull request kubernetes-csi#233 from andyzhangx/andyzhangx-patch-1

de2fba8

remove windows 20H2 build since it's EOL long time ago

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

clean up configuration handling #233

clean up configuration handling #233

pohly commented Oct 29, 2019

k8s-ci-robot commented Oct 29, 2019

pohly Oct 29, 2019

pohly Oct 29, 2019

pohly Oct 29, 2019

msau42 commented Oct 29, 2019

misterikkit left a comment

misterikkit Oct 29, 2019

pohly Nov 5, 2019

misterikkit Oct 29, 2019

pohly Nov 5, 2019

misterikkit Oct 29, 2019

pohly Nov 5, 2019 •

edited

Loading

misterikkit Nov 13, 2019

misterikkit Oct 29, 2019

pohly Nov 5, 2019

pohly commented Nov 5, 2019

pohly commented Nov 6, 2019

wnxn commented Nov 7, 2019

misterikkit left a comment

misterikkit Nov 13, 2019

misterikkit Nov 13, 2019

misterikkit Nov 13, 2019

		// BeforeEach. For example, the BeforeEach could set up the CSI driver
		// and then set the Address field differently for each test.

clean up configuration handling #233

clean up configuration handling #233

Conversation

pohly commented Oct 29, 2019

k8s-ci-robot commented Oct 29, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msau42 commented Oct 29, 2019

misterikkit left a 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 Nov 5, 2019 • edited Loading

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 Nov 5, 2019

pohly commented Nov 6, 2019

wnxn commented Nov 7, 2019

misterikkit left a 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 Nov 5, 2019 •

edited

Loading