makes use of workspaces optional and adds reconfigure config

Author: JDurstberger

src/infrablocks/invoke_terraform/task_factory.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Callable
+from typing import Callable, Optional
 
 from invoke.collection import Collection
 from invoke.context import Context
@@ -9,20 +9,28 @@
 from infrablocks.invoke_terraform.terraform_factory import TerraformFactory
 
 
+@dataclass
+class InitConfiguration:
+    backend_config: tf.BackendConfig
+    reconfigure: bool
+
+
 @dataclass
 class Configuration:
     source_directory: str
-    backend_config: tf.BackendConfig
     variables: tf.Variables
-    workspace: str
+    workspace: Optional[str]
+    init_configuration: InitConfiguration
 
     @staticmethod
     def create_empty():
         return Configuration(
             source_directory="",
-            backend_config={},
             variables={},
-            workspace="default",
+            workspace=None,
+            init_configuration=InitConfiguration(
+                backend_config={}, reconfigure=False
+            ),
         )
 
 
@@ -59,21 +67,8 @@ def _create_plan(
         pre_task_function: PreTaskFunction,
     ) -> invoke_factory.BodyCallable[None]:
         def plan(context: Context, arguments: invoke_factory.Arguments):
-            configuration = Configuration.create_empty()
-            pre_task_function(
-                context,
-                arguments,
-                configuration,
-            )
-            terraform = self._terraformFactory.build(context)
-            terraform.init(
-                chdir=configuration.source_directory,
-                backend_config=configuration.backend_config,
-            )
-            terraform.select_workspace(
-                configuration.workspace,
-                chdir=configuration.source_directory,
-                or_create=True,
+            (terraform, configuration) = self._pre_command_setup(
+                pre_task_function, context, arguments
             )
             terraform.plan(
                 chdir=configuration.source_directory,
@@ -87,25 +82,40 @@ def _create_apply(
         pre_task_function: PreTaskFunction,
     ) -> invoke_factory.BodyCallable[None]:
         def apply(context: Context, arguments: invoke_factory.Arguments):
-            configuration = Configuration.create_empty()
-            pre_task_function(
-                context,
-                arguments,
-                configuration,
+            (terraform, configuration) = self._pre_command_setup(
+                pre_task_function, context, arguments
             )
-            terraform = self._terraformFactory.build(context)
-            terraform.init(
+            terraform.apply(
                 chdir=configuration.source_directory,
-                backend_config=configuration.backend_config,
+                vars=configuration.variables,
             )
+
+        return apply
+
+    def _pre_command_setup(
+        self,
+        pre_task_function: PreTaskFunction,
+        context: Context,
+        arguments: invoke_factory.Arguments,
+    ) -> tuple[tf.Terraform, Configuration]:
+        configuration = Configuration.create_empty()
+        pre_task_function(
+            context,
+            arguments,
+            configuration,
+        )
+        terraform = self._terraformFactory.build(context)
+        terraform.init(
+            chdir=configuration.source_directory,
+            backend_config=configuration.init_configuration.backend_config,
+            reconfigure=configuration.init_configuration.reconfigure,
+        )
+
+        if configuration.workspace is not None:
             terraform.select_workspace(
                 configuration.workspace,
                 chdir=configuration.source_directory,
                 or_create=True,
             )
-            terraform.apply(
-                chdir=configuration.source_directory,
-                vars=configuration.variables,
-            )
 
-        return apply
+        return terraform, configuration

src/infrablocks/invoke_terraform/terraform/terraform.py

@@ -18,13 +18,18 @@ def init(
         self,
         chdir: Optional[str] = None,
         backend_config: Optional[BackendConfig] = {},
+        reconfigure: Optional[bool] = False,
     ):
         base_command = self._build_base_command(chdir)
         command = (
             base_command
             + ["init"]
             + self._build_backend_config(backend_config)
         )
+
+        if reconfigure:
+            command = command + ["-reconfigure"]
+
         self._executor.execute(command)
 
     def plan(

tests/unit/infrablocks/invoke_terraform/terraform/test_terraform.py

@@ -55,6 +55,16 @@ def test_init_executes_with_backend_config_path(self):
             ["terraform", "init", "-backend-config=/some/config.tfvars"]
         )
 
+    def test_init_executes_with_reconfigure(self):
+        executor = Mock(spec=Executor)
+        terraform = Terraform(executor)
+
+        terraform.init(reconfigure=True)
+
+        executor.execute.assert_called_once_with(
+            ["terraform", "init", "-reconfigure"]
+        )
+
     def test_plan_executes(self):
         executor = Mock(spec=Executor)
         terraform = Terraform(executor)

tests/unit/infrablocks/invoke_terraform/test_task_factory.py

@@ -33,7 +33,23 @@ def test_creates_plan_task(self):
 
         assert collection.tasks["plan"] is not None
 
-    def test_plan_uses_workspace(self):
+    def test_plan_does_not_use_workspace_when_not_set(self):
+        terraform = Mock(spec=tf.Terraform)
+        task_factory = TaskFactory()
+        task_factory._terraformFactory = TerraformFactory(terraform)
+
+        def pre_task_function(_context, _, configuration: Configuration):
+            configuration.source_directory = "/some/path"
+            configuration.workspace = None
+
+        collection = task_factory.create("collection", [], pre_task_function)
+        plan: Task = cast(Task, collection.tasks["plan"])
+
+        plan(Context())
+
+        terraform.select_workspace.assert_not_called()
+
+    def test_plan_uses_workspace_when_set(self):
         terraform = Mock(spec=tf.Terraform)
         task_factory = TaskFactory()
         task_factory._terraformFactory = TerraformFactory(terraform)
@@ -53,6 +69,25 @@ def pre_task_function(_context, _, configuration: Configuration):
             workspace, chdir=source_directory, or_create=True
         )
 
+    def test_plan_initialises_with_reconfigure(self):
+        terraform = Mock(spec=tf.Terraform)
+        task_factory = TaskFactory()
+        task_factory._terraformFactory = TerraformFactory(terraform)
+        source_directory = "/some/path"
+
+        def pre_task_function(_context, _, configuration: Configuration):
+            configuration.source_directory = source_directory
+            configuration.init_configuration.reconfigure = True
+
+        collection = task_factory.create("collection", [], pre_task_function)
+        plan: Task = cast(Task, collection.tasks["plan"])
+
+        plan(Context())
+
+        terraform.init.assert_called_once_with(
+            chdir=source_directory, backend_config={}, reconfigure=True
+        )
+
     def test_plan_invokes_init_and_plan(self):
         terraform = Mock(spec=tf.Terraform)
         task_factory = TaskFactory()
@@ -64,15 +99,17 @@ def test_plan_invokes_init_and_plan(self):
         def pre_task_function(_context, _, configuration: Configuration):
             configuration.source_directory = source_directory
             configuration.variables = variables
-            configuration.backend_config = backend_config
+            configuration.init_configuration.backend_config = backend_config
 
         collection = task_factory.create("collection", [], pre_task_function)
         plan: Task = cast(Task, collection.tasks["plan"])
 
         plan(Context())
 
         terraform.init.assert_called_once_with(
-            chdir=source_directory, backend_config=backend_config
+            chdir=source_directory,
+            backend_config=backend_config,
+            reconfigure=False,
         )
         terraform.plan.assert_called_once_with(
             chdir=source_directory, vars=variables
@@ -98,15 +135,17 @@ def test_apply_invokes_init_and_apply(self):
         def pre_task_function(_context, _, configuration: Configuration):
             configuration.source_directory = source_directory
             configuration.variables = variables
-            configuration.backend_config = backend_config
+            configuration.init_configuration.backend_config = backend_config
 
         collection = task_factory.create("collection", [], pre_task_function)
         apply: Task = cast(Task, collection.tasks["apply"])
 
         apply(Context())
 
         terraform.init.assert_called_once_with(
-            chdir=source_directory, backend_config=backend_config
+            chdir=source_directory,
+            backend_config=backend_config,
+            reconfigure=False,
         )
         terraform.apply.assert_called_once_with(
             chdir=source_directory, vars=variables