Merge pull request #7 from arttor/support-apps

Support apps

Author: arttor

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release Go Binaries
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  releases-matrix:
+    name: Release Matrix
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        goos: [ linux, windows, darwin ]
+        goarch: [ amd64, arm, arm64, 386 ]
+        exclude:
+          - goarch: arm
+            goos: darwin
+          - goarch: 386
+            goos: darwin
+          - goarch: arm
+            goos: windows
+          - goarch: arm64
+            goos: windows
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set APP_VERSION env
+        run: echo APP_VERSION=$(echo ${GITHUB_REF} | rev | cut -d'/' -f 1 | rev ) >> ${GITHUB_ENV}
+      - name: Set BUILD_TIME env
+        run: echo BUILD_TIME=$(date) >> ${GITHUB_ENV}
+      - name: Environment Printer
+        uses: managedkaos/[email protected]
+
+      - uses: wangyoucao577/[email protected]
+        with:
+          github_token: ${{ secrets.RELEASE_TOKEN }}
+          goos: ${{ matrix.goos }}
+          goarch: ${{ matrix.goarch }}
+          goversion: 1.16
+          project_path: ./cmd/helmify
+          ldflags: -X "main.appVersion=${{ env.APP_VERSION }}" -X "main.buildTime=${{ env.BUILD_TIME }}" -X main.gitCommit=${{ github.sha }} -X main.gitRef=${{ github.ref }}

README.md

@@ -10,34 +10,44 @@
 
 CLI that creates [Helm](https://github.com/helm/helm) charts from kubernetes yamls.
 
-Helmify reads a list of [supported k8s objects](#status) from stdin and converts it to a helm chart. Main [use-case](#integrate-to-your-operator-sdkkubebuilder-project) is to generate Helm charts for kubernetes operators build with
-[Operator-SDK](https://github.com/operator-framework/operator-sdk) or [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder). Submit issue if some features missing for your use-case.
+Helmify reads a list of [supported k8s objects](#status) from stdin and converts it to a helm chart. 
+[One of use-cases](#integrate-to-your-operator-sdkkubebuilder-project) is to generate Helm charts for kubernetes operators build with
+[Operator-SDK](https://github.com/operator-framework/operator-sdk) or [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder). 
 
-## Run
-Clone repo and execute command: 
+Submit issue if some features missing for your use-case.
 
-```shell
-cat test_data/kustomize.output | go run cmd/helmify/main.go mychart
-```
+## Usage
 
-Will generate `mychart` Helm chart form file `test_data/kustomize.output` representing typical operator 
-[kustomize](https://github.com/kubernetes-sigs/kustomize) output.
+Example 1: `cat my-app.yaml | helmify mychart`
+- will create 'mychart' directory with Helm chart from yaml file with k8s objects.
+
+Example 2: `awk 'FNR==1 && NR!=1  {print "---"}{print}' /<my_directory>/*.yaml | helmify mychart`
+- will create 'mychart' directory with Helm chart from all yaml files in `<my_directory> `directory.
 
-## Integrate to your Operator-SDK/Kubebuilder project
+Example 3: `kustomize build <kustomize_dir> | helmify mychart`
+- will create 'mychart' directory with Helm chart from kustomize output.
+
+### Integrate to your Operator-SDK/Kubebuilder project
 Tested with operator-sdk version: "v1.8.0".
 1. Open `Makefile` in your operator project generated by 
    [Operator-SDK](https://github.com/operator-framework/operator-sdk) or [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
 2. Add these lines to `Makefile`:
 ```makefile
 HELMIFY = $(shell pwd)/bin/helmify
 helmify:
-	$(call go-get-tool,$(HELMIFY),github.com/arttor/helmify/cmd/helmify@v0.2.2)
+	$(call go-get-tool,$(HELMIFY),github.com/arttor/helmify/cmd/helmify@v0.3.0)
 
 helm: manifests kustomize helmify
 	$(KUSTOMIZE) build config/default | $(HELMIFY)
 ```
 3. Run `make helm` in project root. It will generate helm chart with name 'chart' in 'chart' directory.
 
+## Install
+
+Download suitable for your system binary from [the Releases page](https://github.com/arttor/helmify/releases/latest).
+
+Unpack the helmify binary and add it to your PATH and you are good to go!
+
 ## Available options
 Helmify takes a chart name for an argument.
 Usage:
@@ -49,6 +59,7 @@ Usage:
 | -h -help | Prints help | `helmify -h`|
 | -v | Enable verbose output. Prints WARN and INFO. | `helmify -v`|
 | -vv | Enable very verbose output. Also prints DEBUG. | `helmify -vv`|
+| -version | Print helmify version. | `helmify -version`|
 
 ## Status
 Supported default operator resources:
@@ -75,10 +86,21 @@ examples for most k8s objects.
 2. Register your processor in the `pkg/app/app.go`
 3. Add relevant input sample to `test_data/kustomize.output`.
 
+
+### Run
+Clone repo and execute command:
+
+```shell
+cat test_data/k8s-operator-kustomize.output | go run ./cmd/helmify mychart
+```
+
+Will generate `mychart` Helm chart form file `test_data/k8s-operator-kustomize.output` representing typical operator
+[kustomize](https://github.com/kubernetes-sigs/kustomize) output.
+
 ### Test
 For manual testing, run program with debug output:
 ```shell
-cat test_data/kustomize.output | go run cmd/helmify/main.go -vv mychart
+cat test_data/k8s-operator-kustomize.output | go run ./cmd/helmify -vv mychart
 ```
 Then inspect logs and generated chart in `./mychart` directory.
 
@@ -87,5 +109,5 @@ To execute tests, run:
 go test ./...
 ```
 Beside unit-tests, project contains e2e test `pkg/app/app_e2e_test.go`.
-It's a go test, which uses `test_data/kustomize.output` to generate a chart in temporary directory. 
+It's a go test, which uses `test_data/*` to generate a chart in temporary directory. 
 Then runs `helm lint --strict` to check if generated chart is valid.

pkg/flags/flags.go cmd/helmify/flags.gopkg/flags/flags.go renamed to cmd/helmify/flags.go

@@ -1,30 +1,37 @@
-package flags
+package main
 
 import (
 	"flag"
 	"fmt"
-	"github.com/arttor/helmify/pkg/config"
 	"os"
+
+	"github.com/arttor/helmify/pkg/config"
 )
 
 const helpText = `Helmify parses kubernetes resources from std.in and converts it to a Helm chart.
-Use this command as a pipe for 'kustomize build' command output.
 
-Example: 'kustomize build <kustomize_dir> | helmify mychart' 
-  - will create 'mychart' directory with Helm chart.
+Example 1: 'kustomize build <kustomize_dir> | helmify mychart' 
+  - will create 'mychart' directory with Helm chart from kustomize output.
+
+Example 2: 'cat my-app.yaml | helmify mychart' 
+  - will create 'mychart' directory with Helm chart from yaml file.
+
+Example 3: 'awk 'FNR==1 && NR!=1  {print "---"}{print}' /my_directory/*.yaml | helmify mychart' 
+  - will create 'mychart' directory with Helm chart from all yaml files in my_directory directory.
 
 Usage:
   helmify [flags] CHART_NAME  -  CHART_NAME is optional. Default is 'chart'.
 
 Flags:
 `
 
-// Read command-line flags into app config.
-func Read() config.Config {
+// ReadFlags command-line flags into app config.
+func ReadFlags() config.Config {
 	result := config.Config{}
-	var h, help bool
+	var h, help, version bool
 	flag.BoolVar(&h, "h", false, "Print help. Example: helmify -h")
 	flag.BoolVar(&help, "help", false, "Print help. Example: helmify -help")
+	flag.BoolVar(&version, "version", false, "Print helmify version. Example: helmify -version")
 	flag.BoolVar(&result.Verbose, "v", false, "Enable verbose output (print WARN & INFO). Example: helmify -v")
 	flag.BoolVar(&result.VeryVerbose, "vv", false, "Enable very verbose output. Same as verbose but with DEBUG. Example: helmify -vv")
 	flag.Parse()
@@ -33,9 +40,10 @@ func Read() config.Config {
 		flag.PrintDefaults()
 		os.Exit(0)
 	}
-	result.ChartName = flag.Arg(0)
-	if result.ChartName == "" {
-		result.ChartName = config.DefaultChartName
+	if version {
+		printVersion()
+		os.Exit(0)
 	}
+	result.ChartName = flag.Arg(0)
 	return result
 }

cmd/helmify/main.go

@@ -1,14 +1,14 @@
 package main
 
 import (
+	"os"
+
 	"github.com/arttor/helmify/pkg/app"
-	"github.com/arttor/helmify/pkg/flags"
 	"github.com/sirupsen/logrus"
-	"os"
 )
 
 func main() {
-	conf := flags.Read()
+	conf := ReadFlags()
 	stat, err := os.Stdin.Stat()
 	if err != nil {
 		logrus.WithError(err).Error("stdin error")

cmd/helmify/version.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+
+	"helm.sh/helm/v3/pkg/time"
+)
+
+// these information will be collected when build, by `-ldflags "-X main.appVersion=0.1"`.
+var (
+	appVersion = "development"
+	buildTime  = time.Now().Format("2006 Jan 02 15:04:05")
+	gitCommit  = "not set"
+	gitRef     = "not set"
+)
+
+func printVersion() {
+	fmt.Printf("Version:    %s\n", appVersion)
+	fmt.Printf("Build Time: %s\n", buildTime)
+	fmt.Printf("Git Commit: %s\n", gitCommit)
+	fmt.Printf("Git Ref:    %s\n", gitRef)
+}

internal/test_utils.go

@@ -15,7 +15,7 @@ metadata:
 	TestNsName = "my-operator-system"
 )
 
-// TestNs k8s namespace object example
+// TestNs k8s namespace object example.
 var TestNs = GenerateObj(nsYaml)
 
 // GenerateObj generates unstructured form yaml string.

pkg/app/app.go

@@ -2,10 +2,15 @@ package app
 
 import (
 	"context"
+	"github.com/arttor/helmify/pkg/processor"
+	"io"
+	"os"
+	"os/signal"
+	"syscall"
+
 	"github.com/arttor/helmify/pkg/config"
 	"github.com/arttor/helmify/pkg/decoder"
 	"github.com/arttor/helmify/pkg/helm"
-	"github.com/arttor/helmify/pkg/helmify"
 	"github.com/arttor/helmify/pkg/processor/configmap"
 	"github.com/arttor/helmify/pkg/processor/crd"
 	"github.com/arttor/helmify/pkg/processor/deployment"
@@ -14,14 +19,14 @@ import (
 	"github.com/arttor/helmify/pkg/processor/service"
 	"github.com/arttor/helmify/pkg/processor/webhook"
 	"github.com/sirupsen/logrus"
-	"io"
-	"os"
-	"os/signal"
-	"syscall"
 )
 
 // Start - application entrypoint for processing input to a Helm chart.
 func Start(input io.Reader, config config.Config) error {
+	err := config.Validate()
+	if err != nil {
+		return err
+	}
 	setLogLevel(config)
 	ctx, cancelFunc := context.WithCancel(context.Background())
 	defer cancelFunc()
@@ -33,25 +38,23 @@ func Start(input io.Reader, config config.Config) error {
 		cancelFunc()
 	}()
 	objects := decoder.Decode(ctx.Done(), input)
-	helmifyContext := &helmify.Context{}
-	helmifyContext = helmifyContext.WithConfig(config).WithProcessors(configmap.New(),
+	appCtx := New(config, helm.NewOutput())
+	appCtx = appCtx.WithProcessors(configmap.New(),
 		crd.New(),
 		deployment.New(),
 		service.New(),
-		rbac.ClusterRole(),
 		rbac.ClusterRoleBinding(),
 		rbac.Role(),
 		rbac.RoleBinding(),
 		rbac.ServiceAccount(),
 		secret.New(),
 		webhook.Issuer(),
 		webhook.Certificate(),
-		webhook.Webhook()).WithOutput(helm.NewOutput())
-
+		webhook.Webhook()).WithDefaultProcessor(processor.Default())
 	for obj := range objects {
-		helmifyContext.Add(obj)
+		appCtx.Add(obj)
 	}
-	return helmifyContext.CreateHelm(ctx.Done())
+	return appCtx.CreateHelm(ctx.Done())
 }
 
 func setLogLevel(config config.Config) {

pkg/app/app_e2e_test.go

@@ -2,34 +2,58 @@ package app
 
 import (
 	"bufio"
+	"os"
+	"testing"
+
 	"github.com/arttor/helmify/pkg/config"
 	"github.com/stretchr/testify/assert"
 	"helm.sh/helm/v3/pkg/action"
-	"os"
-	"testing"
 )
 
 const (
-	chartName = "my_test_chart"
+	operatorChartName = "test-operator"
+	appChartName      = "test-app"
 )
 
-func TestStart(t *testing.T) {
-	file, err := os.Open("../../test_data/kustomize.output")
+func TestOperator(t *testing.T) {
+	file, err := os.Open("../../test_data/k8s-operator-kustomize.output")
+	assert.NoError(t, err)
+
+	objects := bufio.NewReader(file)
+	err = Start(objects, config.Config{ChartName: operatorChartName})
+	assert.NoError(t, err)
+
+	t.Cleanup(func() {
+		err = os.RemoveAll(operatorChartName)
+		assert.NoError(t, err)
+	})
+
+	helmLint := action.NewLint()
+	helmLint.Strict = true
+	helmLint.Namespace = "test-ns"
+	result := helmLint.Run([]string{operatorChartName}, nil)
+	for _, err = range result.Errors {
+		assert.NoError(t, err)
+	}
+}
+
+func TestApp(t *testing.T) {
+	file, err := os.Open("../../test_data/sample-app.yaml")
 	assert.NoError(t, err)
 
 	objects := bufio.NewReader(file)
-	err = Start(objects, config.Config{ChartName: chartName})
+	err = Start(objects, config.Config{ChartName: appChartName})
 	assert.NoError(t, err)
 
 	t.Cleanup(func() {
-		err = os.RemoveAll(chartName)
+		err = os.RemoveAll(appChartName)
 		assert.NoError(t, err)
 	})
 
 	helmLint := action.NewLint()
 	helmLint.Strict = true
 	helmLint.Namespace = "test-ns"
-	result := helmLint.Run([]string{chartName}, nil)
+	result := helmLint.Run([]string{appChartName}, nil)
 	for _, err = range result.Errors {
 		assert.NoError(t, err)
 	}