// // Copyright Amazon.com Inc. or its affiliates. // All Rights Reserved. // // SPDX-License-Identifier: Apache-2.0 // import XCTest @testable import Amplify @testable import AmplifyTestCommon class HubCategoryConfigurationTests: XCTestCase { override func setUp() async throws { await Amplify.reset() } func testCanAddHubPlugin() throws { let plugin = MockHubCategoryPlugin() XCTAssertNoThrow(try Amplify.add(plugin: plugin)) } func testCanConfigureHubPlugin() throws { let plugin = MockHubCategoryPlugin() try Amplify.add(plugin: plugin) let hubConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) XCTAssertNotNil(Amplify.Hub) XCTAssertNotNil(try Amplify.Hub.getPlugin(for: "MockHubCategoryPlugin")) } func testCanResetHubPlugin() async throws { let plugin = MockHubCategoryPlugin() let resetWasInvoked = expectation(description: "reset() was invoked") plugin.listeners.append { message in if message == "reset" { resetWasInvoked.fulfill() } } try Amplify.add(plugin: plugin) let hubConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) await Amplify.reset() await fulfillment(of: [resetWasInvoked], timeout: 1.0) } func testResetRemovesAddedPlugin() async throws { let plugin = MockHubCategoryPlugin() try Amplify.add(plugin: plugin) let hubConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) await Amplify.reset() XCTAssertThrowsError(try Amplify.Hub.getPlugin(for: "MockHubCategoryPlugin"), "Getting a plugin after reset() should throw") { error in guard case HubError.configuration = error else { XCTFail("Expected PluginError.noSuchPlugin") return } } } func testCanRegisterMultipleHubPlugins() throws { let plugin1 = MockHubCategoryPlugin() try Amplify.add(plugin: plugin1) let plugin2 = MockSecondHubCategoryPlugin() try Amplify.add(plugin: plugin2) let hubConfig = HubCategoryConfiguration( plugins: [ "MockHubCategoryPlugin": true, "MockSecondHubCategoryPlugin": true ] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) XCTAssertNotNil(try Amplify.Hub.getPlugin(for: "MockHubCategoryPlugin")) XCTAssertNotNil(try Amplify.Hub.getPlugin(for: "MockSecondHubCategoryPlugin")) } func testCanUseDefaultPluginIfOnlyOnePlugin() throws { let plugin = MockHubCategoryPlugin() let methodInvokedOnDefaultPlugin = expectation(description: "test method invoked on default plugin") plugin.listeners.append { message in if message == "removeListener" { methodInvokedOnDefaultPlugin.fulfill() } } try Amplify.add(plugin: plugin) let hubConfig = HubCategoryConfiguration(plugins: ["MockHubCategoryPlugin": true]) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) let unsubscribeToken = UnsubscribeToken(channel: .storage, id: UUID()) Amplify.Hub.removeListener(unsubscribeToken) waitForExpectations(timeout: 1.0) } func testPreconditionFailureInvokingWithMultiplePlugins() throws { let plugin1 = MockHubCategoryPlugin() try Amplify.add(plugin: plugin1) let plugin2 = MockSecondHubCategoryPlugin() try Amplify.add(plugin: plugin2) let hubConfig = HubCategoryConfiguration( plugins: [ "MockHubCategoryPlugin": true, "MockSecondHubCategoryPlugin": true ] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) try XCTAssertThrowFatalError { let unsubscribeToken = UnsubscribeToken(channel: .storage, id: UUID()) Amplify.Hub.removeListener(unsubscribeToken) } } func testCanUseSpecifiedPlugin() throws { let plugin1 = MockHubCategoryPlugin() let methodShouldNotBeInvokedOnDefaultPlugin = expectation(description: "test method should not be invoked on default plugin") methodShouldNotBeInvokedOnDefaultPlugin.isInverted = true plugin1.listeners.append { message in if message == "removeListener" { methodShouldNotBeInvokedOnDefaultPlugin.fulfill() } } try Amplify.add(plugin: plugin1) let plugin2 = MockSecondHubCategoryPlugin() let methodShouldBeInvokedOnSecondPlugin = expectation(description: "test method should be invoked on second plugin") plugin2.listeners.append { message in if message == "removeListener" { methodShouldBeInvokedOnSecondPlugin.fulfill() } } try Amplify.add(plugin: plugin2) let hubConfig = HubCategoryConfiguration( plugins: [ "MockHubCategoryPlugin": true, "MockSecondHubCategoryPlugin": true ] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) let unsubscribeToken = UnsubscribeToken(channel: .storage, id: UUID()) try Amplify.Hub.getPlugin(for: "MockSecondHubCategoryPlugin").removeListener(unsubscribeToken) waitForExpectations(timeout: 1.0) } func testCanConfigurePluginDirectly() throws { let plugin = MockHubCategoryPlugin() let configureShouldBeInvokedFromCategory = expectation(description: "Configure should be invoked by Amplify.configure()") let configureShouldBeInvokedDirectly = expectation(description: "Configure should be invoked by getPlugin().configure()") var invocationCount = 0 plugin.listeners.append { message in if message == "configure(using:)" { invocationCount += 1 switch invocationCount { case 1: configureShouldBeInvokedFromCategory.fulfill() case 2: configureShouldBeInvokedDirectly.fulfill() default: XCTFail("Expected configure() to be called only two times, but got \(invocationCount)") } } } try Amplify.add(plugin: plugin) let hubConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) let amplifyConfig = AmplifyConfiguration(hub: hubConfig) try Amplify.configure(amplifyConfig) try Amplify.Hub.getPlugin(for: "MockHubCategoryPlugin").configure(using: true) waitForExpectations(timeout: 1.0) } func testPreconditionFailureInvokingBeforeConfig() throws { let plugin = MockHubCategoryPlugin() try Amplify.add(plugin: plugin) // Remember, this test must be invoked with a category that doesn't include an Amplify-supplied default plugin try XCTAssertThrowFatalError { Amplify.Hub.dispatch(to: .storage, payload: HubPayload(eventName: "foo")) } } // MARK: - Test internal config behavior guarantees func testThrowsConfiguringTwice() throws { let plugin = MockHubCategoryPlugin() try Amplify.add(plugin: plugin) let categoryConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) try Amplify.Hub.configure(using: categoryConfig) XCTAssertThrowsError(try Amplify.Hub.configure(using: categoryConfig), "configure() an already configured plugin should throw") { error in guard case ConfigurationError.amplifyAlreadyConfigured = error else { XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured") return } } } func testCanConfigureAfterReset() async throws { let plugin = MockHubCategoryPlugin() try Amplify.add(plugin: plugin) let categoryConfig = HubCategoryConfiguration( plugins: ["MockHubCategoryPlugin": true] ) try Amplify.Hub.configure(using: categoryConfig) await Amplify.Hub.reset() XCTAssertNoThrow(try Amplify.Hub.configure(using: categoryConfig)) } /// Test that Amplify logs a warning if it encounters a plugin configuration key without a corresponding plugin /// /// - Given: /// - A configuration with a nonexistent plugin key specified /// - When: /// - I invoke `Amplify.configure()` /// - Then: /// - I should see a log warning /// func testWarnsOnMissingPlugin() throws { let warningReceived = expectation(description: "Warning message received") let loggingPlugin = MockLoggingCategoryPlugin() loggingPlugin.listeners.append { message in if message.starts(with: "warn(_:): No plugin found") { warningReceived.fulfill() } } let loggingConfig = LoggingCategoryConfiguration( plugins: [loggingPlugin.key: true] ) try Amplify.add(plugin: loggingPlugin) let categoryConfig = HubCategoryConfiguration( plugins: ["NonExistentPlugin": true] ) let amplifyConfig = AmplifyConfiguration(hub: categoryConfig, logging: loggingConfig) try Amplify.configure(amplifyConfig) waitForExpectations(timeout: 0.1) } }