Tighten GraphQL definition of environment type

README.md

@@ -171,6 +171,12 @@ Run [MkDocs] server to view documentation:
 poetry run mkdocs serve
 ```
 
+To generate a GraphQL schema file:
+
+```
+poetry run strawberry export-schema softpack_core.graphql:GraphQL.schema > schema.graphql
+```
+
 
 [pip]: https://pip.pypa.io
 [Python installation guide]: http://docs.python-guide.org/en/latest/starting/installation/

softpack_core/artifacts.py

@@ -56,6 +56,14 @@
     failed = 'failed'
 
 
+@strawberry.enum
+class Type(Enum):
+    """Environment types."""
+
+    softpack = "softpack"
+    module = "module"
+
+
 class Artifacts:
     """Artifacts repo access class."""
 
@@ -65,9 +73,9 @@
     module_file = "module"
     readme_file = "README.md"
     built_by_softpack_file = ".built_by_softpack"
-    built_by_softpack = "softpack"
+    built_by_softpack = Type.softpack.value
     generated_from_module_file = ".generated_from_module"
-    generated_from_module = "module"
+    generated_from_module = Type.module.value
     users_folder_name = "users"
     groups_folder_name = "groups"
     credentials_callback = None
@@ -133,7 +141,7 @@
             if Artifacts.module_file in self.obj:
                 info["state"] = State.ready
             elif Artifacts.builder_out in self.obj:
                 info["state"] = State.failed
             else:
                 info["state"] = State.queued
 
@@ -207,7 +215,7 @@
     def signature(self) -> pygit2.Signature:
         """Get current pygit2 commit signature: author/committer/timestamp."""
         # creating one of these implicitly looks up the current time.
         return pygit2.Signature(
             self.settings.artifacts.repo.author,
             self.settings.artifacts.repo.email,
         )

softpack_core/schemas/environment.py

@@ -19,7 +19,7 @@
 from strawberry.file_uploads import Upload
 
 from softpack_core.app import app
-from softpack_core.artifacts import Artifacts, Package, State
+from softpack_core.artifacts import Artifacts, Package, State, Type
 from softpack_core.module import GenerateEnvReadme, ToSoftpackYML
 from softpack_core.schemas.base import BaseSchema
 
@@ -158,7 +158,7 @@
             return InvalidInputError(message="all fields must be filled in")
 
         if not re.fullmatch(r"^[a-zA-Z0-9_-]+$", self.name):
             return InvalidInputError(
                 message="name must only contain alphanumerics, "
                 "dash, and underscore"
             )
@@ -196,7 +196,7 @@
     path: str
     description: str
     readme: str
-    type: str
+    type: Type
     packages: list[Package]
     state: Optional[State]
     artifacts = Artifacts()
@@ -247,15 +247,15 @@
         Returns:
             A message confirming the success or failure of the operation.
         """
         input_err = env.validate()
         if input_err is not None:
             return input_err
 
         versionless_name = env.name
         version = 1
 
         while True:
             env.name = versionless_name + "-" + str(version)
             response = cls.create_new_env(
                 env, Artifacts.built_by_softpack_file
             )
@@ -268,9 +268,9 @@
             version += 1
 
         # Send build request
         try:
             host = app.settings.builder.host
             port = app.settings.builder.port
             r = httpx.post(
                 f"http://{host}:{port}/environments/build",
                 json={
@@ -288,10 +288,10 @@
                     },
                 },
             )
             r.raise_for_status()
         except Exception as e:
             cls.delete(env.name, env.path)
             return BuilderError(
                 message="Connection to builder failed: "
                 + "".join(format_exception_only(type(e), e))
             )
@@ -347,9 +347,9 @@
                     for pkg in env.packages
                 ],
             )
             ymlData = yaml.dump(softpack_definition)
 
             tree_oid = cls.artifacts.create_files(
                 new_folder_path,
                 [
                     (env_type, ""),  # e.g. .built_by_softpack
@@ -361,7 +361,7 @@
                 tree_oid, "create environment folder"
             )
         except RuntimeError as e:
             return InvalidInputError(
                 message="".join(format_exception_only(type(e), e))
             )
 
@@ -572,13 +572,13 @@
             tree_oid = cls.artifacts.create_files(
                 Path(folder_path), new_files, overwrite=True
             )
             cls.artifacts.commit_and_push(tree_oid, "write artifact")
             return WriteArtifactSuccess(
                 message="Successfully written artifact(s)",
             )
 
         except Exception as e:
             return InvalidInputError(
                 message="".join(format_exception_only(type(e), e))
             )