Add client-go example using fake client in test. #65291

misterikkit · 2018-06-21T01:39:20Z

What this PR does / why we need it:

This adds an example showing the steps needed to get a working
SharedInformerFactory with a fake client for testing.

Special notes for your reviewer:
I had a really hard time figuring out how to use this utility correctly. I don't think this example is sufficient documentation, but it's a good start.

Release note:

NONE

/sig api-machinery
/kind documentation

misterikkit · 2018-06-21T01:39:50Z

/assign @caesarxuchao

sttts · 2018-06-21T10:39:01Z

/lgtm
/approve

misterikkit · 2018-06-21T18:36:44Z

/assign @lavalamp
/retest

lavalamp · 2018-06-21T20:37:45Z

staging/BUILD

@@ -104,6 +104,7 @@ filegroup(
        "//staging/src/k8s.io/client-go/discovery:all-srcs",
        "//staging/src/k8s.io/client-go/dynamic:all-srcs",
        "//staging/src/k8s.io/client-go/examples/create-update-delete-deployment:all-srcs",
+        "//staging/src/k8s.io/client-go/examples/fake-client:all-srcs",


@ixdy (please route to better person if not you)--Is there a reason why we need this BUILD file? If so, can we make it not change for every subdir added? It kind of defeats the purpose of having nested OWNERS files.

The package-srcs glob only extends recursively to the next deepest package (i.e. BUILD file), so we have the all-srcs rule which includes that package.

We could create BUILD files in the root of all of the staging repos; then only those packages would be listed here, and subsequent changes underneath each repo would affect only that BUILD file.

This is why, for example, there is a pkg/BUILD file - there's no go sources in pkg/, but it prevents any directory changes in pkg/ from percolating up to the root OWNERS file.

(I'd be happy to do this change in a follow-up PR. I've got a different PR open right now affecting a bunch of BUILD files, and I'd like to avoid conflicting with myself.)

lavalamp · 2018-06-21T20:38:21Z

/approve

For build file change

caesarxuchao

Thanks, Jonathon!

Just two nits.

caesarxuchao · 2018-06-21T21:07:52Z

staging/src/k8s.io/client-go/examples/fake-client/main_test.go

+	// This sleep allows the informer goroutine to warm up and call List before we
+	// send any events to it. This is for proof-of-concept; your tests should not
+	// sleep.
+	time.Sleep(time.Second)


You can use a for loop to block on podInformer.HasSynced().

caesarxuchao · 2018-06-21T21:10:12Z

staging/src/k8s.io/client-go/examples/fake-client/main_test.go

+	})
+
+	// Make sure informers are running.
+	go informers.Start(ctx.Done())


As you said, no need to wrap in a goroutine.

This adds an example showing the steps needed to get a working SharedInformerFactory with a fake client for testing.

caesarxuchao · 2018-06-21T21:23:27Z

/lgtm

k8s-ci-robot · 2018-06-21T21:23:33Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: caesarxuchao, lavalamp, misterikkit, sttts

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:

~~staging/OWNERS~~ [lavalamp]

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

fejta-bot · 2018-06-22T00:33:33Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

k8s-github-robot · 2018-06-22T10:08:08Z

Automatic merge from submit-queue (batch tested with PRs 65301, 65291, 65307, 63845, 65313). If you want to cherry-pick this change to another branch, please follow the instructions here.

Automatic merge from submit-queue (batch tested with PRs 63773, 65411). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. client-go/examples/fake-client: add doc.go to fix go build warnings The publishing bot is currently broken (#56876 (comment)). This is due to the following error: ``` [24 Jun 18 15:08 UTC]: Running smoke tests for branch master [24 Jun 18 15:08 UTC]: /bin/bash -xec "godep restore\ngo build ./...\ngo test $(go list ./... | grep -v /vendor/)\n" + godep restore + go build ./... go build k8s.io/client-go/examples/fake-client: no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client [24 Jun 18 15:09 UTC]: exit status 1 + godep restore + go build ./... go build k8s.io/client-go/examples/fake-client: no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client [24 Jun 18 15:09 UTC]: exit status 1``` ``` The fakeclient package does not have any non-test go files. The test file was added in #65291 2 days ago. This causes `go build` to give a warning: `no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client`, which breaks the publishing bot. This PR adds a dummy doc.go file in the package to avoid this warning and fix the publishing bot. **Release note**: ```release-note NONE ```

Automatic merge from submit-queue (batch tested with PRs 63773, 65411). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. client-go/examples/fake-client: add doc.go to fix go build warnings The publishing bot is currently broken (kubernetes/kubernetes#56876 (comment)). This is due to the following error: ``` [24 Jun 18 15:08 UTC]: Running smoke tests for branch master [24 Jun 18 15:08 UTC]: /bin/bash -xec "godep restore\ngo build ./...\ngo test $(go list ./... | grep -v /vendor/)\n" + godep restore + go build ./... go build k8s.io/client-go/examples/fake-client: no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client [24 Jun 18 15:09 UTC]: exit status 1 + godep restore + go build ./... go build k8s.io/client-go/examples/fake-client: no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client [24 Jun 18 15:09 UTC]: exit status 1``` ``` The fakeclient package does not have any non-test go files. The test file was added in kubernetes/kubernetes#65291 2 days ago. This causes `go build` to give a warning: `no non-test Go files in /go-workspace/src/k8s.io/client-go/examples/fake-client`, which breaks the publishing bot. This PR adds a dummy doc.go file in the package to avoid this warning and fix the publishing bot. **Release note**: ```release-note NONE ``` Kubernetes-commit: 7a9a30a4f7eae900bffd4b477a431a999de350dd

k8s-ci-robot assigned caesarxuchao Jun 21, 2018

k8s-ci-robot requested review from deads2k and sttts June 21, 2018 01:39

misterikkit force-pushed the fake-client branch from 88ef188 to 3e6f291 Compare June 21, 2018 01:42

k8s-ci-robot assigned sttts Jun 21, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2018

k8s-ci-robot assigned lavalamp Jun 21, 2018

misterikkit mentioned this pull request Jun 21, 2018

client-go: using a fake client is difficult and undocumented #65333

Closed

lavalamp reviewed Jun 21, 2018

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 21, 2018

caesarxuchao reviewed Jun 21, 2018

View reviewed changes

caesarxuchao removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2018

Add client-go example using fake client in test.

aed487b

This adds an example showing the steps needed to get a working SharedInformerFactory with a fake client for testing.

misterikkit force-pushed the fake-client branch from 3e6f291 to aed487b Compare June 21, 2018 21:18

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2018

k8s-github-robot merged commit 8008c7d into kubernetes:master Jun 22, 2018

nikhita mentioned this pull request Jun 24, 2018

client-go/examples/fake-client: add doc.go to fix go build warnings #65411

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add client-go example using fake client in test. #65291

Add client-go example using fake client in test. #65291

misterikkit commented Jun 21, 2018 •

edited

misterikkit commented Jun 21, 2018

sttts commented Jun 21, 2018

misterikkit commented Jun 21, 2018

lavalamp Jun 21, 2018

ixdy Jun 21, 2018

ixdy Jun 21, 2018

lavalamp commented Jun 21, 2018

caesarxuchao left a comment

caesarxuchao Jun 21, 2018

misterikkit Jun 21, 2018

caesarxuchao Jun 21, 2018

misterikkit Jun 21, 2018

caesarxuchao commented Jun 21, 2018

k8s-ci-robot commented Jun 21, 2018

fejta-bot commented Jun 22, 2018

k8s-github-robot commented Jun 22, 2018

Add client-go example using fake client in test. #65291

Add client-go example using fake client in test. #65291

Conversation

misterikkit commented Jun 21, 2018 • edited

misterikkit commented Jun 21, 2018

sttts commented Jun 21, 2018

misterikkit commented Jun 21, 2018

lavalamp Jun 21, 2018

Choose a reason for hiding this comment

ixdy Jun 21, 2018

Choose a reason for hiding this comment

ixdy Jun 21, 2018

Choose a reason for hiding this comment

lavalamp commented Jun 21, 2018

caesarxuchao left a comment

Choose a reason for hiding this comment

caesarxuchao Jun 21, 2018

Choose a reason for hiding this comment

misterikkit Jun 21, 2018

Choose a reason for hiding this comment

caesarxuchao Jun 21, 2018

Choose a reason for hiding this comment

misterikkit Jun 21, 2018

Choose a reason for hiding this comment

caesarxuchao commented Jun 21, 2018

k8s-ci-robot commented Jun 21, 2018

fejta-bot commented Jun 22, 2018

k8s-github-robot commented Jun 22, 2018

misterikkit commented Jun 21, 2018 •

edited