add openTofu as a new deployer

eclipse-xpanse · Jan 25, 2024 · d48861f · d48861f
1 parent 88f748e
commit d48861f
Show file tree

Hide file tree

Showing 82 changed files with 3,832 additions and 584 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -23,6 +23,10 @@ jobs:
         with:
           java-version: 21
           distribution: 'temurin'
+      - name: Set up OpenTofu
+        uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: 1.6.0
       - name: Build
         run: mvn --batch-mode --update-snapshots --no-transfer-progress verify
       - name: Generate API doc

diff --git a/Dockerfile b/Dockerfile
@@ -1,6 +1,7 @@
 FROM eclipse-temurin:21-jre-alpine
 
-ENV TERRAFORM_VERSION=1.4.4
+ENV TERRAFORM_VERSION=1.6.0
+ENV OPENTOFU_VERSION=1.6.0
 ENV XPANSE_USER=xpanse
 ENV XPANSE_HOME_DIR=/home/xpanse
 
@@ -13,6 +14,11 @@ RUN wget https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform
 RUN unzip terraform_${TERRAFORM_VERSION}_linux_amd64.zip
 RUN mv terraform /usr/bin/terraform
 
+# Install OpenTofu
+RUN wget https://github.com/opentofu/opentofu/releases/download/v${OPENTOFU_VERSION}/tofu_${OPENTOFU_VERSION}_linux_amd64.zip
+RUN unzip tofu_${OPENTOFU_VERSION}_linux_amd64.zip
+RUN mv tofu /usr/bin/tofu
+
 # Copy the script for starting xpanse with private key
 COPY start-xpanse-with-private_key.sh /start-xpanse-with-private_key.sh
 RUN chmod +x /start-xpanse-with-private_key.sh

diff --git a/...i/src/main/java/org/eclipse/xpanse/api/exceptions/handler/DeploymentExceptionHandler.java b/...i/src/main/java/org/eclipse/xpanse/api/exceptions/handler/DeploymentExceptionHandler.java
@@ -7,6 +7,9 @@
 
 import java.util.Collections;
 import lombok.extern.slf4j.Slf4j;
+import org.eclipse.xpanse.modules.deployment.deployers.terraform.exceptions.TerraformBootRequestFailedException;
+import org.eclipse.xpanse.modules.deployment.deployers.terraform.exceptions.TerraformExecutorException;
+import org.eclipse.xpanse.modules.deployment.deployers.terraform.exceptions.TerraformProviderNotFoundException;
 import org.eclipse.xpanse.modules.models.response.Response;
 import org.eclipse.xpanse.modules.models.response.ResultType;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.ActivitiTaskNotFoundException;
@@ -17,9 +20,6 @@
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.PluginNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.ServiceDetailsNotAccessible;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.ServiceNotDeployedException;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformBootRequestFailedException;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformExecutorException;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformProviderNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.VariableInvalidException;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;

diff --git a/...c/test/java/org/eclipse/xpanse/api/exceptions/handler/DeploymentExceptionHandlerTest.java b/...c/test/java/org/eclipse/xpanse/api/exceptions/handler/DeploymentExceptionHandlerTest.java
@@ -18,14 +18,14 @@
 import org.eclipse.xpanse.modules.deployment.DeployServiceEntityHandler;
 import org.eclipse.xpanse.modules.deployment.DeployerKindManager;
 import org.eclipse.xpanse.modules.deployment.ServiceDetailsViewManager;
+import org.eclipse.xpanse.modules.deployment.deployers.terraform.exceptions.TerraformExecutorException;
+import org.eclipse.xpanse.modules.deployment.deployers.terraform.exceptions.TerraformProviderNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.DeployerNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.FlavorInvalidException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.InvalidDeploymentVariableException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.InvalidServiceStateException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.PluginNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.ServiceNotDeployedException;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformExecutorException;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformProviderNotFoundException;
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.VariableInvalidException;
 import org.eclipse.xpanse.modules.security.IdentityProviderManager;
 import org.eclipse.xpanse.modules.workflow.utils.WorkflowUtils;

diff --git a/modules/common/pom.xml b/modules/common/pom.xml
@@ -27,5 +27,10 @@
             <artifactId>commons-io</artifactId>
             <version>${apache.commons.io.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>${apache.commons.lang.version}</version>
+        </dependency>
     </dependencies>
 </project>
diff --git a/.../deployers/terraform/utils/SystemCmd.java → ...se/xpanse/common/systemcmd/SystemCmd.java b/.../deployers/terraform/utils/SystemCmd.java → ...se/xpanse/common/systemcmd/SystemCmd.java
@@ -4,7 +4,7 @@
  *
  */
 
-package org.eclipse.xpanse.modules.deployment.deployers.terraform.utils;
+package org.eclipse.xpanse.common.systemcmd;
 
 import java.io.BufferedReader;
 import java.io.File;
@@ -21,21 +21,18 @@
 import lombok.Getter;
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
-import org.eclipse.xpanse.modules.models.service.deploy.exceptions.TerraformExecutorException;
 import org.slf4j.MDC;
 
 /**
  * Executes operating system commands.
  */
+@Setter
+@Getter
 @Slf4j
 public class SystemCmd {
 
-    @Setter
-    @Getter
     private Map<String, String> env;
 
-    @Setter
-    @Getter
     private String workDir = "";
 
     public SystemCmdResult execute(String cmd) {
@@ -81,18 +78,14 @@ public SystemCmdResult execute(String cmd, int waitSecond) {
             }
             log.debug("stdout of the command: " + systemCmdResult.getCommandStdOutput());
             log.debug("stderr of the command: " + systemCmdResult.getCommandStdError());
-        } catch (final IOException ex) {
+        } catch (final IOException | ExecutionException ex) {
             systemCmdResult.setCommandSuccessful(false);
             systemCmdResult.setCommandStdError(ex.getMessage());
         } catch (final InterruptedException ex) {
             log.error("SystemCmd process be interrupted.");
             Thread.currentThread().interrupt();
             systemCmdResult.setCommandSuccessful(false);
             systemCmdResult.setCommandStdError(ex.getMessage());
-        } catch (ExecutionException e) {
-            systemCmdResult.setCommandSuccessful(false);
-            systemCmdResult.setCommandStdError(e.getMessage());
-            throw new TerraformExecutorException(e.getMessage());
         }
         return systemCmdResult;
     }
@@ -104,7 +97,7 @@ private String readStream(BufferedReader bufferedReader, Map<String, String> con
         bufferedReader.lines().forEach(line -> {
             log.info(line);
             // skip adding new line for the first line.
-            if (stringBuilder.length() > 0) {
+            if (!stringBuilder.isEmpty()) {
                 stringBuilder.append(System.lineSeparator());
             }
             stringBuilder.append(line);

diff --git a/...yers/terraform/utils/SystemCmdResult.java → ...nse/common/systemcmd/SystemCmdResult.java b/...yers/terraform/utils/SystemCmdResult.java → ...nse/common/systemcmd/SystemCmdResult.java
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Huawei Inc.
  */
 
-package org.eclipse.xpanse.modules.deployment.deployers.terraform.utils;
+package org.eclipse.xpanse.common.systemcmd;
 
 import lombok.Data;
 

diff --git a/.../terraform/utils/SystemCmdResultTest.java → ...common/systemcmd/SystemCmdResultTest.java b/.../terraform/utils/SystemCmdResultTest.java → ...common/systemcmd/SystemCmdResultTest.java
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Huawei Inc.
  */
 
-package org.eclipse.xpanse.modules.deployment.deployers.terraform.utils;
+package org.eclipse.xpanse.common.systemcmd;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
@@ -41,7 +41,6 @@ void testGetterAndSetter() {
 
     @Test
     public void testEqualsAndHashCode() {
-        assertEquals(systemCmdResult, systemCmdResult);
         assertEquals(systemCmdResult.hashCode(), systemCmdResult.hashCode());
 
         Object obj = new Object();

diff --git a/...loyers/terraform/utils/SystemCmdTest.java → ...panse/common/systemcmd/SystemCmdTest.java b/...loyers/terraform/utils/SystemCmdTest.java → ...panse/common/systemcmd/SystemCmdTest.java
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Huawei Inc.
  */
 
-package org.eclipse.xpanse.modules.deployment.deployers.terraform.utils;
+package org.eclipse.xpanse.common.systemcmd;
 
 import org.apache.commons.lang3.SystemUtils;
 import org.junit.jupiter.api.Assertions;

diff --git a/modules/credential/src/test/java/org/eclipse/xpanse/modules/credential/DummyPluginImpl.java b/modules/credential/src/test/java/org/eclipse/xpanse/modules/credential/DummyPluginImpl.java
@@ -90,11 +90,6 @@ public List<Metric> getMetricsForService(ServiceMetricsRequest serviceMetricRequ
         return null;
     }
 
-    @Override
-    public String getProvider(String region) {
-        return null;
-    }
-
     @Override
     public boolean startService(ServiceStateManageRequest serviceStateManageRequest) {
         return true;
@@ -109,5 +104,10 @@ public boolean stopService(ServiceStateManageRequest serviceStateManageRequest)
     public boolean restartService(ServiceStateManageRequest serviceStateManageRequest) {
         return true;
     }
+
+    @Override
+    public String getProvider(DeployerKind deployerKind, String region) {
+        return null;
+    }
 }