Merge pull request #10 from sqlitecloud/code-quality-tools-and-cicd-workflow

Code quality tools and CI/CD workflow

Author: andinux

.devcontainer/Dockerfile

@@ -0,0 +1,8 @@
+FROM mcr.microsoft.com/devcontainers/go:1-1-bullseye
+
+# Python environment
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+&& apt-get -y install python3-pip git zlib1g-dev unzip
+
+# Pre-Commit to run pre-commit tools
+RUN pip3 install pre-commit

.devcontainer/devcontainer.json

@@ -3,7 +3,17 @@
 {
 	"name": "Go",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/go:1-1-bullseye"
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"eamodio.gitlens",
+				"golang.go"
+			]
+		}
+	}
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},

.github/workflows/release.yaml

@@ -0,0 +1,44 @@
+# Create an incremental tag on Github using SemVer https://semver.org: x.y.z
+# A tag is a release version on pkg.go.dev, which is
+# notified with the publishing go command.
+
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      choice:
+        type: choice
+        description: "Release types (x.y.patch / x.minor.z / major.y.z)"
+        options:
+        - patch
+        - minor
+        - major
+
+jobs:
+  release:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    name: Tag for release
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Last version
+      id: last-version
+      run: echo "::set-output name=tag::$(git describe --tags `git rev-list --tags --max-count=1`)"
+    - name: Bump version
+      id: bump-version
+      uses: olegsu/semver-action@v1
+      with:
+        version: ${{ steps.last-version.outputs.tag }}
+        bump: ${{ inputs.choice }}
+    - name: Create tag as version for the package
+      run: |
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "GitHub Actions"
+        git tag ${{ steps.bump-version.outputs.version }}
+        git push origin ${{ steps.bump-version.outputs.version }}
+    - name: Publish on pkg.go.dev
+      run: GOPROXY=proxy.golang.org go list -m github.com/sqlitecloud/sqlitecloud-go@${{ steps.bump-version.outputs.version }}

.github/workflows/testing.yaml

@@ -0,0 +1,42 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Test and QA
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.18'
+    - name: Quality Assurance
+      run: |
+        go install golang.org/x/tools/cmd/goimports@latest
+        gofmt -l ./*.go
+        goimports -e -d ./*.go
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: latest
+    - name: Tests
+      env:
+        SQLITE_CONNECTION_STRING: ${{ vars.SQLITE_CONNECTION_STRING }}
+        SQLITE_USER: ${{ secrets.SQLITE_USER }}
+        SQLITE_PASSWORD: ${{ secrets.SQLITE_PASSWORD }}
+        SQLITE_API_KEY: ${{ secrets.SQLITE_API_KEY }}
+        SQLITE_HOST: ${{ vars.SQLITE_HOST }}
+        SQLITE_DB: ${{ vars.SQLITE_DB }}
+        SQLITE_PORT: ${{ vars.SQLITE_PORT }}
+      run: make test-codecov
+    - name: Upload coverage reports to Codecov
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -5,4 +5,4 @@ cli/.vscode
 .vscode/launch.json
 pkg/
 bin
-.env
+.env

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+# Pre-Commit
+# https://pre-commit.com
+# Run formatter and more before git commit.
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: detect-private-key
+      - id: check-merge-conflict
+-   repo: local
+    hooks:
+      - id: gofmt
+        name: gofmt
+        language: golang
+        entry: fmt
+        files: \.go$
+        require_serial: true
+-   repo: local
+    hooks:
+      - id: goimports
+        name: goimports
+        language: golang
+        entry: goimports
+        files: \.go$
+        args:
+        - -w
+        require_serial: true
+-   repo: https://github.com/golangci/golangci-lint
+    rev: v1.59.1
+    hooks:
+    -   id: golangci-lint
+        exclude: ^pkg/

.vscode/settings.json

@@ -1,5 +1,9 @@
 {
     "gopls": {
         "ui.semanticTokens": true
-    }
+    },
+    "go.lintTool": "golangci-lint",
+    "go.lintFlags": [
+        "--fast"
+    ]
 }

ERRORs.md

@@ -3,7 +3,7 @@
 12334
 │││││
 ││││└─ Error Reason
-│││└── Data Type 
+│││└── Data Type
 ││└─── Class
 │└──── Module
 ```
@@ -37,4 +37,4 @@
 ## Module
 
 | Code | Alternative | Explanation |
-|------|-------------|-------------|
+|------|-------------|-------------|

MAKEFILE.md

@@ -1,4 +1,4 @@
-# SQLite Cloud go-sdk Makefile
+# SQLite Cloud sqlitecloud-go Makefile
 
 ### Run the test for the SDK
 If you want to run the Test programs: `make test`
@@ -16,4 +16,4 @@ If you want to see the Documentation: `make doc` - Warning: A browser window wil
 - Check files with gosec: `make checksec`
 - Open the repo in github: `make github`.
 - See changes: `make diff`
-- Clean dependencies and precompiled code: `make clean`
+- Clean dependencies and precompiled code: `make clean`

Makefile

@@ -1,8 +1,18 @@
 GOPATH		= $(shell go env GOPATH)
 
+setup-ide:
+	pre-commit install
+	go install golang.org/x/tools/cmd/goimports@latest
+	go mod tidy
+	cd test; go mod tidy
+	cd cli; go mod tidy
+
 # Test SDK
-test:	
-	cd test; go test -v
+test:
+	cd test; go test -v .
+
+test-codecov:
+	cd test; go test -v -race -coverprofile=coverage.txt -covermode=atomic .
 
 # GO SDK
 sdk:	*.go
@@ -11,15 +21,15 @@ sdk:	*.go
 # CLI App
 $(GOPATH)/bin/sqlc:	*.go cli/sqlc.go
 	cd cli; go build -o $(GOPATH)/bin/sqlc
-	
+
 cli: $(GOPATH)/bin/sqlc
 
 github:
-	open https://github.com/sqlitecloud/go-sdk 
-	
+	open https://github.com/sqlitecloud/sqlitecloud-go
+
 diff:
 	git difftool
-	
+
 
 # gosec
 gosec:
@@ -40,15 +50,15 @@ endif
 
 doc:	godoc
 ifeq ($(wildcard ./src),)
-	ln -s . src			
+	ln -s . src
 endif
 	@echo "Hit CRTL-C to stop the documentation server..."
-	@( sleep 1 && open http://localhost:6060/pkg/github.com/sqlitecloud/go-sdk/ ) &
+	@( sleep 1 && open http://localhost:6060/pkg/github.com/sqlitecloud/sqlitecloud-go/ ) &
 	@$(GOPATH)/bin/godoc -http=:6060 -index -play
 
 clean:
-	rm -rf $(GOPATH)/bin/sqlc* 
+	rm -rf $(GOPATH)/bin/sqlc*
 
 all: sdk cli test
 
-.PHONY: test sdk 
+.PHONY: test sdk