Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jun 22, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions staging/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(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.)

"//staging/src/k8s.io/client-go/examples/in-cluster-client-configuration:all-srcs",
"//staging/src/k8s.io/client-go/examples/out-of-cluster-client-configuration:all-srcs",
"//staging/src/k8s.io/client-go/examples/workqueue:all-srcs",
Expand Down
4 changes: 4 additions & 0 deletions staging/src/k8s.io/client-go/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ for client-go.
the custom resources.

[informer]: https://godoc.org/k8s.io/client-go/tools/cache#NewInformer

### Testing

- [**Fake Client**](./fake-client): Use a fake client in tests.
27 changes: 27 additions & 0 deletions staging/src/k8s.io/client-go/examples/fake-client/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
load("@io_bazel_rules_go//go:def.bzl", "go_test")

go_test(
name = "go_default_test",
srcs = ["main_test.go"],
deps = [
"//vendor/k8s.io/api/core/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//vendor/k8s.io/client-go/informers:go_default_library",
"//vendor/k8s.io/client-go/kubernetes/fake:go_default_library",
"//vendor/k8s.io/client-go/tools/cache:go_default_library",
],
)

filegroup(
name = "package-srcs",
srcs = glob(["**"]),
tags = ["automanaged"],
visibility = ["//visibility:private"],
)

filegroup(
name = "all-srcs",
srcs = [":package-srcs"],
tags = ["automanaged"],
visibility = ["//visibility:public"],
)
14 changes: 14 additions & 0 deletions staging/src/k8s.io/client-go/examples/fake-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Fake Client Example

This example demonstrates how to use a fake client with SharedInformerFactory in tests.

It covers:
* Creating the fake client
* Setting up real informers
* Injecting events into those informers

## Running

```
go test -v k8s.io/client-go/examples/fake-client
```
77 changes: 77 additions & 0 deletions staging/src/k8s.io/client-go/examples/fake-client/main_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
Copyright 2018 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package fakeclient

import (
"context"
"testing"
"time"

"k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes/fake"
"k8s.io/client-go/tools/cache"
)

// TestFakeClient demonstrates how to use a fake client with SharedInformerFactory in tests.
func TestFakeClient(t *testing.T) {
// Use a timeout to keep the test from hanging.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)

// Create the fake client.
client := fake.NewSimpleClientset()

// We will create an informer that writes added pods to a channel.
pods := make(chan *v1.Pod, 1)
informers := informers.NewSharedInformerFactory(client, 0)
podInformer := informers.Core().V1().Pods().Informer()
podInformer.AddEventHandler(&cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
pod := obj.(*v1.Pod)
t.Logf("pod added: %s/%s", pod.Namespace, pod.Name)
pods <- pod
cancel()
},
})

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

// This is not required in tests, but it serves as a proof-of-concept by
// ensuring that the informer goroutine have warmed up and called List before
// we send any events to it.
for !podInformer.HasSynced() {
time.Sleep(10 * time.Millisecond)
}

// Inject an event into the fake client.
p := &v1.Pod{ObjectMeta: metav1.ObjectMeta{Name: "my-pod"}}
_, err := client.Core().Pods("test-ns").Create(p)
if err != nil {
t.Errorf("error injecting pod add: %v", err)
}

// Wait and check result.
<-ctx.Done()
select {
case pod := <-pods:
t.Logf("Got pod from channel: %s/%s", pod.Namespace, pod.Name)
default:
t.Error("Informer did not get the added pod")
}
}