Add CI/CD configuration and API documentation

2026-07-01 21:40:53 +08:00
commit c590135d68
4168 changed files with 740252 additions and 0 deletions
@@ -0,0 +1,144 @@
+import XCTest
+import GRDB
+@testable import GRDBAsyncDemo
+
+class AppDatabaseTests: XCTestCase {
+    func test_database_schema() throws {
+        // Given an empty database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        
+        // When we instantiate an AppDatabase
+        _ = try AppDatabase(dbQueue)
+        
+        // Then the player table exists, with id, name & score columns
+        try dbQueue.read { db in
+            try XCTAssert(db.tableExists("player"))
+            let columns = try db.columns(in: "player")
+            let columnNames = Set(columns.map { $0.name })
+            XCTAssertEqual(columnNames, ["id", "name", "score"])
+        }
+    }
+    
+    func test_savePlayer_inserts() async throws {
+        // Given an empty players database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        
+        // When we save a new player
+        var player = Player(id: nil, name: "Arthur", score: 100)
+        try await appDatabase.savePlayer(&player)
+        
+        // Then the player exists in the database
+        let playerExists = try await dbQueue.read { [player] in try player.exists($0) }
+        XCTAssertTrue(playerExists)
+    }
+    
+    func test_savePlayer_updates() async throws {
+        // Given a players database that contains a player
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        var player = try await dbQueue.write { db in
+            try Player(id: nil, name: "Arthur", score: 100).inserted(db)
+        }
+        
+        // When we modify and save the player
+        player.name = "Barbara"
+        player.score = 1000
+        try await appDatabase.savePlayer(&player)
+        
+        // Then the player has been updated in the database
+        let fetchedPlayer = try await dbQueue.read { [player] db in
+            try XCTUnwrap(Player.fetchOne(db, key: player.id))
+        }
+        XCTAssertEqual(fetchedPlayer, player)
+    }
+    
+    func test_deletePlayers() async throws {
+        // Given a players database that contains four players
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        let playerIds: [Int64] = try await dbQueue.write { db in
+            _ = try Player(id: nil, name: "Arthur", score: 100).inserted(db)
+            _ = try Player(id: nil, name: "Barbara", score: 200).inserted(db)
+            _ = try Player(id: nil, name: "Craig", score: 150).inserted(db)
+            _ = try Player(id: nil, name: "David", score: 120).inserted(db)
+            return try Player.selectPrimaryKey().fetchAll(db)
+        }
+        
+        // When we delete two players
+        let deletedId1 = playerIds[0]
+        let deletedId2 = playerIds[2]
+        try await appDatabase.deletePlayers(ids: [deletedId1, deletedId2])
+        
+        // Then the deleted players no longer exist
+        try await dbQueue.read { db in
+            try XCTAssertFalse(Player.exists(db, id: deletedId1))
+            try XCTAssertFalse(Player.exists(db, id: deletedId2))
+        }
+        
+        // Then the database still contains two players
+        let count = try await dbQueue.read { try Player.fetchCount($0) }
+        XCTAssertEqual(count, 2)
+    }
+    
+    func test_deleteAllPlayers() async throws {
+        // Given a players database that contains players
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        try await dbQueue.write { db in
+            _ = try Player(id: nil, name: "Arthur", score: 100).inserted(db)
+            _ = try Player(id: nil, name: "Barbara", score: 200).inserted(db)
+            _ = try Player(id: nil, name: "Craig", score: 150).inserted(db)
+            _ = try Player(id: nil, name: "David", score: 120).inserted(db)
+        }
+        
+        // When we delete all players
+        try await appDatabase.deleteAllPlayers()
+        
+        // Then the database does not contain any player
+        let count = try await dbQueue.read { try Player.fetchCount($0) }
+        XCTAssertEqual(count, 0)
+    }
+    
+    func test_refreshPlayers_populates_an_empty_database() async throws {
+        // Given an empty players database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        
+        // When we refresh players
+        try await appDatabase.refreshPlayers()
+        
+        // Then the database is not empty
+        let count = try await dbQueue.read { try Player.fetchCount($0) }
+        XCTAssert(count > 0)
+    }
+    
+    func test_createRandomPlayersIfEmpty_populates_an_empty_database() throws {
+        // Given an empty players database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        
+        // When we create random players
+        try appDatabase.createRandomPlayersIfEmpty()
+        
+        // Then the database is not empty
+        try XCTAssert(dbQueue.read(Player.fetchCount) > 0)
+    }
+    
+    func test_createRandomPlayersIfEmpty_does_not_modify_a_non_empty_database() throws {
+        // Given a players database that contains one player
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        let appDatabase = try AppDatabase(dbQueue)
+        var player = Player(id: nil, name: "Arthur", score: 100)
+        try dbQueue.write { db in
+            try player.insert(db)
+        }
+        
+        // When we create random players
+        try appDatabase.createRandomPlayersIfEmpty()
+        
+        // Then the database still only contains the original player
+        let players = try dbQueue.read(Player.fetchAll)
+        XCTAssertEqual(players, [player])
+    }
+}
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>
@@ -0,0 +1,43 @@
+import XCTest
+import GRDB
+@testable import GRDBAsyncDemo
+
+class PlayerRequestTests: XCTestCase {
+    func test_PlayerRequest_byName_fetches_well_ordered_players() throws {
+        // Given a players database that contains two players
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        var player1 = Player(id: nil, name: "Arthur", score: 100)
+        var player2 = Player(id: nil, name: "Barbara", score: 1000)
+        try dbQueue.write { db in
+            try player1.insert(db)
+            try player2.insert(db)
+        }
+        
+        // When we fetch players ordered by name
+        let playerRequest = PlayerRequest(ordering: .byName)
+        let players = try dbQueue.read(playerRequest.fetch)
+        
+        // Then the players are the two players ordered by name
+        XCTAssertEqual(players, [player1, player2])
+    }
+    
+    func test_PlayerRequest_byScore_fetches_well_ordered_players() throws {
+        // Given a players database that contains two players
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        var player1 = Player(id: nil, name: "Arthur", score: 100)
+        var player2 = Player(id: nil, name: "Barbara", score: 1000)
+        try dbQueue.write { db in
+            try player1.insert(db)
+            try player2.insert(db)
+        }
+        
+        // When we fetch players ordered by score
+        let playerRequest = PlayerRequest(ordering: .byScore)
+        let players = try dbQueue.read(playerRequest.fetch)
+        
+        // Then the players are the two players ordered by score descending
+        XCTAssertEqual(players, [player2, player1])
+    }
+}
@@ -0,0 +1,108 @@
+import XCTest
+import GRDB
+@testable import GRDBAsyncDemo
+
+class PlayerTests: XCTestCase {
+    // MARK: - CRUD
+    // Test that our Player type properly talks to GRDB.
+    
+    func testInsert() throws {
+        // Given an empty players database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        
+        // When we insert a player
+        var player = Player(id: nil, name: "Arthur", score: 100)
+        try dbQueue.write { db in
+            try player.insert(db)
+        }
+        
+        // Then the player gets a non-nil id
+        XCTAssertNotNil(player.id)
+    }
+    
+    func testRoundtrip() throws {
+        // Given an empty players database
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        
+        // When we insert a player and fetch the player with the same id
+        var insertedPlayer = Player(id: nil, name: "Arthur", score: 100)
+        let fetchedPlayer: Player? = try dbQueue.write { db in
+            try insertedPlayer.insert(db)
+            return try Player.fetchOne(db, key: insertedPlayer.id)
+        }
+        
+        // Then the fetched player is equal to the inserted player
+        XCTAssertEqual(insertedPlayer, fetchedPlayer)
+    }
+    
+    // MARK: - Requests
+    // Test that requests defined on the Player type behave as expected.
+    
+    func testOrderedByScore() throws {
+        // Given a players database that contains players with distinct scores
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        var player1 = Player(id: 1, name: "Arthur", score: 100)
+        var player2 = Player(id: 2, name: "Barbara", score: 200)
+        var player3 = Player(id: 3, name: "Craig", score: 150)
+        var player4 = Player(id: 4, name: "David", score: 120)
+        try dbQueue.write { db in
+            try player1.insert(db)
+            try player2.insert(db)
+            try player3.insert(db)
+            try player4.insert(db)
+        }
+        
+        // When we fetch players ordered by score
+        let players = try dbQueue.read(Player.all().orderedByScore().fetchAll)
+        
+        // Then fetched players are ordered by score descending
+        XCTAssertEqual(players, [player2, player3, player4, player1])
+    }
+    
+    func testOrderedByScoreSortsIdenticalScoresByName() throws {
+        // Given a players database that contains players with common scores
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        var player1 = Player(id: 1, name: "Arthur", score: 100)
+        var player2 = Player(id: 2, name: "Barbara", score: 200)
+        var player3 = Player(id: 3, name: "Craig", score: 200)
+        var player4 = Player(id: 4, name: "David", score: 200)
+        try dbQueue.write { db in
+            try player1.insert(db)
+            try player2.insert(db)
+            try player3.insert(db)
+            try player4.insert(db)
+        }
+        
+        // When we fetch players ordered by score
+        let players = try dbQueue.read(Player.all().orderedByScore().fetchAll)
+        
+        // Then fetched players are ordered by score descending and by name
+        XCTAssertEqual(players, [player2, player3, player4, player1])
+    }
+    
+    func testOrderedByName() throws {
+        // Given a players database that contains players with distinct names
+        let dbQueue = try DatabaseQueue(configuration: AppDatabase.makeConfiguration())
+        _ = try AppDatabase(dbQueue)
+        var player1 = Player(id: 1, name: "Arthur", score: 100)
+        var player2 = Player(id: 2, name: "Barbara", score: 200)
+        var player3 = Player(id: 3, name: "Craig", score: 150)
+        var player4 = Player(id: 4, name: "David", score: 120)
+        try dbQueue.write { db in
+            try player1.insert(db)
+            try player2.insert(db)
+            try player3.insert(db)
+            try player4.insert(db)
+        }
+        
+        // When we fetch players ordered by name
+        let players = try dbQueue.read(Player.all().orderedByName().fetchAll)
+        
+        // Then fetched players are ordered by name
+        XCTAssertEqual(players, [player1, player2, player3, player4])
+    }
+}