Adapt change endpoints to new schema

Author: Yanni8

src/foxops/database/repositories/change/model.py

@@ -30,6 +30,8 @@ class ChangeInDB(BaseModel):
 
     merge_request_id: str | None
     merge_request_branch_name: str | None
+    initialized_by: int | None
+
     model_config = ConfigDict(from_attributes=True)
 
     @classmethod

src/foxops/database/repositories/change/repository.py

@@ -40,6 +40,7 @@ async def create_change(
         template_data_full: str,
         merge_request_id: str | None = None,
         merge_request_branch_name: str | None = None,
+        initialized_by: int | None = None,
     ) -> ChangeInDB:
         """
         Create a new change for the given incarnation with the given "revision" number.
@@ -67,6 +68,7 @@ async def create_change(
                     commit_pushed=commit_pushed,
                     merge_request_id=merge_request_id,
                     merge_request_branch_name=merge_request_branch_name,
+                    initialized_by=initialized_by,
                 )
                 .returning(*change.columns)
             )

src/foxops/models/change.py

@@ -4,6 +4,7 @@
 
 from foxops.engine import TemplateData
 from foxops.hosters.types import MergeRequestStatus
+from foxops.models.user import User
 
 
 class Change(BaseModel):
@@ -21,6 +22,8 @@ class Change(BaseModel):
     created_at: datetime
     commit_sha: str
 
+    initialized_by: User | None = None
+
 
 class ChangeWithMergeRequest(Change):
     merge_request_id: str

src/foxops/routers/changes.py

@@ -7,10 +7,12 @@
 
 from foxops.database.repositories.change.errors import ChangeNotFoundError
 from foxops.database.repositories.change.model import ChangeType as DatabaseChangeType
-from foxops.dependencies import get_change_service
+from foxops.dependencies import authorization, get_change_service
 from foxops.engine import TemplateData
 from foxops.hosters.types import MergeRequestStatus
 from foxops.models.change import Change, ChangeWithMergeRequest
+from foxops.models.user import User
+from foxops.services.authorization import AuthorizationService
 from foxops.services.change import CannotRepairChangeException, ChangeService
 
 router = APIRouter()
@@ -73,12 +75,15 @@ class ChangeDetails(BaseModel):
     created_at: datetime
     commit_sha: str
 
+    initialized_by: User | None = None
+
     merge_request_id: str | None = None
     merge_request_branch_name: str | None = None
     merge_request_status: MergeRequestStatus | None = None
 
     @classmethod
     def from_service_object(cls, obj: Change | ChangeWithMergeRequest) -> Self:
+        print(obj)
         match obj:
             case ChangeWithMergeRequest():
                 return cls(type=ChangeType.MERGE_REQUEST, **obj.model_dump())
@@ -93,19 +98,31 @@ async def create_change(
     incarnation_id: int,
     request: CreateChangeRequest,
     change_service: ChangeService = Depends(get_change_service),
+    authorization_serive: AuthorizationService = Depends(authorization),
 ) -> ChangeDetails:
     match request.change_type:
         case CreateChangeType.DIRECT:
             change = await change_service.create_change_direct(
-                incarnation_id, request.requested_version, request.requested_data
+                incarnation_id,
+                request.requested_version,
+                request.requested_data,
+                initialized_by=authorization_serive.current_user.id,
             )
         case CreateChangeType.MERGE_REQUEST_MANUAL:
             change = await change_service.create_change_merge_request(
-                incarnation_id, request.requested_version, request.requested_data, automerge=False
+                incarnation_id,
+                request.requested_version,
+                request.requested_data,
+                automerge=False,
+                initialized_by=authorization_serive.current_user.id,
             )
         case CreateChangeType.MERGE_REQUEST_AUTOMERGE:
             change = await change_service.create_change_merge_request(
-                incarnation_id, request.requested_version, request.requested_data, automerge=True
+                incarnation_id,
+                request.requested_version,
+                request.requested_data,
+                automerge=True,
+                initialized_by=authorization_serive.current_user.id,
             )
         case _:
             raise NotImplementedError(f"Unknown change type {request.change_type}")

src/foxops/routers/incarnations.py

@@ -220,10 +220,14 @@ async def reset_incarnation(
     incarnation_service: IncarnationService = Depends(get_incarnation_service),
     change_service: ChangeService = Depends(get_change_service),
     hoster: Hoster = Depends(get_hoster),
+    authorization_service: AuthorizationService = Depends(authorization),
 ):
     try:
         change = await change_service.reset_incarnation(
-            incarnation_id, request.requested_version, request.requested_data
+            incarnation_id,
+            request.requested_version,
+            request.requested_data,
+            initialized_by=authorization_service.current_user.id,
         )
     except ProvidedTemplateDataInvalidError as e:
         response.status_code = status.HTTP_400_BAD_REQUEST
@@ -257,6 +261,7 @@ async def _create_change(
     patch: bool,
     response: Response,
     change_service: ChangeService,
+    initialized_by: int,
 ) -> IncarnationWithDetails | ApiError:
     try:
         await change_service.create_change_merge_request(
@@ -265,6 +270,7 @@ async def _create_change(
             requested_data=requested_data,
             automerge=automerge,
             patch=patch,
+            initialized_by=initialized_by,
         )
     except ProvidedTemplateDataInvalidError as e:
         response.status_code = status.HTTP_400_BAD_REQUEST
@@ -334,6 +340,7 @@ async def update_incarnation(
     request: UpdateIncarnationRequest,
     change_service: ChangeService = Depends(get_change_service),
     incarnation_service: IncarnationService = Depends(get_incarnation_service),
+    authorization_serive: AuthorizationService = Depends(authorization),
 ):
     """Updates the incarnation to the given version and data.
 
@@ -378,6 +385,7 @@ async def update_incarnation(
         patch=False,
         response=response,
         change_service=change_service,
+        initialized_by=authorization_serive.current_user.id,
     )
 
 
@@ -442,6 +450,7 @@ async def patch_incarnation(
     request: PatchIncarnationRequest,
     change_service: ChangeService = Depends(get_change_service),
     incarnation_service: IncarnationService = Depends(get_incarnation_service),
+    authorization_serive: AuthorizationService = Depends(authorization),
 ):
     """Updates the incarnation to the given version and data.
 
@@ -492,6 +501,7 @@ async def patch_incarnation(
             patch=True,
             response=response,
             change_service=change_service,
+            initialized_by=authorization_serive.current_user.id,
         )
     else:
         try:

src/foxops/services/change.py

@@ -206,7 +206,9 @@ async def create_incarnation(
 
         return await self.get_change(change.id)
 
-    async def reset_incarnation(self, incarnation_id: int, version: str, data: TemplateData) -> ChangeWithMergeRequest:
+    async def reset_incarnation(
+        self, incarnation_id: int, version: str, data: TemplateData, initialized_by: int | None = None
+    ) -> ChangeWithMergeRequest:
         """
         Resets an incarnation by removing all customizations that were done to it
         ... and bring it back to a pristine state as if it was just created freshly from the template.
@@ -256,6 +258,7 @@ async def reset_incarnation(self, incarnation_id: int, version: str, data: Templ
                 requested_data=json.dumps(incarnation_state.template_data),
                 template_data_full=json.dumps(incarnation_state.template_data_full),
                 merge_request_branch_name=reset_branch_name,
+                initialized_by=initialized_by,
             )
 
             await self._push_change_commit_and_update_database(incarnation_git, change_in_db.id)
@@ -280,7 +283,7 @@ async def reset_incarnation(self, incarnation_id: int, version: str, data: Templ
         return await self.get_change_with_merge_request(change_in_db.id)
 
     async def create_change_direct(
-        self, incarnation_id: int, requested_version: str, requested_data: TemplateData
+        self, incarnation_id: int, requested_version: str, requested_data: TemplateData, initialized_by: int
     ) -> Change:
         """
         Perform a DIRECT change on the given incarnation.
@@ -315,6 +318,7 @@ async def create_change_direct(
                 requested_version=env.to_version,
                 requested_data=json.dumps(env.to_data),
                 template_data_full=json.dumps(env.to_data_full),
+                initialized_by=initialized_by,
             )
 
             # if some failure happens after this point, the database object can be cleaned
@@ -328,6 +332,7 @@ async def create_change_merge_request(
         incarnation_id: int,
         requested_version: str | None,
         requested_data: TemplateData,
+        initialized_by: int | None = None,
         automerge: bool = False,
         patch: bool = False,
     ) -> ChangeWithMergeRequest:
@@ -354,6 +359,7 @@ async def create_change_merge_request(
                 requested_data=json.dumps(env.to_data),
                 template_data_full=json.dumps(env.to_data_full),
                 merge_request_branch_name=env.branch_name,
+                initialized_by=initialized_by,
             )
 
             await self._push_change_commit_and_update_database(env.incarnation_repository, change_in_db.id)
@@ -454,6 +460,11 @@ async def get_change(self, change_id: int) -> Change:
         """
 
         change = await self._change_repository.get_change(change_id)
+
+        initialized_by = None
+        if change.initialized_by is not None:
+            initialized_by = await self._user_repository.get_by_id(change.initialized_by)
+
         if not change.commit_pushed:
             raise IncompleteChange(
                 "the given change is in an incomplete state (commit_pushed=False). "
@@ -470,6 +481,7 @@ async def get_change(self, change_id: int) -> Change:
             template_data_full=json.loads(change.template_data_full),
             created_at=change.created_at,
             commit_sha=change.commit_sha,
+            initialized_by=initialized_by,
         )
 
     async def get_change_with_merge_request(self, change_id: int) -> ChangeWithMergeRequest:

tests/routers/test_incarnations.py

@@ -230,4 +230,4 @@ async def test_api_get_diff_of_non_existing_incarnation_returns_not_found(
     response = await api_client.get("/incarnations/1/diff")
 
     assert response.status_code == HTTPStatus.NOT_FOUND
-    assert response.json() == {"message": "could not find incarnation in DB with id: 1"}
+    assert response.json() == {"message": "Incarnation with id '1' not found."}

tests/services/test_change.py

@@ -281,11 +281,11 @@ async def test_create_incarnation_fails_if_there_is_already_one_at_the_target(
 
 
 async def test_create_change_direct_succeeds_when_updating_the_template_version(
-    change_service: ChangeService, initialized_incarnation: Incarnation
+    change_service: ChangeService, initialized_incarnation: Incarnation, user: User
 ):
     # WHEN
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}, initialized_by=user.id
     )
 
     # THEN
@@ -302,11 +302,11 @@ async def test_create_change_direct_succeeds_when_updating_the_template_version(
 
 
 async def test_create_change_direct_succeeds_and_makes_new_template_variables_visible_in_the_foxops_api(
-    change_service: ChangeService, initialized_incarnation: Incarnation
+    change_service: ChangeService, initialized_incarnation: Incarnation, user: User
 ):
     # WHEN
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.3.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.3.0", requested_data={}, initialized_by=user.id
     )
 
     # THEN
@@ -324,10 +324,11 @@ async def test_create_change_direct_succeeds_when_updating_to_the_same_branch_na
     local_hoster: LocalHoster,
     initialized_incarnation: Incarnation,
     git_repo_template: str,
+    user: User,
 ):
     # GIVEN
     initial_change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="main", requested_data={}
+        initialized_incarnation.id, requested_version="main", requested_data={}, initialized_by=user.id
     )
     async with local_hoster.cloned_repository(git_repo_template) as repo:
         (repo.directory / "template" / "README.md").write_text("Hello, world - even more!")
@@ -336,7 +337,7 @@ async def test_create_change_direct_succeeds_when_updating_to_the_same_branch_na
 
     # WHEN
     new_change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="main", requested_data={}
+        initialized_incarnation.id, requested_version="main", requested_data={}, initialized_by=user.id
     )
 
     # THEN
@@ -352,9 +353,7 @@ async def test_create_change_direct_succeeds_when_updating_to_the_same_branch_na
 
 
 async def test_create_change_direct_succeeds_when_the_previous_change_was_not_merged(
-    change_service: ChangeService,
-    initialized_incarnation: Incarnation,
-    local_hoster: LocalHoster,
+    change_service: ChangeService, initialized_incarnation: Incarnation, local_hoster: LocalHoster, user: User
 ):
     # GIVEN
     unmerged_change = await change_service.create_change_merge_request(
@@ -369,29 +368,30 @@ async def test_create_change_direct_succeeds_when_the_previous_change_was_not_me
     # WHEN
     local_hoster.close_merge_request(initialized_incarnation.incarnation_repository, unmerged_change.merge_request_id)
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.2.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.2.0", requested_data={}, initialized_by=user.id
     )
 
     # THEN
     assert change.commit_sha != previous_commit_sha
 
 
 async def test_create_change_direct_succeeds_with_reverting_a_variable_back_to_its_default_value_if_not_explicitly_specified(
-    change_service: ChangeService,
-    initialized_incarnation: Incarnation,
-    local_hoster: LocalHoster,
+    change_service: ChangeService, initialized_incarnation: Incarnation, local_hoster: LocalHoster, user: User
 ):
     # GIVEN
     # ... the incarnation is at a version that requires a variable - and the variable was explicitly set
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.3.0", requested_data={"author": "John Doe"}
+        initialized_incarnation.id,
+        requested_version="v1.3.0",
+        requested_data={"author": "John Doe"},
+        initialized_by=user.id,
     )
     assert change.template_data_full["author"] == "John Doe"
 
     # WHEN
     # ... creating a change that no longer specifies the variable
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.3.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.3.0", requested_data={}, initialized_by=user.id
     )
 
     # THEN
@@ -514,11 +514,11 @@ async def test_list_changes(
 
 
 async def test_update_incomplete_change_recovers_from_unpushed_direct_change(
-    local_hoster: LocalHoster, change_service: ChangeService, initialized_incarnation: Incarnation
+    local_hoster: LocalHoster, change_service: ChangeService, initialized_incarnation: Incarnation, user: User
 ):
     # GIVEN
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}, initialized_by=user.id
     )
 
     # remove latest commit from repo
@@ -542,11 +542,11 @@ async def test_update_incomplete_change_recovers_from_unpushed_direct_change(
 
 
 async def test_update_incomplete_change_recovers_from_pushed_direct_change(
-    local_hoster: LocalHoster, change_service: ChangeService, initialized_incarnation: Incarnation
+    local_hoster: LocalHoster, change_service: ChangeService, initialized_incarnation: Incarnation, user: User
 ):
     # GIVEN
     change = await change_service.create_change_direct(
-        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}
+        initialized_incarnation.id, requested_version="v1.1.0", requested_data={}, initialized_by=user.id
     )
 
     # update database to reflect the missing update about the pushed change