pkg/test/context.go: create an id that is a valid namespace name #2335

dustinspecker · 2019-12-13T12:33:38Z

Before this change it was possible for TestCtx.GetNamespace() to create a
namespace with too long of a name, thus getting an error from Kubernetes
saying the namespace name exceeded 63 characters.

Now set the id to "osdk-e2e-UUID", so that TestCtx.GetNamespace() is
guaranteed to have a namespace name be 63 characters or less, which is a
valid namespace name.

Fixes #2101

dustinspecker · 2019-12-13T12:36:27Z

pkg/test/resource_creator.go

@@ -34,7 +35,7 @@ func (ctx *TestCtx) GetNamespace() (string, error) {
 		return ctx.namespace, nil
 	}
 	// create namespace
-	ctx.namespace = ctx.GetID()
+	ctx.namespace = fmt.Sprintf("osdk-e2e-%s", uuid.New())


I'd like to investigate adding unit tests around GetNamespace this weekend. Need to figure how to handle testing code using UUID. Attach a UUID on TestCtx? Maybe change GetID() to return this UUID on TestCtx instead of creating the UUID here.

Taking a second look at this: I think assigning ctx.id in newTestCtx to the above string would make this all easier. So instead of changing resource_creator modify pkg/test/context.go's newTestCtx.

dustinspecker · 2019-12-13T13:01:40Z

pkg/test/context.go

-
-	id := prefix + "-" + strconv.FormatInt(time.Now().Unix(), 10)
+	// TestCtx is used among others for namespace names where '/' is forbidden and must be 63 characters or less
+	id := "osdk-e2e-" + uuid.New()


I like this approach much better than my previous code change. This weekend I'd still like to add unit tests around NewTestCtx, but please let me know thoughts on this approach.

It is ok for me. @joelanford have you any objection?

camilamacedo86 · 2020-01-07T09:17:01Z

pkg/test/context.go

-	}
-
-	id := prefix + "-" + strconv.FormatInt(time.Now().Unix(), 10)
+	// TestCtx is used among others for namespace names where '/' is forbidden and must be 63 characters or less


@joelanford wdyt? Are you ok with?
For me, it shows fine.

camilamacedo86 · 2020-01-07T09:22:06Z

CHANGELOG.md

@@ -25,6 +25,7 @@

 ### Bug Fixes
 - Fix `operator-sdk build`'s `--image-build-args` to support spaces within quotes like `--label some.name="First Last"`. ([#2312](https://github.com/operator-framework/operator-sdk/pull/2312))
+- Fix `pkg/test/NewTestCtx()` to always create an id that is a valid namespace name. This prevents `TestCtx.GetNamespace()` from attempting to sometimes erroneously creating a namespace with a name exceeding 63 characters. ([#2335](https://github.com/operator-framework/operator-sdk/pull/2335))


WDYT?

Suggested change

- Fix `pkg/test/NewTestCtx()` to always create an id that is a valid namespace name. This prevents `TestCtx.GetNamespace()` from attempting to sometimes erroneously creating a namespace with a name exceeding 63 characters. ([#2335](https://github.com/operator-framework/operator-sdk/pull/2335))

- Fix issue to use from test-framework which is faced when the created namespace is exceeding 63 characters. The `TestCtx.GetNamespace()` was changed to always create a unique ID instead of using the operator name in order to avoid this scenario. ([#2335](https://github.com/operator-framework/operator-sdk/pull/2335))

Thank you for the suggestion! I made a couple additional modifications to the proposed change. Please let me know what you think.

camilamacedo86

Hi @dustinspecker,

Really tks for your contribution. It shows OK for me. Just a nit in the CHANGELOG.
Also, please could you rebase it with the master branch?

estroz · 2020-01-09T18:39:36Z

test/test-framework/test/e2e/memcached_test.go

@@ -45,8 +45,8 @@ func TestMemcached(t *testing.T) {
 	}
 	// run subtests
 	t.Run("memcached-group", func(t *testing.T) {
-		t.Run("Cluster", MemcachedCluster)
-		t.Run("Cluster2", MemcachedCluster)
+		t.Run("AVeryLongClusterNameThatIsSoLong", MemcachedCluster)


Why are these names changed?

I think he tried to demonstrate that the issue was solved.
However, I agree with @estroz. I would stick with the previous names either.

Yep, that's why I did it. Before this change that test would fail. I'll change it back.

Before this change it was possible for `TestCtx.GetNamespace()` to create a namespace with too long of a name, thus getting an error from Kubernetes saying the namespace name exceeded 63 characters. Now set the id to "osdk-e2e-UUID", so that `TestCtx.GetNamespace()` is guaranteed to have a namespace name be 63 characters or less, which is a valid namespace name. Fixes operator-framework#2101

camilamacedo86

It shows ok for me
/lgtm
/approve

estroz

/lgtm

openshift-ci-robot requested review from AlexNPavel and theishshah December 13, 2019 12:33

openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 13, 2019

dustinspecker commented Dec 13, 2019

View reviewed changes

dustinspecker force-pushed the fix-namespace-creation branch from 38d189f to dd1cdd8 Compare December 13, 2019 12:59

openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 13, 2019

dustinspecker force-pushed the fix-namespace-creation branch from dd1cdd8 to df69a19 Compare December 13, 2019 12:59

dustinspecker changed the title ~~pkg/test/resource_creator: prevent creating too long of namespace name~~ pkg/test/context.go: create an id that is a valid namespace name. Dec 13, 2019

dustinspecker commented Dec 13, 2019

View reviewed changes

dustinspecker changed the title ~~pkg/test/context.go: create an id that is a valid namespace name.~~ pkg/test/context.go: create an id that is a valid namespace name Dec 13, 2019

dustinspecker force-pushed the fix-namespace-creation branch 3 times, most recently from ed51bc6 to 6938a11 Compare December 19, 2019 12:03

camilamacedo86 reviewed Jan 7, 2020

View reviewed changes

camilamacedo86 requested review from joelanford, estroz and jmccormick2001 January 7, 2020 09:17

camilamacedo86 reviewed Jan 7, 2020

View reviewed changes

camilamacedo86 added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 8, 2020

dustinspecker force-pushed the fix-namespace-creation branch from 6938a11 to 40c907c Compare January 9, 2020 12:37

openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 9, 2020

estroz reviewed Jan 9, 2020

View reviewed changes

dustinspecker force-pushed the fix-namespace-creation branch from 40c907c to 176030b Compare January 10, 2020 00:21

Merge branch 'master' into fix-namespace-creation

d79d275

camilamacedo86 approved these changes Jan 16, 2020

View reviewed changes

openshift-ci-robot assigned camilamacedo86 Jan 16, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 16, 2020

estroz approved these changes Jan 17, 2020

View reviewed changes

openshift-ci-robot assigned estroz Jan 17, 2020

estroz merged commit ab62973 into operator-framework:master Jan 17, 2020

dustinspecker deleted the fix-namespace-creation branch January 17, 2020 22:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pkg/test/context.go: create an id that is a valid namespace name #2335

pkg/test/context.go: create an id that is a valid namespace name #2335

dustinspecker commented Dec 13, 2019 •

edited

Loading

dustinspecker Dec 13, 2019

dustinspecker Dec 13, 2019

dustinspecker Dec 13, 2019

camilamacedo86 Jan 9, 2020

camilamacedo86 Jan 7, 2020

camilamacedo86 Jan 7, 2020

dustinspecker Jan 9, 2020

camilamacedo86 left a comment •

edited

Loading

estroz Jan 9, 2020

camilamacedo86 Jan 9, 2020

dustinspecker Jan 10, 2020

camilamacedo86 left a comment

estroz left a comment

	- Fix `pkg/test/NewTestCtx()` to always create an id that is a valid namespace name. This prevents `TestCtx.GetNamespace()` from attempting to sometimes erroneously creating a namespace with a name exceeding 63 characters. ([#2335](https://github.com/operator-framework/operator-sdk/pull/2335))
	- Fix issue to use from test-framework which is faced when the created namespace is exceeding 63 characters. The `TestCtx.GetNamespace()` was changed to always create a unique ID instead of using the operator name in order to avoid this scenario. ([#2335](https://github.com/operator-framework/operator-sdk/pull/2335))

pkg/test/context.go: create an id that is a valid namespace name #2335

pkg/test/context.go: create an id that is a valid namespace name #2335

Conversation

dustinspecker commented Dec 13, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment • 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

camilamacedo86 left a comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

dustinspecker commented Dec 13, 2019 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading