[MAINT] Refactor and add test suite (#1)

* update version and name in pyproject

* commit old tests

* remove old tests

* add tests for run_argdump

* add clickdump as dependency

* add tests for run_clickdump.py

* add tests for update_descriptor.py

* refactor into a create_descriptor.sh script and add tests

* add pre-commit

* lint

* rename PR branch

* add CI workflow for tests

* rename test workflow

Author: michellewang

.github/workflows/run_tests.yml

@@ -0,0 +1,30 @@
+name: Run tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install . --group test
+
+      - name: Run tests
+        run: pytest

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+# To use to configure behavior of pre-commit ci
+# ci:
+#     skip: [hadolint-docker]
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-ast
+    -   id: check-case-conflict
+    -   id: check-json
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: check-toml
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.15.22
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+    -   id: codespell
+        args: [--toml=pyproject.toml]
+        additional_dependencies: [tomli]

__init__.py

@@ -70,63 +70,15 @@ runs:
 
         pip install -U pip
 
-        echo "::endgroup::"
-
-        echo "::group::Creating the dump file"
         if [[ "$PARSER_TYPE" == "click" ]]; then
-
-          # install clickdump
           pip install clickdump
-
-          # create dump from click command
-          CLICK_ARGS=(--output "$DUMP_FILE")
-          if [[ -n "$CLICK_PROG_NAME" ]]; then
-            CLICK_ARGS+=(--prog "$CLICK_PROG_NAME")
-          fi
-          if [[ -n "$CLICK_PARENT_LOCATION" ]]; then
-            CLICK_ARGS+=(--parent "$CLICK_PARENT_LOCATION")
-          fi
-          python ./scripts/run_clickdump.py "${CLICK_ARGS[@]}" $PARSER_LOCATION
         else
-
-          # install argdump
           pip install argdump
-
-          # create dump from argparse
-          python ./scripts/run_argdump.py --output $DUMP_FILE $PARSER_LOCATION
         fi
-        cat $DUMP_FILE
-        echo "::endgroup::"
-
-        echo "::group::Creating Boutiques descriptor from dump file"
-        npx -y --package @styx-api/cli styx build $DUMP_FILE --out styx-out --backend boutiques
-        echo "::endgroup::"
-
-        echo "::group::Moving descriptor to output path"
-        # move descriptor to output path
-        mkdir -p $(dirname $OUTPUT_PATH)
-        mv ./styx-out/boutiques/descriptor.json $OUTPUT_PATH
-        echo "::endgroup::"
 
-        echo "::group::Applying user-specified updates"
-        UPDATES_DESCRIPTOR_ARGS=()
-        if [[ "${EXCLUDE_VERSION}" == "true" ]]; then
-          UPDATES_DESCRIPTOR_ARGS+=(--remove-version)
-        fi
-        if [[ -n "${UPDATES_FILE}" ]]; then
-          UPDATES_DESCRIPTOR_ARGS+=(--updates-file ${{ github.workspace }}/${UPDATES_FILE})
-        fi
-        if [[ -n "${UPDATES_STR}" ]]; then
-          UPDATES_DESCRIPTOR_ARGS+=(--updates-str "${UPDATES_STR}")
-        fi
-        if [[ "${#UPDATES_DESCRIPTOR_ARGS[@]}" -gt 0 ]]; then
-          python ./scripts/update_descriptor.py --descriptor $OUTPUT_PATH "${UPDATES_DESCRIPTOR_ARGS[@]}"
-        fi
         echo "::endgroup::"
 
-        echo "::group::Final descriptor"
-        cat $OUTPUT_PATH
-        echo "::endgroup::"
+        bash ./scripts/create_descriptor.sh
       env:
         PARSER_TYPE: ${{ inputs.parser-type }}
         PARSER_LOCATION: ${{ inputs.parser-location }}
@@ -135,7 +87,7 @@ runs:
         CLICK_PROG_NAME: ${{ inputs.click-prog-name }}
         CLICK_PARENT_LOCATION: ${{ inputs.click-parent-location }}
         EXCLUDE_VERSION: ${{ inputs.exclude-version }}
-        UPDATES_FILE: ${{ inputs.updates-file }}
+        UPDATES_FILE: ${{ inputs.updates-file && format('{0}/{1}', github.workspace, inputs.updates-file) || '' }}
         UPDATES_STR: ${{ inputs.updates-str }}
       shell: bash
 
@@ -155,7 +107,7 @@ runs:
         SANITIZED="${{ inputs.parser-location }}"
         SANITIZED="${SANITIZED//./__}"
         SANITIZED="${SANITIZED//:/-}"
-        echo "branch=argparse-to-boutiques/${SANITIZED}" >> "$GITHUB_OUTPUT"
+        echo "branch=python-cli-to-boutiques/${SANITIZED}" >> "$GITHUB_OUTPUT"
       shell: bash
 
     - name: Open pull request

action.yml

@@ -1,19 +1,24 @@
 [project]
-name = "argparse-to-boutiques"
-version = "0.1.0"
+name = "python-cli-to-boutiques"
+version = "1.1.0"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [
     "argdump>=0.1.2",
+    "clickdump>=0.1.0",
 ]
 
 [project.optional-dependencies]
 validation = [
     "boutiques>=0.5.33",
 ]
 
+[tool.pytest.ini_options]
+pythonpath = ["scripts", "tests"]
+
 [dependency-groups]
-dev = [
+test = [
     "pytest>=8.4.2",
 ]
+dev = ["pre-commit", {include-group = "test"}]

conftest.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# -- Create dump file --
+if [[ "$PARSER_TYPE" == "click" ]]; then
+  CLICK_ARGS=(--output "$DUMP_FILE")
+  if [[ -n "$CLICK_PROG_NAME" ]]; then
+    CLICK_ARGS+=(--prog "$CLICK_PROG_NAME")
+  fi
+  if [[ -n "$CLICK_PARENT_LOCATION" ]]; then
+    CLICK_ARGS+=(--parent "$CLICK_PARENT_LOCATION")
+  fi
+  python ./scripts/run_clickdump.py "${CLICK_ARGS[@]}" "$PARSER_LOCATION"
+elif [[ "$PARSER_TYPE" == "argparse" ]]; then
+  python ./scripts/run_argdump.py --output "$DUMP_FILE" "$PARSER_LOCATION"
+else
+  echo "Error: PARSER_TYPE must be 'argparse' or 'click', got '$PARSER_TYPE'" >&2
+  exit 1
+fi
+cat "$DUMP_FILE"
+
+# -- Build Boutiques descriptor --
+npx -y --package @styx-api/cli styx build "$DUMP_FILE" --out styx-out --backend boutiques
+
+# -- Move to output path --
+mkdir -p "$(dirname "$OUTPUT_PATH")"
+mv ./styx-out/boutiques/descriptor.json "$OUTPUT_PATH"
+
+# -- Apply updates --
+UPDATES_DESCRIPTOR_ARGS=()
+if [[ "${EXCLUDE_VERSION}" == "true" ]]; then
+  UPDATES_DESCRIPTOR_ARGS+=(--remove-version)
+fi
+if [[ -n "${UPDATES_FILE}" ]]; then
+  UPDATES_DESCRIPTOR_ARGS+=(--updates-file "$UPDATES_FILE")
+fi
+if [[ -n "${UPDATES_STR}" ]]; then
+  UPDATES_DESCRIPTOR_ARGS+=(--updates-str "${UPDATES_STR}")
+fi
+if [[ "${#UPDATES_DESCRIPTOR_ARGS[@]}" -gt 0 ]]; then
+  python ./scripts/update_descriptor.py --descriptor "$OUTPUT_PATH" "${UPDATES_DESCRIPTOR_ARGS[@]}"
+fi
+
+# -- Print final descriptor --
+cat "$OUTPUT_PATH"

pyproject.toml

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 """Update a Boutiques descriptor JSON using dot/bracket path notation."""
 
+from __future__ import annotations
+
 import argparse
 import json
 import re
@@ -25,11 +27,15 @@ def set_at_path(obj: dict | list, path_parts: list[str | int], value) -> None:
     """Navigate *path_parts* through *obj* and set *value* at the leaf."""
     for part in path_parts[:-1]:
         if isinstance(part, int):
+            if not isinstance(obj, list):
+                raise TypeError(f"Expected list, got {type(obj).__name__}")
             obj = obj[part]
         else:
             if part not in obj:
                 obj[part] = {}
             obj = obj[part]
+    if isinstance(path_parts[-1], int) and not isinstance(obj, list):
+        raise TypeError(f"Expected list, got {type(obj).__name__}")
     obj[path_parts[-1]] = value