spaceforge 1.1.7__py3-none-any.whl → 1.2.0__py3-none-any.whl

spaceforge/_version_scm.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.1.7'
-__version_tuple__ = version_tuple = (1, 1, 7)
+__version__ = version = '1.2.0'
+__version_tuple__ = version_tuple = (1, 2, 0)
 
 __commit_id__ = commit_id = None

spaceforge/cls.py

@@ -1,5 +1,5 @@
 import uuid
-from typing import Dict, List, Literal, Optional
+from typing import Dict, List, Literal, Optional, Union
 
 from pydantic import Field
 from pydantic.dataclasses import dataclass as pydantic_dataclass
@@ -12,6 +12,12 @@ BinaryType = Literal[
     "arm64",
 ]
 
+ParameterType = Literal[
+    "string",
+    "number",
+    "boolean",
+]
+
 
 @pydantic_dataclass
 class Binary:
@@ -35,17 +41,19 @@ class Parameter:
     Attributes:
         name (str): The name of the parameter.
         description (str): A description of the parameter.
+        type (ParameterType): The type of the parameter.
         sensitive (bool): Whether the parameter contains sensitive information.
         required (bool): Whether the parameter is required.
-        default (Optional[str]): The default value of the parameter, if any. (required if sensitive is False)
+        default (Optional[Union[str, int, float, bool]]): The default value of the parameter, if any. (required if sensitive is False)
         id (str): Unique identifier for the parameter.
     """
 
     name: str
     description: str
+    type: ParameterType
     sensitive: bool = False
     required: bool = False
-    default: Optional[str] = None
+    default: Optional[Union[str, int, float, bool]] = None
     id: str = Field(default_factory=lambda: str(uuid.uuid4()))
 
     def __post_init__(self) -> None:
@@ -54,6 +62,26 @@ class Parameter:
                 f"Default value for parameter {self.name} should be set if parameter is optional."
             )
 
+        # Validate that default value Python type matches the declared type
+        if self.default is not None:
+            if self.type == "string":
+                if not isinstance(self.default, str):
+                    raise ValueError(
+                        f"Parameter {self.name} has type 'string' but default value has Python type {type(self.default).__name__}. Expected str."
+                    )
+            elif self.type == "number":
+                if not isinstance(self.default, (int, float)) or isinstance(
+                    self.default, bool
+                ):
+                    raise ValueError(
+                        f"Parameter {self.name} has type 'number' but default value has Python type {type(self.default).__name__}. Expected int or float."
+                    )
+            elif self.type == "boolean":
+                if not isinstance(self.default, bool):
+                    raise ValueError(
+                        f"Parameter {self.name} has type 'boolean' but default value has Python type {type(self.default).__name__}. Expected bool."
+                    )
+
 
 @pydantic_dataclass
 class Variable:

spaceforge/conftest.py

@@ -35,6 +35,7 @@ class TestPlugin(SpaceforgePlugin):
         Parameter(
             name="test_param",
             description="Test parameter",
+            type="string",
             required=False,
             default="default_value"
         )

spaceforge/schema.json

@@ -123,7 +123,7 @@
       "type": "object"
     },
     "Parameter": {
-      "description": "A class to represent a parameter with a name and value.\n\nAttributes:\n    name (str): The name of the parameter.\n    description (str): A description of the parameter.\n    sensitive (bool): Whether the parameter contains sensitive information.\n    required (bool): Whether the parameter is required.\n    default (Optional[str]): The default value of the parameter, if any. (required if sensitive is False)\n    id (str): Unique identifier for the parameter.",
+      "description": "A class to represent a parameter with a name and value.\n\nAttributes:\n    name (str): The name of the parameter.\n    description (str): A description of the parameter.\n    type (ParameterType): The type of the parameter.\n    sensitive (bool): Whether the parameter contains sensitive information.\n    required (bool): Whether the parameter is required.\n    default (Optional[Union[str, int, float, bool]]): The default value of the parameter, if any. (required if sensitive is False)\n    id (str): Unique identifier for the parameter.",
       "properties": {
         "name": {
           "title": "Name",
@@ -133,6 +133,15 @@
           "title": "Description",
           "type": "string"
         },
+        "type": {
+          "enum": [
+            "string",
+            "number",
+            "boolean"
+          ],
+          "title": "Type",
+          "type": "string"
+        },
         "sensitive": {
           "default": false,
           "title": "Sensitive",
@@ -148,6 +157,15 @@
             {
               "type": "string"
             },
+            {
+              "type": "integer"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
             {
               "type": "null"
             }
@@ -162,7 +180,8 @@
       },
       "required": [
         "name",
-        "description"
+        "description",
+        "type"
       ],
       "title": "Parameter",
       "type": "object"

spaceforge/test_cls.py

@@ -8,6 +8,7 @@ def test_ensure_optional_parameters_require_default_values() -> None:
         Parameter(
             name="optional_default",
             description="default value",
+            type="string",
             required=False,
         )
 
@@ -15,3 +16,87 @@ def test_ensure_optional_parameters_require_default_values() -> None:
 def test_ensure_variables_have_either_value_or_value_from_parameter() -> None:
     with pytest.raises(ValueError):
         Variable(key="test_var", sensitive=False)
+
+
+def test_parameter_type_validation_string() -> None:
+    """Test that string type accepts any default value."""
+    # Should not raise
+    Parameter(
+        name="string_param",
+        description="A string parameter",
+        type="string",
+        required=False,
+        default="any value works",
+    )
+
+
+def test_parameter_type_validation_number_valid() -> None:
+    """Test that number type accepts valid numeric strings."""
+    # Integer
+    Parameter(
+        name="int_param",
+        description="An integer parameter",
+        type="number",
+        required=False,
+        default=42,
+    )
+
+    # Float
+    Parameter(
+        name="float_param",
+        description="A float parameter",
+        type="number",
+        required=False,
+        default=3.14,
+    )
+
+    # Negative number
+    Parameter(
+        name="negative_param",
+        description="A negative parameter",
+        type="number",
+        required=False,
+        default=-100,
+    )
+
+
+def test_parameter_type_validation_number_invalid() -> None:
+    """Test that number type rejects non-numeric strings."""
+    with pytest.raises(
+        ValueError,
+        match="Parameter invalid_number has type 'number' but default value has Python type str.",
+    ):
+        Parameter(
+            name="invalid_number",
+            description="Invalid number parameter",
+            type="number",
+            required=False,
+            default="not a number",
+        )
+
+
+def test_parameter_type_validation_boolean_invalid() -> None:
+    """Test that boolean type rejects values other than 'true'/'false'."""
+    with pytest.raises(
+        ValueError,
+        match="Parameter invalid_bool has type 'boolean' but default value has Python type str.",
+    ):
+        Parameter(
+            name="invalid_bool",
+            description="Invalid boolean parameter",
+            type="boolean",
+            required=False,
+            default="1",
+        )
+
+    with pytest.raises(
+        ValueError,
+        match="Parameter invalid_bool2 has type 'boolean' but default value has Python type str.",
+    ):
+        Parameter(
+            name="invalid_bool2",
+            description="Invalid boolean parameter",
+            type="boolean",
+            required=False,
+            default="yes",
+        )

spaceforge/test_generator.py

@@ -30,12 +30,14 @@ class PluginExample(SpaceforgePlugin):
         Parameter(
             name="api_key",
             description="API key for authentication",
+            type="string",
             required=True,
             sensitive=True,
         ),
         Parameter(
             name="endpoint",
             description="API endpoint URL",
+            type="string",
             required=False,
             default="https://api.example.com",
         ),
@@ -106,7 +108,7 @@ class TestPlugin(SpaceforgePlugin):
     __author__ = "Test"
     
     __parameters__ = [
-        Parameter(name="test_param", description="Test parameter", required=False, default="default_value")
+        Parameter(name="test_param", description="Test parameter", type="string", required=False, default="default_value")
     ]
     
     def after_plan(self) -> None:
@@ -619,6 +621,7 @@ class FullTestPlugin(SpaceforgePlugin):
         Parameter(
             name="test_param",
             description="Test parameter",
+            type="string",
             required=False,
             default="test_value"
         )
@@ -811,12 +814,14 @@ class TestPluginGeneratorEdgeCases:
                 Parameter(
                     name="api key",
                     description="API key for authentication",
+                    type="string",
                     required=True,
                     sensitive=True,
                 ),
                 Parameter(
                     name="endpoint",
                     description="API endpoint URL",
+                    type="string",
                     required=False,
                     default="https://api.example.com",
                 ),

spaceforge/test_generator_parameters.py

@@ -17,12 +17,14 @@ class TestPluginGeneratorParameters:
                 Parameter(
                     name="api_key",
                     description="API key for authentication",
+                    type="string",
                     required=True,
                     sensitive=True,
                 ),
                 Parameter(
                     name="endpoint",
                     description="API endpoint URL",
+                    type="string",
                     required=False,
                     default="https://api.example.com",
                 ),

{spaceforge-1.1.7.dist-info → spaceforge-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 1.1.7
+Version: 1.2.0
 Summary: A Python framework for building Spacelift plugins
 Author-email: Spacelift <support@spacelift.io>
 Maintainer-email: Spacelift <support@spacelift.io>
@@ -34,6 +34,7 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
 Requires-Dist: setuptools-scm[toml]>=6.2; extra == "dev"
 Requires-Dist: autoflake; extra == "dev"

{spaceforge-1.1.7.dist-info → spaceforge-1.2.0.dist-info}/RECORD

@@ -2,19 +2,19 @@ spaceforge/README.md,sha256=gDyCQN0EW4xp8Skvs6J0qHpO9CjVTnRfSnhduAIFQs4,7717
 spaceforge/__init__.py,sha256=TU-vvm15dK1ucixNW0V42eTT72x3_hmKSyxP4MC1Occ,589
 spaceforge/__main__.py,sha256=UKbeCuEFgoNlEOX44-kYUAQuUdySdkAKsvbjXEyLeWI,965
 spaceforge/_version.py,sha256=70eCBV_uVCm0U7qrtYRUZM3GJnJRtvZQ_aPFLd8H7CI,1009
-spaceforge/_version_scm.py,sha256=XScxAJn_hLwoilMyvvJG_0tPX3X-Jhde5mefhI8pVSM,704
-spaceforge/cls.py,sha256=oYW5t5_xs9ZM6Ne_b4trxCPxLHQrqbqgUeibeM8O4PU,6329
-spaceforge/conftest.py,sha256=U-xCavCsgRAQXqflIIOMeq9pcGbeqRviUNkEXgZol8g,2141
+spaceforge/_version_scm.py,sha256=-uLONazCO1SzFfcY-K6A1keL--LIVfTYccGX6ciADac,704
+spaceforge/cls.py,sha256=qe_-pQ9G7p6Hxv8FxNw9OwhPeMQk3vIS_SezxSoca2M,7644
+spaceforge/conftest.py,sha256=J2BIqOu0VYpUlxnJf07cW6l2NHSzVvkXw18jKTTR3hE,2168
 spaceforge/generator.py,sha256=qOC9YeP9QmwFZQoe0BbvJb8RHtv3BVupYxvu2ceQMkE,18768
 spaceforge/plugin.py,sha256=Ytm2B7nnJNH231V4gUFY1pBmwVNTpIg3YviUL_Bnf24,14963
 spaceforge/runner.py,sha256=NNddgK_OsnQWx2YFcyTpAOWfFLBDUphufBVfXYEzfzM,3166
-spaceforge/schema.json,sha256=89IROLVlCj8txGMiLt4Bbuo_2muSxKoZCyaXQ2vuA9c,10869
-spaceforge/test_cls.py,sha256=nXAgbnFnGdFxrtA7vNXiePjNUASuoYW-lEuQGx9WMGs,468
-spaceforge/test_generator.py,sha256=sEDV7ShT2BpLoW4zC8ZT-P-V4_dP8kOI0WuiZ6uVIgc,32625
+spaceforge/schema.json,sha256=nZf438rSKThw64Au7-tmoVw8EYsb7OGhzLfInO31ddA,11328
+spaceforge/test_cls.py,sha256=uDnEmgF7bHzu3FjMk4-boEuJqk_B5AWKMPiKgl83Onc,2777
+spaceforge/test_generator.py,sha256=Gm3IA-8ykwCbj1JMKe03mj5DMZSNFEtCz8ue0xKjUUs,32791
 spaceforge/test_generator_binaries.py,sha256=X_7pPLGE45eQt-Kv9_ku__LsyLgOvViHc_BvVpSCMp0,7263
 spaceforge/test_generator_core.py,sha256=gOqRx0rnME-srGMHun4KidXMN-iaqfKKTyoQ0Tw6b9Q,6253
 spaceforge/test_generator_hooks.py,sha256=2lJs8dYlFb7QehWcYF0O4qg38s5UudEpzJyBi1XiS3k,2542
-spaceforge/test_generator_parameters.py,sha256=77az9rcocFny2AC4O2eTzjCW712fR1DBHzGrgBKeR4w,1878
+spaceforge/test_generator_parameters.py,sha256=aZRNwYcogJqp2NiYrqEkuxDi2Z6Z2S1SVoejUvsHHCE,1948
 spaceforge/test_plugin.py,sha256=rZ4Uv_0lIR0qb1GFHkiosGO3WHTWhO7epz8INDxV8Q0,13018
 spaceforge/test_plugin_file_operations.py,sha256=B0qvIo5EcfKMiHLhBv-hAnpSonn83ojcmJHXasydojA,3782
 spaceforge/test_plugin_hooks.py,sha256=ugaVdzH1-heRJSJN0lu8zoqLcLPC3tg_PzUX98qu9Sw,1038
@@ -25,9 +25,9 @@ spaceforge/test_runner_core.py,sha256=eNR9YOwJwv7LsMtNQ4WXXMPIW6RE_A7hUp4bCpzz1R
 spaceforge/test_runner_execution.py,sha256=GJhoECdhIY2M3MWcmTrIYfkJd2P5n86zixO3FY38_CQ,5344
 spaceforge/templates/binary_install.sh.j2,sha256=xyq-ol6z8M4RJ107GAs5cdvudVV45JmhwExHovfCHMI,1544
 spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=OKrpZI-M1VU5rCdu7XMbBto7R-HV9lAImc3x3112vhY,580
-spaceforge-1.1.7.dist-info/licenses/LICENSE,sha256=qtl16T_VToz1-IpjGKSLCHsy_zmCFg2H5SkvJi85C4c,1065
-spaceforge-1.1.7.dist-info/METADATA,sha256=sNVO6Alkg9uDBZXmd0rpr8kZy6P6bnAK81gJ0GzvP-o,2307
-spaceforge-1.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-spaceforge-1.1.7.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
-spaceforge-1.1.7.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
-spaceforge-1.1.7.dist-info/RECORD,,
+spaceforge-1.2.0.dist-info/licenses/LICENSE,sha256=qtl16T_VToz1-IpjGKSLCHsy_zmCFg2H5SkvJi85C4c,1065
+spaceforge-1.2.0.dist-info/METADATA,sha256=xVeIjTzuT5KXGjN2wajp8_er_4B8BTIhWYe_lw9FWQs,2345
+spaceforge-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spaceforge-1.2.0.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
+spaceforge-1.2.0.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
+spaceforge-1.2.0.dist-info/RECORD,,