Merge branch '520-add-support-for-opentofu' into 'main'

Resolve "Add support for OpenTofu"

Closes #520

See merge request pub/terrareg!407

Author: MatthewJohn

Dockerfile

@@ -42,7 +42,7 @@ RUN bash -c 'if [ "$(uname -m)" == "aarch64" ]; \
     rm /tmp/infracost.tar.gz'
 
 # Download tfswitch
-RUN bash -c 'curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash /dev/stdin 1.0.0'
+RUN bash -c 'curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash /dev/stdin 1.2.2'
 
 # Install go
 RUN bash -c 'if [ "$(uname -m)" == "aarch64" ]; \

Dockerfile.tests

@@ -42,7 +42,7 @@ RUN bash -c 'if [ "$(uname -m)" == "aarch64" ]; \
     rm /tmp/infracost.tar.gz'
 
 # Download tfswitch
-RUN bash -c 'curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash /dev/stdin 1.0.0'
+RUN bash -c 'curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash /dev/stdin 1.2.2'
 
 # Install go
 RUN bash -c 'if [ "$(uname -m)" == "aarch64" ]; \

docs/CONFIG.md

@@ -790,6 +790,17 @@ A common configuration may require a 'groups' scope to be added to the list of s
 Default: `['openid', 'profile']`
 
 
+### PRODUCT
+
+
+Product to use when performing module extraction
+
+Options: terraform, opentofu
+
+
+Default: `terraform`
+
+
 ### PROVIDER_CATEGORIES
 
 
@@ -1073,10 +1084,12 @@ Default: ``
 ### TERRAFORM_ARCHIVE_MIRROR
 
 
-Mirror for obtaining version list and downloading Terraform
+Mirror for obtaining version list and downloading Terraform.
 
+Defaults to default mirror used by tfswitch
 
-Default: `https://releases.hashicorp.com/terraform`
+
+Default: ``
 
 
 ### TERRAFORM_EXAMPLE_VERSION_TEMPLATE

scripts/dictionary.txt

@@ -143,4 +143,5 @@ endpoint
 prepended
 prepending
 FH
-netloc
+netloc
+opentofu

terrareg/config.py

@@ -33,6 +33,12 @@ class DefaultUiInputOutputView(Enum):
     EXPANDED = "expanded"
 
 
+class Product(Enum):
+    """Type of product"""
+    TERRAFORM = "terraform"
+    OPENTOFU = "opentofu"
+
+
 class Config:
 
     @property
@@ -912,12 +918,23 @@ def DEFAULT_TERRAFORM_VERSION(self):
         """
         return os.environ.get("DEFAULT_TERRAFORM_VERSION", "1.3.6")
 
+    @property
+    def PRODUCT(self):
+        """
+        Product to use when performing module extraction
+
+        Options: terraform, opentofu
+        """
+        return Product(os.environ.get('PRODUCT', Product.TERRAFORM.value).lower())
+
     @property
     def TERRAFORM_ARCHIVE_MIRROR(self):
         """
-        Mirror for obtaining version list and downloading Terraform
+        Mirror for obtaining version list and downloading Terraform.
+
+        Defaults to default mirror used by tfswitch
         """
-        return os.environ.get("TERRAFORM_ARCHIVE_MIRROR", "https://releases.hashicorp.com/terraform")
+        return os.environ.get("TERRAFORM_ARCHIVE_MIRROR", "")
 
     @property
     def MANAGE_TERRAFORM_RC_FILE(self):

terrareg/module_extractor.py

@@ -32,6 +32,7 @@
     UnableToGetGlobalTerraformLockError,
     TerraformVersionSwitchError
 )
+import terrareg.terraform_product
 from terrareg.utils import PathDoesNotExistError, get_public_url_details, safe_iglob, safe_join_paths
 from terrareg.config import Config
 from terrareg.constants import EXTRACTION_VERSION
@@ -51,9 +52,10 @@ def __init__(self, module_version: 'terrareg.models.ModuleVersion'):
         self._upload_directory = tempfile.TemporaryDirectory()  # noqa: R1732
 
     @staticmethod
-    def terraform_binary():
+    def terraform_binary() -> str:
         """Return path of terraform binary"""
-        return os.path.join(os.getcwd(), "bin", "terraform")
+        product = terrareg.terraform_product.ProductFactory.get_product()
+        return os.path.join(os.getcwd(), "bin", product.get_executable_name())
 
     @property
     def terraform_rc_file(self):
@@ -130,16 +132,25 @@ def _switch_terraform_versions(cls, module_path):
                 "Unable to obtain global Terraform lock in 60 seconds"
             )
         try:
-            default_terraform_version = Config().DEFAULT_TERRAFORM_VERSION
+            config = Config()
+
+            default_terraform_version = config.DEFAULT_TERRAFORM_VERSION
             tfswitch_env = os.environ.copy()
 
             if default_terraform_version:
-                tfswitch_env["TF_VERSION"] = default_terraform_version
+                tfswitch_env["TF_DEFAULT_VERSION"] = default_terraform_version
+
+            product = terrareg.terraform_product.ProductFactory.get_product()
+            tfswitch_env["TF_PRODUCT"] = product.get_tfswitch_product_arg()
+
+            tfswitch_args = []
+            if config.TERRAFORM_ARCHIVE_MIRROR:
+                tfswitch_args += ["--mirror", config.TERRAFORM_ARCHIVE_MIRROR]
 
             # Run tfswitch
             try:
                 subprocess.check_output(
-                    ["tfswitch", "--mirror", Config().TERRAFORM_ARCHIVE_MIRROR, "--bin", cls.terraform_binary()],
+                    ["tfswitch", "--bin", cls.terraform_binary(), *tfswitch_args],
                     env=tfswitch_env,
                     cwd=module_path
                 )

terrareg/terraform_product.py

@@ -0,0 +1,52 @@
+import abc
+
+import terrareg.config
+
+
+class BaseProduct(abc.ABC):
+
+    @abc.abstractmethod
+    def get_tfswitch_product_arg(self) -> str:
+        """Return name of tfswitch product argument value"""
+        ...
+
+    @abc.abstractmethod
+    def get_executable_name(self) -> str:
+        """Return executable name for product"""
+        ...
+
+class Terraform(BaseProduct):
+    """Terraform product"""
+
+    def get_tfswitch_product_arg(self) -> str:
+        """Return name of tfswitch product argument value"""
+        return "terraform"
+
+    def get_executable_name(self) -> str:
+        """Return executable name for product"""
+        return "terraform"
+    
+
+class OpenTofu(BaseProduct):
+    """OpenTofu product"""
+
+    def get_tfswitch_product_arg(self) -> str:
+        """Return name of tfswitch product argument value"""
+        return "opentofu"
+
+    def get_executable_name(self) -> str:
+        """Return executable name for product"""
+        return "tofu"
+
+
+class ProductFactory:
+
+    @staticmethod
+    def get_product():
+        """Obtain current product"""
+        product_enum = terrareg.config.Config().PRODUCT
+        if product_enum is terrareg.config.Product.TERRAFORM:
+            return Terraform()
+        elif product_enum is terrareg.config.Product.OPENTOFU:
+            return OpenTofu()
+        raise Exception("Could not determine product class")

test/unit/terrareg/test_config.py

@@ -167,6 +167,7 @@ def test_list_configs(self, config_name, test_value, expected_value):
         ('SERVER', terrareg.config.ServerType, terrareg.config.ServerType.BUILTIN),
         ('ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode, terrareg.config.ModuleHostingMode.ALLOW),
         ('DEFAULT_UI_DETAILS_VIEW', terrareg.config.DefaultUiInputOutputView, terrareg.config.DefaultUiInputOutputView.TABLE),
+        ('PRODUCT', terrareg.config.Product, terrareg.config.Product.TERRAFORM),
     ])
     def test_enum_configs(self, config_name, enum, expected_default):
         """Test enum configs to ensure they are overridden with environment variables."""

test/unit/terrareg/test_module_extractor.py

@@ -16,6 +16,7 @@
 )
 from terrareg.module_extractor import GitModuleExtractor, ModuleExtractor
 import terrareg.models
+import terrareg.config
 
 
 class TestGitModuleExtractor(TerraregUnitTest):
@@ -253,36 +254,46 @@ def test_description_extraction_when_disabled(self, mock_models):
         with unittest.mock.patch('terrareg.config.Config.AUTOGENERATE_MODULE_PROVIDER_DESCRIPTION', False):
             assert module_extractor._extract_description(test_text) == None
 
-    def test_run_tf_init(self):
+    @pytest.mark.parametrize('config_product, expected_binary', [
+        (terrareg.config.Product.TERRAFORM, 'terraform'),
+        (terrareg.config.Product.OPENTOFU, 'tofu'),
+    ])
+    def test_run_tf_init(self, config_product, expected_binary):
         """Test running terraform init"""
         with unittest.mock.patch('terrareg.module_extractor.subprocess.check_call', unittest.mock.MagicMock()) as check_output_mock, \
-                unittest.mock.patch("terrareg.module_extractor.ModuleExtractor._create_terraform_rc_file", unittest.mock.MagicMock()) as mock_create_terraform_rc_file:
+                unittest.mock.patch("terrareg.module_extractor.ModuleExtractor._create_terraform_rc_file", unittest.mock.MagicMock()) as mock_create_terraform_rc_file, \
+                unittest.mock.patch('terrareg.config.Config.PRODUCT', config_product):
 
             module_extractor = GitModuleExtractor(module_version=None)
 
             assert module_extractor._run_tf_init(module_path='/tmp/mock-patch/to/module') is True
 
             check_output_mock.assert_called_once_with(
-                [os.path.join(os.getcwd(), 'bin', 'terraform'), 'init'],
+                [os.path.join(os.getcwd(), 'bin', expected_binary), 'init'],
                 cwd='/tmp/mock-patch/to/module'
             )
             mock_create_terraform_rc_file.assert_called_once_with()
 
-    def test_run_tf_init_error(self):
+    @pytest.mark.parametrize('config_product, expected_binary', [
+        (terrareg.config.Product.TERRAFORM, 'terraform'),
+        (terrareg.config.Product.OPENTOFU, 'tofu'),
+    ])
+    def test_run_tf_init_error(self, config_product, expected_binary):
         """Test running terraform init with error returned"""
 
         def raise_exception(*args, **kwargs):
             raise subprocess.CalledProcessError(cmd="test", returncode=2)
 
         with unittest.mock.patch('terrareg.module_extractor.subprocess.check_call', unittest.mock.MagicMock(side_effect=raise_exception)) as mock_check_call, \
-                unittest.mock.patch("terrareg.module_extractor.ModuleExtractor._create_terraform_rc_file", unittest.mock.MagicMock()) as mock_create_terraform_rc_file:
+                unittest.mock.patch("terrareg.module_extractor.ModuleExtractor._create_terraform_rc_file", unittest.mock.MagicMock()) as mock_create_terraform_rc_file, \
+                unittest.mock.patch('terrareg.config.Config.PRODUCT', config_product):
 
             module_extractor = GitModuleExtractor(module_version=None)
 
             assert module_extractor._run_tf_init(module_path='/tmp/mock-patch/to/module') is False
 
             mock_check_call.assert_called_once_with(
-                [os.path.join(os.getcwd(), 'bin', 'terraform'), 'init'],
+                [os.path.join(os.getcwd(), 'bin', expected_binary), 'init'],
                 cwd='/tmp/mock-patch/to/module'
             )
             mock_create_terraform_rc_file.assert_called_once_with()
@@ -391,7 +402,11 @@ def test_override_tf_backend(self, file_contents, expected_backend_file):
                 shutil.rmtree(temp_dir)
 
 
-    def test_switch_terraform_versions(self):
+    @pytest.mark.parametrize('config_product', [
+        terrareg.config.Product.TERRAFORM,
+        terrareg.config.Product.OPENTOFU,
+    ])
+    def test_switch_terraform_versions(self, config_product):
         """Test switching terraform versions."""
         module_extractor = GitModuleExtractor(module_version=None)
         mock_lock = unittest.mock.MagicMock()
@@ -400,16 +415,19 @@ def test_switch_terraform_versions(self):
         with unittest.mock.patch('terrareg.module_extractor.ModuleExtractor.TERRAFORM_LOCK', mock_lock), \
                 unittest.mock.patch('terrareg.module_extractor.subprocess.check_output', unittest.mock.MagicMock()) as check_output_mock, \
                 unittest.mock.patch('terrareg.config.Config.DEFAULT_TERRAFORM_VERSION', 'unittest-tf-version'), \
-                unittest.mock.patch('terrareg.config.Config.TERRAFORM_ARCHIVE_MIRROR', 'https://localhost-archive/mirror/terraform'):
+                unittest.mock.patch('terrareg.config.Config.TERRAFORM_ARCHIVE_MIRROR', 'https://localhost-archive/mirror/terraform'), \
+                unittest.mock.patch('terrareg.config.Config.PRODUCT', config_product):
 
             with module_extractor._switch_terraform_versions(module_path='/tmp/mock-patch/to/module'):
                 pass
 
             mock_lock.acquire.assert_called_once_with(blocking=True, timeout=60)
+            expected_bin = f"{os.getcwd()}/bin/" + ('terraform' if config_product is terrareg.config.Product.TERRAFORM else 'tofu')
             expected_env = os.environ.copy()
-            expected_env['TF_VERSION'] = "unittest-tf-version"
+            expected_env['TF_DEFAULT_VERSION'] = "unittest-tf-version"
+            expected_env['TF_PRODUCT'] = 'terraform' if config_product is terrareg.config.Product.TERRAFORM else 'opentofu'
             check_output_mock.assert_called_once_with(
-                ["tfswitch", "--mirror", "https://localhost-archive/mirror/terraform", "--bin", f"{os.getcwd()}/bin/terraform"],
+                ["tfswitch", "--bin", expected_bin, "--mirror", "https://localhost-archive/mirror/terraform"],
                 env=expected_env,
                 cwd="/tmp/mock-patch/to/module"
             )
@@ -446,17 +464,22 @@ def test_switch_terraform_versions_with_lock(self):
             mock_lock.acquire.assert_called_once_with(blocking=True, timeout=60)
             check_output_mock.assert_not_called()
 
-    def test_get_graph_data(self):
+    @pytest.mark.parametrize('config_product, expected_binary', [
+        (terrareg.config.Product.TERRAFORM, 'terraform'),
+        (terrareg.config.Product.OPENTOFU, 'tofu'),
+    ])
+    def test_get_graph_data(self, config_product, expected_binary):
         """Test call to terraform graph to generate graph output"""
         module_extractor = GitModuleExtractor(module_version=None)
 
         with unittest.mock.patch('terrareg.module_extractor.subprocess.check_output',
-                                 unittest.mock.MagicMock(return_value="Output graph data".encode("utf-8"))) as mock_check_output:
+                                 unittest.mock.MagicMock(return_value="Output graph data".encode("utf-8"))) as mock_check_output, \
+                unittest.mock.patch('terrareg.config.Config.PRODUCT', config_product):
 
             module_extractor._get_graph_data(module_path='/tmp/mock-patch/to/module')
 
             mock_check_output.assert_called_once_with(
-                [os.getcwd() + '/bin/terraform', 'graph'],
+                [f'{os.getcwd()}/bin/{expected_binary}', 'graph'],
                 cwd='/tmp/mock-patch/to/module'
             )