✨ scaffolding structure using builder pattern

Author: droot

Makefile

@@ -0,0 +1,14 @@
+#
+# Makefile with some common workflow for dev, build and test
+#
+
+all: build test
+
+.PHONY: build test
+
+build:
+	go build -o bin/kubebuilder ./cmd
+
+test:
+	go test -v ./cmd/... ./pkg/...
+

cmd/webhook.go

@@ -53,11 +53,11 @@ Scaffolds webhook handlers based on group, version, kind and other user inputs.
 
 			projectInfo, err := scaffold.LoadProjectFile("PROJECT")
 			if err != nil {
-				log.Fatal("failed to read the PROJECT file: %v", err)
+				log.Fatalf("failed to read the PROJECT file: %v", err)
 			}
 
 			if projectInfo.Version != project.Version1 {
-				fmt.Println("webhook scaffolding is not supported for this project version: %s", projectInfo.Version)
+				fmt.Printf("webhook scaffolding is not supported for this project version: %s \n", projectInfo.Version)
 				os.Exit(0)
 			}
 

common.sh

@@ -159,18 +159,24 @@ function setup_envs {
   export TEST_DEP=$tmp_root/kubebuilder/init_project
 }
 
-function cache_dep {
-  header_text "caching inited projects"
+function restore_go_deps {
+  header_text "restoring Go dependencies"
+  tar -zxf ${go_workspace}/src/sigs.k8s.io/kubebuilder/test/vendor.v1.tgz
+}
+
+function cache_project {
+  header_text "caching initialized projects"
   if [ -d "$TEST_DEP" ]; then
     rm -rf "$TEST_DEP"
   fi
   mkdir -p "$TEST_DEP"
   cp -r $PWD/* $TEST_DEP
 }
 
-function dump_cache {
-  header_text "dump cached project and deps"
+function dump_project {
+  header_text "restoring cached project"
   if [ -d "$TEST_DEP" ]; then
     cp -r $TEST_DEP/* .
+    restore_go_deps
   fi
 }

generate_vendor.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+#  Copyright 2019 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.
+
+#
+# Script to generate vendor archive that contains vendor and Gopkg.toml for a
+# given project version
+#
+set -e
+
+go_workspace=''
+for p in ${GOPATH//:/ }; do
+  if [[ $PWD/ = $p/* ]]; then
+    go_workspace=$p
+  fi
+done
+
+if [ -z $go_workspace ]; then
+  echo 'Current directory is not in $GOPATH' >&2
+  exit 1
+fi
+
+build_kb() {
+	rm -f /tmp/kb && \
+	go build -o /tmp/kb sigs.k8s.io/kubebuilder/cmd
+}
+
+
+#
+# generate_vendor takes project version as input and creates vendor archive
+# containing Go dependencies for a Kubebuilder project along with the Gopkg.lock
+# file.
+#
+generate_vendor() {
+	version=$1
+	project_dir=${go_workspace}/src/sigs.k8s.io/kubebuilder-test
+	mkdir -p ${project_dir}
+	rm -rf ${project_dir}/*
+	pushd . 
+	cd ${project_dir}
+	/tmp/kb init --project-version $version --domain testproject.org --license apache2 --owner "The Kubernetes authors" --dep=true
+	make
+	tar -zcvf vendor.v$version.tgz vendor Gopkg.lock && \
+	echo "vendor archieve vendor.v$version.tgz is ready."
+	popd
+}
+
+build_kb && \
+generate_vendor $1

generated_golden.sh

@@ -33,7 +33,8 @@ scaffold_test_project() {
 	rm -rf ./test/$project/*
 	pushd . 
 	cd test/$project
-	ln -s ../../vendor vendor
+	# untar Gopkg.lock and vendor directory for appropriate project version
+	tar -zxf ../vendor.v$version.tgz
 	../../bin/kubebuilder init --project-version $version --domain testproject.org --license apache2 --owner "The Kubernetes authors" --dep=false
 	../../bin/kubebuilder create api --group crew --version v1 --kind FirstMate --controller=true --resource=true --make=false
 	../../bin/kubebuilder alpha webhook --group crew --version v1 --kind FirstMate --type=mutating --operations=create,update --make=false
@@ -46,9 +47,12 @@ scaffold_test_project() {
 	../../bin/kubebuilder alpha webhook --group core --version v1 --kind Namespace --type=mutating --operations=update --make=false
 	../../bin/kubebuilder create api --group policy --version v1beta1 --kind HealthCheckPolicy --example=false --controller=true --resource=true --namespaced=false --make=false
 	make
+	rm -f Gopkg.lock
+	rm -rf ./vendor
+	rm -rf ./bin
 	popd
 }
 
 build_kb && \
-scaffold_test_project project 1
-# scaffold_test_project project_v2 2
+scaffold_test_project project 1 && \
+scaffold_test_project project_v2 2

pkg/scaffold/api.go

@@ -192,13 +192,19 @@ func (api *API) scaffoldV2() error {
 	if api.DoController {
 		fmt.Println(filepath.Join("controllers", fmt.Sprintf("%s_controller.go", strings.ToLower(r.Kind))))
 
+		ctrlScaffolder := &resourcev2.Controller{Resource: r}
 		err := (&Scaffold{}).Execute(
 			input.Options{},
-			&resourcev2.Controller{Resource: r},
+			ctrlScaffolder,
 		)
 		if err != nil {
 			return fmt.Errorf("error scaffolding controller: %v", err)
 		}
+
+		err = ctrlScaffolder.UpdateMain("main.go")
+		if err != nil {
+			return fmt.Errorf("error updating main.go with reconciler code: %v", err)
+		}
 	}
 	//
 	// if api.RunMake {

pkg/scaffold/project.go

@@ -68,7 +68,6 @@ func (p *Project) Scaffold() error {
 		input.Options{ProjectPath: projectInput.Path, BoilerplatePath: bpInput.Path},
 		&manager.Config{Image: imgName},
 		&project.GitIgnore{},
-		&project.GopkgToml{},
 		&project.Kustomize{},
 		&project.KustomizeRBAC{},
 		&project.KustomizeManager{},
@@ -107,6 +106,7 @@ func (p *Project) scaffoldV1() error {
 	return (&Scaffold{}).Execute(
 		input.Options{ProjectPath: p.Info.Path, BoilerplatePath: p.Boilerplate.Path},
 		&project.Makefile{Image: imgName},
+		&project.GopkgToml{},
 		&manager.Dockerfile{},
 		&manager.APIs{},
 		&manager.Controller{},
@@ -121,6 +121,7 @@ func (p *Project) scaffoldV2() error {
 	return (&Scaffold{}).Execute(
 		input.Options{ProjectPath: p.Info.Path, BoilerplatePath: p.Boilerplate.Path},
 		&scaffoldv2.Main{},
+		&scaffoldv2.GopkgToml{},
 		&scaffoldv2.Doc{},
 		&scaffoldv2.Makefile{Image: imgName},
 		&scaffoldv2.Dockerfile{},

pkg/scaffold/project/project.go

@@ -52,7 +52,7 @@ func (c *Project) GetInput() (input.Input, error) {
 		c.Version = Version1
 	}
 	if c.Repo == "" {
-		r, err := c.repoFromGopathAndWd(os.Getenv("GOPATH"), os.Getwd)
+		r, err := c.RepoFromGopathAndWd(os.Getenv("GOPATH"), os.Getwd)
 		if err != nil {
 			return input.Input{}, err
 		}
@@ -74,7 +74,7 @@ func (c *Project) GetInput() (input.Input, error) {
 	}, nil
 }
 
-func (Project) repoFromGopathAndWd(gopath string, getwd func() (string, error)) (string, error) {
+func (Project) RepoFromGopathAndWd(gopath string, getwd func() (string, error)) (string, error) {
 	// Assume the working dir is the root of the repo
 	wd, err := getwd()
 	if err != nil {