spaceforge 0.0.4__py3-none-any.whl → 0.0.6__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 = '0.0.4'
-__version_tuple__ = version_tuple = (0, 0, 4)
+__version__ = version = '0.0.6'
+__version_tuple__ = version_tuple = (0, 0, 6)
 
 __commit_id__ = commit_id = None

spaceforge/cls.py

@@ -149,6 +149,9 @@ class Webhook:
     labels: Optional[List[str]] = optional_field
 
 
+PolicyTypes = Literal["PUSH", "PLAN", "TRIGGER", "APPROVAL", "NOTIFICATION"]
+
+
 @pydantic_dataclass
 class Policy:
     """
@@ -162,7 +165,7 @@ class Policy:
     """
 
     name_prefix: str
-    type: str
+    type: PolicyTypes
     body: str
     labels: Optional[List[str]] = optional_field
 

spaceforge/generator.py

@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
 
 import yaml
 from jinja2 import Environment, PackageLoader, select_autoescape
+from mergedeep import Strategy, merge  # type: ignore
 
 if TYPE_CHECKING:
     from .plugin import SpaceforgePlugin
@@ -185,7 +186,10 @@ class PluginGenerator:
                 )
 
     def _add_spaceforge_hooks(
-        self, hooks: Dict[str, List[str]], mounted_files: List[MountedFile]
+        self,
+        hooks: Dict[str, List[str]],
+        mounted_files: List[MountedFile],
+        has_binaries: bool,
     ) -> None:
         # Add the spaceforge hook to actually run the plugin
         if self.config is None:
@@ -203,6 +207,7 @@ class PluginGenerator:
                 plugin_path=directory,
                 plugin_file=self.config["plugin_mounted_path"],
                 phase=hook,
+                has_binaries=has_binaries,
             )
             self._add_to_mounted_files(hooks, mounted_files, hook, f"{hook}.sh", render)
 
@@ -244,8 +249,8 @@ class PluginGenerator:
 
         self._update_with_requirements(mounted_files)
         self._update_with_python_file(mounted_files)
-        self._generate_binary_install_command(hooks, mounted_files)
-        self._add_spaceforge_hooks(hooks, mounted_files)
+        has_binaries = self._generate_binary_install_command(hooks, mounted_files)
+        self._add_spaceforge_hooks(hooks, mounted_files, has_binaries)
 
         # Get the contexts and append the hooks and mounted files to it.
         if self.plugin_class is None:
@@ -270,8 +275,8 @@ class PluginGenerator:
             contexts[0].env = []
 
         # Add the hooks and mounted files to the first context
-        contexts[0].hooks.update(hooks)
-        contexts[0].mounted_files.extend(mounted_files)
+        merge(contexts[0].hooks, hooks, strategy=Strategy.TYPESAFE_ADDITIVE)
+        contexts[0].mounted_files += mounted_files
 
         self._map_variables_to_parameters(contexts)
 
@@ -279,10 +284,10 @@ class PluginGenerator:
 
     def _generate_binary_install_command(
         self, hooks: Dict[str, List[str]], mounted_files: List[MountedFile]
-    ) -> None:
+    ) -> bool:
         binaries = self.get_plugin_binaries()
         if binaries is None:
-            return None
+            return False
 
         for i, binary in enumerate(binaries):
             amd64_url = binary.download_urls.get("amd64", None)
@@ -309,6 +314,8 @@ class PluginGenerator:
                 render,
             )
 
+        return True
+
     def get_plugin_binaries(self) -> Optional[List[Binary]]:
         """Get binary definitions from the plugin class."""
         return getattr(self.plugin_class, "__binaries__", None)

spaceforge/plugin.py

@@ -36,21 +36,21 @@ class SpaceforgePlugin(ABC):
         self.logger = self._setup_logger()
 
         self._api_token = os.environ.get("SPACELIFT_API_TOKEN") or False
-        self._spacelift_domain = (
+        self.spacelift_domain = (
             os.environ.get("TF_VAR_spacelift_graphql_endpoint") or False
         )
-        self._api_enabled = bool(self._api_token and self._spacelift_domain)
+        self._api_enabled = bool(self._api_token and self.spacelift_domain)
         self._workspace_root = os.getcwd()
         self._spacelift_markdown_endpoint = None
 
         # This should be the last thing we do in the constructor
         # because we set api_enabled to false if the domain is set up incorrectly.
-        if self._spacelift_domain and isinstance(self._spacelift_domain, str):
+        if self.spacelift_domain and isinstance(self.spacelift_domain, str):
             # this must occur after we check if spacelift domain is false
             # because the domain could be set but not start with https://
-            if self._spacelift_domain.startswith("https://"):
-                if self._spacelift_domain.endswith("/"):
-                    self._spacelift_domain = self._spacelift_domain[:-1]
+            if self.spacelift_domain.startswith("https://"):
+                if self.spacelift_domain.endswith("/"):
+                    self.spacelift_domain = self.spacelift_domain[:-1]
             else:
                 self.logger.warning(
                     "SPACELIFT_DOMAIN does not start with https://, api calls will fail."
@@ -58,7 +58,7 @@ class SpaceforgePlugin(ABC):
                 self._api_enabled = False
 
             if self._api_enabled:
-                self._spacelift_markdown_endpoint = self._spacelift_domain.replace(
+                self._spacelift_markdown_endpoint = self.spacelift_domain.replace(
                     "/graphql", "/worker/plugin_logs_url"
                 )
 
@@ -200,7 +200,7 @@ class SpaceforgePlugin(ABC):
             data["variables"] = variables
 
         req = urllib.request.Request(
-            self._spacelift_domain,  # type: ignore[arg-type]
+            self.spacelift_domain,  # type: ignore[arg-type]
             json.dumps(data).encode("utf-8"),
             headers,
         )
@@ -233,7 +233,7 @@ class SpaceforgePlugin(ABC):
             data: Dict[str, Any] = json.load(f)
             return data
 
-    def send_markdown(self, markdown: str) -> None:
+    def send_markdown(self, markdown: str) -> bool:
         """
         Send a markdown message to the Spacelift run.
 
@@ -245,13 +245,13 @@ class SpaceforgePlugin(ABC):
                 "Spacelift run is local. Not uploading markdown. Below is a preview of what would be sent"
             )
             self.logger.info(markdown)
-            return
+            return True
 
         if self._spacelift_markdown_endpoint is None:
             self.logger.error(
                 'API is not enabled, please export "SPACELIFT_API_TOKEN" and "TF_VAR_spacelift_graphql_endpoint".'
             )
-            exit(1)
+            return False
 
         headers = {"Authorization": f"Bearer {self._api_token}"}
         body = {
@@ -266,26 +266,30 @@ class SpaceforgePlugin(ABC):
             method="POST",
         )
 
-        with urllib.request.urlopen(req) as response:
-            if response.status != 200:
-                self.logger.error(
-                    f"Error getting signed URL for markdown upload: {response}"
-                )
-                return
-
-            raw_response = response.read().decode("utf-8")
-            self.logger.debug(raw_response)
-            resp: Dict[str, Any] = json.loads(raw_response)
-            if "url" not in resp or "headers" not in resp:
-                self.logger.error(
-                    "Markdown signed url response does not contain 'url' or 'headers' key."
-                )
-                return
+        try:
+            with urllib.request.urlopen(req) as response:
+                if response.status != 200:
+                    self.logger.error(
+                        f"Error getting signed URL for markdown upload: {response}"
+                    )
+                    return False
+
+                raw_response = response.read().decode("utf-8")
+                self.logger.debug(raw_response)
+                resp: Dict[str, Any] = json.loads(raw_response)
+                if "url" not in resp or "headers" not in resp:
+                    self.logger.error(
+                        "Markdown signed url response does not contain 'url' or 'headers' key."
+                    )
+                    return False
 
-            signed_url = resp["url"]
-            headers = resp["headers"]
-            headers["Content-Type"] = "text/markdown"
-            headers["Content-Length"] = str(len(markdown))
+                signed_url = resp["url"]
+                headers = resp["headers"]
+                headers["Content-Type"] = "text/markdown"
+                headers["Content-Length"] = str(len(markdown))
+        except urllib.request.HTTPError as e:
+            self.logger.error(f"HTTP error occurred: {e.code} - {e.reason}")
+            return False
 
         # Now we upload the markdown content to the signed URL
         req = urllib.request.Request(
@@ -300,8 +304,9 @@ class SpaceforgePlugin(ABC):
                 self.logger.error(
                     f"Error uploading markdown content: {put_response.status}"
                 )
-                return
+                return False
             self.logger.debug("Markdown content uploaded successfully.")
+        return True
 
     def add_to_policy_input(self, input_name: str, data: Dict[str, Any]) -> None:
         """

spaceforge/schema.json

@@ -170,6 +170,13 @@
           "type": "string"
         },
         "type": {
+          "enum": [
+            "PUSH",
+            "PLAN",
+            "TRIGGER",
+            "APPROVAL",
+            "NOTIFICATION"
+          ],
           "title": "Type",
           "type": "string"
         },

spaceforge/templates/ensure_spaceforge_and_run.sh.j2

@@ -17,6 +17,8 @@ if [ -f requirements.txt ] && [ ! -f .spaceforge_installed_requirements ]; then
     pip install -r requirements.txt
     touch .spaceforge_installed_requirements
 fi
-
+{% if has_binaries %}
+export PATH="/mnt/workspace/plugins/plugin_binaries:$PATH"
+{% endif %}
 cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
 spaceforge runner --plugin-file {{plugin_file}} {{phase}}

spaceforge/test_generator.py

@@ -72,7 +72,7 @@ class PluginExample(SpaceforgePlugin):
     __policies__ = [
         Policy(
             name_prefix="test_policy",
-            type="notification",
+            type="NOTIFICATION",
             body="package test",
             labels=["type:security"],
         )
@@ -396,7 +396,7 @@ class NotAPlugin:
         assert policies is not None
         assert len(policies) == 1
         assert policies[0].name_prefix == "test_policy"
-        assert policies[0].type == "notification"
+        assert policies[0].type == "NOTIFICATION"
         assert policies[0].body == "package test"
 
     def test_get_plugin_webhooks(self) -> None:

spaceforge/test_plugin.py

@@ -21,7 +21,7 @@ class TestSpaceforgePluginInitialization:
 
         # Assert
         assert plugin._api_token is False
-        assert plugin._spacelift_domain is False
+        assert plugin.spacelift_domain is False
         assert plugin._api_enabled is False
         assert plugin._workspace_root == os.getcwd()
         assert isinstance(plugin.logger, logging.Logger)
@@ -36,7 +36,7 @@ class TestSpaceforgePluginInitialization:
 
         # Assert
         assert plugin._api_token == "test_token"
-        assert plugin._spacelift_domain == "https://test.spacelift.io"
+        assert plugin.spacelift_domain == "https://test.spacelift.io"
         assert plugin._api_enabled is True
         assert plugin._workspace_root == os.getcwd()
 
@@ -53,7 +53,7 @@ class TestSpaceforgePluginInitialization:
             plugin = SpaceforgePlugin()
 
         # Assert
-        assert plugin._spacelift_domain == "https://test.spacelift.io"
+        assert plugin.spacelift_domain == "https://test.spacelift.io"
         assert plugin._api_enabled is True
 
     def test_should_disable_api_when_domain_has_no_https_prefix(self) -> None:
@@ -69,7 +69,7 @@ class TestSpaceforgePluginInitialization:
             plugin = SpaceforgePlugin()
 
         # Assert
-        assert plugin._spacelift_domain == "test.spacelift.io"
+        assert plugin.spacelift_domain == "test.spacelift.io"
         assert plugin._api_enabled is False
 
     def test_should_disable_api_when_only_token_provided(self) -> None:
@@ -271,7 +271,7 @@ class TestSpaceforgePluginAPI:
         plugin = SpaceforgePlugin()
         plugin._api_enabled = True
         plugin._api_token = "test_token"
-        plugin._spacelift_domain = "https://test.spacelift.io"
+        plugin.spacelift_domain = "https://test.spacelift.io"
 
         expected_data = {"data": {"test": "result"}}
         mock_api_response.read.return_value = json.dumps(expected_data).encode("utf-8")
@@ -305,7 +305,7 @@ class TestSpaceforgePluginAPI:
         plugin = SpaceforgePlugin()
         plugin._api_enabled = True
         plugin._api_token = "test_token"
-        plugin._spacelift_domain = "https://test.spacelift.io"
+        plugin.spacelift_domain = "https://test.spacelift.io"
 
         mock_response_data = {"data": {"test": "result"}}
         mock_response = Mock()
@@ -331,7 +331,7 @@ class TestSpaceforgePluginAPI:
         plugin = SpaceforgePlugin()
         plugin._api_enabled = True
         plugin._api_token = "test_token"
-        plugin._spacelift_domain = "https://test.spacelift.io"
+        plugin.spacelift_domain = "https://test.spacelift.io"
 
         mock_response_data = {"errors": [{"message": "Test error"}]}
         mock_response = Mock()

{spaceforge-0.0.4.dist-info → spaceforge-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 0.0.4
+Version: 0.0.6
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift
@@ -29,6 +29,7 @@ Requires-Dist: PyYAML>=6.0
 Requires-Dist: click>=8.0.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: Jinja2>=3.1.0
+Requires-Dist: mergedeep>=1.3.4
 Provides-Extra: dev
 Requires-Dist: pytest>=6.0; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{spaceforge-0.0.4.dist-info → spaceforge-0.0.6.dist-info}/RECORD

@@ -2,20 +2,20 @@ spaceforge/README.md,sha256=8o1Nuyasb4OxX3E7ZycyducOrR4J19bZcHrLvFeoFNg,7730
 spaceforge/__init__.py,sha256=TU-vvm15dK1ucixNW0V42eTT72x3_hmKSyxP4MC1Occ,589
 spaceforge/__main__.py,sha256=c3nAw4WBnHXIcfMlRV6Ja7r87pEhSeK-SAqiSYIasIY,643
 spaceforge/_version.py,sha256=RP_LfUd4ODnrfwn9nam8wB6bR3lM4VwmoRxK08Tkiiw,2155
-spaceforge/_version_scm.py,sha256=QlXZ5JTjE_pgpDaeHk0GTExkc75xUZFmd0hA7kGYCJ0,704
-spaceforge/cls.py,sha256=3Js2i0kfWBfa9g-VthuARc3WGwrbdpiQzbQYij59dMo,5981
+spaceforge/_version_scm.py,sha256=7MyqQ3iPP2mJruPfRYGCNCq1z7_Nk7c-eyYecYITxsY,704
+spaceforge/cls.py,sha256=lCGtlMv-rFFVnvfFaq36-GRqLiINswLD78amZigZo7I,6068
 spaceforge/conftest.py,sha256=U-xCavCsgRAQXqflIIOMeq9pcGbeqRviUNkEXgZol8g,2141
-spaceforge/generator.py,sha256=kwWEyVqKaOIgZI4nmu4q30ZefA7w10vj78PmROWW5V4,16484
-spaceforge/plugin.py,sha256=8qPDieG2i6pFBg02GYXSb06DU9xR51b20kU4X9Kv6Ic,13051
+spaceforge/generator.py,sha256=-1lO_1bhaM85-aULpPE2TeG4SlaznETG3YfyucKALns,16709
+spaceforge/plugin.py,sha256=PdQpBle5eU_N__2eArJgNe2BEnN3mL_SMeM6yjnBtGw,13322
 spaceforge/runner.py,sha256=aBQQLG8MFVrqCzM0X8HgERYbhLKbmlOHUPKjV7-xvpA,3163
-spaceforge/schema.json,sha256=syoxxTJuZ9Wn91vLRHeffyDi7xYHjwSZ14AheugLzhY,10336
+spaceforge/schema.json,sha256=scQyV71IlbB5kipAhc880n-PG-FH8BeVk9FWFoA3Wtw,10483
 spaceforge/test_cls.py,sha256=nXAgbnFnGdFxrtA7vNXiePjNUASuoYW-lEuQGx9WMGs,468
-spaceforge/test_generator.py,sha256=liCccHjGQ7SmKc1RCrceS18bisPA9H0FSvMbgOIZ-Sg,32615
+spaceforge/test_generator.py,sha256=Nst3YVu_iZbFopH6ajjxCfqYrZvybteGbwMfZzjBFnI,32615
 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_plugin.py,sha256=pFst9RUpTujuv_zdhWnB9LMeB_vN9qHLNEhnmo8WzkQ,13046
+spaceforge/test_plugin.py,sha256=Q4ztmpDV8Xpr0HVvYXHyAm_VHv8TzLXdN5PHeMI9KnI,13039
 spaceforge/test_plugin_file_operations.py,sha256=B0qvIo5EcfKMiHLhBv-hAnpSonn83ojcmJHXasydojA,3782
 spaceforge/test_plugin_hooks.py,sha256=rNCZZyd_SDMkm1x3yl5mjQ5tBMGm3YNd1U6h_niWRQs,2962
 spaceforge/test_plugin_inheritance.py,sha256=WHfvU5s-2GtfcI9-1bHXH7bacr77ikq68V3Z3BBQKvQ,3617
@@ -24,10 +24,10 @@ spaceforge/test_runner_cli.py,sha256=Sf5X0O9Wc9EhGB5L8SzvlmO7QmgQZQoClSdNYefa-lQ
 spaceforge/test_runner_core.py,sha256=eNR9YOwJwv7LsMtNQ4WXXMPIW6RE_A7hUp4bCpzz1Rk,3941
 spaceforge/test_runner_execution.py,sha256=BRlOApCmlpjE9YYvqHc8creSRu2vyPubzOCVXv-on0w,5335
 spaceforge/templates/binary_install.sh.j2,sha256=UjP_kAdvkkATKds2nqk4ouqLhuIfCgM_x0WQIl1hbIo,477
-spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=qU5UvJhxh8toLrTSH3fUv7UPFaKo7Z1mQCV_bpToDB4,458
-spaceforge-0.0.4.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
-spaceforge-0.0.4.dist-info/METADATA,sha256=6o_AicFSDgu2TnQZIodI7barxJODWNgfMoRtd9DyLzA,16771
-spaceforge-0.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-spaceforge-0.0.4.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
-spaceforge-0.0.4.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
-spaceforge-0.0.4.dist-info/RECORD,,
+spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=g5BldIEve0IkZ-mCzTXfB_rFvyWqUJqymRRaaMrpp0s,550
+spaceforge-0.0.6.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
+spaceforge-0.0.6.dist-info/METADATA,sha256=OwvM8wjFNiRS5kDfYTClgo9H9ZAAMIMOlkCXmqnDMac,16803
+spaceforge-0.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spaceforge-0.0.6.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
+spaceforge-0.0.6.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
+spaceforge-0.0.6.dist-info/RECORD,,