refactor: restructure and cleanup core blueprints

equinor · Jan 3, 2024 · 60741af · 60741af
1 parent 7ba4edf
commit 60741af
Show file tree

Hide file tree

Showing 80 changed files with 72 additions and 164 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -19,11 +19,11 @@ FROM base as development
 RUN poetry install
 COPY /src/.behaverc ./src/.behaverc
 COPY src ./src
-RUN chown -R 1000:1000 /code/src/home/system/data_sources/system.json
+RUN chown -R 1000:1000 /code/src/system_DS.json
 USER 1000
 
 FROM base as prod
 RUN poetry install --no-dev
 COPY src ./src
-RUN chown -R 1000:1000 /code/src/home/system/data_sources/system.json
+RUN chown -R 1000:1000 /code/src/system_DS.json
 USER 1000
diff --git a/docker-compose.override.yml b/docker-compose.override.yml
@@ -8,6 +8,7 @@ services:
     volumes:
       - ./src:/code/src
     environment:
+      SECRET_KEY: sg9aeUM5i1JO4gNN8fQadokJa3_gXQMLBjSGGYcfscs= # Don't reuse this in production...
       ENVIRONMENT: local
       LOGGING_LEVEL: debug
       # MONGO_URI: ${MONGO_URI}

diff --git a/src/home/system/SIMOS/Application.json → src/SIMOS/Application.json b/src/home/system/SIMOS/Application.json → src/SIMOS/Application.json
diff --git a/src/home/system/SIMOS/Blob.json → src/SIMOS/Blob.json b/src/home/system/SIMOS/Blob.json → src/SIMOS/Blob.json
diff --git a/src/home/system/SIMOS/Blueprint.json → src/SIMOS/Blueprint.json b/src/home/system/SIMOS/Blueprint.json → src/SIMOS/Blueprint.json
diff --git a/...home/system/SIMOS/BlueprintAttribute.json → src/SIMOS/BlueprintAttribute.json b/...home/system/SIMOS/BlueprintAttribute.json → src/SIMOS/BlueprintAttribute.json
diff --git a/src/home/system/SIMOS/Dependency.json → src/SIMOS/Dependency.json b/src/home/system/SIMOS/Dependency.json → src/SIMOS/Dependency.json
diff --git a/src/home/system/SIMOS/Entity.json → src/SIMOS/Entity.json b/src/home/system/SIMOS/Entity.json → src/SIMOS/Entity.json
diff --git a/src/home/system/SIMOS/Enum.json → src/SIMOS/Enum.json b/src/home/system/SIMOS/Enum.json → src/SIMOS/Enum.json
diff --git a/src/home/system/SIMOS/File.json → src/SIMOS/File.json b/src/home/system/SIMOS/File.json → src/SIMOS/File.json
diff --git a/.../system/SIMOS/InlineRecipeViewConfig.json → src/SIMOS/InlineRecipeViewConfig.json b/.../system/SIMOS/InlineRecipeViewConfig.json → src/SIMOS/InlineRecipeViewConfig.json
diff --git a/src/home/system/SIMOS/Meta.json → src/SIMOS/Meta.json b/src/home/system/SIMOS/Meta.json → src/SIMOS/Meta.json
diff --git a/src/home/system/SIMOS/NamedEntity.json → src/SIMOS/NamedEntity.json b/src/home/system/SIMOS/NamedEntity.json → src/SIMOS/NamedEntity.json
diff --git a/src/home/system/SIMOS/blob_types/PDF.json → src/SIMOS/PDF.json b/src/home/system/SIMOS/blob_types/PDF.json → src/SIMOS/PDF.json
diff --git a/src/home/system/SIMOS/Package.json → src/SIMOS/Package.json b/src/home/system/SIMOS/Package.json → src/SIMOS/Package.json
diff --git a/src/home/system/SIMOS/RecipeLink.json → src/SIMOS/RecipeLink.json b/src/home/system/SIMOS/RecipeLink.json → src/SIMOS/RecipeLink.json
diff --git a/src/home/system/SIMOS/Reference.json → src/SIMOS/Reference.json b/src/home/system/SIMOS/Reference.json → src/SIMOS/Reference.json
diff --git a/...ome/system/SIMOS/ReferenceViewConfig.json → src/SIMOS/ReferenceViewConfig.json b/...ome/system/SIMOS/ReferenceViewConfig.json → src/SIMOS/ReferenceViewConfig.json
diff --git a/src/home/system/SIMOS/Role.json → src/SIMOS/Role.json b/src/home/system/SIMOS/Role.json → src/SIMOS/Role.json
diff --git a/src/home/system/SIMOS/StorageAttribute.json → src/SIMOS/StorageAttribute.json b/src/home/system/SIMOS/StorageAttribute.json → src/SIMOS/StorageAttribute.json
diff --git a/src/home/system/SIMOS/StorageRecipe.json → src/SIMOS/StorageRecipe.json b/src/home/system/SIMOS/StorageRecipe.json → src/SIMOS/StorageRecipe.json
diff --git a/src/home/system/SIMOS/UiAttribute.json → src/SIMOS/UiAttribute.json b/src/home/system/SIMOS/UiAttribute.json → src/SIMOS/UiAttribute.json
diff --git a/src/home/system/SIMOS/UiAttributeOption.json → src/SIMOS/UiAttributeOption.json b/src/home/system/SIMOS/UiAttributeOption.json → src/SIMOS/UiAttributeOption.json
diff --git a/src/home/system/SIMOS/UiRecipe.json → src/SIMOS/UiRecipe.json b/src/home/system/SIMOS/UiRecipe.json → src/SIMOS/UiRecipe.json
diff --git a/src/home/system/SIMOS/ViewConfig.json → src/SIMOS/ViewConfig.json b/src/home/system/SIMOS/ViewConfig.json → src/SIMOS/ViewConfig.json
diff --git a/src/home/system/SIMOS/enums/ActionTypes.json → src/SIMOS/enums/ActionTypes.json b/src/home/system/SIMOS/enums/ActionTypes.json → src/SIMOS/enums/ActionTypes.json
diff --git a/src/home/system/SIMOS/AttributeTypes.json → src/SIMOS/enums/AttributeTypes.json b/src/home/system/SIMOS/AttributeTypes.json → src/SIMOS/enums/AttributeTypes.json
diff --git a/src/home/system/SIMOS/enums/StatusEnum.json → src/SIMOS/enums/StatusEnum.json b/src/home/system/SIMOS/enums/StatusEnum.json → src/SIMOS/enums/StatusEnum.json
diff --git a/...home/system/SIMOS/enums/StorageTypes.json → src/SIMOS/enums/StorageTypes.json b/...home/system/SIMOS/enums/StorageTypes.json → src/SIMOS/enums/StorageTypes.json
diff --git a/.../system/SIMOS/recipe_links/blueprint.json → src/SIMOS/recipe_links/blueprint.json b/.../system/SIMOS/recipe_links/blueprint.json → src/SIMOS/recipe_links/blueprint.json
diff --git a/...me/system/SIMOS/recipe_links/default.json → src/SIMOS/recipe_links/default.json b/...me/system/SIMOS/recipe_links/default.json → src/SIMOS/recipe_links/default.json
diff --git a/...ome/system/SIMOS/recipe_links/entity.json → src/SIMOS/recipe_links/entity.json b/...ome/system/SIMOS/recipe_links/entity.json → src/SIMOS/recipe_links/entity.json
diff --git a/src/home/system/SIMOS/recipe_links/file.json → src/SIMOS/recipe_links/file.json b/src/home/system/SIMOS/recipe_links/file.json → src/SIMOS/recipe_links/file.json
diff --git a/...me/system/SIMOS/recipe_links/package.json → src/SIMOS/recipe_links/package.json b/...me/system/SIMOS/recipe_links/package.json → src/SIMOS/recipe_links/package.json
diff --git a/src/home/system/SIMOS/recipe_links/pdf.json → src/SIMOS/recipe_links/pdf.json b/src/home/system/SIMOS/recipe_links/pdf.json → src/SIMOS/recipe_links/pdf.json
@@ -1,6 +1,6 @@
 {
   "type": "dmss://system/SIMOS/RecipeLink",
-  "_blueprintPath_": "dmss://system/SIMOS/blob_types/PDF",
+  "_blueprintPath_": "dmss://system/SIMOS/PDF",
   "extends": [
     "dmss://system/SIMOS/NamedEntity",
     "_default_"

diff --git a/src/app.py b/src/app.py
@@ -168,13 +168,12 @@ def init_application():
         }
     )
     import_package(
-        f"{config.APPLICATION_HOME}/system/SIMOS",
+        "/code/src/SIMOS",
         user,
         data_source_name=config.CORE_DATA_SOURCE,
         is_root=True,
     )
     create_lookup_table_use_case(["system/SIMOS/recipe_links"], "DMSS", user)
-    logger.debug("DONE")
 
 
 @cli.command()
@@ -207,7 +206,6 @@ def nuke_db():
             mongo_client[db_name][collection].delete_many({})
         blob_handler = gridfs.GridFS(mongo_client[db_name])
         for filename in blob_handler.list():
-            print(filename)
             blob_handler.delete(filename)
     logger.debug("DONE")
 
@@ -217,7 +215,7 @@ def nuke_db():
 def reset_app(context):
     context.invoke(nuke_db)
     logger.info("CREATING SYSTEM DATA SOURCE")
-    context.invoke(import_data_source, file="/code/src/home/system/data_sources/system.json")
+    context.invoke(import_data_source, file="/code/src/system_DS.json")
     logger.debug("DONE")
     context.invoke(init_application)
 

diff --git a/src/config.py b/src/config.py
@@ -1,5 +1,3 @@
-from pathlib import Path
-
 from pydantic import BaseSettings, Field
 
 from enums import AuthProviderForRoleCheck
@@ -15,7 +13,6 @@ class Config(BaseSettings):
     MAX_ENTITY_RECURSION_DEPTH: int = Field(50, env="MAX_ENTITY_RECURSION_DEPTH")
     CORE_DATA_SOURCE: str = "system"
     CACHE_MAX_SIZE: int = 200
-    APPLICATION_HOME: str = Field(f"{Path(__file__).parent!s}/home", env="APPLICATION_HOME")
     # Access Control
     DMSS_ADMIN: str = Field("dmss-admin", env="DMSS_ADMIN")
     DMSS_ADMIN_ROLE: str = Field("dmss-admin", env="DMSS_ADMIN_ROLE")

diff --git a/src/enums.py b/src/enums.py
@@ -61,7 +61,7 @@ class SIMOS(Enum):
     NAMED_ENTITY = "dmss://system/SIMOS/NamedEntity"
     PACKAGE = "dmss://system/SIMOS/Package"
     BLUEPRINT_ATTRIBUTE = "dmss://system/SIMOS/BlueprintAttribute"
-    ATTRIBUTE_TYPES = "dmss://system/SIMOS/AttributeTypes"
+    ATTRIBUTE_TYPES = "dmss://system/SIMOS/enums/AttributeTypes"
     BLOB = "dmss://system/SIMOS/Blob"
     RECIPE_LINK = "dmss://system/SIMOS/RecipeLink"
     DATASOURCE = "datasource"

diff --git a/src/home/system/SIMOS/Action.json b/src/home/system/SIMOS/Action.json
diff --git a/src/home/system/SIMOS/Annotation.json b/src/home/system/SIMOS/Annotation.json
diff --git a/src/home/system/data_sources/azure.json b/src/home/system/data_sources/azure.json
diff --git a/src/init.sh b/src/init.sh
@@ -11,7 +11,7 @@ echo -e "########### VERSION ##########\n"
 
 if [ "$1" = 'api' ]; then
   if [ "${DATA_SOURCE_FILES:-""}" != "" ]; then
-    echo "$DATA_SOURCE_FILES" > /code/src/home/system/data_sources/system.json
+    echo "$DATA_SOURCE_FILES" > /code/src/system_DS.json
   fi
 
   if [ "${RESET_DATA_SOURCE:-"on"}" == "on" ]; then

diff --git a/src/reset-database.sh b/src/reset-database.sh
diff --git a/src/storage/repositories/file.py b/src/storage/repositories/file.py
@@ -7,13 +7,13 @@
 class LocalFileRepository(RepositoryInterface):
     def __init__(self, location: str | Path | None = None):
         if location is None:
-            location = f"{Path(__file__).parent.parent.parent!s}/home/"
+            location = f"{Path(__file__).parent.parent.parent}/SIMOS"
         self.path = Path(location)
 
     def get(self, absolute_ref: str) -> dict:
         try:
-            protocol, address = absolute_ref.split("://", 1)
-            with open(f"{self.path}/{address}.json") as f:
+            path_to_json = absolute_ref.replace("dmss://system/SIMOS/", "")
+            with open(f"{self.path}/{path_to_json}.json") as f:
                 return json.load(f)
         except FileNotFoundError as ex:
             raise FileNotFoundError(

diff --git a/src/home/system/data_sources/system.json → src/system_DS.json b/src/home/system/data_sources/system.json → src/system_DS.json
diff --git a/src/tests/bdd/document/add_file.feature b/src/tests/bdd/document/add_file.feature
@@ -83,12 +83,12 @@ Feature: Explorer - Add file
         },
         {
           "name": "a_pdf",
-          "attributeType": "dmss://system/SIMOS/blob_types/PDF",
+          "attributeType": "dmss://system/SIMOS/PDF",
           "type": "dmss://system/SIMOS/BlueprintAttribute"
         },
         {
           "name": "another_pdf",
-          "attributeType": "dmss://system/SIMOS/blob_types/PDF",
+          "attributeType": "dmss://system/SIMOS/PDF",
           "type": "dmss://system/SIMOS/BlueprintAttribute"
         },
         {
@@ -707,7 +707,7 @@ Feature: Explorer - Add file
         "a_pdf": {
           "name": "MyPDF1",
           "description": "",
-          "type": "dmss://system/SIMOS/blob_types/PDF",
+          "type": "dmss://system/SIMOS/PDF",
           "blob": {
             "name": "file1",
             "type": "dmss://system/SIMOS/Blob"
@@ -717,7 +717,7 @@ Feature: Explorer - Add file
         "another_pdf": {
           "name": "MyPDF2",
           "description": "",
-          "type": "dmss://system/SIMOS/blob_types/PDF",
+          "type": "dmss://system/SIMOS/PDF",
           "blob": {
             "name": "file2",
             "type": "dmss://system/SIMOS/Blob"
@@ -731,7 +731,7 @@ Feature: Explorer - Add file
           "a_pdf": {
             "name": "MyPDF3",
             "description": "",
-            "type": "dmss://system/SIMOS/blob_types/PDF",
+            "type": "dmss://system/SIMOS/PDF",
             "blob": {
               "name": "file3",
               "type": "dmss://system/SIMOS/Blob"
@@ -741,7 +741,7 @@ Feature: Explorer - Add file
           "another_pdf": {
             "name": "MyPDF4",
             "description": "",
-            "type": "dmss://system/SIMOS/blob_types/PDF",
+            "type": "dmss://system/SIMOS/PDF",
             "blob": {
               "name": "file4",
               "type": "dmss://system/SIMOS/Blob",

diff --git a/src/tests/bdd/document/update_with_blob.feature b/src/tests/bdd/document/update_with_blob.feature
@@ -44,13 +44,13 @@ Feature: Update document that has blob data
       "attributes": [
         {
           "name": "a_pdf",
-          "attributeType": "dmss://system/SIMOS/blob_types/PDF",
+          "attributeType": "dmss://system/SIMOS/PDF",
           "type": "dmss://system/SIMOS/BlueprintAttribute",
           "optional": true
         },
         {
           "name": "another_pdf",
-          "attributeType": "dmss://system/SIMOS/blob_types/PDF",
+          "attributeType": "dmss://system/SIMOS/PDF",
           "type": "dmss://system/SIMOS/BlueprintAttribute",
           "optional": true
         },
@@ -84,7 +84,7 @@ Feature: Update document that has blob data
         "a_pdf": {
           "name": "MyPDF1",
           "description": "",
-          "type": "dmss://system/SIMOS/blob_types/PDF",
+          "type": "dmss://system/SIMOS/PDF",
           "blob": {
             "name": "file1",
             "type": "dmss://system/SIMOS/Blob",
@@ -95,7 +95,7 @@ Feature: Update document that has blob data
         "another_pdf": {
           "name": "MyPDF2",
           "description": "",
-          "type": "dmss://system/SIMOS/blob_types/PDF",
+          "type": "dmss://system/SIMOS/PDF",
           "blob": {
             "name": "file2",
             "type": "dmss://system/SIMOS/Blob",
@@ -110,7 +110,7 @@ Feature: Update document that has blob data
           "a_pdf": {
             "name": "MyPDF3",
             "description": "",
-            "type": "dmss://system/SIMOS/blob_types/PDF",
+            "type": "dmss://system/SIMOS/PDF",
             "blob": {
               "name": "file3",
               "type": "dmss://system/SIMOS/Blob",
@@ -121,7 +121,7 @@ Feature: Update document that has blob data
           "another_pdf": {
             "name": "MyPDF4",
             "description": "",
-            "type": "dmss://system/SIMOS/blob_types/PDF",
+            "type": "dmss://system/SIMOS/PDF",
             "blob": {
               "name": "file4",
               "type": "dmss://system/SIMOS/Blob",

diff --git a/src/tests/bdd/steps/schemas.py b/src/tests/bdd/steps/schemas.py
@@ -50,7 +50,7 @@ def step_impl(context):
     logger_level_before = logger.level
     logger.setLevel("ERROR")
     import_package(
-        f"{config.APPLICATION_HOME}/system/SIMOS",
+        "SIMOS",
         context.user,
         is_root=True,
         data_source_name="system",

diff --git a/src/tests/unit/authentication/test_pat_data.py b/src/tests/unit/authentication/test_pat_data.py
@@ -1,5 +1,5 @@
 import unittest
-from datetime import datetime
+from datetime import UTC, datetime
 from uuid import UUID
 
 from authentication.models import AccessLevel, PATData
@@ -29,7 +29,7 @@ def test_dict(self):
             user_id="user1",
             roles=["role1", "role2"],
             scope=AccessLevel.READ,
-            expire=datetime.utcnow(),
+            expire=datetime.now(UTC),
         )
         as_dict = pat_data.dict()
         self.assertEqual(as_dict["_id"], "hash123")
@@ -38,7 +38,7 @@ def test_dict(self):
         self.assertEqual(as_dict["scope"], AccessLevel.READ)
 
     def test_uuid_default(self):
-        pat_data = PATData(user_id="user1", scope=AccessLevel.WRITE, expire=datetime.utcnow())
+        pat_data = PATData(user_id="user1", scope=AccessLevel.WRITE, expire=datetime.now(UTC))
 
         self.assertIsInstance(pat_data.uuid, str)
         try:

diff --git a/src/tests/unit/common/entity/validators/mock_data/CarRental.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/CarRental.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "CarRental",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"
   ],

diff --git a/src/tests/unit/common/entity/validators/mock_data/CarTest.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/CarTest.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "CarTest",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"
   ],

diff --git a/src/tests/unit/common/entity/validators/mock_data/EngineTest.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/EngineTest.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "EngineTest",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "description": "This describes an engine",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"

diff --git a/src/tests/unit/common/entity/validators/mock_data/FuelPumpTest.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/FuelPumpTest.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "FuelPumpTest",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "description": "This describes a fuel pump",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"

diff --git a/src/tests/unit/common/entity/validators/mock_data/RentalCar.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/RentalCar.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "RentalCar",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"
   ],

diff --git a/src/tests/unit/common/entity/validators/mock_data/WheelTest.blueprint.json b/src/tests/unit/common/entity/validators/mock_data/WheelTest.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "WheelTest",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"
   ],

diff --git a/src/tests/unit/common/tree/mock_data/mock_blueprints/Blueprint4.blueprint.json b/src/tests/unit/common/tree/mock_data/mock_blueprints/Blueprint4.blueprint.json
@@ -1,6 +1,6 @@
 {
   "name": "Blueprint4",
-  "type": "system/SIMOS/Blueprint",
+  "type": "dmss://system/SIMOS/Blueprint",
   "description": "Second blueprint",
   "extends": [
     "dmss://system/SIMOS/NamedEntity"