You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ma...@apache.org on 2022/09/02 03:35:52 UTC
[shardingsphere] branch master updated: [Issue #19912]-Added unit test for JDBCRepository (#20699)
This is an automated email from the ASF dual-hosted git repository.
machen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new e042f33589e [Issue #19912]-Added unit test for JDBCRepository (#20699)
e042f33589e is described below
commit e042f33589e740966c218a24d51240ac32a85b40
Author: Abhinav Koppula <ab...@gmail.com>
AuthorDate: Fri Sep 2 09:05:41 2022 +0530
[Issue #19912]-Added unit test for JDBCRepository (#20699)
* [Issue #19912]-Added unit test for JDBCRepository
* [ReviewComment]-Removed unnecessary blank lines
* [ReviewComment]-Made JDBCRepositoryTest as final
* [ReviewComment]-Moved the initialisation of JDBCRepository to @Before and cleared mocks in @After
---
.../standalone/jdbc/JDBCRepositoryTest.java | 261 +++++++++++++++++++++
.../fixture/JDBCRepositoryProviderFixture.java | 68 ++++++
...standalone.jdbc.provider.JDBCRepositoryProvider | 18 ++
3 files changed, 347 insertions(+)
diff --git a/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/java/org/apache/shardingsphere/mode/repository/standalone/jdbc/JDBCRepositoryTest.java b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-reposit [...]
new file mode 100644
index 00000000000..be9e8412856
--- /dev/null
+++ b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/java/org/apache/shardingsphere/mode/repository/standalone/jdbc/JDBCRepositoryTest.java
@@ -0,0 +1,261 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.shardingsphere.mode.repository.standalone.jdbc;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.anyString;
+import static org.mockito.Mockito.eq;
+import static org.mockito.Mockito.mockConstruction;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import com.zaxxer.hikari.HikariDataSource;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Properties;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.shardingsphere.mode.repository.standalone.jdbc.fixture.JDBCRepositoryProviderFixture;
+import org.h2.jdbc.JdbcCallableStatement;
+import org.h2.jdbc.JdbcConnection;
+import org.h2.jdbc.JdbcResultSet;
+import org.h2.jdbc.JdbcStatement;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockedConstruction;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public final class JDBCRepositoryTest {
+
+ @Mock
+ private JdbcConnection mockJdbcConnection;
+
+ @Mock
+ private JdbcStatement mockStatement;
+
+ @Mock
+ private JdbcCallableStatement mockPreparedStatement;
+
+ @Mock
+ private JdbcCallableStatement mockPreparedStatementForPersist;
+
+ @Mock
+ private JdbcResultSet mockResultSet;
+
+ private final JDBCRepositoryProviderFixture fixture = new JDBCRepositoryProviderFixture();
+
+ private MockedConstruction<HikariDataSource> mockedConstruction;
+
+ private JDBCRepository repository;
+
+ @Before
+ public void setup() throws Exception {
+ this.mockedConstruction = mockConstruction(HikariDataSource.class, (mock, context) -> when(mock.getConnection()).thenReturn(mockJdbcConnection));
+ when(mockJdbcConnection.createStatement()).thenReturn(mockStatement);
+ repository = new JDBCRepository();
+ repository.init(getHikariProperties());
+ }
+
+ @After
+ public void tearDown() {
+ this.mockedConstruction.close();
+ }
+
+ @Test
+ public void assertInit() throws Exception {
+ verify(mockStatement).execute(fixture.dropTableSQL());
+ verify(mockStatement).execute(fixture.createTableSQL());
+ }
+
+ @Test
+ public void assertGet() throws Exception {
+ String key = "key";
+ String value = "value";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next()).thenReturn(true);
+ when(mockResultSet.getString(eq("value"))).thenReturn(value);
+ String actualResponse = repository.get(key);
+ verify(mockPreparedStatement).setString(eq(1), eq(key));
+ assertEquals(value, actualResponse);
+ }
+
+ @Test
+ public void assertGetFailure() throws Exception {
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenThrow(new SQLException());
+ String actualResponse = repository.get("key");
+ assertEquals("", actualResponse);
+ }
+
+ @Test
+ public void assertPersistAndGetChildrenKeys() throws Exception {
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByParentKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next())
+ .thenReturn(true)
+ .thenReturn(true)
+ .thenReturn(true)
+ .thenReturn(false);
+ when(mockResultSet.getString(eq("key")))
+ .thenReturn("parent1/test1")
+ .thenReturn("parent1/test2")
+ .thenReturn("");
+ List<String> childrenKeys = repository.getChildrenKeys("/testPath");
+ assertThat(childrenKeys.get(0), is("test1"));
+ assertThat(childrenKeys.get(1), is("test2"));
+ }
+
+ @Test
+ public void assertPersistAndGetChildrenKeysFailure() throws Exception {
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByParentKeySQL()))).thenThrow(new SQLException());
+ List<String> actualResponse = repository.getChildrenKeys("key");
+ assertEquals(0, actualResponse.size());
+ }
+
+ @Test
+ public void assertPersistWithUpdateForSimpleKeys() throws Exception {
+ final String key = "key";
+ final String value = "value";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockJdbcConnection.prepareStatement(eq(fixture.updateSQL()))).thenReturn(mockPreparedStatementForPersist);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next()).thenReturn(true);
+ when(mockResultSet.getString(eq("value"))).thenReturn("oldValue");
+ repository.persist(key, value);
+ verify(mockPreparedStatement).setString(eq(1), eq(key));
+ verify(mockPreparedStatementForPersist).setString(eq(1), anyString());
+ verify(mockPreparedStatementForPersist).setString(eq(1), eq(value));
+ verify(mockPreparedStatementForPersist).setString(eq(2), eq(key));
+ verify(mockPreparedStatementForPersist).executeUpdate();
+ }
+
+ @Test
+ public void assertPersistForDirectory() throws Exception {
+ final String key = "/parent/child/test1";
+ final String value = "test1_content";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockJdbcConnection.prepareStatement(eq(fixture.insertSQL()))).thenReturn(mockPreparedStatementForPersist);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next()).thenReturn(false);
+ repository.persist(key, value);
+ int depthOfDirectory = StringUtils.countMatches(key, "/");
+ int beginIndex = 0;
+ String parentDirectory = "/";
+ for (int i = 0; i < depthOfDirectory; i++) {
+ int separatorIndex = key.indexOf('/', beginIndex);
+ int nextSeparatorIndex = key.indexOf('/', separatorIndex + 1);
+ if (nextSeparatorIndex == -1) {
+ nextSeparatorIndex = key.length();
+ }
+ String directoryPath = key.substring(0, nextSeparatorIndex);
+ // Verifying if get operation is called for every directory level
+ verify(mockPreparedStatement).setString(eq(1), eq(directoryPath));
+ // Verifying that during insert operation, setString at index 2 is called for every directory level
+ verify(mockPreparedStatementForPersist).setString(eq(2), eq(directoryPath));
+ // Verifying that during insert operation, setString at index 4 is called for every parent directory
+ verify(mockPreparedStatementForPersist).setString(eq(4), eq(parentDirectory));
+ beginIndex = nextSeparatorIndex;
+ parentDirectory = directoryPath;
+ }
+ // Verifying that during insert operation, setString at index 3 is called with "" for all the parent directories
+ verify(mockPreparedStatementForPersist, times(depthOfDirectory - 1)).setString(eq(3), eq(""));
+ // Verifying that during insert operation, setString at index 3 is called with the leaf node once
+ verify(mockPreparedStatementForPersist, times(1)).setString(eq(3), eq("test1_content"));
+ // Verifying that during insert operation, setString at index 1 is called with a UUID
+ verify(mockPreparedStatementForPersist, times(depthOfDirectory)).setString(eq(1), anyString());
+ // Verifying that executeOperation in insert is called for all the directory levels
+ verify(mockPreparedStatementForPersist, times(depthOfDirectory)).executeUpdate();
+ }
+
+ @Test
+ public void assertPersistFailureDuringUpdate() throws Exception {
+ final String key = "key";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next()).thenReturn(true);
+ when(mockResultSet.getString(eq("value"))).thenReturn("oldValue");
+ when(mockJdbcConnection.prepareStatement(eq(fixture.updateSQL()))).thenThrow(new SQLException());
+ repository.persist(key, "value");
+ verify(mockPreparedStatementForPersist, times(0)).executeUpdate();
+ }
+
+ @Test
+ public void assertPersistWithInsertForSimpleKeys() throws Exception {
+ final String key = "key";
+ final String value = "value";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenReturn(mockPreparedStatement);
+ when(mockJdbcConnection.prepareStatement(eq(fixture.insertSQL()))).thenReturn(mockPreparedStatementForPersist);
+ when(mockPreparedStatement.executeQuery()).thenReturn(mockResultSet);
+ when(mockResultSet.next()).thenReturn(false);
+ repository.persist(key, value);
+ verify(mockPreparedStatement).setString(eq(1), eq(key));
+ verify(mockPreparedStatementForPersist).setString(eq(1), anyString());
+ verify(mockPreparedStatementForPersist).setString(eq(2), eq(key));
+ verify(mockPreparedStatementForPersist).setString(eq(3), eq(value));
+ verify(mockPreparedStatementForPersist).setString(eq(4), eq("/"));
+ verify(mockPreparedStatementForPersist).executeUpdate();
+ }
+
+ @Test
+ public void assertPersistFailureDuringInsert() throws Exception {
+ String key = "key";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.selectByKeySQL()))).thenThrow(new SQLException());
+ when(mockJdbcConnection.prepareStatement(eq(fixture.insertSQL()))).thenThrow(new SQLException());
+ repository.persist(key, "value");
+ verify(mockPreparedStatementForPersist, times(0)).executeUpdate();
+ }
+
+ @Test
+ public void assertDelete() throws Exception {
+ String key = "key";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.deleteSQL()))).thenReturn(mockPreparedStatement);
+ repository.delete(key);
+ verify(mockPreparedStatement).setString(eq(1), eq(key));
+ verify(mockPreparedStatement).executeUpdate();
+ }
+
+ @Test
+ public void assertDeleteFailure() throws Exception {
+ String key = "key";
+ when(mockJdbcConnection.prepareStatement(eq(fixture.deleteSQL()))).thenThrow(new SQLException());
+ repository.delete(key);
+ verify(mockPreparedStatement, times(0)).executeUpdate();
+ }
+
+ @Test
+ public void assertClose() {
+ repository.close();
+ HikariDataSource hikariDataSource = mockedConstruction.constructed().get(0);
+ verify(hikariDataSource).close();
+ }
+
+ private Properties getHikariProperties() {
+ Properties props = new Properties();
+ props.setProperty("jdbc_url", "jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL");
+ props.setProperty("username", "sa");
+ props.setProperty("password", "");
+ props.setProperty("provider", "FIXTURE");
+ return props;
+ }
+}
diff --git a/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/java/org/apache/shardingsphere/mode/repository/standalone/jdbc/fixture/JDBCRepositoryProviderFixture.java b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-stan [...]
new file mode 100644
index 00000000000..1c13a55cda6
--- /dev/null
+++ b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/java/org/apache/shardingsphere/mode/repository/standalone/jdbc/fixture/JDBCRepositoryProviderFixture.java
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.shardingsphere.mode.repository.standalone.jdbc.fixture;
+
+import org.apache.shardingsphere.mode.repository.standalone.jdbc.provider.JDBCRepositoryProvider;
+
+public final class JDBCRepositoryProviderFixture implements JDBCRepositoryProvider {
+
+ @Override
+ public String dropTableSQL() {
+ return "DROP TABLE IF EXISTS `repository`";
+ }
+
+ @Override
+ public String createTableSQL() {
+ return "CREATE TABLE IF NOT EXISTS `repository`(id varchar(36) PRIMARY KEY, `key` TEXT, `value` TEXT, parent TEXT)";
+ }
+
+ @Override
+ public String selectByKeySQL() {
+ return "SELECT `value` FROM `repository` WHERE `key` = ?";
+ }
+
+ @Override
+ public String selectByParentKeySQL() {
+ return "SELECT `key` FROM `repository` WHERE parent = ?";
+ }
+
+ @Override
+ public String insertSQL() {
+ return "INSERT INTO `repository` VALUES(?, ?, ?, ?)";
+ }
+
+ @Override
+ public String updateSQL() {
+ return "UPDATE `repository` SET `value` = ? WHERE `key` = ?";
+ }
+
+ @Override
+ public String deleteSQL() {
+ return "DELETE FROM `repository` WHERE `key` = ?";
+ }
+
+ @Override
+ public String getType() {
+ return "FIXTURE";
+ }
+
+ @Override
+ public boolean isDefault() {
+ return true;
+ }
+}
diff --git a/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/resources/META-INF/services/org.apache.shardingsphere.mode.repository.standalone.jdbc.provider.JDBCRepositoryProvider b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardin [...]
new file mode 100644
index 00000000000..bfb8e45119f
--- /dev/null
+++ b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-jdbc/shardingsphere-standalone-mode-repository-jdbc-core/src/test/resources/META-INF/services/org.apache.shardingsphere.mode.repository.standalone.jdbc.provider.JDBCRepositoryProvider
@@ -0,0 +1,18 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+org.apache.shardingsphere.mode.repository.standalone.jdbc.fixture.JDBCRepositoryProviderFixture