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

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