feat: Add support for OpenTofu

Add new configurations to specify product.
Use product to determine product passed to tfswitch and for executable used when calling terraform

Issue #520

docs/CONFIG.md

@@ -774,6 +774,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
 
 
@@ -1057,10 +1068,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

terrareg/config.py

@@ -26,6 +26,12 @@ class ModuleHostingMode(Enum):
     ENFORCE = "enforce"
 
 
+class Product(Enum):
+    """Type of product"""
+    TERRAFORM = "terraform"
+    OPENTOFU = "opentofu"
+
+
 class Config:
 
     @property
@@ -861,12 +867,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

@@ -31,6 +31,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
@@ -50,9 +51,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):
@@ -118,16 +120,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
 
+            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")