initial version

Author: padurean

.github/workflows/checks.yml

@@ -0,0 +1,55 @@
+name: go-test
+on: [push, pull_request]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_DB: gosmig
+          POSTGRES_USER: gosmig
+          POSTGRES_PASSWORD: gosmig
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      GOFLAGS: -buildvcs=false
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.25.x'
+
+      - name: Check that Go modules are tidy
+        uses: katexochen/go-tidy-check@v2
+
+      - name: Lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: latest
+
+      - name: Check for vulnerabilities
+        uses: golang/govulncheck-action@v1
+
+      - name: Build
+        run: make build-only
+
+      - name: Test with coverage
+        run: make test-coverage
+
+      - name: Check test coverage
+        uses: vladopajic/go-test-coverage@v2
+        with:
+          config: ./.testcoverage.yml
+

.gitignore

@@ -0,0 +1,3 @@
+.vscode
+cover.out
+cover.html

.testcoverage.yml

@@ -0,0 +1,75 @@
+# (mandatory)
+# Path to coverage profile file (output of `go test -coverprofile` command).
+#
+# For cases where there are many coverage profiles, such as when running
+# unit tests and integration tests separately, you can combine all those
+# profiles into one. In this case, the profile should have a comma-separated list
+# of profile files, e.g., 'cover_unit.out,cover_integration.out'.
+profile: cover.out
+
+# Holds coverage thresholds percentages, values should be in range [0-100].
+threshold:
+  # (optional; default 0)
+  # Minimum coverage percentage required for individual files.
+  file: 90
+
+  # (optional; default 0)
+  # Minimum coverage percentage required for each package.
+  package: 90
+
+  # (optional; default 0)
+  # Minimum overall project coverage percentage required.
+  total: 95
+
+# Holds regexp rules which will override thresholds for matched files or packages
+# using their paths.
+#
+# First rule from this list that matches file or package is going to apply
+# new threshold to it. If project has multiple rules that match same path,
+# override rules should be listed in order from specific to more general rules.
+override:
+  # Increase coverage threshold to 100% for `foo` package
+  # (default is 80, as configured above in this example).
+  # - path: ^pkg/lib/foo$
+  #   threshold: 100
+
+# Holds regexp rules which will exclude matched files or packages
+# from coverage statistics.
+exclude:
+  # Exclude files or packages matching their paths
+  paths:
+    # - \.pb\.go$    # excludes all protobuf generated files
+    # - ^pkg/bar     # exclude package `pkg/bar`
+
+# (optional; default false)
+# When true, requires all coverage-ignore annotations to include explanatory comments
+force-annotation-comment: false
+
+# If specified, saves the current test coverage breakdown to this file.
+#
+# Typically, this breakdown is generated only for main (base) branches and
+# stored as an artifact. Later, this file can be used in feature branches
+# to compare test coverage against the base branch.
+breakdown-file-name: ''
+
+diff:
+  # Path to the test coverage breakdown file from the base branch.
+  #
+  # This file is usually generated and stored in the main (base) branch,
+  # controled via `breakdown-file-name` property.
+  # When set in a feature branch, it allows the tool to compute and report
+  # the coverage difference between the current (feature) branch and the base.
+  base-breakdown-file-name: ''
+
+  # Allowed threshold for the test coverage difference (in percentage)
+  # between the feature branch and the base branch.
+  #
+  # By default, this is disabled (set to null). Valid values range from
+  # -100.0 to +100.0.
+  #
+  # Example:
+  #   If set to 0.5, an error will be reported if the feature branch has
+  #   less than 0.5% more coverage than the base.
+  #
+  #   If set to -0.5, the check allows up to 0.5% less coverage than the base.
+  threshold: null

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

Makefile

@@ -0,0 +1,69 @@
+cover_file = cover.out
+
+lint:
+	@echo "\n[lint] Linting ..."
+	golangci-lint run
+
+vulncheck:
+	@echo "\n[vuln] Checking for vulnerabilities ..."
+	govulncheck ./...
+
+build: vulncheck lint
+	@echo "\n[build] Building ..."
+	go build -v ./...
+
+build-only:
+	@echo "\n[build] Building only ..."
+	go build -v ./...
+
+test:
+	@echo "\n[test] Testing ..."
+	go test -count=1 -shuffle=on -failfast -race -v ./...
+
+test-docker:
+	@bash -c '\
+		set -e; \
+		cleanup() { \
+			echo "[docker] Stopping PostgreSQL container for tests ..."; \
+			docker compose -f docker-compose.test.yml down -v; \
+		}; \
+		trap cleanup EXIT; \
+		echo "[docker] Starting PostgreSQL container for tests ..."; \
+		docker compose -f docker-compose.test.yml up -d; \
+		echo "[docker] Waiting for PostgreSQL to be ready ..."; \
+		sleep 2; \
+		docker compose -f docker-compose.test.yml exec -T gosmig_test_postgres sh -c "while ! pg_isready -U gosmig -d gosmig; do echo \"[docker] Waiting for PostgreSQL...\"; sleep 2; done"; \
+		echo "[docker] Running tests with Docker PostgreSQL ..."; \
+		go test -count=1 -shuffle=on -failfast -race -v ./...; \
+	'
+
+test-docker-down:
+	@echo "\n[docker] Stopping PostgreSQL container for tests ..."
+	docker compose -f docker-compose.test.yml down -v
+
+test-coverage:
+	@echo "\n[coverage] Testing with coverage ..."
+	go test -count=1 -shuffle=on -failfast -race -v -coverprofile=${cover_file} -covermode=atomic -coverpkg=./... ./...
+
+test-coverage-html: test-coverage
+	@echo "\n[coverage] Generating HTML coverage report ..."
+	go tool cover -html=${cover_file}
+# Uncomment the following line to output the HTML report to a file:
+# 	go tool cover -html=${cover_file} -o=cover.html
+
+install-go-test-coverage:
+	@echo "\n[tools] Installing go-test-coverage tool ..."
+	go install github.com/vladopajic/go-test-coverage/v2@latest
+
+check-coverage: test-coverage
+	@echo "\n[coverage] Checking coverage thresholds ..."
+	go-test-coverage --config=./.testcoverage.yml
+
+check-coverage-only: test-coverage
+	@echo "\n[coverage] Checking coverage thresholds ..."
+	go-test-coverage --config=./.testcoverage.yml
+
+test-github-workflow:
+	@echo "\n[ci] Running GitHub Actions checks locally ..."
+	# Requires github.com/nektos/act
+	act --job checks