run pg tests on macos and windows in CI

coder · hugodutka · Dec 3, 2024 · Nov 14, 2024 · Nov 14, 2024 · Nov 15, 2024
commit 56867715ba3b046b0b4b13a3f781c8f9e057783d
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -370,15 +370,17 @@ jobs:
           api-key: ${{ secrets.DATADOG_API_KEY }}
 
   test-go-pg:
-    runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}
-    needs:
-      - changes
+    runs-on: ${{ matrix.os == 'ubuntu-latest' && github.repository_owner == 'coder' && 'depot-ubuntu-22.04-4' || matrix.os == 'macos-latest' && github.repository_owner == 'coder' && 'macos-latest-xlarge' || matrix.os == 'windows-2022' && github.repository_owner == 'coder' && 'windows-latest-16-cores' || matrix.os }}
+    needs: changes
     if: needs.changes.outputs.go == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'
-    # This timeout must be greater than the timeout set by `go test` in
-    # `make test-postgres` to ensure we receive a trace of running
-    # goroutines. Setting this to the timeout +5m should work quite well
-    # even if some of the preceding steps are slow.
     timeout-minutes: 25
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-2022
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
@@ -400,8 +402,31 @@ jobs:
         env:
           POSTGRES_VERSION: "13"
           TS_DEBUG_DISCO: "true"
+        shell: bash
         run: |
-          make test-postgres
+          # if macOS, install google-chrome for scaletests
+          # As another concern, should we really have this kind of external dependency
+          # requirement on standard CI?
+          if [ "${{ matrix.os }}" == "macos-latest" ]; then
+            brew install google-chrome
+          fi
+
+          # By default Go will use the number of logical CPUs, which
+          # is a fine default.
+          PARALLEL_FLAG=""
+
+          # macOS will output "The default interactive shell is now zsh"
+          # intermittently in CI...
+          if [ "${{ matrix.os }}" == "macos-latest" ]; then
+            touch ~/.bash_profile && echo "export BASH_SILENCE_DEPRECATION_WARNING=1" >> ~/.bash_profile
+          fi
+
+          if [ "${{ runner.os }}" == "Linux" ]; then
+            make test-postgres
+          else
+            go run scripts/embedded-pg/main.go
+            DB=ci gotestsum --format standard-quiet -- -v -short -count=1 ./...
+          fi
 
       - name: Upload test stats to Datadog
         timeout-minutes: 1

diff --git a/scripts/embedded-pg/main.go b/scripts/embedded-pg/main.go
@@ -0,0 +1,63 @@
+// Start an embedded postgres database on port 5432. Used in CI on macOS and Windows.
+package main
+
+import (
+	"database/sql"
+	"os"
+	"path/filepath"
+
+	embeddedpostgres "github.com/fergusstrange/embedded-postgres"
+)
+
+func main() {
+	postgresPath := filepath.Join(os.TempDir(), "coder-test-postgres")
+	ep := embeddedpostgres.NewDatabase(
+		embeddedpostgres.DefaultConfig().
+			Version(embeddedpostgres.V16).
+			BinariesPath(filepath.Join(postgresPath, "bin")).
+			DataPath(filepath.Join(postgresPath, "data")).
+			RuntimePath(filepath.Join(postgresPath, "runtime")).
+			CachePath(filepath.Join(postgresPath, "cache")).
+			Username("postgres").
+			Password("postgres").
+			Database("postgres").
+			Port(uint32(5432)).
+			Logger(os.Stdout),
+	)
+	err := ep.Start()
+	if err != nil {
+		panic(err)
+	}
+	// We execute these queries instead of using the embeddedpostgres
+	// StartParams because it doesn't work on Windows. The library
+	// seems to have a bug where it sends malformed parameters to
+	// pg_ctl. It encloses each parameter in single quotes, which
+	// Windows can't handle.
+	paramQueries := []string{
+		`ALTER SYSTEM SET effective_cache_size = '1GB';`,
+		`ALTER SYSTEM SET fsync = 'off';`,
+		`ALTER SYSTEM SET full_page_writes = 'off';`,
+		`ALTER SYSTEM SET max_connections = '1000';`,
+		`ALTER SYSTEM SET shared_buffers = '1GB';`,
+		`ALTER SYSTEM SET synchronous_commit = 'off';`,
+	}
+	db, err := sql.Open("postgres", "postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable")
+	if err != nil {
+		panic(err)
+	}
+	for _, query := range paramQueries {
+		if _, err := db.Exec(query); err != nil {
+			panic(err)
+		}
+	}
+	if err := db.Close(); err != nil {
+		panic(err)
+	}
+	// We restart the database to apply all the parameters.
+	if err := ep.Stop(); err != nil {
+		panic(err)
+	}
+	if err := ep.Start(); err != nil {
+		panic(err)
+	}
+}