fix: deep_import on a repository loading (#62)

howbazaar · web-flow · commit e169b9c8f9f3 · 2024-07-30T14:08:56.000-07:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @stacklet/platform
+* @stacklet/engineering
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -12,53 +12,70 @@ jobs:
   Lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2.2.1
+      - uses: actions/checkout@v4
+      - uses: wistia/parse-tool-versions@v1.0
+      - uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: ${{ env.PYTHON_TOOL_VERSION }}
       - name: Linting
         run: |
           pip install pre-commit
           pre-commit run --all-files
 
   Tests:
+    name: Run the tests against .tool-versions python
     needs: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2.2.1
+      - uses: actions/checkout@v4
+      - uses: wistia/parse-tool-versions@v1.0
+      - uses: extractions/setup-just@v1
+        with:
+          just-version: ${{ env.JUST_TOOL_VERSION }}
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
         with:
-          python-version: "3.9"
+          version: ${{ env.POETRY_TOOL_VERSION }}
+          virtualenvs-in-project: true
 
-      - name: Install poetry
-        shell: bash
-        run: |
-          curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
-          echo "$HOME/.local/bin" >> $GITHUB_PATH
+      - name: Set up Python ${{ env.PYTHON_TOOL_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_TOOL_VERSION }}
+          cache: poetry
 
-      - name: Configure poetry
+      - name: Install dependencies
         shell: bash
-        run: poetry config virtualenvs.in-project true
+        run: poetry install
+
+      - name: Pytest run
+        run: just test -v
 
-      - name: Set up cache
-        uses: actions/cache@v2.1.4
-        id: cache
+  OldestPython:
+    name: Run the tests against python 3.9 (oldest supported version)
+    needs: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wistia/parse-tool-versions@v1.0
+      - uses: extractions/setup-just@v1
         with:
-          path: |
-            .venv
-            ~/.cache
-          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
+          just-version: ${{ env.JUST_TOOL_VERSION }}
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: ${{ env.POETRY_TOOL_VERSION }}
+          virtualenvs-in-project: true
 
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        shell: bash
-        run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+          cache: poetry
 
       - name: Install dependencies
         shell: bash
         run: poetry install
 
       - name: Pytest run
-        shell: bash
-        run: poetry run pytest --cov=stacklet_cli -v tests
+        run: just test -v
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -8,16 +8,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: wistia/parse-tool-versions@v1.0
+      - uses: extractions/setup-just@v1
         with:
-          python-version: "3.9"
+          just-version: ${{ env.JUST_TOOL_VERSION }}
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1
         with:
-          version: 1.5.1
+          version: ${{ env.POETRY_TOOL_VERSION }}
+          virtualenvs-in-project: true
+
+      - name: Set up Python ${{ env.PYTHON_TOOL_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_TOOL_VERSION }}
+          cache: poetry
+
       - name: Build a binary wheel and a source tarball
         run: poetry build
+
       - name: Store the distribution packages
         uses: actions/upload-artifact@v3
         with:
diff --git a/.tool-versions b/.tool-versions
@@ -1,3 +1,3 @@
 just 1.13.0
-poetry 1.5.1
-python 3.9.15
+poetry 1.8.3
+python 3.11.3
diff --git a/stacklet/client/platform/commands/policycollection.py b/stacklet/client/platform/commands/policycollection.py
@@ -183,6 +183,7 @@ class AddPolicyCollectionItem(StackletGraphqlSnippet):
     }
 
     optional = {"policy_version": "Policy Version"}
+    variable_transformers = {"policy_version": lambda x: x and int(x)}
 
 
 @StackletGraphqlExecutor.registry.register("remove-policy-collection-item")
diff --git a/stacklet/client/platform/commands/repository.py b/stacklet/client/platform/commands/repository.py
@@ -61,6 +61,9 @@ class AddRepositorySnippet(StackletGraphqlSnippet):
         },
         "deep_import": "Deep Import Repository true | false",
     }
+    variable_transformers = {
+        "deep_import": lambda x: x and x.lower() in ("true", "t", "yes", "y")
+    }
 
 
 @StackletGraphqlExecutor.registry.register("process-repository")
diff --git a/stacklet/client/platform/graphql.py b/stacklet/client/platform/graphql.py
@@ -4,7 +4,7 @@
 
 class StackletGraphqlSnippet:
     """
-    A resusable Graphql Snippet
+    A reusable Graphql Snippet
 
     Define required variables with the required class attribute and optional
     variables with the optional class attribute. The value can either be a string
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -6,7 +6,7 @@
 from tempfile import NamedTemporaryFile
 import textwrap
 
-from utils import BaseCliTest
+from .utils import BaseCliTest
 
 
 class AdminCliTest(BaseCliTest):
diff --git a/tests/test_graphql.py b/tests/test_graphql.py
@@ -5,7 +5,7 @@
 import yaml
 from unittest.mock import patch
 
-from utils import BaseCliTest, get_executor_adapter
+from .utils import BaseCliTest, get_executor_adapter
 
 
 class GraphqlTest(BaseCliTest):
diff --git a/tests/test_policy_collection.py b/tests/test_policy_collection.py
@@ -0,0 +1,35 @@
+import uuid
+
+from .utils import BaseCliTest, JSONDict
+
+
+class TestPolicyCollection(BaseCliTest):
+    def test_add_item(self):
+        "Ensure that the policy version is converted properly."
+        pc_uuid = str(uuid.uuid4())
+        policy_uuid = str(uuid.uuid4())
+
+        # Only giving a partial response because that isn't what we're testing.
+        response = JSONDict(
+            data={
+                "addPolicyCollectionItems": {
+                    "collection": {"id": "something-opaque", "uuid": pc_uuid}
+                }
+            }
+        )
+        res, body = self.run_query(
+            "policy-collection",
+            [
+                "add-item",
+                f"--uuid={pc_uuid}",
+                f"--policy-uuid={policy_uuid}",
+                "--policy-version=42",
+            ],
+            response,
+        )
+        # Check the variable conversion.
+        assert body["variables"] == {
+            "uuid": pc_uuid,
+            "policy_uuid": policy_uuid,
+            "policy_version": 42,
+        }
diff --git a/tests/test_repository.py b/tests/test_repository.py
@@ -2,56 +2,51 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import json
+from typing import Optional
+from textwrap import dedent
 from unittest.mock import patch
 
-from utils import BaseCliTest, get_executor_adapter
+from click.testing import Result
+
+from .utils import BaseCliTest, get_executor_adapter, JSONDict
 
 
 class RepositoryTest(BaseCliTest):
-    def test_add_repository(self):
-        executor, adapter = get_executor_adapter()
-        adapter.register_uri(
-            "POST",
-            "mock://stacklet.acme.org/api",
-            json={
-                "data": {
+    def run_query(
+        self, args: list[str], response: Optional[JSONDict] = None
+    ) -> tuple[Result, JSONDict]:
+        if response is None:
+            response = JSONDict(
+                data={
                     "addRepository": {
                         "url": "mock://git.acme.org/stacklet/policies.git",
                         "name": "test-policies",
                     }
                 }
-            },
+            )
+        return super().run_query("repository", args, response)
+
+    def test_add_repository(self):
+        res, body = self.run_query(
+            [
+                "add",
+                "--url=mock://git.acme.org/stacklet/policies.git",
+                "--name=test-policies",
+            ]
         )
+        assert res.output == dedent(
+            """\
+            data:
+              addRepository:
+                name: test-policies
+                url: mock://git.acme.org/stacklet/policies.git
 
-        with patch(
-            "stacklet.client.platform.executor.requests.Session", autospec=True
-        ) as patched:
-            with patch(
-                "stacklet.client.platform.executor.get_token", return_value="foo"
-            ):
-                patched.return_value = executor.session
-                res = self.runner.invoke(
-                    self.cli,
-                    [
-                        "repository",
-                        "--api=mock://stacklet.acme.org/api",
-                        "--cognito-region=us-east-1",
-                        "--cognito-user-pool-id=foo",
-                        "--cognito-client-id=bar",
-                        "add",
-                        "--url=mock://git.acme.org/stacklet/policies.git",
-                        "--name=test-policies",
-                    ],
-                )
-                self.assertEqual(res.exit_code, 0)
-                self.assertEqual(
-                    res.output,
-                    "data:\n  addRepository:\n    name: test-policies\n    url: mock://git.acme.org/stacklet/policies.git\n\n",  # noqa
-                )
-                body = json.loads(adapter.last_request.body.decode("utf-8"))
-                self.assertEqual(
-                    body["query"].strip(),
-                    """mutation ($url: String!, $name: String!) {
+            """
+        )
+
+        assert (
+            body["query"].strip()
+            == """mutation ($url: String!, $name: String!) {
       addRepository(
         input: {
           url: $url
@@ -63,8 +58,51 @@ def test_add_repository(self):
             name
         }
       }
-    }""",
-                )
+    }"""
+        )
+
+    def test_add_repository_deep(self):
+        res, body = self.run_query(
+            [
+                "add",
+                "--url=mock://git.acme.org/stacklet/policies.git",
+                "--name=test-policies",
+                "--deep-import=true",
+            ]
+        )
+        assert res.output == dedent(
+            """\
+            data:
+              addRepository:
+                name: test-policies
+                url: mock://git.acme.org/stacklet/policies.git
+
+            """
+        )
+
+        assert (
+            body["query"].strip()
+            == """mutation ($url: String!, $name: String!, $deep_import: Boolean!) {
+      addRepository(
+        input: {
+          url: $url
+          name: $name
+          deepImport: $deep_import
+        }
+      ) {
+        repository {
+            url
+            name
+        }
+      }
+    }"""
+        )
+        # Check the conversion of string to bool.
+        assert body["variables"] == {
+            "deep_import": True,
+            "name": "test-policies",
+            "url": "mock://git.acme.org/stacklet/policies.git",
+        }
 
     def test_process_repository(self):
         executor, adapter = get_executor_adapter()
diff --git a/tests/utils.py b/tests/utils.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @stacklet/platform`
	`1`	`+* @stacklet/engineering`
Original file line number	Diff line number	Diff line change
`@@ -183,6 +183,7 @@ class AddPolicyCollectionItem(StackletGraphqlSnippet):`
`183`	`183`	`}`
`184`	`184`
`185`	`185`	`optional = {"policy_version": "Policy Version"}`
	`186`	`+ variable_transformers = {"policy_version": lambda x: x and int(x)}`
`186`	`187`
`187`	`188`
`188`	`189`	`@StackletGraphqlExecutor.registry.register("remove-policy-collection-item")`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ class AddRepositorySnippet(StackletGraphqlSnippet):`
`61`	`61`	`},`
`62`	`62`	`"deep_import": "Deep Import Repository true \| false",`
`63`	`63`	`}`
	`64`	`+ variable_transformers = {`
	`65`	`+ "deep_import": lambda x: x and x.lower() in ("true", "t", "yes", "y")`
	`66`	`+ }`
`64`	`67`
`65`	`68`
`66`	`69`	`@StackletGraphqlExecutor.registry.register("process-repository")`