spaceforge 1.1.3__tar.gz → 1.1.4__tar.gz

{spaceforge-1.1.3 → spaceforge-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 1.1.3
+Version: 1.1.4
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift
@@ -60,15 +60,15 @@ pip install spaceforge
 
 ### 1. Create Your Plugin
 
-Create a Python file (e.g., `my_plugin.py`) and inherit from `SpaceforgePlugin`:
+Create a Python file (e.g., `plugin.py`) and inherit from `SpaceforgePlugin`:
 
 ```python
-from spaceforge import SpaceforgePlugin, Parameter, Variable, Context, Binary, Policy, Webhook, MountedFile
+from spaceforge import SpaceforgePlugin, Parameter, Variable, Context
 import os
 
 class MyPlugin(SpaceforgePlugin):
     # Plugin metadata
-    __plugin_name__ = "my-awesome-plugin"
+    __plugin_name__ = "my-plugin"
     __version__ = "1.0.0"
     __author__ = "Your Name"
     __labels__ = ["security", "monitoring"]  # Optional labels for categorization
@@ -127,7 +127,7 @@ class MyPlugin(SpaceforgePlugin):
 Generate the Spacelift plugin YAML manifest:
 
 ```bash
-spaceforge generate my_plugin.py
+spaceforge generate plugin.py
 ```
 
 This creates `plugin.yaml` that you can upload to Spacelift.
@@ -142,7 +142,7 @@ export API_KEY="your-api-key"
 export ENVIRONMENT="staging"
 
 # Test the after_plan hook
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Available Hooks
@@ -527,13 +527,13 @@ export API_KEY="test-key"
 export TIMEOUT="60"
 
 # Test specific hook
-spaceforge runner after_plan
+spaceforge run after_plan
 
 # Test with specific plugin file
-spaceforge runner --plugin-file my_plugin.py before_apply
+spaceforge run --plugin-file my_plugin.py before_apply
 
 # Get help
-spaceforge runner --help
+spaceforge run --help
 ```
 
 ## Plugin Development Tips
@@ -577,7 +577,7 @@ def after_plan(self):
 ### 4. Testing and Debugging
 
 - Set `SPACELIFT_DEBUG=true` to enable debug logging
-- Use the runner command to test hooks during development
+- Use the `run` command to test hooks during development
 - Test with different parameter combinations
 - Validate your generated YAML before uploading to Spacelift
 
@@ -718,7 +718,7 @@ spaceforge generate security_scanner.py
 # Test locally
 export API_TOKEN="your-token"
 export SEVERITY_THRESHOLD="high"
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Speeding up plugin execution
@@ -734,8 +734,8 @@ There are a few things you can do to speed up plugin execution.
 
 1. **Install spaceforge:** `pip install spaceforge`
 2. **Create your plugin:** Start with the quick start example
-3. **Test locally:** Use the runner command to test your hooks
-4. **Generate manifest:** Use the generate command to create plugin.yaml
+3. **Test locally:** Use the `run` command to test your hooks
+4. **Generate manifest:** Use the `generate` command to create plugin.yaml
 5. **Upload to Spacelift:** Add your plugin manifest to your Spacelift account
 
 For more advanced examples, see the [plugins](plugins/) directory in this repository.

{spaceforge-1.1.3 → spaceforge-1.1.4}/README.md

@@ -14,15 +14,15 @@ pip install spaceforge
 
 ### 1. Create Your Plugin
 
-Create a Python file (e.g., `my_plugin.py`) and inherit from `SpaceforgePlugin`:
+Create a Python file (e.g., `plugin.py`) and inherit from `SpaceforgePlugin`:
 
 ```python
-from spaceforge import SpaceforgePlugin, Parameter, Variable, Context, Binary, Policy, Webhook, MountedFile
+from spaceforge import SpaceforgePlugin, Parameter, Variable, Context
 import os
 
 class MyPlugin(SpaceforgePlugin):
     # Plugin metadata
-    __plugin_name__ = "my-awesome-plugin"
+    __plugin_name__ = "my-plugin"
     __version__ = "1.0.0"
     __author__ = "Your Name"
     __labels__ = ["security", "monitoring"]  # Optional labels for categorization
@@ -81,7 +81,7 @@ class MyPlugin(SpaceforgePlugin):
 Generate the Spacelift plugin YAML manifest:
 
 ```bash
-spaceforge generate my_plugin.py
+spaceforge generate plugin.py
 ```
 
 This creates `plugin.yaml` that you can upload to Spacelift.
@@ -96,7 +96,7 @@ export API_KEY="your-api-key"
 export ENVIRONMENT="staging"
 
 # Test the after_plan hook
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Available Hooks
@@ -481,13 +481,13 @@ export API_KEY="test-key"
 export TIMEOUT="60"
 
 # Test specific hook
-spaceforge runner after_plan
+spaceforge run after_plan
 
 # Test with specific plugin file
-spaceforge runner --plugin-file my_plugin.py before_apply
+spaceforge run --plugin-file my_plugin.py before_apply
 
 # Get help
-spaceforge runner --help
+spaceforge run --help
 ```
 
 ## Plugin Development Tips
@@ -531,7 +531,7 @@ def after_plan(self):
 ### 4. Testing and Debugging
 
 - Set `SPACELIFT_DEBUG=true` to enable debug logging
-- Use the runner command to test hooks during development
+- Use the `run` command to test hooks during development
 - Test with different parameter combinations
 - Validate your generated YAML before uploading to Spacelift
 
@@ -672,7 +672,7 @@ spaceforge generate security_scanner.py
 # Test locally
 export API_TOKEN="your-token"
 export SEVERITY_THRESHOLD="high"
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Speeding up plugin execution
@@ -688,8 +688,8 @@ There are a few things you can do to speed up plugin execution.
 
 1. **Install spaceforge:** `pip install spaceforge`
 2. **Create your plugin:** Start with the quick start example
-3. **Test locally:** Use the runner command to test your hooks
-4. **Generate manifest:** Use the generate command to create plugin.yaml
+3. **Test locally:** Use the `run` command to test your hooks
+4. **Generate manifest:** Use the `generate` command to create plugin.yaml
 5. **Upload to Spacelift:** Add your plugin manifest to your Spacelift account
 
 For more advanced examples, see the [plugins](plugins/) directory in this repository.

{spaceforge-1.1.3 → spaceforge-1.1.4}/plugins/enviroment_manager/plugin.py

@@ -109,15 +109,15 @@ The above configuration will create the following in a plan:
 
     __parameters__ = [
         Parameter(
-            name="Spacelift API Key ID",
+            name="Spacelift API key ID",
             id="spacelift_api_key_id",
-            description="The API Key that will trigger the stack previews",
+            description="The API key that will trigger the stack previews",
             required=True,
         ),
         Parameter(
-            name="Spacelift API Key Secret",
+            name="Spacelift API key secret",
             id="spacelift_api_key_secret",
-            description="The API Key Secret that will trigger the stack previews",
+            description="The API key secret that will trigger the stack previews",
             required=True,
             sensitive=True
         ),
@@ -126,7 +126,7 @@ The above configuration will create the following in a plan:
     __contexts__ = [
         Context(
             name_prefix="Environment Manager",
-            description="Environment Manager Plugin",
+            description="Environment Manager plugin",
             hooks = {
                 "before_init": [
                     "mv /mnt/workspace/__environment_manager.tf /mnt/workspace/source/$TF_VAR_spacelift_project_root/__environment_manager.tf",

{spaceforge-1.1.3 → spaceforge-1.1.4}/plugins/enviroment_manager/plugin.yaml

@@ -100,19 +100,19 @@ labels:
 - management
 - infrastructure
 parameters:
-- name: Spacelift API Key ID
-  description: The API Key that will trigger the stack previews
+- name: Spacelift API key ID
+  description: The API key that will trigger the stack previews
   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
+- name: Spacelift API key secret
+  description: The API key secret that will trigger the stack previews
   sensitive: true
   required: true
   id: spacelift_api_key_secret
 contexts:
 - name_prefix: Environment Manager
-  description: Environment Manager Plugin
+  description: Environment Manager plugin
   env:
   - key: SPACELIFT_API_KEY_ID
     value_from_parameter: spacelift_api_key_id
@@ -263,15 +263,15 @@ contexts:
 
           __parameters__ = [
               Parameter(
-                  name="Spacelift API Key ID",
+                  name="Spacelift API key ID",
                   id="spacelift_api_key_id",
-                  description="The API Key that will trigger the stack previews",
+                  description="The API key that will trigger the stack previews",
                   required=True,
               ),
               Parameter(
-                  name="Spacelift API Key Secret",
+                  name="Spacelift API key secret",
                   id="spacelift_api_key_secret",
-                  description="The API Key Secret that will trigger the stack previews",
+                  description="The API key secret that will trigger the stack previews",
                   required=True,
                   sensitive=True
               ),
@@ -280,7 +280,7 @@ contexts:
           __contexts__ = [
               Context(
                   name_prefix="Environment Manager",
-                  description="Environment Manager Plugin",
+                  description="Environment Manager plugin",
                   hooks = {
                       "before_init": [
                           "mv /mnt/workspace/__environment_manager.tf /mnt/workspace/source/$TF_VAR_spacelift_project_root/__environment_manager.tf",
@@ -458,7 +458,7 @@ contexts:
       fi
 
       cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
-      spaceforge runner --plugin-file /mnt/workspace/plugins/environment_manager/plugin.py before_init
+      spaceforge run --plugin-file /mnt/workspace/plugins/environment_manager/plugin.py before_init
     sensitive: false
   hooks:
     before_init:

{spaceforge-1.1.3 → spaceforge-1.1.4}/plugins/sops/plugin.yaml

@@ -181,7 +181,7 @@ contexts:
       export PATH="/mnt/workspace/plugins/plugin_binaries:$PATH"
 
       cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
-      spaceforge runner --plugin-file /mnt/workspace/plugins/sops/plugin.py before_init
+      spaceforge run --plugin-file /mnt/workspace/plugins/sops/plugin.py before_init
     sensitive: false
   hooks:
     before_init:

spaceforge-1.1.4/plugins/tflint/plugin.py

@@ -0,0 +1,195 @@
+import json
+import os
+
+from spaceforge import Binary, Context, Parameter, Policy, SpaceforgePlugin, Variable
+
+DEFAULT_TFLINT_CONFIG_FILE = ""
+DEFAULT_TFLINT_RECURSIVE = "true"
+
+
+class TFLintPlugin(SpaceforgePlugin):
+    """
+    # Plugin TFLint
+
+    The TFLint plugin analyzes your Terraform/OpenTofu files and generates a report with findings categorized by severity.
+
+    You can also access the data from a plan policy via the `input.third_party_metadata.custom.tflint` object.
+    An example Plan policy is included with the plugin.
+
+    ## Usage
+
+    1. Install the plugin
+    2. Add the `autoattach` label to any stack that uses Terraform/OpenTofu.
+    """
+
+    __author__ = "Spacelift"
+    __labels__ = ["qa", "security"]
+    __plugin_name__ = "tflint"
+    __version__ = "0.1.0"
+
+    __binaries__ = [
+        Binary(
+            name="tflint",
+            download_urls={
+                "amd64": "https://github.com/terraform-linters/tflint/releases/download/v0.59.1/tflint_linux_amd64.zip",
+                "arm64": "https://github.com/terraform-linters/tflint/releases/download/v0.59.1/tflint_linux_arm64.zip",
+            },
+        ),
+    ]
+
+    __parameters__ = [
+        Parameter(
+            name="Configuration file",
+            id="tflint_config_file",
+            description="Configuration file name",
+            default=DEFAULT_TFLINT_CONFIG_FILE,
+        ),
+        Parameter(
+            name="Recursive",
+            id="tflint_recursive",
+            description="Run command in each directory recursively. Allowed values: true, false",
+            default=DEFAULT_TFLINT_RECURSIVE,
+        ),
+    ]
+
+    __contexts__ = [
+        Context(
+            name_prefix="tflint",
+            description="TFLint Plugin",
+            env=[
+                Variable(
+                    key="TFLINT_CONFIG_FILE",
+                    value_from_parameter="tflint_config_file",
+                ),
+                Variable(
+                    key="TFLINT_RECURSIVE",
+                    value_from_parameter="tflint_recursive",
+                ),
+            ],
+        )
+    ]
+
+    __policies__ = [
+        Policy(
+            name_prefix="tflint",
+            type="PLAN",
+            labels=["tflint"],
+            body="""
+package spacelift
+
+import rego.v1
+
+max_errors := 0
+max_warnings := 0
+max_notices := 3
+
+issues := input.third_party_metadata.custom.tflint.issues
+
+deny contains sprintf("Too many errors (%d)", [cnt]) if {
+    cnt := count([issue | issue := issues[_]; issue.rule.severity == "error"])
+    cnt > max_errors
+}
+
+deny contains sprintf("Too many warnings (%d)", [cnt]) if {
+    cnt := count([issue | issue := issues[_]; issue.rule.severity == "warning"])
+    cnt > max_warnings
+}
+
+deny contains sprintf("Too many notices (%d)", [cnt]) if {
+    cnt := count([issue | issue := issues[_]; issue.rule.severity == "notice"])
+    cnt > max_notices
+}
+            """,
+        )
+    ]
+
+    def before_plan(self):
+        try:
+            options = ["--format=json"]
+
+            # Configuration file
+            config_file = (
+                os.environ.get("TFLINT_CONFIG_FILE") or DEFAULT_TFLINT_CONFIG_FILE
+            )
+            if config_file:
+                options.append(f"--config={config_file}")
+
+            # Recursive
+            recursive = os.environ.get("TFLINT_RECURSIVE") or DEFAULT_TFLINT_RECURSIVE
+            if recursive == "true":
+                options.append("--recursive")
+
+            return_code, stdout, stderr = self.run_cli("tflint", "--init")
+            if return_code != 0:
+                self.logger.error(f"tflint --init failed with code {return_code}")
+                if stderr:
+                    # Display stderr manually because output display is disabled
+                    self.logger.error("\n".join(stderr))
+                exit(1)
+
+            return_code, stdout, stderr = self.run_cli(
+                "tflint", *options, print_output=False
+            )
+            stdout_json = json.loads("\n".join(stdout))
+
+            # KLUDGE: The `expect_code` argument does not support multiple values so we need to manually handle this.
+            # `0` means success and `2` means issues found which is informational, not a failure.
+            if return_code not in [0, 2]:
+                for error in stdout_json["errors"]:
+                    self.logger.error(error["message"])
+                exit(1)
+
+            self.add_to_policy_input("tflint", stdout_json)
+
+            if len(stdout_json["issues"]) == 0:
+                self.logger.info("No issues found")
+                return
+
+            findings = {
+                "error": {},
+                "warning": {},
+                "notice": {},
+            }
+            for match in stdout_json["issues"]:
+                severity = match["rule"]["severity"]
+                rule_name = match["rule"]["name"]
+
+                if rule_name not in findings[severity]:
+                    findings[severity][rule_name] = []
+
+                findings[severity][rule_name].append(match)
+
+            markdown = "# TFLint Findings\n\n"
+            for severity, rules in findings.items():
+                # Skip severity level if no issues were found
+                if len(rules) == 0:
+                    continue
+
+                emoji = None
+                if severity == "notice":
+                    emoji = "🟡"
+                elif severity == "warning":
+                    emoji = "🟠"
+                elif severity == "error":
+                    emoji = "🔴"
+                if emoji is not None:
+                    markdown += f"## {emoji} {severity.title()} Findings\n\n"
+                else:
+                    markdown += f"## {severity.title()} Findings\n\n"
+
+                for rule_name, issues in rules.items():
+                    markdown += f"### {rule_name}\n\n"
+                    for issue in issues:
+                        markdown += f"- {issue['message']} _({issue['range']['filename']}:{issue['range']['start']['line']})_\n"
+                    markdown += "\n"
+
+            result = self.send_markdown(markdown)
+            if result:
+                self.logger.info(
+                    "Issues found. Check the Plugins Output tab for details."
+                )
+            else:
+                self.logger.error("Failed to upload plugin outputs")
+        except Exception as e:
+            self.logger.error(f"Plugin failed: {e}")
+            exit(1)