Initial OpenTofu support (#675)

* Initial OpenTofu support
AzBuilder · Jan 17, 2024 · 13636b1 · 13636b1
1 parent 84d476c
commit 13636b1
Show file tree

Hide file tree

Showing 11 changed files with 65 additions and 15 deletions.
diff --git a/api/src/main/java/org/terrakube/api/plugin/scheduler/job/tcl/executor/ExecutorContext.java b/api/src/main/java/org/terrakube/api/plugin/scheduler/job/tcl/executor/ExecutorContext.java
@@ -29,6 +29,7 @@ public class ExecutorContext {
     private String accessToken;
     private String moduleSshKey;
     private String commitId;
+    private boolean tofu;
     private HashMap<String, String> environmentVariables;
     private HashMap<String, String> variables;
 }
diff --git a/api/src/main/java/org/terrakube/api/plugin/scheduler/job/tcl/executor/ExecutorService.java b/api/src/main/java/org/terrakube/api/plugin/scheduler/job/tcl/executor/ExecutorService.java
@@ -123,6 +123,7 @@ public boolean execute(Job job, String stepId, Flow flow) {
                 executorContext.setModuleSshKey(ssh.get().getPrivateKey());
             }
         }
+        executorContext.setTofu(job.getWorkspace().isTofu());
         executorContext.setCommitId(job.getCommitId());
         executorContext.setFolder(job.getWorkspace().getFolder());
         executorContext.setRefresh(job.isRefresh());

diff --git a/api/src/main/java/org/terrakube/api/rs/workspace/Workspace.java b/api/src/main/java/org/terrakube/api/rs/workspace/Workspace.java
@@ -60,6 +60,9 @@ public class Workspace extends GenericAuditFields {
     @Column(name = "deleted")
     private boolean deleted;
 
+    @Column(name = "tofu")
+    private boolean tofu = false;
+
     @Column(name = "module_ssh_key")
     private String moduleSshKey;
 

diff --git a/api/src/main/resources/db/changelog/changelog-demo.xml b/api/src/main/resources/db/changelog/changelog-demo.xml
@@ -13,4 +13,5 @@
     <include file="/db/changelog/demo-data/gcp.xml"/>
     <include file="/db/changelog/demo-data/simple.xml"/>
     <include file="/db/changelog/demo-data/simple-tag.xml"/>
+    <include file="/db/changelog/demo-data/demo-tofu.xml"/>
 </databaseChangeLog>
diff --git a/api/src/main/resources/db/changelog/changelog.xml b/api/src/main/resources/db/changelog/changelog.xml
@@ -45,4 +45,5 @@
     <include file="/db/changelog/local/changelog-2.19.0-allow-refresh.xml"/>
     <include file="/db/changelog/local/changelog-2.19.0-vcs-module-ssh.xml"/>
     <include file="/db/changelog/local/changelog-2.19.0-workspace-folder-length.xml"/>
+    <include file="/db/changelog/local/changelog-2.19.0-workspace-tofu.xml"/>
 </databaseChangeLog>
diff --git a/api/src/main/resources/db/changelog/demo-data/demo-tofu.xml b/api/src/main/resources/db/changelog/demo-data/demo-tofu.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+            http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.3.xsd">
+    <changeSet author="demo-data" id="demo-6">
+        <update tableName="workspace">
+            <column name="tofu" valueBoolean="false"/>
+        </update>
+    </changeSet>
+</databaseChangeLog>
diff --git a/api/src/main/resources/db/changelog/local/changelog-2.19.0-workspace-tofu.xml b/api/src/main/resources/db/changelog/local/changelog-2.19.0-workspace-tofu.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+            http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.3.xsd">
+    <changeSet id="33" author="alfespa17@gmail.com">
+        <addColumn tableName="workspace" >
+            <column name="tofu" type="boolean"/>
+        </addColumn>
+        <update tableName="workspace">
+            <column name="tofu" valueBoolean="false"/>
+        </update>
+    </changeSet>
+</databaseChangeLog>
diff --git a/executor/pom.xml b/executor/pom.xml
@@ -16,7 +16,7 @@
 	<properties>
 		<java.version>17</java.version>
 		<commons-text.version>1.10.0</commons-text.version>
-		<terraform-spring-boot-starter.version>0.11.2</terraform-spring-boot-starter.version>
+		<terraform-spring-boot-starter.version>0.12.0</terraform-spring-boot-starter.version>
 		<terrakube-client-starter.version>0.12.0</terrakube-client-starter.version>
 		<commons-io.version>2.8.0</commons-io.version>
 		<commons-codec>1.15</commons-codec>

diff --git a/executor/src/main/java/org/terrakube/executor/service/mode/TerraformJob.java b/executor/src/main/java/org/terrakube/executor/service/mode/TerraformJob.java
@@ -30,6 +30,7 @@ public class TerraformJob {
     private boolean refreshOnly;
     private String moduleSshKey;
     private String commitId;
+    private boolean tofu;
     private HashMap<String, String> environmentVariables;
     private HashMap<String, String> variables;
 

diff --git a/.../src/main/java/org/terrakube/executor/service/terraform/TerraformExecutorServiceImpl.java b/.../src/main/java/org/terrakube/executor/service/terraform/TerraformExecutorServiceImpl.java
@@ -107,7 +107,7 @@ public ExecutorJobResult plan(TerraformJob terraformJob, File workingDirectory,
 
             scriptBeforeSuccessPlan = executePreOperationScripts(terraformJob, terraformWorkingDir, planOutput);
 
-            showTerraformMessage("PLAN", planOutput);
+            showTerraformMessage(terraformJob,"PLAN", planOutput);
 
             if (scriptBeforeSuccessPlan)
                 if (isDestroy) {
@@ -180,7 +180,7 @@ public ExecutorJobResult apply(TerraformJob terraformJob, File workingDirectory)
 
             scriptBeforeSuccess = executePreOperationScripts(terraformJob, terraformWorkingDir, applyOutput);
 
-            showTerraformMessage("APPLY", applyOutput);
+            showTerraformMessage(terraformJob, "APPLY", applyOutput);
 
             if (scriptBeforeSuccess) {
                 TerraformProcessData terraformProcessData = getTerraformProcessData(terraformJob, terraformWorkingDir);
@@ -245,7 +245,7 @@ public ExecutorJobResult destroy(TerraformJob terraformJob, File workingDirector
 
             scriptBeforeSuccess = executePreOperationScripts(terraformJob, terraformWorkingDir, outputDestroy);
 
-            showTerraformMessage("DESTROY", outputDestroy);
+            showTerraformMessage(terraformJob, "DESTROY", outputDestroy);
 
             if (scriptBeforeSuccess) {
                 execution = terraformClient.destroy(
@@ -410,15 +410,19 @@ private void initBanner(TerraformJob terraformJob, Consumer<String> output) {
         output.accept(
                 colorize("Initializing Terrakube Job " + terraformJob.getJobId() + " Step " + terraformJob.getStepId(),
                         colorMessage));
-        output.accept(colorize("Running Terraform " + terraformJob.getTerraformVersion(), colorMessage));
+        output.accept(colorize(String.format("Running %s ", getIaCType(terraformJob)) + terraformJob.getTerraformVersion(), colorMessage));
         output.accept(colorize("\n\n" + STEP_SEPARATOR, colorMessage));
-        output.accept(colorize("Running Terraform Init: ", colorMessage));
+        output.accept(colorize(String.format("Running %s Init: ",getIaCType(terraformJob)), colorMessage));
     }
 
-    private void showTerraformMessage(String operation, Consumer<String> output) throws InterruptedException {
+    private String getIaCType(TerraformJob terraformJob){
+        return terraformJob.isTofu() ? "Tofu": "Terraform";
+    }
+
+    private void showTerraformMessage(TerraformJob terraformJob, String operation, Consumer<String> output) throws InterruptedException {
         AnsiFormat colorMessage = new AnsiFormat(GREEN_TEXT(), BLACK_BACK(), BOLD());
         output.accept(colorize(STEP_SEPARATOR, colorMessage));
-        output.accept(colorize("Running Terraform " + operation, colorMessage));
+        output.accept(colorize(String.format("Running %s ",getIaCType(terraformJob)) + operation, colorMessage));
         output.accept(colorize(STEP_SEPARATOR, colorMessage));
         Thread.sleep(2000);
     }
@@ -456,6 +460,7 @@ private TerraformProcessData getTerraformProcessData(TerraformJob terraformJob,
                 .workingDirectory(workingDirectory)
                 .refresh(terraformJob.isRefresh())
                 .refreshOnly(terraformJob.isRefreshOnly())
+                .tofu(terraformJob.isTofu())
                 .sshFile(sshKeyFile)
                 .build();
 

diff --git a/ui/src/domain/Workspaces/Details.jsx b/ui/src/domain/Workspaces/Details.jsx
@@ -315,6 +315,7 @@ export const WorkspaceDetails = (props) => {
           executionMode: values.executionMode,
           moduleSshKey: values.moduleSshKey,
           terraformVersion: values.terraformVersion,
+          tofu: values.tofu,
         },
       },
     };
@@ -798,6 +799,7 @@ export const WorkspaceDetails = (props) => {
                           moduleSshKey: workspace.data.attributes.moduleSshKey,
                           executionMode:
                             workspace.data.attributes.executionMode,
+                          tofu: workspace.data.attributes.tofu,
                         }}
                         layout="vertical"
                         name="form-settings"
@@ -857,15 +859,26 @@ export const WorkspaceDetails = (props) => {
                         </Form.Item>
 
                         <Form.Item
-                          name="executionMode"
-                          label="Execution Mode"
-                          extra="Use this option with terraform remote state/cloud block if you want to execute Terraform CLI remotely and just upload the state to Terrakube"
+                            name="tofu"
+                            valuePropName="checked"
+                            label="Use OpenTofu"
+                            tooltip={{
+                              title: "Use OpenTofu",
+                              icon: <InfoCircleOutlined />,
+                            }}
+                        >
+                          <Switch />
+                        </Form.Item>
+                        <Form.Item
+                            name="executionMode"
+                            label="Execution Mode"
+                            extra="Use this option with terraform remote state/cloud block if you want to execute Terraform CLI remotely and just upload the state to Terrakube"
                         >
                           <Select
-                            defaultValue={
-                              workspace.data.attributes.executionMode
-                            }
-                            style={{ width: 250 }}
+                              defaultValue={
+                                workspace.data.attributes.executionMode
+                              }
+                              style={{ width: 250 }}
                           >
                             <Option key="remote">remote</Option>
                             <Option key="local">local</Option>