spaceforge 1.1.7__tar.gz → 1.2.0__tar.gz

{spaceforge-1.1.7/spaceforge.egg-info → spaceforge-1.2.0}/PKG-INFO

@@ -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.2.0/linting/__init__.py

@@ -0,0 +1 @@
+"""Custom linting tools for Spaceforge plugins."""

spaceforge-1.2.0/linting/spaceforge_checker.py

@@ -0,0 +1,75 @@
+"""Custom pylint checker for Spaceforge plugin conventions."""
+
+import os
+from typing import TYPE_CHECKING
+
+from pylint.checkers import BaseChecker
+
+if TYPE_CHECKING:
+    from pylint.lint import PyLinter
+
+
+class SpaceforgePluginChecker(BaseChecker):
+    """Checker for Spaceforge plugin naming conventions."""
+
+    name = "spaceforge-plugin"
+    msgs = {
+        "E9001": (
+            "Plugin name '%s' should start with a capital letter",
+            "plugin-name-not-capitalized",
+            "The __plugin_name__ attribute must start with a capital letter for consistency.",
+        ),
+        "E9002": (
+            "Plugin class '%s' must have a docstring",
+            "plugin-missing-docstring",
+            "All plugin classes extending SpaceforgePlugin must have a docstring explaining what the plugin does.",
+        ),
+    }
+
+    def visit_classdef(self, node):
+        """Check class definitions that extend SpaceforgePlugin."""
+        # Skip test files
+        filename = os.path.basename(node.root().file)
+        if filename.startswith("test_") or filename == "conftest.py":
+            return
+
+        # Check if this class extends SpaceforgePlugin
+        if not any(
+            base.name == "SpaceforgePlugin"
+            for base in node.bases
+            if hasattr(base, "name")
+        ):
+            return
+
+        # Check if the plugin class has a docstring
+        # In astroid, docstrings are stored in the doc_node attribute
+        if not node.doc_node:
+            self.add_message(
+                "plugin-missing-docstring",
+                node=node,
+                args=(node.name,),
+            )
+
+        # Look for __plugin_name__ attribute in the class body
+        for item in node.body:
+            if (
+                hasattr(item, "targets")
+                and len(item.targets) == 1
+                and hasattr(item.targets[0], "name")
+                and item.targets[0].name == "__plugin_name__"
+            ):
+                # Get the value of __plugin_name__
+                if hasattr(item.value, "value") and isinstance(item.value.value, str):
+                    plugin_name = item.value.value
+                    if plugin_name and not plugin_name[0].isupper():
+                        self.add_message(
+                            "plugin-name-not-capitalized",
+                            node=item,
+                            args=(plugin_name,),
+                        )
+                break
+
+
+def register(linter: "PyLinter") -> None:
+    """Register the checker with pylint."""
+    linter.register_checker(SpaceforgePluginChecker(linter))

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/checkov/plugin.py

@@ -6,8 +6,6 @@ from spaceforge import Context, Parameter, Policy, SpaceforgePlugin, Variable
 
 class CheckovPlugin(SpaceforgePlugin):
     """
-    Checkov Security Scanner Plugin
-
     This plugin runs Checkov security scanning on Terraform/OpenTofu configurations
     during the after_plan hook and reports findings with detailed resource-level
     information.
@@ -77,9 +75,9 @@ class CheckovPlugin(SpaceforgePlugin):
     ```
     """
 
-    __plugin_name__ = "checkov"
+    __plugin_name__ = "Checkov"
     __author__ = "Spacelift"
-    __version__ = "1.0.2"
+    __version__ = "1.0.3"
     __labels__ = ["security", "terraform"]
 
     __parameters__ = [
@@ -88,6 +86,7 @@ class CheckovPlugin(SpaceforgePlugin):
             id="checkov_additional_args",
             description="Additional command-line arguments to pass to Checkov (e.g., --check HIGH,CRITICAL or --skip-check CKV_AWS_123)",
             default="",
+            type="string",
             required=False,
         )
     ]

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/checkov/plugin.yaml

@@ -1,8 +1,6 @@
-name: checkov
-version: 1.0.2
+name: Checkov
+version: 1.0.3
 description: |-
-  Checkov Security Scanner Plugin
-
   This plugin runs Checkov security scanning on Terraform/OpenTofu configurations
   during the after_plan hook and reports findings with detailed resource-level
   information.
@@ -77,6 +75,7 @@ labels:
 parameters:
 - name: Additional Arguments
   description: Additional command-line arguments to pass to Checkov (e.g., --check HIGH,CRITICAL or --skip-check CKV_AWS_123)
+  type: string
   sensitive: false
   required: false
   default: ''
@@ -103,8 +102,6 @@ contexts:
 
       class CheckovPlugin(SpaceforgePlugin):
           """
-          Checkov Security Scanner Plugin
-
           This plugin runs Checkov security scanning on Terraform/OpenTofu configurations
           during the after_plan hook and reports findings with detailed resource-level
           information.
@@ -174,9 +171,9 @@ contexts:
           ```
           """
 
-          __plugin_name__ = "checkov"
+          __plugin_name__ = "Checkov"
           __author__ = "Spacelift"
-          __version__ = "1.0.2"
+          __version__ = "1.0.3"
           __labels__ = ["security", "terraform"]
 
           __parameters__ = [
@@ -185,6 +182,7 @@ contexts:
                   id="checkov_additional_args",
                   description="Additional command-line arguments to pass to Checkov (e.g., --check HIGH,CRITICAL or --skip-check CKV_AWS_123)",
                   default="",
+                  type="string",
                   required=False,
               )
           ]

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/enviroment_manager/plugin.py

@@ -7,7 +7,6 @@ from spaceforge import Context, MountedFile, Parameter, SpaceforgePlugin, Variab
 
 class EnvironmentManagerPlugin(SpaceforgePlugin):
     """
-    # Spacelift Environment Variable Manager
     This plugin allows you to manage Spacelift environment variables using a centralized YAML configuration file for multiple stacks.
 
     ## Features
@@ -106,7 +105,7 @@ class EnvironmentManagerPlugin(SpaceforgePlugin):
     # Plugin metadata
     __plugin_name__ = "Environment Manager"
     __labels__ = ["management", "infrastructure"]
-    __version__ = "1.0.2"
+    __version__ = "1.0.3"
     __author__ = "Spacelift Team"
 
     __parameters__ = [
@@ -114,12 +113,14 @@ class EnvironmentManagerPlugin(SpaceforgePlugin):
             name="Spacelift API key ID",
             id="spacelift_api_key_id",
             description="The API key that will trigger the stack previews",
+            type="string",
             required=True,
         ),
         Parameter(
             name="Spacelift API key secret",
             id="spacelift_api_key_secret",
             description="The API key secret that will trigger the stack previews",
+            type="string",
             required=True,
             sensitive=True,
         ),

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/enviroment_manager/plugin.yaml

@@ -1,7 +1,6 @@
 name: Environment Manager
-version: 1.0.2
+version: 1.0.3
 description: |-
-  # Spacelift Environment Variable Manager
   This plugin allows you to manage Spacelift environment variables using a centralized YAML configuration file for multiple stacks.
 
   ## Features
@@ -102,11 +101,13 @@ labels:
 parameters:
 - name: Spacelift API key ID
   description: The API key that will trigger the stack previews
+  type: string
   sensitive: false
   required: true
   id: spacelift_api_key_id
 - name: Spacelift API key secret
   description: The API key secret that will trigger the stack previews
+  type: string
   sensitive: true
   required: true
   id: spacelift_api_key_secret
@@ -161,7 +162,6 @@ contexts:
 
       class EnvironmentManagerPlugin(SpaceforgePlugin):
           """
-          # Spacelift Environment Variable Manager
           This plugin allows you to manage Spacelift environment variables using a centralized YAML configuration file for multiple stacks.
 
           ## Features
@@ -260,7 +260,7 @@ contexts:
           # Plugin metadata
           __plugin_name__ = "Environment Manager"
           __labels__ = ["management", "infrastructure"]
-          __version__ = "1.0.2"
+          __version__ = "1.0.3"
           __author__ = "Spacelift Team"
 
           __parameters__ = [
@@ -268,12 +268,14 @@ contexts:
                   name="Spacelift API key ID",
                   id="spacelift_api_key_id",
                   description="The API key that will trigger the stack previews",
+                  type="string",
                   required=True,
               ),
               Parameter(
                   name="Spacelift API key secret",
                   id="spacelift_api_key_secret",
                   description="The API key secret that will trigger the stack previews",
+                  type="string",
                   required=True,
                   sensitive=True,
               ),

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/envsubst/plugin.py

@@ -3,7 +3,6 @@ from spaceforge import Binary, Context, SpaceforgePlugin
 
 class EnvsubstPlugin(SpaceforgePlugin):
     """
-    # Plugin Envsubst
     This plugin allows the use of environment variables in Kubernetes manifests.
 
     ## Usage
@@ -28,7 +27,7 @@ class EnvsubstPlugin(SpaceforgePlugin):
     # Plugin metadata
     __plugin_name__ = "Envsubst"
     __labels__ = ["kubernetes", "environment"]
-    __version__ = "1.0.2"
+    __version__ = "1.0.3"
     __author__ = "Spacelift Team"
 
     __binaries__ = [

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/envsubst/plugin.yaml

@@ -1,7 +1,6 @@
 name: Envsubst
-version: 1.0.2
+version: 1.0.3
 description: |-
-  # Plugin Envsubst
   This plugin allows the use of environment variables in Kubernetes manifests.
 
   ## Usage
@@ -37,7 +36,6 @@ contexts:
 
       class EnvsubstPlugin(SpaceforgePlugin):
           """
-          # Plugin Envsubst
           This plugin allows the use of environment variables in Kubernetes manifests.
 
           ## Usage
@@ -62,7 +60,7 @@ contexts:
           # Plugin metadata
           __plugin_name__ = "Envsubst"
           __labels__ = ["kubernetes", "environment"]
-          __version__ = "1.0.2"
+          __version__ = "1.0.3"
           __author__ = "Spacelift Team"
 
           __binaries__ = [

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/infracost/plugin.py

@@ -9,7 +9,7 @@ class InfracostPlugin(SpaceforgePlugin):
     # Plugin metadata
     __plugin_name__ = "Infracost"
     __labels__ = ["cost estimation", "infrastructure"]
-    __version__ = "1.0.1"
+    __version__ = "1.0.2"
     __author__ = "Spacelift Team"
 
     __parameters__ = [
@@ -17,6 +17,7 @@ class InfracostPlugin(SpaceforgePlugin):
             name="Infracost API Key",
             id="infracost_api_key",
             description="The API key for Infracost authentication",
+            type="string",
             required=True,
             sensitive=True,
         )

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/infracost/plugin.yaml

@@ -1,5 +1,5 @@
 name: Infracost
-version: 1.0.1
+version: 1.0.2
 description: A plugin for integrating with Infracost to estimate costs of infrastructure changes.
 author: Spacelift Team
 labels:
@@ -8,6 +8,7 @@ labels:
 parameters:
 - name: Infracost API Key
   description: The API key for Infracost authentication
+  type: string
   sensitive: true
   required: true
   id: infracost_api_key
@@ -32,7 +33,7 @@ contexts:
           # Plugin metadata
           __plugin_name__ = "Infracost"
           __labels__ = ["cost estimation", "infrastructure"]
-          __version__ = "1.0.1"
+          __version__ = "1.0.2"
           __author__ = "Spacelift Team"
 
           __parameters__ = [
@@ -40,6 +41,7 @@ contexts:
                   name="Infracost API Key",
                   id="infracost_api_key",
                   description="The API key for Infracost authentication",
+                  type="string",
                   required=True,
                   sensitive=True,
               )

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/opentofu-tracing/plugin.py

@@ -9,8 +9,6 @@ from spaceforge import Binary, Context, Parameter, SpaceforgePlugin, Variable
 
 class OpenTofuTracingPlugin(SpaceforgePlugin):
     """
-    # OpenTofu Tracing Plugin
-
     This plugin enables OpenTelemetry tracing for OpenTofu operations in Spacelift using Tracedown.
 
     ## Overview
@@ -49,7 +47,7 @@ class OpenTofuTracingPlugin(SpaceforgePlugin):
     # Plugin metadata
     __plugin_name__ = "OpenTofu Tracing"
     __labels__ = ["opentofu", "observability", "tracing"]
-    __version__ = "2.0.1"
+    __version__ = "2.0.2"
     __author__ = "Spacelift Team"
 
     __binaries__ = [
@@ -64,30 +62,38 @@ class OpenTofuTracingPlugin(SpaceforgePlugin):
 
     __parameters__ = [
         Parameter(
-            name="Output File (str: traces.md)",
+            name="Output File",
             id="output_file",
             description="Path where the markdown report will be generated",
+            default="traces.md",
+            type="string",
             required=True,
             sensitive=False,
         ),
         Parameter(
-            name="Max Traces (int: 10000)",
+            name="Max Traces",
             id="max_traces",
             description="Maximum number of trace batches to store",
+            default=10000,
+            type="number",
             required=True,
             sensitive=False,
         ),
         Parameter(
-            name="Max Memory MB (int: 500)",
+            name="Max Memory MB",
             id="max_memory_mb",
             description="Memory limit in MB",
+            default=500,
+            type="number",
             required=True,
             sensitive=False,
         ),
         Parameter(
-            name="Summary Mode (bool: false)",
+            name="Summary Mode",
             id="summary_mode",
             description="Enable summary mode for large traces (set to 'true' to enable)",
+            default=False,
+            type="boolean",
             required=True,
             sensitive=False,
         ),

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/opentofu-tracing/plugin.yaml

@@ -1,8 +1,6 @@
 name: OpenTofu Tracing
-version: 2.0.1
+version: 2.0.2
 description: |-
-  # OpenTofu Tracing Plugin
-
   This plugin enables OpenTelemetry tracing for OpenTofu operations in Spacelift using Tracedown.
 
   ## Overview
@@ -42,25 +40,33 @@ labels:
 - observability
 - tracing
 parameters:
-- name: 'Output File (str: traces.md)'
+- name: Output File
   description: Path where the markdown report will be generated
+  type: string
   sensitive: false
   required: true
+  default: traces.md
   id: output_file
-- name: 'Max Traces (int: 10000)'
+- name: Max Traces
   description: Maximum number of trace batches to store
+  type: number
   sensitive: false
   required: true
+  default: 10000
   id: max_traces
-- name: 'Max Memory MB (int: 500)'
+- name: Max Memory MB
   description: Memory limit in MB
+  type: number
   sensitive: false
   required: true
+  default: 500
   id: max_memory_mb
-- name: 'Summary Mode (bool: false)'
+- name: Summary Mode
   description: Enable summary mode for large traces (set to 'true' to enable)
+  type: boolean
   sensitive: false
   required: true
+  default: false
   id: summary_mode
 contexts:
 - name_prefix: opentofu-tracing
@@ -101,8 +107,6 @@ contexts:
 
       class OpenTofuTracingPlugin(SpaceforgePlugin):
           """
-          # OpenTofu Tracing Plugin
-
           This plugin enables OpenTelemetry tracing for OpenTofu operations in Spacelift using Tracedown.
 
           ## Overview
@@ -141,7 +145,7 @@ contexts:
           # Plugin metadata
           __plugin_name__ = "OpenTofu Tracing"
           __labels__ = ["opentofu", "observability", "tracing"]
-          __version__ = "2.0.1"
+          __version__ = "2.0.2"
           __author__ = "Spacelift Team"
 
           __binaries__ = [
@@ -156,30 +160,38 @@ contexts:
 
           __parameters__ = [
               Parameter(
-                  name="Output File (str: traces.md)",
+                  name="Output File",
                   id="output_file",
                   description="Path where the markdown report will be generated",
+                  default="traces.md",
+                  type="string",
                   required=True,
                   sensitive=False,
               ),
               Parameter(
-                  name="Max Traces (int: 10000)",
+                  name="Max Traces",
                   id="max_traces",
                   description="Maximum number of trace batches to store",
+                  default=10000,
+                  type="number",
                   required=True,
                   sensitive=False,
               ),
               Parameter(
-                  name="Max Memory MB (int: 500)",
+                  name="Max Memory MB",
                   id="max_memory_mb",
                   description="Memory limit in MB",
+                  default=500,
+                  type="number",
                   required=True,
                   sensitive=False,
               ),
               Parameter(
-                  name="Summary Mode (bool: false)",
+                  name="Summary Mode",
                   id="summary_mode",
                   description="Enable summary mode for large traces (set to 'true' to enable)",
+                  default=False,
+                  type="boolean",
                   required=True,
                   sensitive=False,
               ),

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/sops/plugin.py

@@ -8,8 +8,6 @@ from spaceforge import Binary, SpaceforgePlugin
 
 class SopsPlugin(SpaceforgePlugin):
     """
-    # Plugin Sops
-
     This adds the `SOPS` plugin to your Spacelift account.
     It will decrypt an arbitrary number of files based on config you set.
 
@@ -41,7 +39,7 @@ class SopsPlugin(SpaceforgePlugin):
     # Plugin metadata
     __plugin_name__ = "Sops"
     __labels__ = ["secrets management", "encryption"]
-    __version__ = "1.0.2"
+    __version__ = "1.0.3"
     __author__ = "Spacelift Team"
 
     __binaries__ = [

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/sops/plugin.yaml

@@ -1,8 +1,6 @@
 name: Sops
-version: 1.0.2
+version: 1.0.3
 description: |-
-  # Plugin Sops
-
   This adds the `SOPS` plugin to your Spacelift account.
   It will decrypt an arbitrary number of files based on config you set.
 
@@ -55,8 +53,6 @@ contexts:
 
       class SopsPlugin(SpaceforgePlugin):
           """
-          # Plugin Sops
-
           This adds the `SOPS` plugin to your Spacelift account.
           It will decrypt an arbitrary number of files based on config you set.
 
@@ -88,7 +84,7 @@ contexts:
           # Plugin metadata
           __plugin_name__ = "Sops"
           __labels__ = ["secrets management", "encryption"]
-          __version__ = "1.0.2"
+          __version__ = "1.0.3"
           __author__ = "Spacelift Team"
 
           __binaries__ = [

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/terrascan/plugin.py

@@ -6,8 +6,6 @@ from spaceforge import Binary, Context, Parameter, Policy, SpaceforgePlugin, Var
 
 class TerrascanPlugin(SpaceforgePlugin):
     """
-    Terrascan security scanner plugin for Spacelift.
-
     The Terrascan plugin scans your Infrastructure as Code for security and compliance
     violations and generates a detailed report with findings categorized by severity.
 
@@ -58,8 +56,8 @@ class TerrascanPlugin(SpaceforgePlugin):
     - [Terrascan GitHub Repository](https://github.com/tenable/terrascan)
     """
 
-    __plugin_name__ = "terrascan"
-    __version__ = "1.0.2"
+    __plugin_name__ = "Terrascan"
+    __version__ = "1.0.3"
     __author__ = "Spacelift"
     __labels__ = ["security", "terraform", "cloudformation", "kubernetes"]
 
@@ -78,7 +76,9 @@ class TerrascanPlugin(SpaceforgePlugin):
             name="Additional Arguments",
             id="terrascan_additional_args",
             description="Additional command-line arguments to pass to Terrascan",
+            type="string",
             default="",
+            required=False,
         ),
     ]
 

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/terrascan/plugin.yaml

@@ -1,8 +1,6 @@
-name: terrascan
-version: 1.0.2
+name: Terrascan
+version: 1.0.3
 description: |-
-  Terrascan security scanner plugin for Spacelift.
-
   The Terrascan plugin scans your Infrastructure as Code for security and compliance
   violations and generates a detailed report with findings categorized by severity.
 
@@ -60,6 +58,7 @@ labels:
 parameters:
 - name: Additional Arguments
   description: Additional command-line arguments to pass to Terrascan
+  type: string
   sensitive: false
   required: false
   default: ''
@@ -82,8 +81,6 @@ contexts:
 
       class TerrascanPlugin(SpaceforgePlugin):
           """
-          Terrascan security scanner plugin for Spacelift.
-
           The Terrascan plugin scans your Infrastructure as Code for security and compliance
           violations and generates a detailed report with findings categorized by severity.
 
@@ -134,8 +131,8 @@ contexts:
           - [Terrascan GitHub Repository](https://github.com/tenable/terrascan)
           """
 
-          __plugin_name__ = "terrascan"
-          __version__ = "1.0.2"
+          __plugin_name__ = "Terrascan"
+          __version__ = "1.0.3"
           __author__ = "Spacelift"
           __labels__ = ["security", "terraform", "cloudformation", "kubernetes"]
 
@@ -154,7 +151,9 @@ contexts:
                   name="Additional Arguments",
                   id="terrascan_additional_args",
                   description="Additional command-line arguments to pass to Terrascan",
+                  type="string",
                   default="",
+                  required=False,
               ),
           ]
 

{spaceforge-1.1.7 → spaceforge-1.2.0}/plugins/trivy/plugin.py

@@ -6,8 +6,6 @@ from spaceforge import Binary, Context, Parameter, Policy, SpaceforgePlugin, Var
 
 class TrivyPlugin(SpaceforgePlugin):
     """
-    # Plugin Trivy
-
     The Trivy plugin scans your Terraform/OpenTofu configurations for security misconfigurations
     and generates a detailed report with findings categorized by severity.
 
@@ -31,8 +29,8 @@ class TrivyPlugin(SpaceforgePlugin):
 
     __author__ = "Spacelift"
     __labels__ = ["security", "terraform"]
-    __plugin_name__ = "trivy"
-    __version__ = "1.0.2"
+    __plugin_name__ = "Trivy"
+    __version__ = "1.0.3"
 
     __binaries__ = [
         Binary(
@@ -50,6 +48,8 @@ class TrivyPlugin(SpaceforgePlugin):
             id="trivy_additional_args",
             description="Additional command-line arguments to pass to Trivy",
             default="",
+            type="string",
+            required=False,
         ),
     ]