CONFIG: Skip integration tests if TMDb API Key is missing (#114)

adamayoung · Aug 31, 2023 · 0c0b14b · 0c0b14b
1 parent 14e24cd
commit 0c0b14b
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 61 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -58,6 +58,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+
+      - name: Cache SPM
+        uses: actions/cache@v3
+        with:
+          path: ~/Library/Developer/Xcode/DerivedData/TMDb-*/SourcePackages 
+          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+          restore-keys: |
+            ${{ runner.os }}-spm-
 
       - name: Build
         run: xcodebuild build-for-testing -scheme TMDb -only-testing TMDbTests -destination '${{ matrix.destination }}'
@@ -68,11 +76,17 @@ jobs:
   build-test-linux:
     name: Build and Test (Linux)
     runs-on: ubuntu-latest
-    container:
-        image: swift:5.8.1-focal
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+
+      - name: Cache SPM
+        uses: actions/cache@v3
+        with:
+          path: .build
+          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+          restore-keys: |
+            ${{ runner.os }}-spm-
 
       - name: Build
         run: swift build -Xswiftc -warnings-as-errors --build-tests

diff --git a/Tests/TMDbIntegrationTests/CertificationIntegrationTests.swift b/Tests/TMDbIntegrationTests/CertificationIntegrationTests.swift
@@ -5,9 +5,9 @@ final class CertificationIntegrationTests: XCTestCase {
 
     var certificationService: CertificationService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         certificationService = CertificationService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/CompanyIntegrationTests.swift b/Tests/TMDbIntegrationTests/CompanyIntegrationTests.swift
@@ -5,9 +5,9 @@ final class CompanyIntegrationTests: XCTestCase {
 
     var companyService: CompanyService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         companyService = CompanyService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/ConfigurationIntegrationTests.swift b/Tests/TMDbIntegrationTests/ConfigurationIntegrationTests.swift
@@ -5,9 +5,9 @@ final class ConfigurationIntegrationTests: XCTestCase {
 
     var configurationService: ConfigurationService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         configurationService = ConfigurationService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/DiscoverIntegrationTests.swift b/Tests/TMDbIntegrationTests/DiscoverIntegrationTests.swift
@@ -5,9 +5,9 @@ final class DiscoverIntegrationTests: XCTestCase {
 
     var discoverService: DiscoverService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         discoverService = DiscoverService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/Extensions/XCTestCase+Environment.swift b/Tests/TMDbIntegrationTests/Extensions/XCTestCase+Environment.swift
diff --git a/Tests/TMDbIntegrationTests/GenreIntegrationTests.swift b/Tests/TMDbIntegrationTests/GenreIntegrationTests.swift
@@ -5,9 +5,9 @@ final class GenreIntegrationTests: XCTestCase {
 
     var genreService: GenreService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         genreService = GenreService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/MovieIntegrationTests.swift b/Tests/TMDbIntegrationTests/MovieIntegrationTests.swift
@@ -5,9 +5,9 @@ final class MovieIntegrationTests: XCTestCase {
 
     var movieService: MovieService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         movieService = MovieService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/PersonIntegrationTests.swift b/Tests/TMDbIntegrationTests/PersonIntegrationTests.swift
@@ -5,9 +5,9 @@ final class PersonIntegrationTests: XCTestCase {
 
     var personService: PersonService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         personService = PersonService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/SearchIntegrationTests.swift b/Tests/TMDbIntegrationTests/SearchIntegrationTests.swift
@@ -5,9 +5,9 @@ final class SearchIntegrationTests: XCTestCase {
 
     var searchService: SearchService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         searchService = SearchService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/TVShowEpisodeServiceTests.swift b/Tests/TMDbIntegrationTests/TVShowEpisodeServiceTests.swift
@@ -5,9 +5,9 @@ final class TVShowEpisodeServiceTests: XCTestCase {
 
     var tvShowEpisodeService: TVShowEpisodeService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         tvShowEpisodeService = TVShowEpisodeService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/TVShowSeasonService.swift b/Tests/TMDbIntegrationTests/TVShowSeasonService.swift
@@ -5,9 +5,9 @@ final class TVShowSeasonServiceTests: XCTestCase {
 
     var tvShowSeasonService: TVShowSeasonService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         tvShowSeasonService = TVShowSeasonService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/TVShowServiceTests.swift b/Tests/TMDbIntegrationTests/TVShowServiceTests.swift
@@ -5,9 +5,9 @@ final class TVShowServiceTests: XCTestCase {
 
     var tvShowService: TVShowService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         tvShowService = TVShowService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/TrendingIntegrationTests.swift b/Tests/TMDbIntegrationTests/TrendingIntegrationTests.swift
@@ -5,9 +5,9 @@ final class TrendingIntegrationTests: XCTestCase {
 
     var trendingService: TrendingService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         trendingService = TrendingService()
     }
 

diff --git a/Tests/TMDbIntegrationTests/Utility/XCTestCase+ConfigureTMDb.swift b/Tests/TMDbIntegrationTests/Utility/XCTestCase+ConfigureTMDb.swift
@@ -0,0 +1,25 @@
+import TMDb
+import XCTest
+
+extension XCTestCase {
+
+    func configureTMDb() throws {
+        try TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey()))
+    }
+
+    private func tmdbAPIKey() throws -> String {
+        try Self.tmdbAPIKey()
+    }
+
+    private static func tmdbAPIKey() throws -> String {
+        guard
+            let apiKey = ProcessInfo.processInfo.environment["TMDB_API_KEY"],
+            !apiKey.isEmpty
+        else {
+            throw XCTSkip("TMDB_API_KEY environment variable not set.")
+        }
+
+        return apiKey
+    }
+
+}
diff --git a/Tests/TMDbIntegrationTests/WatchProviderIntegrationTests.swift b/Tests/TMDbIntegrationTests/WatchProviderIntegrationTests.swift
@@ -5,9 +5,9 @@ final class WatchProviderIntegrationTests: XCTestCase {
 
     var watchProviderService: WatchProviderService!
 
-    override func setUp() {
-        super.setUp()
-        TMDb.configure(TMDbConfiguration(apiKey: tmdbAPIKey))
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        try configureTMDb()
         watchProviderService = WatchProviderService()
     }