feat: linting (#2)

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## Description
+
+Any further details ...
+
+## Related Issue(s)
+
+- <https://jira.arubanetworks.com/browse/UXI-XXX>

.github/workflows/lint-test-code.yaml

@@ -0,0 +1,48 @@
+name: Lint & Test Code
+
+on:
+  push:
+    branches:
+      - "**"
+      - "!main"
+      - "!master"
+
+env:
+  go_version: 1.22
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint-test-code:
+    name: Lint & Test Code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: "${{ env.go_version }}"
+
+      - name: Setup Just
+        uses: extractions/setup-just@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install Dependencies
+        run: just setup-dev
+
+      - name: Run Code Linting Test
+        run: just lint >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Run Tests
+        run: |
+          just test
+
+      - name: Upload Code Coverage Report
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

pkg/config-api-client/.gitignore → .gitignore

@@ -22,3 +22,5 @@ _testmain.go
 *.exe
 *.test
 *.prof
+
+.coverage

Justfile

@@ -18,6 +18,37 @@ generate-config-api-client: retrieve-config-api-openapi-spec
   --git-user-id aruba-uxi \
   --git-repo-id configuration-api-terraform-provider/{{ CONFIG_API_DIR }} \
   cd {{ CONFIG_API_DIR }} && go mod tidy
+  just fmt-client
+
+setup-dev:
+  curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.60.1
 
 test-client:
-  cd {{ CONFIG_API_DIR }} && go test -v ./...
+  cd {{ CONFIG_API_DIR }} && go test -v ./... -race -covermode=atomic -coverprofile=.coverage
+
+fmt-client:
+  gofmt -w pkg/config-api-client
+
+lint-client:
+  #!/usr/bin/env bash
+
+  cd pkg/config-api-client
+
+  if [ -n "$(gofmt -d .)" ]; then
+    echo "Error: (gofmt) formatting required" >&2
+    exit 1
+  fi
+
+  golangci-lint run
+
+test:
+  just test-client
+
+lint:
+  just lint-client
+
+fmt:
+  just fmt-client
+
+clean:
+  find . -name ".coverage" -type f -delete

pkg/config-api-client/.openapi-generator-ignore

@@ -22,5 +22,6 @@
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
 
-git_push.sh
+.gitignore
 .travis.yml
+git_push.sh