test(auth): add integration tests to Auth (#280)

* test(auth): add integration tests to Auth

test: lower expectation timeout

ci: run test library with local supabase

ci: run docker on macos

wip

Revert package folder structure

revert ci

* Add IntegrationTests test plan

* chore: get secrets from environment

* ci: add integration-tests jobs

* chore: baseURL raw string

* chore: fix test plan

* revert: PostgrestIntegrationTests

* chore: load env from file

* chore: set-env before test-library

* chore: move setenv.sh to scripts folder

* chore: allow test prefix on commit

* chore: allow package prefix

Author: Guilherme Souza

.env

@@ -0,0 +1,3 @@
+SUPABASE_URL=
+SUPABASE_ANON_KEY=
+SUPABASE_SERVICE_KEY=

.github/workflows/ci.yml

@@ -40,6 +40,23 @@ jobs:
       - name: Build for library evolution
         run: make build-for-library-evolution
 
+  integration-tests:
+    runs-on: macos-14
+    name: Integration Tests
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Select Xcode 15.3
+        run: sudo xcode-select -s /Applications/Xcode_15.3.app
+      - name: Run tests
+        run: make test-integration
+        env: 
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_ANON_KEY: ${{ secrets.SUPABASE_ANON_KEY }}
+          SUPABASE_SERVICE_KEY: ${{ secrets.SUPABASE_SERVICE_KEY }}
+
+
   examples:
     runs-on: macos-14
     name: Build Examples

.github/workflows/conventional-commits-lint.js

@@ -15,6 +15,7 @@ const ALLOWED_CONVENTIONAL_COMMIT_PREFIXES = [
   "docs",
   "chore",
   "style",
+  "test",
 ];
 
 const object = process.argv[2];
@@ -72,12 +73,6 @@ validate.forEach((payload) => {
         );
         failed = true;
       }
-
-      if (groups.package && groups.prefix !== "chore") {
-        console.warn(
-          "Avoid using package specifications in PR titles or commits except for the `chore` prefix.",
-        );
-      }
     } else {
       console.error(
         "PR or commit title must match conventional commit structure.",

.gitignore

@@ -95,5 +95,8 @@ iOSInjectionProject/
 /*.xcodeproj
 # /.swiftpm
 
+
+# Environment
+.env.local
 Secrets.swift
-.env
+Tests/IntegrationTests/Environment.swift

.swiftpm/xcode/xcshareddata/xcschemes/Supabase.xcscheme

@@ -32,6 +32,9 @@
             reference = "container:Supabase.xctestplan"
             default = "YES">
          </TestPlanReference>
+         <TestPlanReference
+            reference = "container:IntegrationTests.xctestplan">
+         </TestPlanReference>
       </TestPlans>
    </TestAction>
    <LaunchAction

IntegrationTests.xctestplan

@@ -0,0 +1,24 @@
+{
+  "configurations" : [
+    {
+      "id" : "EFD3DB79-4307-4515-8158-5E17BF4577D4",
+      "name" : "Configuration 1",
+      "options" : {
+
+      }
+    }
+  ],
+  "defaultOptions" : {
+
+  },
+  "testTargets" : [
+    {
+      "target" : {
+        "containerPath" : "container:",
+        "identifier" : "IntegrationTests",
+        "name" : "IntegrationTests"
+      }
+    }
+  ],
+  "version" : 1
+}

Makefile

@@ -4,9 +4,12 @@ PLATFORM_MAC_CATALYST = macOS,variant=Mac Catalyst
 PLATFORM_TVOS = tvOS Simulator,name=Apple TV
 PLATFORM_WATCHOS = watchOS Simulator,name=Apple Watch Series 9 (41mm)
 
+set-env:
+	@source scripts/setenv.sh > Tests/IntegrationTests/Environment.swift
+
 test-all: test-library test-linux
 
-test-library:
+test-library: set-env
 	for platform in "$(PLATFORM_IOS)" "$(PLATFORM_MACOS)" "$(PLATFORM_MAC_CATALYST)" "$(PLATFORM_TVOS)" "$(PLATFORM_WATCHOS)"; do \
 		set -o pipefail && \
 			xcodebuild test \
@@ -17,6 +20,16 @@ test-library:
 				-destination platform="$$platform" | xcpretty; \
 	done;
 
+test-integration: set-env
+	@set -o pipefail && \
+		xcodebuild test \
+			-skipMacroValidation \
+			-workspace supabase-swift.xcworkspace \
+			-scheme Supabase \
+			-testPlan IntegrationTests \
+			-destination platform="$(PLATFORM_IOS)" | xcpretty
+
+
 test-linux:
 	docker build -t supabase-swift .
 	docker run supabase-swift

Package.swift

@@ -70,18 +70,30 @@ let package = Package(
         .product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
       ]
     ),
+    .testTarget(
+      name: "IntegrationTests",
+      dependencies: [
+        .product(name: "CustomDump", package: "swift-custom-dump"),
+        .product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
+        "_Helpers",
+        "Auth",
+        "TestHelpers",
+        "PostgREST",
+      ]
+    ),
     .target(
       name: "Auth",
       dependencies: goTrueDependencies
     ),
     .testTarget(
       name: "AuthTests",
       dependencies: [
-        "Auth",
-        "_Helpers",
-        "TestHelpers",
+        .product(name: "CustomDump", package: "swift-custom-dump"),
         .product(name: "SnapshotTesting", package: "swift-snapshot-testing"),
         .product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
+        "_Helpers",
+        "Auth",
+        "TestHelpers",
       ],
       exclude: [
         "__Snapshots__",
@@ -104,7 +116,6 @@ let package = Package(
       ],
       exclude: ["__Snapshots__"]
     ),
-    .testTarget(name: "PostgRESTIntegrationTests", dependencies: ["PostgREST"]),
     .target(
       name: "Realtime",
       dependencies: [
@@ -141,7 +152,13 @@ let package = Package(
       ]
     ),
     .testTarget(name: "SupabaseTests", dependencies: ["Supabase"]),
-    .target(name: "TestHelpers"),
+    .target(
+      name: "TestHelpers",
+      dependencies: [
+        .product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
+        "Auth",
+      ]
+    ),
   ]
 )
 

Sources/Auth/AuthError.swift

@@ -1,14 +1,14 @@
 import Foundation
 
-public enum AuthError: LocalizedError, Sendable {
+public enum AuthError: LocalizedError, Sendable, Equatable {
   case missingExpClaim
   case malformedJWT
   case sessionNotFound
   case api(APIError)
   case pkce(PKCEFailureReason)
   case invalidImplicitGrantFlowURL
 
-  public struct APIError: Error, Decodable, Sendable {
+  public struct APIError: Error, Decodable, Sendable, Equatable {
     /// A basic message describing the problem with the request. Usually missing if
     /// ``AuthError/APIError/error`` is present.
     public var msg: String?

Sources/TestHelpers/InMemoryLocalStorage.swift

@@ -0,0 +1,29 @@
+import Auth
+import ConcurrencyExtras
+import Foundation
+
+package final class InMemoryLocalStorage: AuthLocalStorage, @unchecked Sendable {
+  let _storage = LockIsolated([String: Data]())
+
+  package var storage: [String: Data] {
+    _storage.value
+  }
+
+  package init() {}
+
+  package func store(key: String, value: Data) throws {
+    _storage.withValue {
+      $0[key] = value
+    }
+  }
+
+  package func retrieve(key: String) throws -> Data? {
+    _storage.value[key]
+  }
+
+  package func remove(key: String) throws {
+    _storage.withValue {
+      $0[key] = nil
+    }
+  }
+}