spaceforge 0.0.12__tar.gz → 0.0.14__tar.gz

{spaceforge-0.0.12 → spaceforge-0.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 0.0.12
+Version: 0.0.14
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift

{spaceforge-0.0.12 → spaceforge-0.0.14}/plugins/enviroment_manager/plugin.py

@@ -1,4 +1,4 @@
-from spaceforge import SpaceforgePlugin, MountedFile, Context
+from spaceforge import SpaceforgePlugin, MountedFile, Context, Parameter, Variable
 
 import yaml
 import os
@@ -107,6 +107,22 @@ The above configuration will create the following in a plan:
     __version__ = "1.0.0"
     __author__ = "Spacelift Team"
 
+    __parameters__ = [
+        Parameter(
+            name="Spacelift API Key ID",
+            id="spacelift_api_key_id",
+            description="The API Key that will trigger the stack previews",
+            required=True,
+        ),
+        Parameter(
+            name="Spacelift API Key Secret",
+            id="spacelift_api_key_secret",
+            description="The API Key Secret that will trigger the stack previews",
+            required=True,
+            sensitive=True
+        ),
+    ]
+
     __contexts__ = [
         Context(
             name_prefix="Environment Manager",
@@ -116,6 +132,18 @@ The above configuration will create the following in a plan:
                     "mv /mnt/workspace/__environment_manager.tf /mnt/workspace/source/$TF_VAR_spacelift_project_root/__environment_manager.tf",
                 ]
             },
+            env=[
+                Variable(
+                    key="SPACELIFT_API_KEY_ID",
+                    value_from_parameter="spacelift_api_key_id",
+                    sensitive=False
+                ),
+                Variable(
+                    key="SPACELIFT_API_KEY_SECRET",
+                    value_from_parameter="spacelift_api_key_secret",
+                    sensitive=True
+                ),
+            ],
             mounted_files=[
                 MountedFile(
                     path="__environment_manager.tf",
@@ -220,6 +248,9 @@ resource "spacelift_environment_variable" "__this" {
                 "runtimeConfig": yaml.dump(env)
             }
 
+            self.use_user_token(os.environ.get("SPACELIFT_API_KEY_ID"),
+                                os.environ.get("SPACELIFT_API_KEY_SECRET"))
+
             response = self.query_api(query, variables)
             if "errors" in response:
                 self.logger.error(f"Error triggering stack preview for {stack_id}:", response["errors"])

{spaceforge-0.0.12 → spaceforge-0.0.14}/plugins/enviroment_manager/plugin.yaml

@@ -99,10 +99,27 @@ author: Spacelift Team
 labels:
 - management
 - infrastructure
+parameters:
+- 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
+  sensitive: true
+  required: true
+  id: spacelift_api_key_secret
 contexts:
 - name_prefix: Environment Manager
   description: Environment Manager Plugin
-  env: []
+  env:
+  - key: SPACELIFT_API_KEY_ID
+    value_from_parameter: spacelift_api_key_id
+    sensitive: false
+  - key: SPACELIFT_API_KEY_SECRET
+    value_from_parameter: spacelift_api_key_secret
+    sensitive: true
   mounted_files:
   - path: __environment_manager.tf
     content: |-
@@ -135,7 +152,7 @@ contexts:
     sensitive: false
   - path: /mnt/workspace/plugins/environment_manager/plugin.py
     content: |-
-      from spaceforge import SpaceforgePlugin, MountedFile, Context
+      from spaceforge import SpaceforgePlugin, MountedFile, Context, Parameter, Variable
 
       import yaml
       import os
@@ -244,6 +261,22 @@ contexts:
           __version__ = "1.0.0"
           __author__ = "Spacelift Team"
 
+          __parameters__ = [
+              Parameter(
+                  name="Spacelift API Key ID",
+                  id="spacelift_api_key_id",
+                  description="The API Key that will trigger the stack previews",
+                  required=True,
+              ),
+              Parameter(
+                  name="Spacelift API Key Secret",
+                  id="spacelift_api_key_secret",
+                  description="The API Key Secret that will trigger the stack previews",
+                  required=True,
+                  sensitive=True
+              ),
+          ]
+
           __contexts__ = [
               Context(
                   name_prefix="Environment Manager",
@@ -253,6 +286,18 @@ contexts:
                           "mv /mnt/workspace/__environment_manager.tf /mnt/workspace/source/$TF_VAR_spacelift_project_root/__environment_manager.tf",
                       ]
                   },
+                  env=[
+                      Variable(
+                          key="SPACELIFT_API_KEY_ID",
+                          value_from_parameter="spacelift_api_key_id",
+                          sensitive=False
+                      ),
+                      Variable(
+                          key="SPACELIFT_API_KEY_SECRET",
+                          value_from_parameter="spacelift_api_key_secret",
+                          sensitive=True
+                      ),
+                  ],
                   mounted_files=[
                       MountedFile(
                           path="__environment_manager.tf",
@@ -357,6 +402,9 @@ contexts:
                       "runtimeConfig": yaml.dump(env)
                   }
 
+                  self.use_user_token(os.environ.get("SPACELIFT_API_KEY_ID"),
+                                      os.environ.get("SPACELIFT_API_KEY_SECRET"))
+
                   response = self.query_api(query, variables)
                   if "errors" in response:
                       self.logger.error(f"Error triggering stack preview for {stack_id}:", response["errors"])

{spaceforge-0.0.12 → spaceforge-0.0.14}/spaceforge/_version_scm.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.12'
-__version_tuple__ = version_tuple = (0, 0, 12)
+__version__ = version = '0.0.14'
+__version_tuple__ = version_tuple = (0, 0, 14)
 
-__commit_id__ = commit_id = 'g8d47ec028'
+__commit_id__ = commit_id = 'ga50701aaf'

{spaceforge-0.0.12 → spaceforge-0.0.14}/spaceforge/cls.py

@@ -145,7 +145,7 @@ class Webhook:
 
     name_prefix: str
     endpoint: str
-    secretFromParameter: str
+    secretFromParameter: Optional[str] = optional_field
     labels: Optional[List[str]] = optional_field
 
 
@@ -202,4 +202,7 @@ if __name__ == "__main__":
 
     from pydantic import TypeAdapter
 
-    print(json.dumps(TypeAdapter(PluginManifest).json_schema(), indent=2))
+    schema = TypeAdapter(PluginManifest).json_schema()
+    schema["$schema"] = "http://json-schema.org/draft-07/schema#"
+
+    print(json.dumps(schema, indent=2))

{spaceforge-0.0.12 → spaceforge-0.0.14}/spaceforge/plugin.py

@@ -43,6 +43,7 @@ class SpaceforgePlugin(ABC):
         self._api_enabled = bool(self._api_token and self.spacelift_domain)
         self._workspace_root = os.getcwd()
         self._spacelift_markdown_endpoint = None
+        self._markdown_endpoint_token = os.environ.get("SPACELIFT_API_TOKEN") or False
 
         # 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.
@@ -109,6 +110,58 @@ class SpaceforgePlugin(ABC):
 
         return logger
 
+    def use_user_token(self, id: str, token: str) -> None:
+        headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {self._api_token}",
+        }
+
+        query = """
+        mutation requestApiKey($id: ID!, $secret: String!){
+          apiKeyUser(id: $id, secret: $secret){
+            jwt
+          }
+        }
+        """
+
+        data: Dict[str, Any] = {
+            "query": query,
+            "variables": {"id": id, "secret": token},
+        }
+
+        req = urllib.request.Request(
+            self.spacelift_domain,  # type: ignore[arg-type]
+            json.dumps(data).encode("utf-8"),
+            headers,
+        )
+
+        self.logger.debug(f"Sending request to url: {self.spacelift_domain}")
+        try:
+            with urllib.request.urlopen(req) as response:
+                resp: Dict[str, Any] = json.loads(response.read().decode("utf-8"))
+        except urllib.error.HTTPError as e:
+            if hasattr(e, "read"):
+                resp = json.loads(e.read().decode("utf-8"))
+            else:
+                # We should not get here, but if we do re-raise the exception
+                self.logger.error(f"HTTP error occurred: ({e.code}) {e.reason} {e.msg}")
+                raise e
+
+        if "errors" in resp:
+            self.logger.error(f"Error: {resp['errors']}")
+            return
+
+        if (
+            "data" in resp
+            and "apiKeyUser" in resp["data"]
+            and "jwt" in resp["data"]["apiKeyUser"]
+        ):
+            self._api_token = resp["data"]["apiKeyUser"]["jwt"]
+            self._api_enabled = True
+            self.logger.debug("Successfully set user token for API calls.")
+        else:
+            self.logger.error(f"API call returned no data: {resp}")
+
     def get_available_hooks(self) -> List[str]:
         """
         Get list of hook methods available in this plugin.
@@ -256,13 +309,16 @@ class SpaceforgePlugin(ABC):
             self.logger.info(markdown)
             return True
 
-        if self._spacelift_markdown_endpoint is None:
+        if (
+            self._spacelift_markdown_endpoint is None
+            or not self._markdown_endpoint_token
+        ):
             self.logger.error(
                 'API is not enabled, please export "SPACELIFT_API_TOKEN" and "TF_VAR_spacelift_graphql_endpoint".'
             )
             return False
 
-        headers = {"Authorization": f"Bearer {self._api_token}"}
+        headers = {"Authorization": f"Bearer {self._markdown_endpoint_token}"}
         body = {
             "plugin_name": self.__plugin_name__,
         }

{spaceforge-0.0.12 → spaceforge-0.0.14}/spaceforge/schema.json

@@ -260,8 +260,15 @@
           "type": "string"
         },
         "secretFromParameter": {
-          "title": "Secretfromparameter",
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Secretfromparameter"
         },
         "labels": {
           "anyOf": [
@@ -280,8 +287,7 @@
       },
       "required": [
         "name_prefix",
-        "endpoint",
-        "secretFromParameter"
+        "endpoint"
       ],
       "title": "Webhook",
       "type": "object"
@@ -383,5 +389,6 @@
     "author"
   ],
   "title": "PluginManifest",
-  "type": "object"
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-07/schema#"
 }

{spaceforge-0.0.12 → spaceforge-0.0.14}/spaceforge.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 0.0.12
+Version: 0.0.14
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift