feat: Add tket1-passes subcrate (#939)

This introduces a way to call into TKET1's C++ library from here
(tket2). In writing this, it was my priority to

1. not complicate the build process for anyone that is not interested in
this functionality, and
2. not slow down CI too much.

By not including `tket1-passes` in Cargo's `default-members`, this will
not be compiled unless required explicitly. One way to simplify the
compilation process further would be to provide pre-compiled libraries
for the main platforms. This requires a certain maintenance burden on
us, however, which is why I haven't gone down this route (yet).

On CI speed: this uses a pre-compiled version of tket1, so that the
compilation times for the library are low (~30s). The library is
uploaded as artifact and re-used for every job. I've also amended the CI
job `rust-stable-no-features` to not compile `tket1-passes` (as well as
the other CLI tools that have no tests) for further speed up. A way to
speed up the CI further would be to cache the compiled library across
workflow runs. I'll create an issue for this.

Finally, a note on platform support: the current build scripts will
probably not work on Windows. I am not familliar with Windows tooling
and had no way of testing it. Is this something that must be tackled
before merging @aborgna-q ?

Closes #940

---------

Co-authored-by: Agustín Borgna <121866228+aborgna-q@users.noreply.github.com>
Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Author: 3 people

.github/actions/tket1-passes/action.yml

@@ -0,0 +1,46 @@
+name: "Build/cache tket1-passes C++ library"
+description: "Retrieve cached tket1-passes C++ library or build if needed"
+
+inputs:
+  lib-path:
+    description: "Path to the tket1-passes C++ library"
+    required: false
+    default: "tket1-passes/lib"
+
+runs:
+  using: composite
+  steps:
+    # Attempt to retrieve from cache
+    - name: Retrieve cached tket1-passes C++ library
+      uses: actions/cache/restore@v4
+      id: cache
+      with:
+        path: ${{ inputs.lib-path }}
+        key: ${{ runner.os }}-${{ hashFiles('tket1-passes/cpp/**') }}
+
+    # Build tket1-passes
+    - name: Install conan
+      if: steps.cache.outputs.cache-hit != 'true'
+      uses: turtlebrowser/get-conan@v1.2
+    - name: Set up conan
+      if: steps.cache.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        conan profile detect
+        conan remote add tket-libs https://quantinuumsw.jfrog.io/artifactory/api/conan/tket1-libs --index 0
+    - name: Build tket1-passes C++ library
+      if: steps.cache.outputs.cache-hit != 'true'
+      shell: bash
+      env:
+        TKET_LIB_PATH: "${{ inputs.lib-path }}"
+      run: |
+        cd tket1-passes/cpp
+        ./build.sh
+
+    # Upload cache
+    - name: Update tket1-passes C++ library cache
+      if: steps.cache.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v4
+      with:
+        path: ${{ inputs.lib-path }}
+        key: ${{ steps.cache.outputs.cache-primary-key }}

.github/change-filters.yml

@@ -11,6 +11,7 @@ rust:
   - "tket2-hseries/**"
   - "badger-optimiser/**"
   - "compile-rewriter/**"
+  - "tket1-passes/**"
 
 python:
   - *rust-core

.github/workflows/ci.yml

@@ -65,7 +65,7 @@ jobs:
 
   check-rs:
     name: Check Rust code 🦀
-    needs: changes
+    needs: [changes]
     if: ${{ needs.changes.outputs.rust == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -75,6 +75,8 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
         with:
           components: rustfmt, clippy
+      - name: Retrieve tket1-passes library
+        uses: ./.github/actions/tket1-passes
       - name: Check formatting
         run: cargo fmt -- --check
       - name: Install LLVM and Clang
@@ -153,13 +155,13 @@ jobs:
       - name: Configure default rust toolchain
         run: rustup override set ${{steps.toolchain.outputs.name}}
       - name: Build with no features
-        run: cargo test --verbose --workspace --no-default-features --no-run
+        run: cargo test --verbose -p tket2 -p tket2-py -p tket2-hseries --no-default-features --no-run
       - name: Tests with no features
-        run: cargo test --verbose --workspace --no-default-features
+        run: cargo test --verbose -p tket2 -p tket2-py -p tket2-hseries --no-default-features
 
   # Run tests on Rust stable
   tests-rs-stable-all-features:
-    needs: changes
+    needs: [changes]
     if: ${{ needs.changes.outputs.rust == 'true' }}
     runs-on: ubuntu-latest
     name: tests (Rust stable, all features)
@@ -169,21 +171,23 @@ jobs:
       - id: toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: 'stable'
+          toolchain: "stable"
       - name: Configure default rust toolchain
         run: rustup override set ${{steps.toolchain.outputs.name}}
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v2
         with:
           version: ${{ env.LLVM_VERSION }}
+      - name: Retrieve tket1-passes library
+        uses: ./.github/actions/tket1-passes
       - name: Build with all features
         run: cargo test --verbose --workspace --all-features --no-run
       - name: Tests with all features
         run: cargo test --verbose --workspace --all-features
 
   # Run tests on other toolchains
   tests-rs-other:
-    needs: changes
+    needs: [changes]
     if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }}
     runs-on: ubuntu-latest
     strategy:
@@ -204,6 +208,8 @@ jobs:
         uses: KyleMayes/install-llvm-action@v2
         with:
           version: ${{ env.LLVM_VERSION }}
+      - name: Retrieve tket1-passes library
+        uses: ./.github/actions/tket1-passes
       - name: Configure default rust toolchain
         run: rustup override set ${{steps.toolchain.outputs.name}}
       - name: Build with no features
@@ -216,7 +222,7 @@ jobs:
         run: cargo test --verbose --workspace --all-features
 
   tests-nightly-coverage:
-    needs: changes
+    needs: [changes]
     # Run only if there are changes in the relevant files
     if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }}
     runs-on: ubuntu-latest
@@ -234,6 +240,8 @@ jobs:
         uses: KyleMayes/install-llvm-action@v2
         with:
           version: ${{ env.LLVM_VERSION }}
+      - name: Retrieve tket1-passes library
+        uses: ./.github/actions/tket1-passes
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
       - name: Run tests with coverage instrumentation

.github/workflows/semver-checks.yml

@@ -42,8 +42,20 @@ jobs:
   rs-semver-checks:
     needs: [changes]
     if: ${{ needs.changes.outputs.rust == 'true' }}
-    uses: CQCL/hugrverse-actions/.github/workflows/rs-semver-checks.yml@main
-    with:
-      apt-dependencies: llvm-14
-    secrets:
-      GITHUB_PAT: ${{ secrets.HUGRBOT_PAT }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tket2
+        uses: actions/checkout@v4
+      - name: Retrieve tket1-passes library
+        uses: ./.github/actions/tket1-passes
+        with:
+          lib-path: ${{ github.workspace }}/tket1-lib
+      - name: Install LLVM from apt
+        run: |
+          echo "Installing apt dependencies: llvm-14"
+          sudo apt-get install -y llvm-14
+      - uses: CQCL/hugrverse-actions/rs-semver-checks@main
+        env:
+          TKET_LIB_PATH: ${{ github.workspace }}/tket1-lib
+        with:
+          token: ${{ secrets.HUGRBOT_PAT }}