Release v0.0.1 (#4)

* Add version subcommand (add cicd for testing and code quality and version command #1)
* Add gcp deploy for go codebase (#2)

Author: vipul-rawat

.github/workflows/cicd.yml

@@ -0,0 +1,63 @@
+name: CI-CD
+
+on:
+  push:
+    branches:
+      - main
+      - development
+  pull_request:
+    branches:
+      - main
+      - development
+
+jobs:
+  unit-testing:
+    name: 🧪 unit testing
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ['1.21', '1.22']
+
+    steps:
+      - name: Checkout code into go module directory
+        uses: actions/checkout@v4
+
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: Go
+
+      - name: Get dependencies
+        run: |
+          go mod download
+
+      - name: Test
+        run: |
+          export APP_ENV=test
+          go test ./... -v -coverprofile profile.cov -coverpkg=./...
+          go tool cover -func profile.cov
+
+      - name: Parse code-coverage value
+        run: |
+          codeCoverage=$(go tool cover -func=profile.cov | grep total | awk '{print $3}')
+          codeCoverage=${codeCoverage%?}
+          echo $codeCoverage:
+
+  code_quality:
+    name: 🎖Code Quality️
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Go 1.21
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.21
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.57.2
+          args: --timeout=9m

.golangci.yml

@@ -0,0 +1,117 @@
+linters-settings:
+  dupl:
+    threshold: 100
+  exhaustive:
+    default-signifies-exhaustive: false
+  funlen:
+    lines: 100
+    statements: 50
+  gci:
+    sections:
+      - prefix(kops.dev)
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
+      - ifElseChain
+      - octalLiteral
+      - whyNoLint
+      - wrapperFunc
+  gocyclo:
+    min-complexity: 10
+  goimports:
+    local-prefixes: kops.dev
+  golint:
+    min-confidence: 0
+  gomnd:
+    checks:
+      - argument
+      - case
+      - condition
+      - return
+  govet:
+    enable:
+      - shadow
+  lll:
+    line-length: 140
+  maligned:
+    suggest-new: true
+  misspell:
+    locale: US
+  nolintlint:
+    allow-unused: false # report any unused nolint directives
+    require-explanation: true # require an explanation for nolint directives
+    require-specific: true # require nolint directives to be specific about which linter is being skipped
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - asciicheck
+    - bodyclose
+    - dogsled
+    - dupl
+    - errcheck
+    - exhaustive
+    - exportloopref
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - gocognit
+    - goconst
+    - gocritic
+    - gocyclo
+    - godot
+    - goerr113
+    - gofmt
+    - goimports
+    - gomnd
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - nestif
+    - noctx
+    - nolintlint
+    - prealloc
+    - revive
+    - rowserrcheck
+    - staticcheck
+    - stylecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
+    - wsl
+
+  # don't enable:
+  # - godox  # Disabling because we need TODO lines at this stage of project.
+  # - testpackage # We also need to do unit test for unexported functions. And adding _internal in all files is cumbersome.
+
+
+service:
+  golangci-lint-version: 1.58.x
+
+issues:
+  # exclude-use-default: false
+  # exclude-use-default: false # By default, golangci-lint does not enforce comments on exported types. We want it.
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - gomnd
+        - dupl
+        - goconst

README.md

@@ -1,4 +1,16 @@
 # KOPS Command Line Tool
 
 The Kops-cli provides the functionality to deploy your applications seamlessly on 
-cloud using kops - simplified devops.
+cloud using kops - simplified devops.
+
+To install the cli app run the following command
+```
+go install kops.dev@latest //to get the latest release for kops cli
+```
+
+or clone the repo and build binary
+```bash
+git clone https://github.com/kops-dev/kops-cli
+
+go build -o kops.dev .
+```

deploy.go

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+
+	"gofr.dev/pkg/gofr"
+
+	"kops.dev/internal/models"
+)
+
+const (
+	gcp            = "GCP"
+	executableName = "main"
+)
+
+var (
+	errDepKeyNotProvided          = errors.New("KOPS_DEPLOYMENT_KEY not provided, please download the key form https://kops.dev")
+	errCloudProviderNotRecognized = errors.New("cloud provider in KOPS_DEPLOYMENT_KEY is not provided or supported")
+)
+
+func Deploy(ctx *gofr.Context) (interface{}, error) {
+	var deploy models.Deploy
+
+	keyFile := os.Getenv("KOPS_DEPLOYMENT_KEY")
+	if keyFile == "" {
+		return nil, errDepKeyNotProvided
+	}
+
+	f, err := os.ReadFile(filepath.Clean(keyFile))
+	if err != nil {
+		return nil, err
+	}
+
+	err = json.Unmarshal(f, &deploy)
+	if err != nil {
+		return nil, err
+	}
+
+	// build binaries for the current working directory
+	err = buildBinary()
+	if err != nil {
+		return nil, err
+	}
+
+	// create and build docker image
+	err = createGoDockerFile()
+	if err != nil {
+		return nil, err
+	}
+
+	tag := ctx.Param("tag")
+	if tag == "" {
+		tag = "latest"
+	}
+
+	image := filepath.Clean(deploy.ServiceName + ":" + tag)
+
+	err = replaceInputOutput(exec.Command("docker", "build", "-t", image, ".")).Run()
+	if err != nil {
+		return nil, err
+	}
+
+	// check what cloud provider is
+	switch deploy.CloudProvider {
+	case gcp:
+		err = deployGCP(&deploy, image)
+		if err != nil {
+			return nil, err
+		}
+
+		return "Successfully deployed!", nil
+	default:
+		return nil, errCloudProviderNotRecognized
+	}
+}
+
+func buildBinary() error {
+	fmt.Println("Creating binary for the project")
+
+	output, err := exec.Command("sh", "-c", "CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o "+executableName+" .").CombinedOutput()
+	if err != nil {
+		fmt.Println("error occurred while creating binary!", output)
+
+		return err
+	}
+
+	fmt.Println("Binary created successfully")
+
+	return nil
+}
+
+func createGoDockerFile() error {
+	content := `FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY main ./main
+RUN chmod +x /main
+EXPOSE 8000
+CMD ["/main"]`
+
+	fi, _ := os.Stat("Dockerfile")
+	if fi != nil {
+		fmt.Println("Dockerfile present, using already created dockerfile")
+		return nil
+	}
+
+	file, err := os.Create("Dockerfile")
+	if err != nil {
+		return err
+	}
+
+	defer file.Close()
+
+	if _, err = file.WriteString(content); err != nil {
+		return err
+	}
+
+	fmt.Println("Dockerfile created successfully!")
+
+	return nil
+}