You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2022/07/19 15:52:44 UTC

[shardingsphere] branch master updated: Refactor ITContainers (#19363)

This is an automated email from the ASF dual-hosted git repository.

zhaojinchao 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 6b632f52e12 Refactor ITContainers (#19363)
6b632f52e12 is described below

commit 6b632f52e12496185974aac9cb5b6c6f093dd4c5
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Tue Jul 19 23:52:40 2022 +0800

    Refactor ITContainers (#19363)
    
    * Remove NetworkAliasUtil
    
    * Refactor ITContainers
---
 .../subscriber/ScalingRegistrySubscriberTest.java  |  8 ++--
 .../integration/container/atomic/ITContainers.java | 16 ++++---
 .../container/util/NetworkAliasUtil.java           | 49 ----------------------
 .../container/compose/BaseComposedContainer.java   |  4 +-
 .../container/compose/DockerComposedContainer.java |  9 ++--
 .../compose/mode/ClusterComposedContainer.java     | 10 ++---
 .../compose/mode/StandaloneComposedContainer.java  | 13 +++---
 7 files changed, 30 insertions(+), 79 deletions(-)

diff --git a/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/test/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/cache/subscriber/ScalingRegistrySubscriberTest.java b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/test/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/cache/subscriber/ScalingRegistrySubscriberTest.java
index fd679fbb8ec..9d625a94a4b 100644
--- a/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/test/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/cache/subscriber/ScalingRegistrySubscriberTest.java
+++ b/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/test/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/cache/subscriber/ScalingRegistrySubscriberTest.java
@@ -45,10 +45,10 @@ public final class ScalingRegistrySubscriberTest {
     
     @Mock
     private MetaDataVersionPersistService metaDataVersionPersistService;
-
+    
     @Mock
     private EventBusContext eventBusContext;
-
+    
     private ScalingRegistrySubscriber scalingRegistrySubscriber;
     
     @Before
@@ -58,7 +58,7 @@ public final class ScalingRegistrySubscriberTest {
         persistServiceField.setAccessible(true);
         persistServiceField.set(scalingRegistrySubscriber, metaDataVersionPersistService);
     }
-
+    
     @Test
     public void assertStartScaling() {
         verify(eventBusContext).register(scalingRegistrySubscriber);
@@ -68,7 +68,7 @@ public final class ScalingRegistrySubscriberTest {
         StartScalingEvent startScalingEvent = new StartScalingEvent("ds_0", "", "", "", "", 1, 2);
         verify(eventBusContext).post(ArgumentMatchers.refEq(startScalingEvent));
     }
-
+    
     @Test
     public void assertScalingTaskFinished() {
         when(metaDataVersionPersistService.getActiveVersion("ds_0")).thenReturn(Optional.of("1"));
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/atomic/ITContainers.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/atomic/ITContainers.java
index a4db9e336a9..118d126fb70 100644
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/atomic/ITContainers.java
+++ b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/atomic/ITContainers.java
@@ -17,7 +17,9 @@
 
 package org.apache.shardingsphere.test.integration.container.atomic;
 
+import com.google.common.base.Strings;
 import lombok.RequiredArgsConstructor;
+import org.apache.shardingsphere.test.integration.container.atomic.governance.GovernanceContainer;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.Network;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
@@ -46,19 +48,19 @@ public final class ITContainers implements Startable {
     
     /**
      * Register container.
-     * 
+     *
      * @param container container to be registered
-     * @param networkAlias network alias
-     * @param <T> type of ShardingSphere container
+     * @param type container type
+     * @param <T> type of container
      * @return registered container
      */
-    public <T extends ITContainer> T registerContainer(final T container, final String networkAlias) {
+    public <T extends ITContainer> T registerContainer(final T container, final String type) {
         if (container instanceof EmbeddedITContainer) {
             embeddedContainers.add((EmbeddedITContainer) container);
         } else {
             DockerITContainer dockerContainer = (DockerITContainer) container;
             dockerContainer.setNetwork(network);
-            dockerContainer.setNetworkAliases(Collections.singletonList(networkAlias));
+            dockerContainer.setNetworkAliases(Collections.singletonList(getNetworkAlias(container, type)));
             String loggerName = String.join(":", scenario, dockerContainer.getName());
             dockerContainer.withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger(loggerName), false));
             dockerContainers.add(dockerContainer);
@@ -66,6 +68,10 @@ public final class ITContainers implements Startable {
         return container;
     }
     
+    private <T extends ITContainer> String getNetworkAlias(final T container, final String type) {
+        return container instanceof GovernanceContainer || Strings.isNullOrEmpty(scenario) ? String.join(".", type.toLowerCase(), "host") : String.join(".", type.toLowerCase(), scenario, "host");
+    }
+    
     @Override
     public void start() {
         if (!started) {
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/util/NetworkAliasUtil.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/util/NetworkAliasUtil.java
deleted file mode 100644
index 1842cd07546..00000000000
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-env/src/test/java/org/apache/shardingsphere/test/integration/container/util/NetworkAliasUtil.java
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * 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.test.integration.container.util;
-
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
-
-/**
- * Network alias util.
- */
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
-public final class NetworkAliasUtil {
-    
-    /**
-     * Get network alias.
-     *
-     * @param containerType container type
-     * @return network alias
-     */
-    public static String getNetworkAlias(final String containerType) {
-        return String.join(".", containerType.toLowerCase(), "host");
-    }
-    
-    /**
-     * Get network alias.
-     *
-     * @param containerType container type
-     * @param scenario scenario
-     * @return network alias
-     */
-    public static String getNetworkAlias(final String containerType, final String scenario) {
-        return String.join(".", containerType.toLowerCase(), scenario, "host");
-    }
-}
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/BaseComposedContainer.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/BaseComposedContainer.java
index baf5faef9ca..201af433401 100644
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/BaseComposedContainer.java
+++ b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/BaseComposedContainer.java
@@ -21,13 +21,13 @@ import lombok.Getter;
 import org.apache.shardingsphere.test.integration.container.atomic.ITContainers;
 import org.testcontainers.lifecycle.Startable;
 
+@Getter
 public abstract class BaseComposedContainer implements Startable {
     
-    @Getter
     private final ITContainers containers;
     
     public BaseComposedContainer() {
-        this.containers = new ITContainers("");
+        containers = new ITContainers("");
     }
     
     /**
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/DockerComposedContainer.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/DockerComposedContainer.java
index d1b9d273ce2..4a4ac8d3e67 100644
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/DockerComposedContainer.java
+++ b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/src/test/java/org/apache/shardingsphere/integration/data/pipeline/framework/container/compose/DockerComposedContainer.java
@@ -23,9 +23,8 @@ import org.apache.shardingsphere.integration.data.pipeline.factory.DatabaseConta
 import org.apache.shardingsphere.integration.data.pipeline.framework.container.cluster.ZookeeperContainer;
 import org.apache.shardingsphere.integration.data.pipeline.framework.container.database.DatabaseContainer;
 import org.apache.shardingsphere.integration.data.pipeline.framework.container.proxy.ShardingSphereProxyDockerContainer;
-import org.apache.shardingsphere.test.integration.env.DataSourceEnvironment;
 import org.apache.shardingsphere.test.integration.container.atomic.governance.GovernanceContainer;
-import org.apache.shardingsphere.test.integration.container.util.NetworkAliasUtil;
+import org.apache.shardingsphere.test.integration.env.DataSourceEnvironment;
 
 /**
  * Composed container, include governance container and database container.
@@ -44,10 +43,10 @@ public final class DockerComposedContainer extends BaseComposedContainer {
     public DockerComposedContainer(final DatabaseType databaseType, final String dockerImageName) {
         this.databaseType = databaseType;
         ShardingSphereProxyDockerContainer proxyContainer = new ShardingSphereProxyDockerContainer(databaseType);
-        governanceContainer = getContainers().registerContainer(new ZookeeperContainer(), NetworkAliasUtil.getNetworkAlias("zk"));
-        databaseContainer = getContainers().registerContainer(DatabaseContainerFactory.newInstance(databaseType, dockerImageName), NetworkAliasUtil.getNetworkAlias("db"));
+        governanceContainer = getContainers().registerContainer(new ZookeeperContainer(), "zk");
+        databaseContainer = getContainers().registerContainer(DatabaseContainerFactory.newInstance(databaseType, dockerImageName), "db");
         proxyContainer.dependsOn(governanceContainer, databaseContainer);
-        this.proxyContainer = getContainers().registerContainer(proxyContainer, NetworkAliasUtil.getNetworkAlias("sharding-proxy"));
+        this.proxyContainer = getContainers().registerContainer(proxyContainer, "sharding-proxy");
     }
     
     @Override
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/ClusterComposedContainer.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/ClusterComposedContainer.java
index a1c45ae60ea..aaa335132b3 100644
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/ClusterComposedContainer.java
+++ b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/ClusterComposedContainer.java
@@ -17,7 +17,6 @@
 
 package org.apache.shardingsphere.test.integration.container.compose.mode;
 
-import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainerFactory;
 import org.apache.shardingsphere.test.integration.container.atomic.DockerITContainer;
 import org.apache.shardingsphere.test.integration.container.atomic.ITContainers;
 import org.apache.shardingsphere.test.integration.container.atomic.adapter.AdapterContainer;
@@ -25,9 +24,9 @@ import org.apache.shardingsphere.test.integration.container.atomic.adapter.Adapt
 import org.apache.shardingsphere.test.integration.container.atomic.governance.GovernanceContainer;
 import org.apache.shardingsphere.test.integration.container.atomic.governance.GovernanceContainerFactory;
 import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainer;
+import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainerFactory;
 import org.apache.shardingsphere.test.integration.container.compose.ComposedContainer;
 import org.apache.shardingsphere.test.integration.framework.param.model.ParameterizedArray;
-import org.apache.shardingsphere.test.integration.container.util.NetworkAliasUtil;
 
 import javax.sql.DataSource;
 import java.util.Map;
@@ -49,15 +48,14 @@ public final class ClusterComposedContainer implements ComposedContainer {
         String scenario = parameterizedArray.getScenario();
         containers = new ITContainers(scenario);
         // TODO support other types of governance
-        governanceContainer = containers.registerContainer(GovernanceContainerFactory.newInstance("ZooKeeper"), NetworkAliasUtil.getNetworkAlias("zk"));
-        storageContainer = containers.registerContainer(StorageContainerFactory.newInstance(parameterizedArray.getDatabaseType(), scenario),
-                NetworkAliasUtil.getNetworkAlias(parameterizedArray.getDatabaseType().getType(), scenario));
+        governanceContainer = containers.registerContainer(GovernanceContainerFactory.newInstance("ZooKeeper"), "zk");
+        storageContainer = containers.registerContainer(StorageContainerFactory.newInstance(parameterizedArray.getDatabaseType(), scenario), parameterizedArray.getDatabaseType().getType());
         AdapterContainer adapterContainer = AdapterContainerFactory.newInstance(parameterizedArray.getMode(), parameterizedArray.getAdapter(), parameterizedArray.getDatabaseType(), storageContainer,
                 scenario);
         if (adapterContainer instanceof DockerITContainer) {
             ((DockerITContainer) adapterContainer).dependsOn(governanceContainer, storageContainer);
         }
-        this.adapterContainer = containers.registerContainer(adapterContainer, NetworkAliasUtil.getNetworkAlias(parameterizedArray.getAdapter(), scenario));
+        this.adapterContainer = containers.registerContainer(adapterContainer, parameterizedArray.getAdapter());
     }
     
     @Override
diff --git a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/StandaloneComposedContainer.java b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/StandaloneComposedContainer.java
index 353e3cf4f23..50b323ff1fd 100644
--- a/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/StandaloneComposedContainer.java
+++ b/shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite/src/test/java/org/apache/shardingsphere/test/integration/container/compose/mode/StandaloneComposedContainer.java
@@ -17,15 +17,14 @@
 
 package org.apache.shardingsphere.test.integration.container.compose.mode;
 
-import org.apache.shardingsphere.test.integration.container.atomic.adapter.AdapterContainerFactory;
-import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainerFactory;
 import org.apache.shardingsphere.test.integration.container.atomic.DockerITContainer;
 import org.apache.shardingsphere.test.integration.container.atomic.ITContainers;
 import org.apache.shardingsphere.test.integration.container.atomic.adapter.AdapterContainer;
+import org.apache.shardingsphere.test.integration.container.atomic.adapter.AdapterContainerFactory;
 import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainer;
+import org.apache.shardingsphere.test.integration.container.atomic.storage.StorageContainerFactory;
 import org.apache.shardingsphere.test.integration.container.compose.ComposedContainer;
 import org.apache.shardingsphere.test.integration.framework.param.model.ParameterizedArray;
-import org.apache.shardingsphere.test.integration.container.util.NetworkAliasUtil;
 
 import javax.sql.DataSource;
 import java.util.Map;
@@ -44,11 +43,9 @@ public final class StandaloneComposedContainer implements ComposedContainer {
     public StandaloneComposedContainer(final ParameterizedArray parameterizedArray) {
         String scenario = parameterizedArray.getScenario();
         containers = new ITContainers(scenario);
-        storageContainer = containers.registerContainer(StorageContainerFactory.newInstance(parameterizedArray.getDatabaseType(), scenario),
-                NetworkAliasUtil.getNetworkAlias(parameterizedArray.getDatabaseType().getType(), scenario));
-        adapterContainer = containers.registerContainer(AdapterContainerFactory.newInstance(parameterizedArray.getMode(), parameterizedArray.getAdapter(), parameterizedArray.getDatabaseType(),
-                storageContainer, scenario),
-                NetworkAliasUtil.getNetworkAlias(parameterizedArray.getAdapter(), scenario));
+        storageContainer = containers.registerContainer(StorageContainerFactory.newInstance(parameterizedArray.getDatabaseType(), scenario), parameterizedArray.getDatabaseType().getType());
+        adapterContainer = containers.registerContainer(AdapterContainerFactory.newInstance(
+                parameterizedArray.getMode(), parameterizedArray.getAdapter(), parameterizedArray.getDatabaseType(), storageContainer, scenario), parameterizedArray.getAdapter());
         if (adapterContainer instanceof DockerITContainer) {
             ((DockerITContainer) adapterContainer).dependsOn(storageContainer);
         }