Normalize environment variable naming to match official PostgreSQL Docker image usage. Clean up CI workflow to match postgres-kit and postgres-nio where applicable, including fixes to Homebrew usage. (vapor#186)

gwynne · web-flow · commit a0383f0c4eff · 2021-11-22T06:02:32.000-06:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,7 +2,7 @@ name: test
 on: [ 'pull_request' ]
 
 jobs:
-  linux:
+  linux-all:
     strategy:
       fail-fast: false
       matrix:
@@ -25,15 +25,10 @@ jobs:
     runs-on: ubuntu-latest
     env:
       LOG_LEVEL: debug
-      POSTGRES_DB: 'vapor_database'
-      POSTGRES_DATABASE: 'vapor_database'
-      POSTGRES_DATABASE_A: 'vapor_database'
-      POSTGRES_DATABASE_B: 'vapor_database'
-      POSTGRES_USER: 'vapor_username'
-      POSTGRES_USERNAME: 'vapor_username'
-      POSTGRES_USERNAME_A: 'vapor_username'
-      POSTGRES_USERNAME_B: 'vapor_username'
-      POSTGRES_PASSWORD: 'vapor_password'
+      POSTGRES_DB_A: 'vapor_database'
+      POSTGRES_DB_B: 'vapor_database'
+      POSTGRES_USER_A: 'vapor_username'
+      POSTGRES_USER_B: 'vapor_username'
       POSTGRES_PASSWORD_A: 'vapor_password'
       POSTGRES_PASSWORD_B: 'vapor_password'
       POSTGRES_HOSTNAME_A: 'psql-a'
@@ -59,17 +54,18 @@ jobs:
     steps:
       - name: Check out package
         uses: actions/checkout@v2
-      - name: Run unit tests
-        run: swift test --enable-test-discovery
+      - name: Run all tests with Thread Sanitizer
+        run: swift test --enable-test-discovery --sanitize=thread
 
   macos-all:
     strategy:
       fail-fast: false
       matrix:
         dbimage:
+          # Only test the lastest version on macOS, let Linux do the rest
           - postgresql@14
-          - postgresql@13
         dbauth:
+          # Only test one auth method on macOS, Linux tests will cover the others
           - scram-sha-256
         xcode:
           - latest-stable
@@ -79,13 +75,12 @@ jobs:
       LOG_LEVEL: debug
       POSTGRES_HOSTNAME_A: 127.0.0.1
       POSTGRES_HOSTNAME_B: 127.0.0.1
-      POSTGRES_USERNAME_A: 'vapor_username'
-      POSTGRES_USERNAME_B: 'vapor_username'
+      POSTGRES_USER_A: 'vapor_username'
+      POSTGRES_USER_B: 'vapor_username'
       POSTGRES_PASSWORD_A: 'vapor_password'
       POSTGRES_PASSWORD_B: 'vapor_password'
-      POSTGRES_DATABASE_A: 'vapor_database_a'
-      POSTGRES_DATABASE_B: 'vapor_database_b'
-      POSTGRES_HOST_AUTH_METHOD: ${{ matrix.dbauth }}
+      POSTGRES_DB_A: 'vapor_database_a'
+      POSTGRES_DB_B: 'vapor_database_b'
     steps:
       - name: Select latest available Xcode
         uses: maxim-lobanov/setup-xcode@v1
@@ -94,19 +89,19 @@ jobs:
       - name: Install Postgres, setup DB and auth, and wait for server start
         run: |
           export PATH="$(brew --prefix)/opt/${{ matrix.dbimage }}/bin:$PATH" PGDATA=/tmp/vapor-postgres-test PGUSER=postgres
-          brew install ${{ matrix.dbimage }}
+          (brew unlink postgresql || true) && brew install ${{ matrix.dbimage }} && brew link --force ${{ matrix.dbimage }}
           initdb --locale=C --auth-host ${{ matrix.dbauth }} --username=postgres --pwfile=<(echo postgres)
           pg_ctl start --wait
-          psql postgres <<<"CREATE ROLE $POSTGRES_USERNAME_A LOGIN PASSWORD '$POSTGRES_PASSWORD_A';"
-          psql postgres <<<"CREATE ROLE $POSTGRES_USERNAME_B LOGIN PASSWORD '$POSTGRES_PASSWORD_B';"
-          psql postgres <<<"CREATE DATABASE $POSTGRES_DATABASE_A OWNER = $POSTGRES_USERNAME_A;"
-          psql postgres <<<"CREATE DATABASE $POSTGRES_DATABASE_B OWNER = $POSTGRES_USERNAME_B;"
-          psql $POSTGRES_DATABASE_A <<<"ALTER SCHEMA public OWNER TO $POSTGRES_USERNAME_A;"
-          psql $POSTGRES_DATABASE_B <<<"ALTER SCHEMA public OWNER TO $POSTGRES_USERNAME_B;"
+          psql postgres <<<"CREATE ROLE $POSTGRES_USER_A LOGIN PASSWORD '$POSTGRES_PASSWORD_A';"
+          psql postgres <<<"CREATE ROLE $POSTGRES_USER_B LOGIN PASSWORD '$POSTGRES_PASSWORD_B';"
+          psql postgres <<<"CREATE DATABASE $POSTGRES_DB_A OWNER = $POSTGRES_USER_A;"
+          psql postgres <<<"CREATE DATABASE $POSTGRES_DB_B OWNER = $POSTGRES_USER_B;"
+          psql $POSTGRES_DB_A <<<"ALTER SCHEMA public OWNER TO $POSTGRES_USER_A;"
+          psql $POSTGRES_DB_B <<<"ALTER SCHEMA public OWNER TO $POSTGRES_USER_B;"
         timeout-minutes: 2
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Run all tests
+      - name: Run all tests with Thread Sanitizer
         run: |
-          swift test --enable-test-discovery -Xlinker -rpath \
+          swift test --sanitize=thread -Xlinker -rpath \
                 -Xlinker $(xcode-select -p)/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.5/macosx
diff --git a/Tests/FluentPostgresDriverTests/FluentPostgresDriverTests.swift b/Tests/FluentPostgresDriverTests/FluentPostgresDriverTests.swift
@@ -1,7 +1,9 @@
 import Logging
+import FluentKit
 import FluentBenchmark
 import FluentPostgresDriver
 import XCTest
+import PostgresKit
 
 final class FluentPostgresDriverTests: XCTestCase {
     func testAll() throws { try self.benchmarker.testAll() }
@@ -133,15 +135,7 @@ final class FluentPostgresDriverTests: XCTestCase {
         let jsonDecoder = JSONDecoder()
         jsonDecoder.dateDecodingStrategy = .iso8601
 
-        let configuration = PostgresConfiguration(
-            hostname: env("POSTGRES_HOSTNAME_A") ?? "localhost",
-            port: env("POSTGRES_PORT_A").flatMap(Int.init) ?? PostgresConfiguration.ianaPortNumber,
-            username: env("POSTGRES_USERNAME_A") ?? "vapor_username",
-            password: env("POSTGRES_PASSWORD_A") ?? "vapor_password",
-            database: env("POSTGRES_DATABASE_A") ?? "vapor_database"
-        )
-        self.dbs.use(.postgres(
-            configuration: configuration,
+        self.dbs.use(.testPostgres(subconfig: "A",
             encoder: PostgresDataEncoder(json: jsonEncoder),
             decoder: PostgresDataDecoder(json: jsonDecoder)
         ), as: .iso8601)
@@ -179,27 +173,13 @@ final class FluentPostgresDriverTests: XCTestCase {
     override func setUpWithError() throws {
         try super.setUpWithError()
         
-        let aConfig = PostgresConfiguration(
-            hostname: env("POSTGRES_HOSTNAME_A") ?? "localhost",
-            port: env("POSTGRES_PORT_A").flatMap(Int.init) ?? PostgresConfiguration.ianaPortNumber,
-            username: env("POSTGRES_USERNAME_A") ?? "vapor_username",
-            password: env("POSTGRES_PASSWORD_A") ?? "vapor_password",
-            database: env("POSTGRES_DATABASE_A") ?? "vapor_database"
-        )
-        let bConfig = PostgresConfiguration(
-            hostname: env("POSTGRES_HOSTNAME_B") ?? "localhost",
-            port: env("POSTGRES_PORT_B").flatMap(Int.init) ?? PostgresConfiguration.ianaPortNumber,
-            username: env("POSTGRES_USERNAME_B") ?? "vapor_username",
-            password: env("POSTGRES_PASSWORD_B") ?? "vapor_password",
-            database: env("POSTGRES_DATABASE_B") ?? "vapor_database"
-        )
         XCTAssert(isLoggingConfigured)
         self.eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: System.coreCount)
         self.threadPool = NIOThreadPool(numberOfThreads: System.coreCount)
         self.dbs = Databases(threadPool: threadPool, on: self.eventLoopGroup)
 
-        self.dbs.use(.postgres(configuration: aConfig, connectionPoolTimeout: .seconds(30)), as: .a)
-        self.dbs.use(.postgres(configuration: bConfig, connectionPoolTimeout: .seconds(30)), as: .b)
+        self.dbs.use(.testPostgres(subconfig: "A"), as: .a)
+        self.dbs.use(.testPostgres(subconfig: "B"), as: .b)
 
         let a = self.dbs.database(.a, logger: Logger(label: "test.fluent.a"), on: self.eventLoopGroup.next())
         _ = try (a as! PostgresDatabase).query("drop schema public cascade").wait()
@@ -218,6 +198,23 @@ final class FluentPostgresDriverTests: XCTestCase {
     }
 }
 
+extension DatabaseConfigurationFactory {
+    static func testPostgres(
+        subconfig: String,
+        encoder: PostgresDataEncoder = .init(), decoder: PostgresDataDecoder = .init()
+    ) -> DatabaseConfigurationFactory {
+        let baseSubconfig = PostgresConfiguration(
+            hostname: env("POSTGRES_HOSTNAME_\(subconfig)") ?? "localhost",
+            port: env("POSTGRES_PORT_\(subconfig)").flatMap(Int.init) ?? PostgresConfiguration.ianaPortNumber,
+            username: env("POSTGRES_USER_\(subconfig)") ?? "vapor_username",
+            password: env("POSTGRES_PASSWORD_\(subconfig)") ?? "vapor_password",
+            database: env("POSTGRES_DB_\(subconfig)") ?? "vapor_database"
+        )
+        
+        return .postgres(configuration: baseSubconfig, connectionPoolTimeout: .seconds(30), encoder: encoder, decoder: decoder)
+    }
+}
+
 extension DatabaseID {
     static let iso8601 = DatabaseID(string: "iso8601")
     static let a = DatabaseID(string: "a")
