186 dockter 1 (#195)

* #186 Working tests * #186 Savepoint * #186 Savepoint * 186 Working test and lint * #186 Working test, lint, and coverage * #186 Working test, lint, and coverage * #186 Working test, lint, and coverage * #186 Prepare for versioned release * #186 Prepare for versioned release * #186 Prepare for versioned release * #186 Prepare for versioned release
senzing-garage · Jun 28, 2024 · 58c0480 · 58c0480
1 parent 4f81c84
commit 58c0480
Show file tree

Hide file tree

Showing 49 changed files with 4,483 additions and 1,742 deletions.
diff --git a/.github/linters/.checkov.yaml b/.github/linters/.checkov.yaml
@@ -0,0 +1,6 @@
+quiet: true
+skip-check:
+  - CKV_DOCKER_7
+  - CKV_OPENAPI_4
+  - CKV_OPENAPI_5
+  - CKV_OPENAPI_21
diff --git a/.github/linters/.golangci.yml b/.github/linters/.golangci.yml
@@ -0,0 +1,47 @@
+run:
+  modules-download-mode: readonly
+  show-stats: true
+
+output:
+  print-linter-name: false
+  sort-results: true
+
+linters:
+  enable:
+    # List generated from: https://golangci-lint.run/usage/linters/
+    # We are enabling all defaults as well as any bug/security related
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - contextcheck
+    - durationcheck
+    - errcheck
+    - errchkjson
+    - errorlint
+    - exhaustive
+    - exportloopref
+    - gocheckcompilerdirectives
+    - gochecksumtype
+    - gocritic
+    - gofmt
+    - gosec
+    - gosimple
+    - gosmopolitan
+    - govet
+    - ineffassign
+    - loggercheck
+    - makezero
+    - musttag
+    - nilerr
+    - noctx
+    - protogetter
+    - reassign
+    - revive
+    - rowserrcheck
+    - spancheck
+    - sqlclosecheck
+    - staticcheck
+    - testifylint
+    - unused
+    - zerologlint
diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json
@@ -0,0 +1,6 @@
+{
+  "ignore": [
+    "**/*.go,**/go-test*.yaml"
+  ],
+  "threshold": 20
+}
diff --git a/.github/workflows/add-labels-standardized.yaml b/.github/workflows/add-labels-standardized.yaml
@@ -14,4 +14,4 @@ jobs:
     secrets:
       ORG_MEMBERSHIP_TOKEN: ${{ secrets.ORG_MEMBERSHIP_TOKEN }}
       SENZING_MEMBERS: ${{ secrets.SENZING_MEMBERS }}
-    uses: senzing-factory/build-resources/.github/workflows/add-labels-to-issue.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/add-labels-to-issue.yaml@v2
diff --git a/.github/workflows/add-to-project-garage-dependabot.yaml b/.github/workflows/add-to-project-garage-dependabot.yaml
@@ -11,6 +11,6 @@ jobs:
   add-to-project-dependabot:
     secrets:
       SENZING_GITHUB_PROJECT_RW_TOKEN: ${{ secrets.SENZING_GITHUB_PROJECT_RW_TOKEN }}
-    uses: senzing-factory/build-resources/.github/workflows/add-to-project-dependabot.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/add-to-project-dependabot.yaml@v2
     with:
       project: ${{ vars.SENZING_PROJECT_GARAGE }}
diff --git a/.github/workflows/add-to-project-garage.yaml b/.github/workflows/add-to-project-garage.yaml
@@ -13,7 +13,7 @@ jobs:
   add-to-project:
     secrets:
       SENZING_GITHUB_PROJECT_RW_TOKEN: ${{ secrets.SENZING_GITHUB_PROJECT_RW_TOKEN }}
-    uses: senzing-factory/build-resources/.github/workflows/add-to-project.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/add-to-project.yaml@v2
     with:
       classic: false
       project-number: ${{ vars.SENZING_PROJECT_GARAGE }}

diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml
@@ -4,11 +4,12 @@ on:
   pull_request:
     branches: [main]
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   dependabot-approve-and-merge:
-    permissions:
-      contents: write
-      pull-requests: write
     secrets:
       SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN: ${{ secrets.SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN }}
-    uses: senzing-factory/build-resources/.github/workflows/dependabot-approve-and-merge.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/dependabot-approve-and-merge.yaml@v2
diff --git a/.github/workflows/go-proxy-pull.yaml b/.github/workflows/go-proxy-pull.yaml
@@ -14,6 +14,6 @@ jobs:
 
     steps:
       - name: pull new module version
-        uses: andrewslotin/go-proxy-pull-action@v1.1.0
+        uses: andrewslotin/go-proxy-pull-action@v1.2.0
         with:
-          import_path: github.com/senzing-garage/go-rest-api-service
+          import_path: github.com/${{ github.repository }}
diff --git a/.github/workflows/go-test-darwin.yaml.disabled b/.github/workflows/go-test-darwin.yaml.disabled
@@ -1,6 +1,6 @@
 name: go test darwin
 
-on: [push]
+on: [pull_request, workflow_dispatch]
 
 env:
   DYLD_LIBRARY_PATH: /opt/senzing/g2/lib:/opt/senzing/g2/lib/macos
@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         go: ["1.21"]
-        os: [macos-latest]
+        os: [macos-13]
         senzingapi-version: [staging-v4]
 
     steps:
@@ -31,6 +31,11 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
+      - name: Set up gotestfmt
+        uses: gotesttools/gotestfmt-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: install Senzing API
         uses: senzing-factory/github-action-install-senzing-api@v3
         with:
@@ -43,4 +48,23 @@ jobs:
         run: mkdir /tmp/sqlite && cp testdata/sqlite/G2C.db /tmp/sqlite/G2C.db
 
       - name: run go test
-        run: go test -exec /Users/runner/work/go-rest-api-service/go-rest-api-service/bin/macos_exec_dyld.sh -v -p 1 ./...
+        run: go test -exec /Users/runner/work/go-rest-api-service/go-rest-api-service/bin/macos_exec_dyld.sh  -json -v -p 1 -coverprofile=./cover.out -covermode=atomic -coverpkg=./... ./...  2>&1 | tee /tmp/gotest.log | gotestfmt
+
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        with:
+          name: cover.out
+          path: ./cover.out
+
+      - name: Upload test log
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-log
+          path: /tmp/gotest.log
+          if-no-files-found: error
+
+  coverage:
+    name: coverage
+    needs: go-test-darwin
+    uses: senzing-factory/build-resources/.github/workflows/go-coverage.yaml@v2
diff --git a/.github/workflows/go-test-linux.yaml b/.github/workflows/go-test-linux.yaml
@@ -30,6 +30,11 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
+      - name: Set up gotestfmt
+        uses: gotesttools/gotestfmt-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: install Senzing API
         uses: senzing-factory/github-action-install-senzing-api@v3
         with:
@@ -42,4 +47,23 @@ jobs:
         run: mkdir /tmp/sqlite && cp testdata/sqlite/G2C.db /tmp/sqlite/G2C.db
 
       - name: run go test
-        run: go test -v -p 1 ./...
+        run: go test -json -v -p 1 -coverprofile=./cover.out -covermode=atomic -coverpkg=./... ./...  2>&1 | tee /tmp/gotest.log | gotestfmt
+
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        with:
+          name: cover.out
+          path: ./cover.out
+
+      - name: Upload test log
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-log
+          path: /tmp/gotest.log
+          if-no-files-found: error
+
+  coverage:
+    name: coverage
+    needs: go-test-linux
+    uses: senzing-factory/build-resources/.github/workflows/go-coverage.yaml@v2
diff --git a/.github/workflows/go-test-windows.yaml b/.github/workflows/go-test-windows.yaml
@@ -1,6 +1,6 @@
 name: go test windows
 
-on: [push]
+on: [pull_request, workflow_dispatch]
 
 env:
   SENZING_TOOLS_DATABASE_URL: 'sqlite3://na:na@nowhere/C:\Temp\sqlite\G2C.db'
@@ -29,6 +29,11 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
+      - name: Set up gotestfmt
+        uses: gotesttools/gotestfmt-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: install Senzing API
         uses: senzing-factory/github-action-install-senzing-api@v3
         with:
@@ -44,4 +49,25 @@ jobs:
         run: mkdir "C:\Temp\sqlite" && copy testdata/sqlite/G2C.db "C:\Temp\sqlite\G2C.db"
 
       - name: run go test
-        run: go test -v -p 1 ./...
+        run: |
+          go test -json -v -p 1 -coverprofile=cover -covermode=atomic -coverpkg=./... ./... 2>&1 | tee "C:\Temp\gotest.log" | gotestfmt
+          cp cover cover.out
+
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        with:
+          name: cover.out
+          path: cover.out
+
+      - name: Upload test log
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-log
+          path: "C:\\Temp\\gotest.log"
+          if-no-files-found: error
+
+  coverage:
+    name: coverage
+    needs: go-test-windows
+    uses: senzing-factory/build-resources/.github/workflows/go-coverage.yaml@v2
diff --git a/.github/workflows/gofmt.yaml b/.github/workflows/gofmt.yaml
diff --git a/.github/workflows/golangci-lint.yaml b/.github/workflows/golangci-lint.yaml
@@ -0,0 +1,59 @@
+name: golangci-lint
+
+on:
+  push:
+    branches-ignore: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  # Required: allow read access to the content for analysis.
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Senzing API
+        uses: senzing-factory/github-action-install-senzing-api@v3
+        with:
+          senzingapi-runtime-version: staging-v4
+
+      - name: Copy Senzing headers
+        run: |
+          mkdir --parents ./szconfig/gohelpers
+          cp /opt/senzing/g2/sdk/c/*.h ./szconfig/
+          cp /opt/senzing/g2/sdk/c/gohelpers/*.h ./szconfig/gohelpers
+          mkdir --parents ./szconfigmanager/gohelpers
+          cp /opt/senzing/g2/sdk/c/*.h ./szconfigmanager/
+          cp /opt/senzing/g2/sdk/c/gohelpers/*.h ./szconfigmanager/gohelpers
+          mkdir --parents ./szdiagnostic/gohelpers
+          cp /opt/senzing/g2/sdk/c/*.h ./szdiagnostic/
+          cp /opt/senzing/g2/sdk/c/gohelpers/*.h ./szdiagnostic/gohelpers
+          mkdir --parents ./szengine/gohelpers
+          cp /opt/senzing/g2/sdk/c/*.h ./szengine/
+          cp /opt/senzing/g2/sdk/c/gohelpers/*.h ./szengine/gohelpers
+          mkdir --parents ./szproduct/gohelpers
+          cp /opt/senzing/g2/sdk/c/*.h ./szproduct/
+          cp /opt/senzing/g2/sdk/c/gohelpers/*.h ./szproduct/gohelpers
+
+      - name: setup go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          args: --config=${{ github.workspace }}/.github/linters/.golangci.yml
+          only-new-issues: false
+          version: latest
diff --git a/.github/workflows/gosec.yaml b/.github/workflows/gosec.yaml
diff --git a/.github/workflows/lint-workflows.yaml b/.github/workflows/lint-workflows.yaml
@@ -14,4 +14,4 @@ permissions:
 
 jobs:
   lint-workflows:
-    uses: senzing-factory/build-resources/.github/workflows/lint-workflows.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/lint-workflows.yaml@v2
diff --git a/.github/workflows/move-pr-to-done-dependabot.yaml b/.github/workflows/move-pr-to-done-dependabot.yaml
@@ -12,6 +12,6 @@ jobs:
   move-pr-to-done-dependabot:
     secrets:
       SENZING_GITHUB_PROJECT_RW_TOKEN: ${{ secrets.SENZING_GITHUB_PROJECT_RW_TOKEN }}
-    uses: senzing-factory/build-resources/.github/workflows/move-pr-to-done-dependabot.yaml@v1
+    uses: senzing-factory/build-resources/.github/workflows/move-pr-to-done-dependabot.yaml@v2
     with:
       project: ${{ vars.SENZING_PROJECT_GARAGE }}
diff --git a/.gitignore b/.gitignore
@@ -31,3 +31,4 @@ go.work
 # Makefile
 target/
 .coverage
+coverage.html