|
| 1 | +/* |
| 2 | + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"). |
| 5 | + * You may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package software.amazon.jdbc.plugin.iam; |
| 18 | + |
| 19 | +import static org.junit.jupiter.api.Assertions.assertEquals; |
| 20 | +import static org.junit.jupiter.api.Assertions.assertInstanceOf; |
| 21 | +import static org.mockito.ArgumentMatchers.anyString; |
| 22 | +import static org.mockito.ArgumentMatchers.eq; |
| 23 | +import static org.mockito.Mockito.doReturn; |
| 24 | +import static software.amazon.jdbc.plugin.iam.DsqlTokenUtilityTest.ADMIN_USER; |
| 25 | +import static software.amazon.jdbc.plugin.iam.DsqlTokenUtilityTest.REGULAR_USER; |
| 26 | +import static software.amazon.jdbc.plugin.iam.DsqlTokenUtilityTest.assertTokenContainsProperties; |
| 27 | + |
| 28 | +import java.sql.Connection; |
| 29 | +import java.sql.SQLException; |
| 30 | +import java.util.List; |
| 31 | +import java.util.Properties; |
| 32 | +import org.junit.jupiter.api.AfterEach; |
| 33 | +import org.junit.jupiter.api.BeforeEach; |
| 34 | +import org.junit.jupiter.api.Test; |
| 35 | +import org.junit.jupiter.params.ParameterizedTest; |
| 36 | +import org.junit.jupiter.params.provider.ValueSource; |
| 37 | +import org.mockito.Mock; |
| 38 | +import org.mockito.Mockito; |
| 39 | +import org.mockito.MockitoAnnotations; |
| 40 | +import software.amazon.awssdk.regions.Region; |
| 41 | +import software.amazon.jdbc.ConnectionPlugin; |
| 42 | +import software.amazon.jdbc.ConnectionPluginChainBuilder; |
| 43 | +import software.amazon.jdbc.ConnectionProvider; |
| 44 | +import software.amazon.jdbc.HostSpec; |
| 45 | +import software.amazon.jdbc.HostSpecBuilder; |
| 46 | +import software.amazon.jdbc.JdbcCallable; |
| 47 | +import software.amazon.jdbc.PluginManagerService; |
| 48 | +import software.amazon.jdbc.PluginService; |
| 49 | +import software.amazon.jdbc.PropertyDefinition; |
| 50 | +import software.amazon.jdbc.dialect.Dialect; |
| 51 | +import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; |
| 52 | +import software.amazon.jdbc.plugin.TokenInfo; |
| 53 | +import software.amazon.jdbc.util.FullServicesContainer; |
| 54 | +import software.amazon.jdbc.util.IamAuthUtils; |
| 55 | +import software.amazon.jdbc.util.telemetry.TelemetryContext; |
| 56 | +import software.amazon.jdbc.util.telemetry.TelemetryFactory; |
| 57 | +import software.amazon.jdbc.util.telemetry.TelemetryTraceLevel; |
| 58 | + |
| 59 | +class DsqlIamConnectionPluginTest { |
| 60 | + |
| 61 | + private static final Region TEST_REGION = Region.US_EAST_1; |
| 62 | + private static final String TEST_HOSTNAME = String.format("foo0bar1baz2quux3quuux4.dsql.%s.on.aws", TEST_REGION); |
| 63 | + private static final int TEST_PORT = 5432; |
| 64 | + |
| 65 | + private static final String DRIVER_PROTOCOL = "jdbc:postgresql:"; |
| 66 | + private static final HostSpec HOST_SPEC = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) |
| 67 | + .host(TEST_HOSTNAME).port(TEST_PORT).build(); |
| 68 | + |
| 69 | + private static final String DEFAULT_USERNAME = "admin"; |
| 70 | + |
| 71 | + private final Properties props = new Properties(); |
| 72 | + |
| 73 | + private AutoCloseable cleanMocksCallback; |
| 74 | + @Mock private Connection mockConnection; |
| 75 | + @Mock private PluginService mockPluginService; |
| 76 | + @Mock private FullServicesContainer mockServicesContainer; |
| 77 | + @Mock private Dialect mockDialect; |
| 78 | + @Mock private TelemetryFactory mockTelemetryFactory; |
| 79 | + @Mock private TelemetryContext mockTelemetryContext; |
| 80 | + @Mock private JdbcCallable<Connection, SQLException> mockLambda; |
| 81 | + @Mock private ConnectionProvider mockConnectionProvider; |
| 82 | + @Mock private PluginManagerService mockPluginManagerService; |
| 83 | + |
| 84 | + @BeforeEach |
| 85 | + public void init() { |
| 86 | + cleanMocksCallback = MockitoAnnotations.openMocks(this); |
| 87 | + |
| 88 | + IamAuthConnectionPlugin.clearCache(); |
| 89 | + |
| 90 | + props.setProperty(PropertyDefinition.USER.name, DEFAULT_USERNAME); |
| 91 | + props.setProperty("iamRegion", Region.US_EAST_1.toString()); |
| 92 | + props.setProperty(PropertyDefinition.PLUGINS.name, "dsql"); |
| 93 | + |
| 94 | + doReturn(mockPluginService).when(mockServicesContainer).getPluginService(); |
| 95 | + doReturn(mockDialect).when(mockPluginService).getDialect(); |
| 96 | + doReturn(TEST_PORT).when(mockDialect).getDefaultPort(); |
| 97 | + doReturn(mockTelemetryFactory).when(mockPluginService).getTelemetryFactory(); |
| 98 | + doReturn(mockTelemetryContext).when(mockTelemetryFactory) |
| 99 | + .openTelemetryContext(anyString(), eq(TelemetryTraceLevel.NESTED)); |
| 100 | + } |
| 101 | + |
| 102 | + @AfterEach |
| 103 | + public void cleanup() throws Exception { |
| 104 | + cleanMocksCallback.close(); |
| 105 | + } |
| 106 | + |
| 107 | + @SuppressWarnings("resource") // Prevent Mockito warning when mocking closeable return type. |
| 108 | + private void assertPluginProvidesDsqlTokens(final ConnectionPlugin plugin, final String username) throws SQLException { |
| 109 | + Mockito.doReturn(mockConnection).when(mockLambda).call(); |
| 110 | + |
| 111 | + plugin |
| 112 | + .connect(DRIVER_PROTOCOL, HOST_SPEC, props, true, mockLambda) |
| 113 | + .close(); |
| 114 | + |
| 115 | + final String cacheKey = IamAuthUtils.getCacheKey( |
| 116 | + username, |
| 117 | + TEST_HOSTNAME, |
| 118 | + TEST_PORT, |
| 119 | + TEST_REGION); |
| 120 | + |
| 121 | + final TokenInfo info = IamAuthCacheHolder.tokenCache.get(cacheKey); |
| 122 | + final String token = info.getToken(); |
| 123 | + |
| 124 | + assertTokenContainsProperties(token, TEST_HOSTNAME, username); |
| 125 | + } |
| 126 | + |
| 127 | + @Test |
| 128 | + public void testDsqlPluginRegistration() throws SQLException { |
| 129 | + ConnectionPluginChainBuilder builder = new ConnectionPluginChainBuilder(); |
| 130 | + |
| 131 | + final List<ConnectionPlugin> result = builder.getPlugins( |
| 132 | + mockServicesContainer, |
| 133 | + mockConnectionProvider, |
| 134 | + null, |
| 135 | + mockPluginManagerService, |
| 136 | + props, |
| 137 | + null); |
| 138 | + |
| 139 | + // 2 because default plugin is always included. |
| 140 | + assertEquals(2, result.size()); |
| 141 | + final ConnectionPlugin plugin = result.get(0); |
| 142 | + |
| 143 | + assertInstanceOf(IamAuthConnectionPlugin.class, plugin); |
| 144 | + assertPluginProvidesDsqlTokens(plugin, DEFAULT_USERNAME); |
| 145 | + } |
| 146 | + |
| 147 | + @ParameterizedTest |
| 148 | + @ValueSource(strings = {REGULAR_USER, ADMIN_USER}) |
| 149 | + public void testDsqlTokenGeneratedBasedOnUser(final String username) throws SQLException { |
| 150 | + props.setProperty(PropertyDefinition.USER.name, username); |
| 151 | + |
| 152 | + final DsqlIamConnectionPluginFactory factory = new DsqlIamConnectionPluginFactory(); |
| 153 | + final ConnectionPlugin plugin = factory.getInstance(mockPluginService, props); |
| 154 | + assertPluginProvidesDsqlTokens(plugin, username); |
| 155 | + } |
| 156 | +} |
0 commit comments