feat: Test code-generated Waiters components

AWSClientRuntime/Sources/Protocols/RestJSON/RestJSONError.swift

@@ -50,7 +50,7 @@ public struct RestJSONError {
     }
 
     /// Filter additional information from error name and sanitize it
-    // Reference: https://awslabs.github.io/smithy/1.0/spec/aws/aws-restjson1-protocol.html#operation-error-serialization
+    /// Reference: https://awslabs.github.io/smithy/1.0/spec/aws/aws-restjson1-protocol.html#operation-error-serialization
     static func sanitizeErrorType(_ type: String?) -> String? {
         guard let errorType = type else {
             return type

Package.swift

@@ -340,7 +340,7 @@ let package = Package(
         .library(name: "AWSXRay", targets: ["AWSXRay"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/awslabs/smithy-swift", branch: "main"),
+        .package(url: "https://github.com/awslabs/smithy-swift", branch: "jbe/acceptors"),
         .package(url: "https://github.com/awslabs/aws-crt-swift", branch: "main")
     ],
     targets: [

codegen/Package.swift

@@ -59,6 +59,8 @@ appendLibTarget(name: "aws_restjson", path: "\(baseDirLocal)/aws-restjson")
 appendTstTarget(name: "aws_restjsonTests", path: "\(baseDirLocal)/aws-restjson", dependency: "aws_restjson")
 appendLibTarget(name: "rest_json_extras", path: "\(baseDirLocal)/rest_json_extras")
 appendTstTarget(name: "rest_json_extrasTests", path: "\(baseDirLocal)/rest_json_extras", dependency: "rest_json_extras")
+appendLibTarget(name: "Waiters", path: "\(baseDirLocal)/Waiters")
+appendTstTarget(name: "WaitersTests", path: "./protocol-test-codegen-local/Tests", dependency: "Waiters")
 
 func appendLibTarget(name: String, path: String) {
     package.targets.append(
@@ -103,7 +105,7 @@ if let smithySwiftDir = ProcessInfo.processInfo.environment["SMITHY_SWIFT_CI_DIR
     ]
 } else {
     package.dependencies += [
-        .package(path: "~/Projects/Amplify/SwiftSDK/smithy-swift"),
-        .package(path: "~/Projects/Amplify/SwiftSDK/aws-sdk-swift"),
+        .package(path: "../../smithy-swift"),
+        .package(path: "../../aws-sdk-swift"),
     ]
 }

codegen/protocol-test-codegen-local/Tests/swift-codegen/WaitersTests/ErrorTypeMatcherTests.swift

@@ -0,0 +1,24 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+@testable import Waiters
+@testable import ClientRuntime
+
+#if swift(>=5.7)
+class ErrorTypeMatcherTests: XCTestCase {
+
+    // MARK: - errorType matcher
+
+    func test_errorType_neverMatchesUntilImplemented() async throws {
+        let subject = try WaitersClient.errorTypeMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .failure("MyError"))
+        XCTAssertNil(match)
+    }
+
+}
+#endif

codegen/protocol-test-codegen-local/Tests/swift-codegen/WaitersTests/InputOutputMatcherTests.swift

@@ -0,0 +1,33 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+@testable import Waiters
+@testable import ClientRuntime
+
+#if swift(>=5.7)
+class InputOutputMatcherTests: XCTestCase {
+
+    func test_inputOutput_acceptorMatchesWhenInputAndOutputPropertiesMatch() async throws {
+        let value = UUID().uuidString
+        let input = GetWidgetInput(stringProperty: value)
+        let output = GetWidgetOutputResponse(stringProperty: value)
+        let subject = try WaitersClient.inputOutputPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: input, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_inputOutput_acceptorFailsToMatchWhenInputAndOutputPropertiesDontMatch() async throws {
+        let value = UUID().uuidString
+        let input = GetWidgetInput(stringProperty: value)
+        let output = GetWidgetOutputResponse(stringProperty: value + "xxx")
+        let subject = try WaitersClient.inputOutputPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: input, result: .success(output))
+        XCTAssertNil(match)
+    }
+}
+#endif

codegen/protocol-test-codegen-local/Tests/swift-codegen/WaitersTests/OutputMatcherTests.swift

@@ -0,0 +1,204 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+@testable import Waiters
+@testable import ClientRuntime
+
+#if swift(>=5.7)
+class OutputMatcherTests: XCTestCase {
+
+    // MARK: properties & stringEquals comparator
+
+    func test_outputStringProperty_acceptorMatchesOnPropertyMatch() async throws {
+        let output = GetWidgetOutputResponse(stringProperty: "payload property contents")
+        let subject = try WaitersClient.outputStringPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_outputStringProperty_acceptorFailsToMatchOnPropertyMismatch() async throws {
+        let output = GetWidgetOutputResponse(stringProperty: "not the payload property contents")
+        let subject = try WaitersClient.outputStringPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_outputStringProperty_acceptorFailsToMatchOnNullProperty() async throws {
+        let output = GetWidgetOutputResponse(stringProperty: nil)
+        let subject = try WaitersClient.outputStringPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    // MARK: properties & booleanEquals comparator
+
+    func test_outputBooleanProperty_acceptorMatchesOnPropertyMatch() async throws {
+        let output = GetWidgetOutputResponse(booleanProperty: false)
+        let subject = try WaitersClient.outputBooleanPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_outputBooleanProperty_acceptorFailsToMatchOnPropertyMismatch() async throws {
+        let output = GetWidgetOutputResponse(booleanProperty: true)
+        let subject = try WaitersClient.outputBooleanPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_outputBooleanProperty_acceptorFailsToMatchOnNullProperty() async throws {
+        let output = GetWidgetOutputResponse(booleanProperty: nil)
+        let subject = try WaitersClient.outputBooleanPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    // MARK: properties & allStringEquals comparator
+
+    func test_arrayPropertyAll_acceptorMatchesWhenArrayElementsAllMatch() async throws {
+        let expected = "payload property contents"
+        let output = GetWidgetOutputResponse(stringArrayProperty: [expected, expected, expected])
+        let subject = try WaitersClient.outputStringArrayAllPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_arrayPropertyAll_acceptorFailsToMatchWhenArrayElementsDontMatch() async throws {
+        let expected = "payload property contents"
+        let output = GetWidgetOutputResponse(stringArrayProperty: [expected, expected, "unexpected"])
+        let subject = try WaitersClient.outputStringArrayAllPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_arrayPropertyAll_acceptorFailsToMatchWhenArrayIsEmpty() async throws {
+        let output = GetWidgetOutputResponse(stringArrayProperty: [])
+        let subject = try WaitersClient.outputStringArrayAllPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_arrayPropertyAll_acceptorFailsToMatchWhenArrayIsNull() async throws {
+        let output = GetWidgetOutputResponse(stringArrayProperty: nil)
+        let subject = try WaitersClient.outputStringArrayAllPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    // MARK: properties & anyStringEquals comparator
+
+    func test_arrayPropertyAny_acceptorMatchesWhenArrayElementsAllMatch() async throws {
+        let expected = "payload property contents"
+        let output = GetWidgetOutputResponse(stringArrayProperty: [expected, expected, expected])
+        let subject = try WaitersClient.outputStringArrayAnyPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_arrayPropertyAny_acceptorMatchesWhenAllButOneElementMismatches() async throws {
+        let expected = "payload property contents"
+        let output = GetWidgetOutputResponse(stringArrayProperty: [expected, expected, "unexpected"])
+        let subject = try WaitersClient.outputStringArrayAnyPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_arrayPropertyAny_acceptorFailsToMatchWhenAllElementsMismatch() async throws {
+        let unexpected = "unexpected"
+        let output = GetWidgetOutputResponse(stringArrayProperty: [unexpected, unexpected, unexpected])
+        let subject = try WaitersClient.outputStringArrayAnyPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_arrayPropertyAny_acceptorFailsToMatchWhenArrayIsEmpty() async throws {
+        let output = GetWidgetOutputResponse(stringArrayProperty: [])
+        let subject = try WaitersClient.outputStringArrayAnyPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_arrayPropertyAny_acceptorFailsToMatchWhenArrayIsNull() async throws {
+        let output = GetWidgetOutputResponse(stringArrayProperty: nil)
+        let subject = try WaitersClient.outputStringArrayAnyPropertyMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    // MARK: - Flatten operator
+
+    func test_flatten_acceptorMatchesWhenFlattenedValueMatches() async throws {
+        let expected = "expected name"
+        let output = outputTree(embeddedName: expected)
+        let subject = try WaitersClient.flattenMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_flatten_acceptorDoesNotMatchWhenNoFlattenedValueMatches() async throws {
+        let unexpected = "not the expected name"
+        let output = outputTree(embeddedName: unexpected)
+        let subject = try WaitersClient.flattenMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_flattenLength_acceptorMatchesWhenFlattenedValueMatchesCount() async throws {
+        let unexpected = "not the expected name"
+        let output = outputTree(embeddedName: unexpected)
+        let subject = try WaitersClient.flattenLengthMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    // MARK: - Filter
+
+    func test_filter_acceptorMatchesWhenFilterMatches() async throws {
+        let output1 = outputTree()
+        let subject = try WaitersClient.filterMatcherWaiterConfig().acceptors[0]
+        let match1 = subject.evaluate(input: anInput, result: .success(output1))
+        XCTAssertNil(match1)
+        let output2 = outputTree(appendBonusKid: true)
+        let match2 = subject.evaluate(input: anInput, result: .success(output2))
+        XCTAssertEqual(match2, .success(.success(output2)))
+    }
+
+    // MARK: - Projections
+
+    func test_projectedLength_acceptorMatchesWhenFlattenedValueMatchesCount() async throws {
+        let output1 = outputTree()
+        let subject = try WaitersClient.projectedLengthMatcherWaiterConfig().acceptors[0]
+        let match1 = subject.evaluate(input: anInput, result: .success(output1))
+        XCTAssertNil(match1)
+        let output2 = outputTree(appendBonusKid: true)
+        let match2 = subject.evaluate(input: anInput, result: .success(output2))
+        XCTAssertEqual(match2, .success(.success(output2)))
+    }
+
+    // MARK: - Helper methods
+
+    private func outputTree(globalName: String? = nil, embeddedName: String? = "c", appendBonusKid: Bool = false) -> GetWidgetOutputResponse {
+        var grandchildren2: [WaitersClientTypes.Grandchild] = [
+            .init(name: embeddedName ?? globalName, number: 1),
+            .init(name: globalName ?? "d", number: 2)
+        ]
+        if appendBonusKid { grandchildren2.append(.init(name: "bonus kid", number: 7))}
+        return GetWidgetOutputResponse(children: [
+            .init(grandchildren: [
+                .init(name: globalName ?? "a", number: 3),
+                .init(name: globalName ?? "b", number: 4)
+            ]),
+            .init(grandchildren: grandchildren2),
+            .init(grandchildren: [
+                .init(name: globalName ?? "e", number: 5),
+                .init(name: globalName ?? "f", number: 6)
+            ])
+        ])
+    }
+}
+#endif

codegen/protocol-test-codegen-local/Tests/swift-codegen/WaitersTests/SuccessMatcherTests.swift

@@ -0,0 +1,50 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+@testable import Waiters
+@testable import ClientRuntime
+
+#if swift(>=5.7)
+class SuccessMatcherTests: XCTestCase {
+
+    // MARK: - success matcher
+
+    func test_successTrue_hasSuccessStateWaiter() async throws {
+        let waiterConfig = try WaitersClient.successTrueMatcherWaiterConfig()
+        let subject = waiterConfig.acceptors[0]
+        XCTAssertEqual(subject.state, .success)
+    }
+
+    func test_successTrue_acceptorMatchesOnOutput() async throws {
+        let output = GetWidgetOutputResponse()
+        let subject = try WaitersClient.successTrueMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertEqual(match, .success(.success(output)))
+    }
+
+    func test_successTrue_acceptorFailsToMatchOnError() async throws {
+        let subject = try WaitersClient.successTrueMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .failure("boom"))
+        XCTAssertNil(match)
+    }
+
+    func test_successFalse_acceptorFailsToMatchOnOutput() async throws {
+        let output = GetWidgetOutputResponse()
+        let subject = try WaitersClient.successFalseMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .success(output))
+        XCTAssertNil(match)
+    }
+
+    func test_successFalse_acceptorMatchesOnError() async throws {
+        let error = "boom"
+        let subject = try WaitersClient.successFalseMatcherWaiterConfig().acceptors[0]
+        let match = subject.evaluate(input: anInput, result: .failure(error))
+        XCTAssertEqual(match, .success(.failure(error)))
+    }
+}
+#endif