Introduce utils Module to Reuse Common Code (#724)

CHANGES.md

@@ -1,7 +1,8 @@
 # Changes
 
-## Version 1.0.0 (Not yet Release)
+## Version 1.0.0 (Not yet Released)
 
+* Create a New Maven Module "utils" for Common Code Reuse - Issue #720
 * Implement ReplicationStateImpl to Manage and Cache Token Range to Replica Mappings - Issue #719
 * Implement NodeResolverImpl to Resolve Nodes by IP Address and UUID - Issue #718
 * Specify Interval for Next Connection - Issue #674

application/pom.xml

@@ -62,6 +62,12 @@
             <version>${project.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.ericsson.bss.cassandra.ecchronos</groupId>
+            <artifactId>utils</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
         <!-- Spring boot -->
         <dependency>
             <groupId>org.springframework.boot</groupId>

application/src/main/java/com/ericsson/bss/cassandra/ecchronos/application/config/ConfigurationHelper.java

@@ -14,13 +14,13 @@
  */
 package com.ericsson.bss.cassandra.ecchronos.application.config;
 
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.ConfigurationException;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.FileSystems;
 import java.nio.file.Path;
 
-import com.ericsson.bss.cassandra.ecchronos.application.exceptions.ConfigurationException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 

application/src/main/java/com/ericsson/bss/cassandra/ecchronos/application/config/connection/AgentConnectionConfig.java

@@ -14,13 +14,14 @@
  */
 package com.ericsson.bss.cassandra.ecchronos.application.config.connection;
 
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.connection.ConnectionType;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.ConfigurationException;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
 
 import com.datastax.oss.driver.internal.core.loadbalancing.DefaultLoadBalancingPolicy;
-import com.ericsson.bss.cassandra.ecchronos.application.exceptions.ConfigurationException;
 import com.ericsson.bss.cassandra.ecchronos.connection.DataCenterAwarePolicy;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
@@ -227,27 +228,6 @@ public HostAware getHostAware()
         return myHostAware;
     }
 
-    /**
-     * Enum representing the connection types.
-     */
-    public enum ConnectionType
-    {
-        /**
-         * ecChronos will register its control over all the nodes in the specified datacenter.
-         */
-        datacenterAware,
-
-        /**
-         * ecChronos is responsible only for a subset of racks specified in the declared list.
-         */
-        rackAware,
-
-        /**
-         * ecChronos is responsible only for the specified list of hosts.
-         */
-        hostAware
-    }
-
     /**
      * Configuration for datacenter-aware connections.
      */

application/src/main/java/com/ericsson/bss/cassandra/ecchronos/application/providers/AgentNativeConnectionProvider.java

@@ -86,7 +86,7 @@ public AgentNativeConnectionProvider(
         DistributedNativeBuilder nativeConnectionBuilder =
                 DistributedNativeConnectionProviderImpl.builder()
                         .withInitialContactPoints(resolveInitialContactPoints(agentConnectionConfig.getContactPoints()))
-                        .withAgentType(agentConnectionConfig.getType().toString())
+                        .withAgentType(agentConnectionConfig.getType())
                         .withLocalDatacenter(agentConnectionConfig.getLocalDatacenter())
                         .withAuthProvider(authProvider)
                         .withSslEngineFactory(sslEngineFactory);

application/src/main/java/com/ericsson/bss/cassandra/ecchronos/application/spring/BeanConfigurator.java

@@ -24,9 +24,10 @@
 import com.ericsson.bss.cassandra.ecchronos.core.impl.state.ReplicationStateImpl;
 import com.ericsson.bss.cassandra.ecchronos.core.metadata.NodeResolver;
 import com.ericsson.bss.cassandra.ecchronos.core.state.ReplicationState;
-import com.ericsson.bss.cassandra.ecchronos.data.exceptions.EcChronosException;
 import com.ericsson.bss.cassandra.ecchronos.data.sync.EccNodesSync;
 
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.ConfigurationException;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.EcChronosException;
 import java.net.InetAddress;
 import java.io.IOException;
 import java.net.UnknownHostException;
@@ -38,7 +39,6 @@
 import com.ericsson.bss.cassandra.ecchronos.application.config.ConfigRefresher;
 import com.ericsson.bss.cassandra.ecchronos.application.config.ConfigurationHelper;
 import com.ericsson.bss.cassandra.ecchronos.application.config.security.Security;
-import com.ericsson.bss.cassandra.ecchronos.application.exceptions.ConfigurationException;
 import com.ericsson.bss.cassandra.ecchronos.application.providers.AgentNativeConnectionProvider;
 import com.ericsson.bss.cassandra.ecchronos.connection.CertificateHandler;
 import com.ericsson.bss.cassandra.ecchronos.connection.DistributedNativeConnectionProvider;

application/src/main/java/com/ericsson/bss/cassandra/ecchronos/application/spring/RetrySchedulerService.java

@@ -20,8 +20,8 @@
 import com.ericsson.bss.cassandra.ecchronos.application.config.Config;
 import com.ericsson.bss.cassandra.ecchronos.connection.DistributedJmxConnectionProvider;
 import com.ericsson.bss.cassandra.ecchronos.connection.DistributedNativeConnectionProvider;
-import com.ericsson.bss.cassandra.ecchronos.data.enums.NodeStatus;
 import com.ericsson.bss.cassandra.ecchronos.data.sync.EccNodesSync;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.sync.NodeStatus;
 import com.google.common.annotations.VisibleForTesting;
 import jakarta.annotation.PostConstruct;
 import java.util.ArrayList;

application/src/test/java/com/ericsson/bss/cassandra/ecchronos/application/config/TestConfig.java

@@ -15,12 +15,11 @@
 package com.ericsson.bss.cassandra.ecchronos.application.config;
 
 import com.ericsson.bss.cassandra.ecchronos.application.config.connection.*;
-import com.ericsson.bss.cassandra.ecchronos.application.exceptions.ConfigurationException;
 import com.ericsson.bss.cassandra.ecchronos.application.providers.AgentJmxConnectionProvider;
 import com.ericsson.bss.cassandra.ecchronos.application.providers.AgentNativeConnectionProvider;
 import com.ericsson.bss.cassandra.ecchronos.connection.DataCenterAwarePolicy;
-import com.fasterxml.jackson.core.exc.StreamReadException;
-import com.fasterxml.jackson.databind.DatabindException;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.connection.ConnectionType;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.ConfigurationException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 
@@ -30,7 +29,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.concurrent.TimeUnit;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
@@ -47,7 +45,7 @@ public class TestConfig
     private static DistributedJmxConnection distributedJmxConnection;
 
     @Before
-    public void setup() throws StreamReadException, DatabindException, IOException
+    public void setup() throws IOException
     {
         ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
 
@@ -66,7 +64,7 @@ public void setup() throws StreamReadException, DatabindException, IOException
     @Test
     public void testDefaultAgentType()
     {
-        assertThat(nativeConnection.getAgentConnectionConfig().getType()).isEqualTo(AgentConnectionConfig.ConnectionType.datacenterAware);
+        assertThat(nativeConnection.getAgentConnectionConfig().getType()).isEqualTo(ConnectionType.datacenterAware);
     }
 
     @Test
@@ -237,12 +235,13 @@ public void testMaxDelayLessThanStartDelayThrowsException()
         });
         assertEquals("Max delay cannot be less than start delay.", exception.getMessage());
     }
+
+    @Test
     public void testConnectionDelay()
     {
         Interval connectionDelay = config.getConnectionConfig().getConnectionDelay();
         assertThat(connectionDelay.getUnit()).isEqualTo(TimeUnit.MINUTES);
         assertThat(connectionDelay.getTime()).isEqualTo(45l);
     }
-
 }
 

application/src/test/java/com/ericsson/bss/cassandra/ecchronos/application/config/TestDefaultConfig.java

@@ -27,7 +27,6 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-
 public class TestDefaultConfig
 {
     private static final String DEFAULT_AGENT_FILE_NAME = "nothing_set.yml";
@@ -47,8 +46,6 @@ public void setup() throws StreamReadException, DatabindException, IOException
 
     }
 
-
-
     @Test
     public void testConnectionDelayDefault()
     {

application/src/test/java/com/ericsson/bss/cassandra/ecchronos/application/spring/RetrySchedulerServiceTest.java

@@ -23,8 +23,8 @@
 import com.ericsson.bss.cassandra.ecchronos.application.config.connection.RetryPolicyConfig;
 import com.ericsson.bss.cassandra.ecchronos.connection.DistributedJmxConnectionProvider;
 import com.ericsson.bss.cassandra.ecchronos.connection.DistributedNativeConnectionProvider;
-import com.ericsson.bss.cassandra.ecchronos.data.enums.NodeStatus;
 import com.ericsson.bss.cassandra.ecchronos.data.sync.EccNodesSync;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.sync.NodeStatus;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mock;

connection.impl/pom.xml

@@ -40,6 +40,13 @@
             <artifactId>data</artifactId>
             <version>${project.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>com.ericsson.bss.cassandra.ecchronos</groupId>
+            <artifactId>utils</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
         <!-- Cassandra driver -->
         <dependency>
             <groupId>com.datastax.oss</groupId>

connection.impl/src/main/java/com/ericsson/bss/cassandra/ecchronos/connection/impl/builders/DistributedJmxBuilder.java

@@ -21,9 +21,9 @@
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.servererrors.QueryExecutionException;
 import com.ericsson.bss.cassandra.ecchronos.connection.impl.providers.DistributedJmxConnectionProviderImpl;
-import com.ericsson.bss.cassandra.ecchronos.data.enums.NodeStatus;
-import com.ericsson.bss.cassandra.ecchronos.data.exceptions.EcChronosException;
 import com.ericsson.bss.cassandra.ecchronos.data.sync.EccNodesSync;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.sync.NodeStatus;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.EcChronosException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

connection.impl/src/main/java/com/ericsson/bss/cassandra/ecchronos/connection/impl/builders/DistributedNativeBuilder.java

@@ -16,7 +16,6 @@
 
 import com.ericsson.bss.cassandra.ecchronos.connection.CustomDriverOption;
 import com.ericsson.bss.cassandra.ecchronos.connection.DataCenterAwarePolicy;
-import com.ericsson.bss.cassandra.ecchronos.connection.impl.enums.ConnectionType;
 import com.datastax.oss.driver.api.core.CqlSession;
 import com.datastax.oss.driver.api.core.CqlSessionBuilder;
 import com.datastax.oss.driver.api.core.auth.AuthProvider;
@@ -31,6 +30,7 @@
 import com.datastax.oss.driver.shaded.guava.common.annotations.VisibleForTesting;
 import com.datastax.oss.driver.api.core.metrics.DefaultSessionMetric;
 import com.ericsson.bss.cassandra.ecchronos.connection.impl.providers.DistributedNativeConnectionProviderImpl;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.connection.ConnectionType;
 import com.google.common.collect.ImmutableList;
 
 import java.net.InetSocketAddress;
@@ -95,9 +95,9 @@ public final DistributedNativeBuilder withInitialContactPoints(final List<InetSo
      *         the type of the agent as a {@link String}.
      * @return the current instance of {@link DistributedNativeBuilder}.
      */
-    public final DistributedNativeBuilder withAgentType(final String type)
+    public final DistributedNativeBuilder withAgentType(final ConnectionType type)
     {
-        myType = ConnectionType.valueOf(type);
+        myType = type;
         return this;
     }
 

connection.impl/src/test/java/com/ericsson/bss/cassandra/ecchronos/connection/impl/providers/TestDistributedNativeConnectionProviderImpl.java

@@ -16,6 +16,7 @@
 
 import com.ericsson.bss.cassandra.ecchronos.connection.impl.builders.ContactEndPoint;
 import com.ericsson.bss.cassandra.ecchronos.connection.impl.builders.DistributedNativeBuilder;
+import com.ericsson.bss.cassandra.ecchronos.utils.enums.connection.ConnectionType;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -136,7 +137,7 @@ public void testResolveRackAware() throws SecurityException, IllegalArgumentExce
 
         DistributedNativeBuilder provider = DistributedNativeConnectionProviderImpl.builder()
                 .withInitialContactPoints(contactPoints)
-                .withAgentType("rackAware")
+                .withAgentType(ConnectionType.rackAware)
                 .withRackAware(rackList);
 
         List<Node> realNodesList = provider.testResolveRackNodes(mySessionMock, rackList);
@@ -155,7 +156,7 @@ public void testResolveHostAware()
         hostList.add(new InetSocketAddress("127.0.0.3", 9042));
         DistributedNativeBuilder provider = DistributedNativeConnectionProviderImpl.builder()
                 .withInitialContactPoints(contactPoints)
-                .withAgentType("hostAware")
+                .withAgentType(ConnectionType.hostAware)
                 .withHostAware(hostList);
         List<Node> realNodesList = provider.testResolveHostAware(mySessionMock, hostList);
         assertEquals(3, realNodesList.size());

core.impl/pom.xml

@@ -41,12 +41,12 @@
             <version>${project.version}</version>
         </dependency>
 
+        <!-- Cassandra driver -->
         <dependency>
             <groupId>com.datastax.oss</groupId>
             <artifactId>java-driver-core</artifactId>
         </dependency>
 
-        <!-- Cassandra driver -->
         <dependency>
             <groupId>com.datastax.oss</groupId>
             <artifactId>java-driver-query-builder</artifactId>

core.impl/src/test/java/com/ericsson/bss/cassandra/ecchronos/core/impl/table/MockTableReferenceFactory.java

@@ -14,9 +14,9 @@
  */
 package com.ericsson.bss.cassandra.ecchronos.core.impl.table;
 
-import com.ericsson.bss.cassandra.ecchronos.core.exceptions.EcChronosException;
 import com.ericsson.bss.cassandra.ecchronos.core.table.TableReference;
 import com.ericsson.bss.cassandra.ecchronos.core.table.TableReferenceFactory;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.EcChronosException;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.Set;

core/pom.xml

@@ -28,6 +28,13 @@
     <artifactId>core</artifactId>
 
     <dependencies>
+        <!-- Internal -->
+        <dependency>
+            <groupId>com.ericsson.bss.cassandra.ecchronos</groupId>
+            <artifactId>utils</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
         <!-- Cassandra driver -->
         <dependency>
             <groupId>com.datastax.oss</groupId>

core/src/main/java/com/ericsson/bss/cassandra/ecchronos/core/table/TableReferenceFactory.java

@@ -15,7 +15,7 @@
 package com.ericsson.bss.cassandra.ecchronos.core.table;
 
 import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata;
-import com.ericsson.bss.cassandra.ecchronos.core.exceptions.EcChronosException;
+import com.ericsson.bss.cassandra.ecchronos.utils.exceptions.EcChronosException;
 import java.util.Set;
 
 /**
@@ -44,7 +44,7 @@ public interface TableReferenceFactory
      * Get all table references in keyspace.
      *
      * @param keyspace The keyspace name
-     * @throws com.ericsson.bss.cassandra.ecchronos.core.exceptions.EcChronosException if keyspace does not exist.
+     * @throws EcChronosException if keyspace does not exist.
      * @return A unique set of all table references for a specific keyspace.
      */
     Set<TableReference> forKeyspace(String keyspace) throws EcChronosException;