Merge pull request #80 from guzman-raphael/diagram-test

Improve diagram generation

Author: Synicix

.clippy.toml

@@ -6,10 +6,14 @@ allowed-duplicate-crates = [
     "clap",
     "clap_derive",
     "clap_lex",
+    "getrandom",
     "hashbrown",
     "heck",
     "indexmap",
     "strsim",
     "syn",
+    "thiserror",
+    "thiserror-impl",
+    "wasi",
     "windows-sys",
 ]

.github/actions/build-diagram/action.yaml

@@ -0,0 +1,31 @@
+name: Build Diagram
+runs:
+  using: composite  
+  steps:
+    - shell: bash
+      run: |
+        : Install dependencies
+        sudo apt-get update
+        sudo apt-get install graphviz -y
+        cargo install cargo-modules
+    - shell: bash
+      run: |
+        : Generate crate diagram
+        mkdir -p docs/images
+        set -o pipefail
+        cargo modules dependencies --lib --max-depth 0 \
+          --no-uses --no-fns \
+          --focus-on "
+            orcapod::uniffi::{
+              model::{Pod,PodJob,PodResult},
+              store::filestore::LocalFileStore,
+              orchestrator::{PodRun,docker::LocalDockerOrchestrator},
+            }
+          " \
+          --layout dot | \
+          dot -T svg > docs/images/orcapod_diagram.svg
+    - uses: actions/upload-artifact@v4
+      with:
+        name: orcapod_diagram
+        path: docs/images/orcapod_diagram.svg
+        retention-days: 1

.github/workflows/docs.yaml

@@ -6,11 +6,6 @@ jobs:
     if: github.repository_owner == 'walkerlab' && github.event.pusher.name != 'walkerlab-repo-writer[bot]'
     runs-on: ubuntu-latest
     steps:
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install graphviz -y
-          cargo install cargo-modules
       - uses: actions/create-github-app-token@v1
         id: generate_app_token
         with:
@@ -19,20 +14,13 @@ jobs:
       - uses: actions/checkout@v4
         with:
           token: ${{ steps.generate_app_token.outputs.token }}
-      - name: Generate crate diagram
-        run: |
-          mkdir -p docs/images
-          set -o pipefail
-          cargo modules dependencies --lib \
-            --no-uses --no-fns \
-            --focus-on "orcapod::uniffi::model::{Pod}" \
-            --layout dot | \
-            dot -T svg > docs/images/crate_diagram.svg
+      - name: Build Diagram
+        uses: ./.github/actions/build-diagram
       - name: Sync GitHub
         run: |
           git config user.name github-actions
           git config user.email [email protected]
-          git add docs/images/crate_diagram.svg
+          git add docs/images/*
           git commit -m "Update crate diagram." || echo "Diagram unchanged, skipping commit."
           git push
   api:

.github/workflows/tests.yaml

@@ -2,7 +2,13 @@ name: Tests
 on:
   - pull_request
 jobs:
-  tests:
+  diagram:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build Diagram
+        uses: ./.github/actions/build-diagram
+  syntax-style-format-and-integration:
     runs-on: ubuntu-latest
     env:
       CARGO_TERM_COLOR: always

README.md

@@ -4,7 +4,7 @@
 
 # orcapod
 
-![orcapod crate diagram](docs/images/crate_diagram.svg "Orcapod Crate Diagram")
+![orcapod crate diagram](docs/images/orcapod_diagram.svg "Orcapod Crate Diagram")
 
 ## Tests
 
@@ -23,9 +23,9 @@ cargo llvm-cov --ignore-filename-regex "bin/.*|lib\.rs" --cobertura --output-pat
 
 ```bash
 cargo doc --no-deps                       # gen api docs (target/doc/orcapod/index.html)
-cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot > docs/images/crate_diagram.dot # orcapod diagram as DOT
-cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot | dot -T png > docs/images/crate_diagram.png # orcapod diagram as PNG
-cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot | dot -T svg > docs/images/crate_diagram.svg # orcapod diagram as SVG
+cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::{model::{Pod,PodJob,PodResult},store::filestore::LocalFileStore,orchestrator::{PodRun,docker::LocalDockerOrchestrator}}" --layout dot > docs/images/orcapod_diagram.dot # orcapod diagram as DOT
+cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::{model::{Pod,PodJob,PodResult},store::filestore::LocalFileStore,orchestrator::{PodRun,docker::LocalDockerOrchestrator}}" --layout dot | dot -T png > docs/images/orcapod_diagram.png # orcapod diagram as PNG
+cargo modules dependencies --lib --no-uses --no-fns --focus-on "orcapod::uniffi::{model::{Pod,PodJob,PodResult},store::filestore::LocalFileStore,orchestrator::{PodRun,docker::LocalDockerOrchestrator}}" --layout dot | dot -T svg > docs/images/orcapod_diagram.svg # orcapod diagram as SVG
 ```
 
 ## Project Management

cspell.json

@@ -71,6 +71,8 @@
         "maturin",
         "ipykernel",
         "getset",
-        "strsim"
+        "strsim",
+        "getrandom",
+        "wasi"
     ]
 }