build: add CI/CD and a basic test

Author: daniel-makerx

.github/workflows/cd.yaml

@@ -0,0 +1,36 @@
+name: Continuous Delivery of Template
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: release
+
+jobs:
+  ci-check-python:
+    name: Check Python
+    uses: ./.github/workflows/check-python.yaml
+
+  tag-release:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v3
+
+      - name: Tag release
+        id: tag
+        uses: TriPSs/conventional-changelog-action@v3.18.0
+        with:
+          skip-commit: "true"
+          tag-prefix: ""
+          skip-on-empty: "false"
+          
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        if: ${{ steps.tag.outputs.skipped == 'false' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.tag.outputs.tag }}
+          body: ${{ steps.tag.outputs.clean_changelog }}

.github/workflows/check-python.yaml

@@ -0,0 +1,47 @@
+name: Check Template
+
+on:
+  workflow_call:
+
+jobs:
+  check-python:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v3
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Install algokit
+        run: pipx install algokit
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+
+      - name: Install dependencies
+        run: poetry install --no-interaction --no-root
+
+      - name: Configure git
+        shell: bash
+        run: |
+          # set git user and email as test invoke git
+          git config --global user.email "actions@github.com" && git config --global user.name "github-actions"
+
+      - name: Run tests
+        shell: bash
+        run: |
+          set -o pipefail
+          poetry run pytest --junitxml=pytest-junit.xml
+
+      - name: Check generated templates have been reviewed
+        shell: bash
+        run: |
+          # Add untracked files as empty so they come up in diff
+          git add -N ./tests_generated
+          # Look for changes in generated templates and error if there are any
+          git diff --exit-code --minimal ./tests_generated
+        working-directory: ${{ inputs.working-directory }}

.github/workflows/pr.yaml

@@ -0,0 +1,8 @@
+name: Pull Request validation
+
+on: [pull_request]
+
+jobs:
+  pr-check:
+    name: Check Python
+    uses: ./.github/workflows/check-python.yaml

poetry.lock

@@ -15,6 +15,7 @@ python-dotenv = "^1.0.0"
 ruff = "*"
 black = {extras = ["d"], version = "*"}
 mypy = "*"
+pytest = "^7.3.1"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -0,0 +1,104 @@
+import re
+import shutil
+import subprocess
+import tempfile
+from collections.abc import Iterator
+from pathlib import Path
+
+import pytest
+
+
+commit_pattern = re.compile(r"_commit: .*")
+src_path_pattern = re.compile(r"_src_path: .*")
+tests_path = Path(__file__).parent
+root = tests_path.parent
+generated_folder = "tests_generated"
+generated_root = root / generated_folder
+DEFAULT_PARAMETERS = {
+    "author_name": "None",
+    "author_email": "None",
+}
+
+
+@pytest.fixture(autouse=True, scope="module")
+def working_dir() -> Iterator[Path]:
+    with tempfile.TemporaryDirectory(ignore_cleanup_errors=True) as temp:
+        working_dir = Path(temp) / "template"
+        working_generated_root = working_dir / generated_folder
+        shutil.copytree(root, working_dir)
+        subprocess.run(["git", "add", "-A"], cwd=working_dir)
+        subprocess.run(["git", "commit", "-m", "draft changes", "--no-verify"], cwd=working_dir)
+
+        yield working_dir
+
+        for src_dir in working_generated_root.iterdir():
+            dest_dir = generated_root / src_dir.stem
+            shutil.rmtree(dest_dir, ignore_errors=True)
+            shutil.copytree(src_dir, dest_dir, dirs_exist_ok=True)
+
+
+def run_init(
+    working_dir: Path,
+    test_name: str,
+    *args: str,
+    template_url: str | None = None,
+    template_branch: str | None = None,
+    answers: dict[str, str] | None = None,
+) -> subprocess.CompletedProcess:
+    copy_to = working_dir / generated_folder / test_name
+    shutil.rmtree(copy_to, ignore_errors=True)
+    if template_url is None:
+        template_url = str(working_dir)
+
+        if template_branch is None:
+            git_output = subprocess.run(
+                ["git", "rev-parse", "--abbrev-ref", "HEAD"],
+                cwd=working_dir,
+                stdout=subprocess.PIPE,
+            )
+            template_branch = git_output.stdout.decode("utf-8").strip()
+
+    init_args = [
+        "algokit",
+        "init",
+        "--name",
+        str(copy_to.stem),
+        "--template-url",
+        template_url,
+        "--UNSAFE-SECURITY-accept-template-url",
+        "--defaults",
+        "--no-ide",
+        "--no-git",
+        "--no-bootstrap",
+    ]
+    answers = {**DEFAULT_PARAMETERS, **(answers or {})}
+
+    for question, answer in answers.items():
+        init_args.extend(["-a", question, answer])
+    if template_branch:
+        init_args.extend(["--template-url-ref", template_branch])
+    init_args.extend(args)
+
+    result = subprocess.run(
+        init_args,
+        input="y",  # acknowledge that input is not a tty
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        text=True,
+        cwd=copy_to.parent,
+    )
+
+    if result.returncode == 0:  # if successful, normalize .copier-answers.yml to make observing diffs easier
+        copier_answers = Path(copy_to / ".copier-answers.yml")
+        content = copier_answers.read_text("utf-8")
+        content = commit_pattern.sub("_commit: <commit>", content)
+        content = src_path_pattern.sub("_src_path: <src>", content)
+        copier_answers.write_text(content, "utf-8")
+
+    return result
+
+
+def test_default_parameters(working_dir: Path) -> None:
+    response = run_init(working_dir, "test_default_parameters")
+
+    assert response.returncode == 0

tests/test_templates.py

@@ -0,0 +1,11 @@
+# AlgoKit template generation answers
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: <commit>
+_src_path: <src>
+algod_port: 4001
+algod_server: http://localhost
+algod_token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+indexer_port: 8980
+indexer_server: http://localhost
+indexer_token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+

tests_generated/test_default_parameters/.copier-answers.yml

@@ -0,0 +1,11 @@
+# Consistent IDE settings: https://editorconfig.org/
+root=true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+indent_size = 4

tests_generated/test_default_parameters/.editorconfig

@@ -0,0 +1,2 @@
+# Git configuration: https://git-scm.com/docs/gitattributes
+* text=auto eol=lf