Implementation

.dockerignore

@@ -0,0 +1,11 @@
+# Ignore everything by default
+*
+
+# Keep Go module files
+!go.mod
+!go.sum
+
+# Keep source code directories
+!cmd/
+!pkg/
+!internal/

.github/dependabot.yml

@@ -0,0 +1,37 @@
+version: 2
+updates:
+  # Keep Go modules up to date
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    groups:
+      # Group minor and patch updates together to reduce PR noise
+      go-minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"
+    commit-message:
+      prefix: "deps"
+
+  # Keep GitHub Actions up to date
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "ci"
+
+  # Keep Dockerfiles up to date
+  - package-ecosystem: "docker"
+    directory: "/build/package/*"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "docker"

.github/workflows/ci.yml

@@ -0,0 +1,125 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ "v*" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  # JOB 1: Test & Security
+  test:
+    runs-on: ubuntu-latest
+    container: debian:trixie
+    env:
+      PGPASSWORD: deframer
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_USER: deframer
+          POSTGRES_PASSWORD: ${{ env.PGPASSWORD }}
+          POSTGRES_DB: deframer
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      valkey:
+        image: valkey/valkey:latest
+        options: >-
+          --health-cmd "valkey-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+      - name: Install System Dependencies
+        run: |
+          apt-get update && apt-get install -y git make curl bash binutils build-essential postgresql-client
+
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.25'
+
+      - name: Check Formatting
+        run: |
+          if [ -n "$(gofmt -l .)" ]; then
+            echo "Go code is not formatted:"
+            gofmt -d .
+            exit 1
+          fi
+
+      - name: GolangCI-Lint
+        uses: golangci/golangci-lint-action@v9
+        with:
+          version: latest
+        env:
+          GOFLAGS: "-buildvcs=false"
+
+      - name: Run Gosec Security Scanner
+        uses: securego/gosec@master
+        with:
+          args: ./...
+
+      - name: Run govulncheck
+        run: |
+          go install golang.org/x/vuln/cmd/govulncheck@latest
+          govulncheck ./...
+
+      - name: Setup Database
+        run: |
+          psql -h postgres -U deframer -d deframer -c 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp";'
+
+      - name: Run Tests
+        run: |
+          go test -v -count=1 -race -coverprofile=coverage.out ./...
+          go tool cover -func=coverage.out
+        env:
+          CGO_ENABLED: 1
+          GOFLAGS: "-buildvcs=false"
+          DSN: "host=postgres user=deframer password=${{ env.PGPASSWORD }} dbname=deframer port=5432 sslmode=disable"
+          VALKEY_HOST: "valkey:6379"
+          VALKEY_PASSWORD: ""
+          VALKEY_DB: "0"
+
+  docker:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        app: [service, worker] # List your apps here
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to the Container registry
+        if: github.ref == 'refs/heads/main'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Calculate Image ID
+        run: |
+          echo "IMAGE_ID=ghcr.io/$(echo "${{ github.repository }}" | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: build/package/${{ matrix.app }}/Dockerfile
+          push: ${{ github.ref == 'refs/heads/main' }}
+          tags: ${{ env.IMAGE_ID }}/${{ matrix.app }}:latest
+          build-args: |
+            REPO_URL=${{ github.server_url }}/${{ github.repository }}

.gitignore

@@ -1,4 +1,5 @@
 /.bin
+/bin
 /dist
 .env*
 !/.env.example
@@ -13,3 +14,5 @@ __debug_bin*
 developer-sqlite.db
 developer-source.json
 .python-venv
+*.swp
+coverage.*

.vscode/launch.json

@@ -5,14 +5,27 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "Launch Package",
+      "name": "Launch Command",
       "type": "go",
       "request": "launch",
       "mode": "auto",
-      "preLaunchTask": "build",
       "cwd": "${workspaceFolder}",
-      "program": "${workspaceFolder}/cmd/service",
+      "program": "${workspaceFolder}/cmd/${input:appName}",
       "envFile": "${workspaceFolder}/.env"
     }
+  ],
+  "inputs": [
+    {
+      "id": "appName",
+      "type": "pickString",
+      "description": "Select the application to launch",
+      "options": [
+        "service",
+        "worker",
+        "migration",
+        "admin"
+      ],
+      "default": "server"
+    }
   ]
-}
+}

.vscode/settings.json

@@ -1,4 +1,9 @@
 {
   "go.testEnvFile": "${workspaceFolder}/.env",
-  "go.testFlags": ["-count=1"]
-}
+  "go.testFlags": [
+    "-count=1"
+  ],
+  "go.testEnvVars": {
+    "PROJECT_ROOT": "${workspaceFolder}"
+  }
+}

Makefile

@@ -1,74 +1,92 @@
+APP_NAME := news-deframer
+DOCKER_REPO := egandro
+BUILD_DIR := bin
+CMD_DIR := cmd
+DOCKER_COMPOSE_FILE ?= docker-compose.yml
+
+# we want to avoid to share the developer .env file with docker compose (the DSN hosts etc. are different)
+COMPOSE_ENV_FILE ?= .env-compose
+DOCKER_ENV_FLAG := $(if $(wildcard $(COMPOSE_ENV_FILE)),--env-file $(COMPOSE_ENV_FILE),--env-file /dev/null)
+
 ifneq ("$(wildcard .env)","")
   #$(info using .env file)
   include .env
   export $(shell sed 's/=.*//' .env)
 endif
 
-all:
-	@echo all
+.PHONY: all build clean test help
 
-.PHONY: deps
-deps:
-	go install goa.design/goa/v3/cmd/goa@latest
-	go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest
-	go install github.com/securego/gosec/v2/cmd/gosec@latest
-	go install go.uber.org/mock/mockgen@latest
+.PHONY: all test-env-start test-env-stop test-env-down test-env-zap infra-env-start infra-env-stop infra-env-down infra-env-zap zap build clean test help docker-all docker-build
 
-.PHONY: build
-build:
-	$(MAKE) gen
-	GOOS=linux GOARCH=amd64 go build $(LDFLAGS) -o infra/deploy/service ./cmd/service
-	GOOS=linux GOARCH=amd64 go build $(LDFLAGS) -o infra/deploy/service-cli ./cmd/service-cli
-	cp ./gen/http/openapi3.json infra/deploy
+all: build
+
+test-env-start:
+	$(MAKE) -C test-env start
+
+test-env-stop:
+	$(MAKE) -C test-env stop
+
+test-env-down:
+	$(MAKE) -C test-env down
+
+test-env-zap:
+	$(MAKE) -C test-env zap
+
+infra-env-start:
+	$(MAKE) -C infra-env start
+
+infra-env-stop:
+	$(MAKE) -C infra-env stop
+
+infra-env-down:
+	$(MAKE) -C infra-env down
+
+infra-env-zap:
+	$(MAKE) -C infra-env zap
 
-.PHONY: run
-run: build
-	infra/deploy/service
+zap: down start
 
-.PHONY: test-ci
-test-ci: run-migration test
+# DOCKER_COMPOSE_FILE=docker-compose-lb.yml make start/stop/down/logs
+
+start:
+	docker compose $(DOCKER_ENV_FLAG) -f $(DOCKER_COMPOSE_FILE) up -d --build --force-recreate --no-deps
+
+stop:
+	docker compose $(DOCKER_ENV_FLAG) -f $(DOCKER_COMPOSE_FILE) stop
+
+down:
+	docker compose $(DOCKER_ENV_FLAG) -f $(DOCKER_COMPOSE_FILE) down --remove-orphans --volumes
+
+logs:
+	docker compose $(DOCKER_ENV_FLAG) -f $(DOCKER_COMPOSE_FILE) logs -f
+
+build:
+	mkdir -p $(BUILD_DIR)
+	go build -o $(BUILD_DIR)/ ./$(CMD_DIR)/...
+
+clean:
+	rm -rf $(BUILD_DIR)
+	docker compose $(DOCKER_ENV_FLAG) -f $(DOCKER_COMPOSE_FILE) down --rmi local
 
-.PHONY: test
 test:
-	$(MAKE) gen
 	go clean -testcache
-	go test -v ./...
+	go test ./...
+
+coverage:
+	go test -v -coverprofile=coverage.out ./...
+	go tool cover -html=coverage.out -o coverage.html
 
-.PHONY: lint
 lint:
-	$(MAKE) gen
 	golangci-lint run ./...
-	gosec -exclude-dir=gen -exclude-dir=.gomodcache ./...
+	gosec ./...
+	govulncheck ./...
+	gofmt -l .
 
-.PHONY: tidy
 tidy:
 	go mod tidy
 
-.PHONY: gen
-gen:
-	goa gen github.com/egandro/news-deframer/pkg/design
-	go mod tidy
-	go generate ./...
-
-.PHONY: example
-example: gen
-	goa example github.com/egandro/news-deframer/pkg/design
-
-.PHONY: package
-package:
-	docker pull $(CI_REGISTRY_IMAGE):latest || true
-	docker pull $(IMAGE)
-	cd infra/deploy && \
-	DOCKER_BUILDKIT=1 docker build --build-arg "IMAGE=$(IMAGE)"  --cache-from $(CONTAINER_IMAGE):latest \
-		--tag $(CI_REGISTRY_IMAGE):$(TAG) \
-		--tag $(CI_REGISTRY_IMAGE):latest .
-	@echo created $(CI_REGISTRY_IMAGE):$(TAG)
-
-.PHONY: push
-push:
-	docker push $(CI_REGISTRY_IMAGE):$(TAG)
-	docker push $(CI_REGISTRY_IMAGE):latest
-
-.PHONY: run-container
-run-container: package
-	docker run -p 8080:8080 --rm -it --name $(CI_PROJECT_NAME) $(CI_REGISTRY_IMAGE):latest
+docker-all: $(addprefix docker-,$(notdir $(wildcard build/package/*)))
+
+docker-%:
+	@echo "Building Docker image for $*..."
+	docker build -t $(DOCKER_REPO)/$*:latest -f build/package/$*/Dockerfile .