Merge pull request #62 from anmol372/helmv1

Move plugin helm/v1 from Operator SDK

Author: Eric Stroczynski

Dockerfile

@@ -24,4 +24,4 @@ WORKDIR /
 COPY --from=builder /workspace/helm-operator .
 USER nonroot:nonroot
 
-ENTRYPOINT ["/helm-operator"]
+ENTRYPOINT ["/helm-operator", "run"]

Makefile

@@ -12,7 +12,8 @@ endif
 
 # GO_BUILD_ARGS should be set when running 'go build' or 'go install'.
 REPO = $(shell go list -m)
-VERSION = $(shell git describe --dirty --tags --always)
+#TODO (anrastog): set version to repo build/tag after v1 plugin is available in master.
+VERSION = master
 GIT_COMMIT = $(shell git rev-parse HEAD)
 GO_BUILD_ARGS = \
   -gcflags "all=-trimpath=$(shell dirname $(shell pwd))" \
@@ -22,7 +23,7 @@ GO_BUILD_ARGS = \
     -X '$(REPO)/internal/version.GitCommit=$(GIT_COMMIT)' \
   " \
 
-all: manager
+#all: manager
 
 # Run tests
 ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
@@ -45,14 +46,15 @@ vet:
 
 lint: golangci-lint
 	$(GOLANGCI_LINT) run
-
+lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
+	$(GOLANGCI_LINT) run --fix
 # Build the docker image
 docker-build:
-	docker build . -t ${IMG}
+	docker build . -t quay.io/joelanford/helm-operator:$(VERSION)
 
 # Push the docker image
 docker-push:
-	docker push ${IMG}
+	docker push quay.io/joelanford/helm-operator:$(VERSION)
 
 # find or download controller-gen
 # download controller-gen if necessary

go.mod

@@ -3,24 +3,50 @@ module github.com/joelanford/helm-operator
 go 1.13
 
 require (
+	github.com/Microsoft/hcsshim v0.8.9 // indirect
+	github.com/bugsnag/bugsnag-go v1.5.3 // indirect
+	github.com/bugsnag/panicwrap v1.2.0 // indirect
+	github.com/containerd/continuity v0.0.0-20200413184840-d3ef23f19fbb // indirect
+	github.com/docker/go-metrics v0.0.1 // indirect
+	github.com/docker/libtrust v0.0.0-20160708172513-aabc10ec26b7 // indirect
+	github.com/garyburd/redigo v1.6.0 // indirect
 	github.com/go-logr/logr v0.1.0
+	github.com/gofrs/uuid v3.3.0+incompatible // indirect
+	github.com/gorilla/handlers v1.4.2 // indirect
+	github.com/iancoleman/strcase v0.1.2
+	github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 // indirect
+	github.com/kr/text v0.1.0
+	github.com/mattn/go-colorable v0.1.2 // indirect
 	github.com/onsi/ginkgo v1.12.1
 	github.com/onsi/gomega v1.10.1
+	github.com/opencontainers/image-spec v1.0.2-0.20190823105129-775207bd45b6 // indirect
 	github.com/operator-framework/operator-lib v0.1.0
+	github.com/prometheus/client_golang v1.5.1 // indirect
+	github.com/sirupsen/logrus v1.6.0
+	github.com/spf13/afero v1.2.2
 	github.com/spf13/cobra v1.0.0
 	github.com/spf13/pflag v1.0.5
-	github.com/stretchr/testify v1.5.1
-	go.uber.org/zap v1.13.0
+	github.com/stretchr/testify v1.6.1
+	github.com/yvasiyarov/go-metrics v0.0.0-20150112132944-c25f46c4b940 // indirect
+	github.com/yvasiyarov/gorelic v0.0.7 // indirect
+	github.com/yvasiyarov/newrelic_platform_go v0.0.0-20160601141957-9c099fbc30e9 // indirect
+	golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f // indirect
+	golang.org/x/net v0.0.0-20200625001655-4c5254603344 // indirect
+	golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae // indirect
+	golang.org/x/tools v0.0.0-20200403190813-44a64ad78b9b
 	gomodules.xyz/jsonpatch/v2 v2.0.1
-	helm.sh/helm/v3 v3.2.0
-	k8s.io/api v0.18.4
-	k8s.io/apiextensions-apiserver v0.18.4
-	k8s.io/apimachinery v0.18.4
-	k8s.io/cli-runtime v0.18.2
-	k8s.io/client-go v0.18.4
-	k8s.io/klog v1.0.0
-	k8s.io/kubectl v0.18.2
+	google.golang.org/genproto v0.0.0-20200701001935-0939c5918c31 // indirect
+	google.golang.org/grpc v1.30.0 // indirect
+	google.golang.org/protobuf v1.25.0 // indirect
+	helm.sh/helm/v3 v3.3.4
+	k8s.io/api v0.18.8
+	k8s.io/apiextensions-apiserver v0.18.8
+	k8s.io/apimachinery v0.18.8
+	k8s.io/cli-runtime v0.18.8
+	k8s.io/client-go v0.18.8
+	k8s.io/kubectl v0.18.8
 	rsc.io/letsencrypt v0.0.3 // indirect
-	sigs.k8s.io/controller-runtime v0.6.1
+	sigs.k8s.io/controller-runtime v0.6.2
+	sigs.k8s.io/kubebuilder v1.0.9-0.20201021204649-36124ae2e027
 	sigs.k8s.io/yaml v1.2.0
 )

go.sum

@@ -43,7 +43,7 @@ func NewCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "run",
-		Short: "Run the operator",
+		Short: "Run the helm operator controller",
 		Run: func(cmd *cobra.Command, _ []string) {
 			logf.SetLogger(zapl.New(zapl.UseFlagOptions(opts)))
 			r.run(cmd)

internal/cmd/run/cmd.go

@@ -17,6 +17,7 @@ limitations under the License.
 package version
 
 var (
+	//TODO: Hardcode it to version string to support importing and usage in operator-sdk
 	Version   = "unknown"
 	GitCommit = "unknown"
 )

internal/version/version.go

@@ -0,0 +1,56 @@
+/*
+Copyright 2020 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 cmdutil
+
+import "sigs.k8s.io/kubebuilder/pkg/plugin/scaffold"
+
+// RunOptions represent the types used to implement the different commands
+type RunOptions interface {
+	// - Step 1: verify that the command can be run (e.g., go version, project version, arguments, ...)
+	Validate() error
+	// - Step 2: create the Scaffolder instance
+	GetScaffolder() (scaffold.Scaffolder, error)
+	// - Step 3: call the Scaffold method of the Scaffolder instance. Doesn't need any method
+	// - Step 4: finish the command execution
+	PostScaffold() error
+}
+
+// Run executes a command
+func Run(options RunOptions) error {
+	// Step 1: validate
+	if err := options.Validate(); err != nil {
+		return err
+	}
+
+	// Step 2: get scaffolder
+	scaffolder, err := options.GetScaffolder()
+	if err != nil {
+		return err
+	}
+	// Step 3: scaffold
+	if scaffolder != nil {
+		if err := scaffolder.Scaffold(); err != nil {
+			return err
+		}
+	}
+	// Step 4: finish
+	if err := options.PostScaffold(); err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/plugins/internal/kubebuilder/cmdutil/cmdutil.go

@@ -0,0 +1,173 @@
+/*
+Copyright 2020 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 filesystem
+
+import (
+	"errors"
+	"fmt"
+)
+
+// This file contains the errors returned by the file system wrapper
+// They are not exported as they should not be created outside of this package
+// Exported functions are provided to check which kind of error was returned
+
+// fileExistsError is returned if it could not be checked if the file exists
+type fileExistsError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e fileExistsError) Error() string {
+	return fmt.Sprintf("failed to check if %s exists: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e fileExistsError) Unwrap() error {
+	return e.err
+}
+
+// IsFileExistsError checks if the returned error is because the file could not be checked for existence
+func IsFileExistsError(err error) bool {
+	return errors.As(err, &fileExistsError{})
+}
+
+// openFileError is returned if the file could not be opened
+type openFileError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e openFileError) Error() string {
+	return fmt.Sprintf("failed to open %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e openFileError) Unwrap() error {
+	return e.err
+}
+
+// IsOpenFileError checks if the returned error is because the file could not be opened
+func IsOpenFileError(err error) bool {
+	return errors.As(err, &openFileError{})
+}
+
+// createDirectoryError is returned if the directory could not be created
+type createDirectoryError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e createDirectoryError) Error() string {
+	return fmt.Sprintf("failed to create directory for %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e createDirectoryError) Unwrap() error {
+	return e.err
+}
+
+// IsCreateDirectoryError checks if the returned error is because the directory could not be created
+func IsCreateDirectoryError(err error) bool {
+	return errors.As(err, &createDirectoryError{})
+}
+
+// createFileError is returned if the file could not be created
+type createFileError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e createFileError) Error() string {
+	return fmt.Sprintf("failed to create %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e createFileError) Unwrap() error {
+	return e.err
+}
+
+// IsCreateFileError checks if the returned error is because the file could not be created
+func IsCreateFileError(err error) bool {
+	return errors.As(err, &createFileError{})
+}
+
+// readFileError is returned if the file could not be read
+type readFileError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e readFileError) Error() string {
+	return fmt.Sprintf("failed to read from %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e readFileError) Unwrap() error {
+	return e.err
+}
+
+// IsReadFileError checks if the returned error is because the file could not be read
+func IsReadFileError(err error) bool {
+	return errors.As(err, &readFileError{})
+}
+
+// writeFileError is returned if the file could not be written
+type writeFileError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e writeFileError) Error() string {
+	return fmt.Sprintf("failed to write to %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e writeFileError) Unwrap() error {
+	return e.err
+}
+
+// IsWriteFileError checks if the returned error is because the file could not be written to
+func IsWriteFileError(err error) bool {
+	return errors.As(err, &writeFileError{})
+}
+
+// closeFileError is returned if the file could not be created
+type closeFileError struct {
+	path string
+	err  error
+}
+
+// Error implements error interface
+func (e closeFileError) Error() string {
+	return fmt.Sprintf("failed to close %s: %v", e.path, e.err)
+}
+
+// Unwrap implements Wrapper interface
+func (e closeFileError) Unwrap() error {
+	return e.err
+}
+
+// IsCloseFileError checks if the returned error is because the file could not be closed
+func IsCloseFileError(err error) bool {
+	return errors.As(err, &closeFileError{})
+}