Add test to validate examples in the main PALS repository (#55)

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

Author: EZoni

.github/workflows/tests.yml .github/workflows/examples.yml.github/workflows/tests.yml renamed to .github/workflows/examples.yml

@@ -7,15 +7,15 @@ on:
   pull_request:
 
 concurrency:
-  group: ${{ github.ref }}-${{ github.head_ref }}-pals-python
+  group: ${{ github.ref }}-${{ github.head_ref }}-examples
   cancel-in-progress: true
 
 permissions:
   contents: read  # access to check out code and install dependencies
 
 jobs:
-  tests:
-    name: tests
+  examples:
+    name: examples
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -30,9 +30,6 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install ".[test]"
-      - name: Test
-        run: |
-          pytest tests -v
-      - name: Examples
+      - name: Run examples
         run: |
           python examples/fodo.py

.github/workflows/standard_examples.yml

@@ -0,0 +1,45 @@
+name: pals
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.head_ref }}-standard-examples
+  cancel-in-progress: true
+
+permissions:
+    contents: read  # access to check out code and install dependencies
+
+jobs:
+  standard-examples:
+    name: standard examples
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Checkout PALS repository
+        uses: actions/checkout@v6
+        with:
+          repository: pals-project/pals
+          path: pals_temp
+          fetch-depth: 1
+          sparse-checkout: |
+            examples/
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+      - name: Run standard examples
+        run: |
+          for file in pals_temp/examples/*.pals.yaml; do
+            python tests/validate_standard_examples.py --path "${file}"
+          done

.github/workflows/unit_tests.yml

@@ -0,0 +1,35 @@
+name: pals
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.head_ref }}-unit-tests
+  cancel-in-progress: true
+
+permissions:
+  contents: read  # access to check out code and install dependencies
+
+jobs:
+  unit-tests:
+    name: unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+      - name: Run unit tests
+        run: |
+          pytest tests -v

src/pals/kinds/mixin/all_element_mixin.py

@@ -61,7 +61,17 @@ def unpack_element_list_structure(
                     f"but we got {item!r}"
                 )
             name, fields = list(item.items())[0]
+            # In addition to the existing shorthand `- element_name`
+            # (a plain string reference), also allow the alternative
+            # reference syntax `- use: element_name`.
+            # If the value is not a dict but the key is 'use',
+            # treat it as a reference to an existing element name
+            # and wrap it in a PlaceholderName so downstream code
+            # can resolve it.
             if not isinstance(fields, dict):
+                if name == "use" and isinstance(fields, str):
+                    new_list.append(PlaceholderName(fields))
+                    continue
                 raise TypeError(
                     f"Value for element key {name!r} must be a dict (the element's properties), "
                     f"but we got {fields!r}"

tests/validate_standard_examples.py

@@ -0,0 +1,49 @@
+"""Utility script to validate standard PALS example files.
+
+This script is not run by pytest and is intended to be used as a standalone script.
+Run it from the repository root like:
+
+    python tests/validate_standard_examples.py --path /path/to/example.pals.yaml
+
+Before running, download the desired standard PALS example files from pals-project/pals/examples.
+"""
+
+import argparse
+
+from pals import load
+from pals.kinds import PlaceholderName
+from pals.kinds.BeamLine import BeamLine
+from pals.kinds.Drift import Drift
+from pals.kinds.Lattice import Lattice
+from pals.kinds.Quadrupole import Quadrupole
+
+
+def main():
+    # Parse command-line arguments
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--path",
+        required=True,
+        help="Path to the example file",
+    )
+    args = parser.parse_args()
+    example_file = args.path
+    # Parse and validate YAML data from file
+    lattice = load(example_file)
+    # The following assertions are based on the standard PALS example file
+    # fodo.pals.yaml from pals-project/pals/examples
+    assert isinstance(lattice.facility[0], Drift)
+    assert lattice.facility[0].name == "drift1"
+    assert isinstance(lattice.facility[1], Quadrupole)
+    assert lattice.facility[1].name == "quad1"
+    assert isinstance(lattice.facility[2], BeamLine)
+    assert lattice.facility[2].name == "fodo_cell"
+    assert isinstance(lattice.facility[3], BeamLine)
+    assert lattice.facility[3].name == "fodo_channel"
+    assert isinstance(lattice.facility[4], Lattice)
+    assert lattice.facility[4].name == "fodo_lattice"
+    assert isinstance(lattice.facility[5], PlaceholderName)
+
+
+if __name__ == "__main__":
+    main()