Merge pull request #310 from mengqiy/v1e2e

add e2e test for v1 kubebuilder

Author: k8s-ci-robot

cmd/kubebuilder/v1/api.go

@@ -77,6 +77,12 @@ func (o *apiOptions) RunAddAPI() {
 		if err != nil {
 			log.Fatal(err)
 		}
+	} else {
+		// disable generation of example reconcile body if not scaffolding resource
+		// because this could result in a fork-bomb of k8s resources where watching a
+		// deployment, replicaset etc. results in generating deployment which
+		// end up genrating replicaset, pod etc recursively.
+		r.CreateExampleReconcileBody = false
 	}
 
 	if o.doController {
@@ -172,6 +178,6 @@ func ResourceForFlags(f *flag.FlagSet) *resource.Resource {
 	f.StringVar(&r.Version, "version", "", "resource Version")
 	f.BoolVar(&r.Namespaced, "namespaced", true, "resource is namespaced")
 	f.BoolVar(&r.CreateExampleReconcileBody, "example", true,
-		"true if an example reconcile body should be written")
+		"if true an example reconcile body should be written while scaffolding a resource.")
 	return r
 }

common.sh

@@ -142,7 +142,7 @@ function setup_envs {
   header_text "setting up env vars"
 
   # Setup env vars
-  export PATH=/tmp/kubebuilder/bin/:$PATH
+  export PATH=/tmp/kubebuilder/bin:$PATH
   export TEST_ASSET_KUBECTL=/tmp/kubebuilder/bin/kubectl
   export TEST_ASSET_KUBE_APISERVER=/tmp/kubebuilder/bin/kube-apiserver
   export TEST_ASSET_ETCD=/tmp/kubebuilder/bin/etcd

test/e2e/common.go

@@ -0,0 +1,72 @@
+/*
+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 e2e
+
+import (
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/kubernetes-sigs/kubebuilder/test/e2e/framework"
+	e2einternal "github.com/kubernetes-sigs/kubebuilder/test/internal/e2e"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func prepare(workDir string) {
+	By("create a path under given project dir, as the test work dir")
+	err := os.MkdirAll(workDir, 0755)
+	Expect(err).NotTo(HaveOccurred())
+}
+
+func cleanupv0(builderTest *e2einternal.KubebuilderTest, workDir string, imageName string) {
+	By("clean up created API objects during test process")
+	inputFile := filepath.Join(workDir, "hack", "install.yaml")
+	deleteOptions := []string{"delete", "-f", inputFile}
+	builderTest.RunKubectlCommand(framework.GetKubectlArgs(deleteOptions))
+
+	By("remove container image created during test")
+	builderTest.CleanupImage([]string{imageName})
+
+	By("remove test work dir")
+	os.RemoveAll(workDir)
+}
+
+func cleanupv1(builderTest *e2einternal.KubebuilderTest, workDir string, imageName string) {
+	By("clean up created API objects during test process")
+
+	kustomizeOptions := []string{"build", filepath.Join("config", "default")}
+	resources, err := builderTest.RunKustomizeCommand(kustomizeOptions)
+	if err != nil {
+		log.Printf("error when runing kustomize build during cleaning up: %v", err)
+	}
+
+	deleteOptions := []string{"delete", "--recursive", "-f", "-"}
+	_, err = builderTest.RunKubectlCommandWithInput(framework.GetKubectlArgs(deleteOptions), resources)
+	if err != nil {
+		log.Printf("error when runing kubectl delete during cleaning up: %v", err)
+	}
+
+	deleteOptions = []string{"delete", "--recursive", "-f", filepath.Join("config", "crds")}
+	_, err = builderTest.RunKubectlCommand(framework.GetKubectlArgs(deleteOptions))
+
+	By("remove container image created during test")
+	builderTest.CleanupImage([]string{imageName})
+
+	By("remove test work dir")
+	os.RemoveAll(workDir)
+}

test/e2e/e2e_test.go

@@ -17,9 +17,18 @@ limitations under the License.
 package e2e
 
 import (
+	"log"
+	"os"
+	"os/exec"
+	"path"
+	"strings"
 	"testing"
 
+	"github.com/golang/glog"
 	"github.com/kubernetes-sigs/kubebuilder/test/e2e/framework"
+	"github.com/kubernetes-sigs/kubebuilder/test/e2e/framework/ginkgowrapper"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 	"github.com/spf13/pflag"
 )
 
@@ -28,6 +37,51 @@ func init() {
 	pflag.Parse()
 }
 
+var kubebuilderBinDir string
+
+/*
+2 steps to do before running the e2e test suite
+1) go build a new kubebuilder binary
+2) install all required binaries, such as etcd and kube-apiserver
+If you have run testv0.sh or testv1.sh before running this e2e suite,
+it will build the new kubebuilder.
+*/
+// TODO: ensure the required binaries are installed when integrate with Prow.
+var _ = BeforeSuite(func(done Done) {
+	// Uncomment the following line to set the image name before runing the e2e test
+	//os.Setenv("IMG", "gcr.io/<my-project-name>/<iamge-name:tag>")
+	// If you want to run the test against a GKE cluster, run the following command first
+	// $ kubectl create clusterrolebinding myname-cluster-admin-binding --clusterrole=cluster-admin [email protected]
+	framework.TestContext.BinariesDir = "/tmp/kubebuilder/bin/"
+	// build a kubebuilder
+	targets := []string{"kubebuilder", "kubebuilder-gen"}
+	for _, target := range targets {
+		buildOptions := []string{
+			"build", "-o", path.Join(framework.TestContext.BinariesDir, target), path.Join("github.com/kubernetes-sigs/kubebuilder/cmd", target)}
+		cmd := exec.Command("go", buildOptions...)
+		cmd.Env = os.Environ()
+		command := strings.Join(cmd.Args, " ")
+		log.Printf("running %v", command)
+		output, err := cmd.CombinedOutput()
+		log.Printf("output when running:\n%s", output)
+		Expect(err).NotTo(HaveOccurred())
+	}
+
+	close(done)
+}, 60)
+
+var _ = AfterSuite(func() {
+	os.RemoveAll(kubebuilderBinDir)
+})
+
+// RunE2ETests checks configuration parameters (specified through flags) and then runs
+// E2E tests using the Ginkgo runner.
+func RunE2ETests(t *testing.T) {
+	RegisterFailHandler(ginkgowrapper.Fail)
+	glog.Infof("Starting kubebuilder suite")
+	RunSpecs(t, "Kubebuilder e2e suite")
+}
+
 func TestE2E(t *testing.T) {
 	RunE2ETests(t)
 }

test/e2e/e2e.go renamed to test/e2e/e2e_v0.go

@@ -5,7 +5,7 @@ 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
+  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,
@@ -18,42 +18,30 @@ package e2e
 
 import (
 	"fmt"
-	"os"
 	"path/filepath"
 	"strings"
-	"testing"
 	"time"
 
-	"github.com/golang/glog"
 	"github.com/kubernetes-sigs/kubebuilder/cmd/kubebuilder/util"
 	"github.com/kubernetes-sigs/kubebuilder/test/e2e/framework"
-	"github.com/kubernetes-sigs/kubebuilder/test/e2e/framework/ginkgowrapper"
 	e2einternal "github.com/kubernetes-sigs/kubebuilder/test/internal/e2e"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )
 
-// RunE2ETests checks configuration parameters (specified through flags) and then runs
-// E2E tests using the Ginkgo runner.
-func RunE2ETests(t *testing.T) {
-	RegisterFailHandler(ginkgowrapper.Fail)
-	glog.Infof("Starting kubebuilder suite")
-	RunSpecs(t, "Kubebuilder e2e suite")
-}
-
-var _ = Describe("main workflow", func() {
+var _ = Describe("v0 main workflow", func() {
 	It("should perform main kubebuilder workflow successfully", func() {
 		testSuffix := framework.RandomSuffix()
 		c := initConfig(testSuffix)
 		kubebuilderTest := e2einternal.NewKubebuilderTest(c.workDir, framework.TestContext.BinariesDir)
 
 		prepare(c.workDir)
-		defer cleanup(kubebuilderTest, c.workDir, c.controllerImageName)
+		defer cleanupv0(kubebuilderTest, c.workDir, c.controllerImageName)
 
 		var controllerPodName string
 
 		By("init project")
-		initOptions := []string{"--domain", c.domain}
+		initOptions := []string{"--domain", c.domain, "--project-version", "v0"}
 		err := kubebuilderTest.Init(initOptions)
 		Expect(err).NotTo(HaveOccurred())
 
@@ -86,7 +74,7 @@ var _ = Describe("main workflow", func() {
 		Expect(err).NotTo(HaveOccurred())
 
 		By("installing controller-manager in cluster")
-		inputFile := filepath.Join(kubebuilderTest.Dir, "hack", "install.yaml")
+		inputFile := filepath.Join("hack", "install.yaml")
 		installOptions := []string{"apply", "-f", inputFile}
 		_, err = kubebuilderTest.RunKubectlCommand(framework.GetKubectlArgs(installOptions))
 		Expect(err).NotTo(HaveOccurred())
@@ -104,7 +92,7 @@ var _ = Describe("main workflow", func() {
 				return fmt.Errorf("expect 1 controller pods running, but got %d", len(podNames))
 			}
 			controllerPodName = podNames[0]
-			Expect(controllerPodName).Should(HavePrefix(c.installName+"-controller-manager"))
+			Expect(controllerPodName).Should(HavePrefix(c.installName + "-controller-manager"))
 
 			// Validate pod status
 			getOptions = []string{"get", "pods", controllerPodName, "-n", c.namespace, "-o", "jsonpath={.status.phase}"}
@@ -150,22 +138,3 @@ var _ = Describe("main workflow", func() {
 		Eventually(controllerContainerLogs, 1*time.Minute, 500*time.Millisecond).Should(ContainSubstring("to reconcile deployment-example"))
 	})
 })
-
-func prepare(workDir string) {
-	By("create a path under given project dir, as the test work dir")
-	err := os.MkdirAll(workDir, 0755)
-	Expect(err).NotTo(HaveOccurred())
-}
-
-func cleanup(builderTest *e2einternal.KubebuilderTest, workDir string, imageName string) {
-	By("clean up created API objects during test process")
-	inputFile := filepath.Join(workDir, "hack", "install.yaml")
-	createOptions := []string{"delete", "-f", inputFile}
-	builderTest.RunKubectlCommand(framework.GetKubectlArgs(createOptions))
-
-	By("remove container image created during test")
-	builderTest.CleanupImage([]string{imageName})
-
-	By("remove test work dir")
-	os.RemoveAll(workDir)
-}