Remove unsupported allow_import parameter (#18)

remove support for allow_import when creating incarnation

(it's no longer supported by foxops)

Author: defreng

.gitignore

@@ -2,5 +2,6 @@
 **/.pytest_cache/
 **/.mypy_cache/
 .coverage
+.dmypy.json
 .idea/
 dist/

Makefile

@@ -3,3 +3,17 @@ clean:
 	docker ps -aq --filter "label=creator=pytest-docker-tools" | xargs docker rm -f
 	docker volume ls --filter "label=creator=pytest-docker-tools" --format '{{ .Name }}' | xargs docker volume rm
 	docker network ls --filter "label=creator=pytest-docker-tools" --format '{{ .Name }}' | xargs docker network rm
+
+fmt:
+	poetry run black src tests
+	poetry run isort src tests
+
+lint:
+	poetry run black --check --diff src tests
+	poetry run isort --check-only src tests
+	poetry run flake8 src tests
+
+typecheck:
+	poetry run dmypy run -- src tests
+
+pre-commit: fmt lint typecheck

poetry.lock

@@ -10,20 +10,20 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = ">=3.11,<4.0"
-httpx = "^0.23.0"
+httpx = "^0.24.1"
 tenacity = "^8.0.1"
-structlog = ">=21.2,<23.0"
+structlog = "^23.1.0"
 
 [tool.poetry.group.dev.dependencies]
 # Linting
-black = {extras = ["d"], version = "^22.10.0"}
-flake8 = "^5.0.4"
-flake8-bugbear = "^22.9.23"
+black = "^23.7.0"
+flake8 = "^6.1.0"
+flake8-bugbear = "^23.7.10"
 isort = "^5.9.3"
 
 # Testing
 pytest = "^7.1.3"
-pytest-asyncio = "^0.20.1"
+pytest-asyncio = "^0.21.1"
 pytest-cov = "^4.0.0"
 pytest-docker-tools = "^3.1.3"
 pytest-mock = "^3.10.0"

pyproject.toml

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Tuple
+from typing import Any
 
 import httpx
 from httpx import Response
@@ -135,15 +135,7 @@ async def create_incarnation(
         template_data: dict[str, str],
         target_directory: str | None = None,
         automerge: bool | None = None,
-        allow_import: bool | None = None,
-    ) -> Tuple[bool, IncarnationWithDetails]:
-        """
-        Call the FoxOps API to create a new incarnation.
-
-        Returns a tuple of (imported, incarnation), where imported is a boolean that is True if the incarnation
-        already existed and was added to the foxops inventory. This can only be True if the allow_import parameter
-        is set to True.
-        """
+    ) -> IncarnationWithDetails:
         data: dict[str, Any] = {
             "incarnation_repository": incarnation_repository,
             "template_repository": template_repository,
@@ -155,17 +147,11 @@ async def create_incarnation(
         if automerge is not None:
             data["automerge"] = automerge
 
-        params = {}
-        if allow_import is not None:
-            params["allow_import"] = allow_import
-
-        resp = await self.retry_function(self.client.post)("/api/incarnations", params=params, json=data)
+        resp = await self.retry_function(self.client.post)("/api/incarnations", json=data)
 
         match resp.status_code:
-            case httpx.codes.OK:
-                return True, IncarnationWithDetails.from_dict(resp.json())
             case httpx.codes.CREATED:
-                return False, IncarnationWithDetails.from_dict(resp.json())
+                return IncarnationWithDetails.from_dict(resp.json())
             case httpx.codes.BAD_REQUEST:
                 self.log.error(f"received error from FoxOps API: {resp.status_code} {resp.headers} {resp.text}")
                 raise FoxopsApiError(resp.json()["message"])

src/foxops_client/client_async.py

@@ -1,5 +1,4 @@
 import asyncio
-from typing import Tuple
 
 from foxops_client.client_async import AsyncFoxopsClient
 from foxops_client.types import Incarnation, IncarnationWithDetails
@@ -60,8 +59,7 @@ def create_incarnation(
         template_data: dict[str, str],
         target_directory: str | None = None,
         automerge: bool | None = None,
-        allow_import: bool | None = None,
-    ) -> Tuple[bool, IncarnationWithDetails]:
+    ) -> IncarnationWithDetails:
         return self.loop.run_until_complete(
             self.client.create_incarnation(
                 incarnation_repository,
@@ -70,6 +68,5 @@ def create_incarnation(
                 template_data,
                 target_directory=target_directory,
                 automerge=automerge,
-                allow_import=allow_import,
             )
         )

src/foxops_client/client_sync.py

@@ -25,15 +25,14 @@ def test_create_incarnation(gitlab_api_client, foxops_client: FoxopsClient, temp
     incarnation_path = gitlab_project_factory(return_path=True)
 
     # WHEN
-    imported, incarnation = foxops_client.create_incarnation(
+    incarnation = foxops_client.create_incarnation(
         incarnation_repository=incarnation_path,
         template_repository=template_path,
         template_repository_version="main",
         template_data={"input_variable": "foo"},
     )
 
     # THEN
-    assert imported is False
     assert incarnation.id is not None
 
     assert incarnation.incarnation_repository == incarnation_path
@@ -42,28 +41,6 @@ def test_create_incarnation(gitlab_api_client, foxops_client: FoxopsClient, temp
     assert incarnation.template_data == {"input_variable": "foo"}
 
 
-def test_create_incarnation_import_with_existing_incarnation(incarnation, foxops_client: FoxopsClient):
-    # GIVEN
-    foxops_client.delete_incarnation(incarnation.id)
-
-    # WHEN
-    imported, response = foxops_client.create_incarnation(
-        incarnation_repository=incarnation.incarnation_repository,
-        template_repository=incarnation.template_repository,
-        template_repository_version=incarnation.template_repository_version,
-        template_data=incarnation.template_data,
-        allow_import=True,
-    )
-
-    # THEN
-    assert imported is True
-
-    assert response.incarnation_repository == incarnation.incarnation_repository
-    assert response.template_repository == incarnation.template_repository
-    assert response.template_repository_version == "main"
-    assert response.template_data == {"input_variable": "foo"}
-
-
 def test_create_incarnation_with_conflicting_existing_incarnation(incarnation, foxops_client):
     # WHEN
     with pytest.raises(FoxopsApiError) as e:
@@ -148,7 +125,7 @@ def create_incarnation(template, gitlab_project_factory, foxops_client):
     template_path = template
     incarnation_path = gitlab_project_factory(return_path=True)
 
-    _, incarnation = foxops_client.create_incarnation(
+    incarnation = foxops_client.create_incarnation(
         incarnation_repository=incarnation_path,
         template_repository=template_path,
         template_repository_version="main",