ci: add tests (#2)

Author: wilsonehusin

.github/workflows/build.yaml

@@ -3,15 +3,61 @@ name: Build
 on:
   pull_request:
   push:
+    branches:
+      - main
     tags:
       - "*"
 
 permissions:
   contents: write
 
 jobs:
+  test:
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: Run tests
+        run: go test -v ./...
+        env:
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v5
+        with:
+          install-mode: goinstall
+          version: latest
   goreleaser:
     runs-on: ubuntu-latest
+    needs: [ test, lint ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -23,6 +69,7 @@ jobs:
           go-version: stable
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
+        if: startsWith(github.ref, 'refs/tags/v')
         with:
           distribution: goreleaser
           version: latest

md/md_test.go

@@ -64,7 +64,11 @@ func TestRenderTable(t *testing.T) {
 		if err := m.Generate(ctx); err != nil {
 			t.Fatalf("generating documentation: %s", err.Error())
 		}
-		golden.Assert(t, filepath.Join(dir, out), goldenFileName(out))
+		written, err := os.ReadFile(filepath.Join(dir, out))
+		if err != nil {
+			t.Fatalf("reading written file: %s", err.Error())
+		}
+		golden.Assert(t, string(written), goldenFileName(out))
 	}
 
 	t.Run("SingleTableWithColumns", runTest)

md/testdata/testdata/TestRenderTable__SingleTableWithColumns.golden.md

@@ -1 +1,11 @@
-/var/folders/zq/ykt92t3956v7l2yx0l3dk5r80000gn/T/TestRenderTableSingleTableWithColumns2035277813/001/TestRenderTable__SingleTableWithColumns.md
+# `sqldoc_single_table_with_columns`
+
+|       NAME        |            TYPE             | NULLABLE |   DEFAULT    |
+|-------------------|-----------------------------|----------|--------------|
+| `uuid_field`      | uuid                        | NOT NULL |              |
+| `varchar_field`   | character varying           | NOT NULL |              |
+| `int_field`       | integer                     | NOT NULL |              |
+| `text_field`      | text                        |          |              |
+| `boolean_field`   | boolean                     | NOT NULL | `false`      |
+| `json_field`      | json                        | NOT NULL | `'{}'::json` |
+| `timestamp_field` | timestamp without time zone | NOT NULL | `now()`      |