microsoft/openvmm
Publicmirrored from https://github.com/microsoft/openvmmAvailable
Guide/src/dev_guide/dev_tools/xflowey.md
23lines · modecode
| 1 | # cargo xflowey |
| 2 | |
| 3 | To implement various developer workflows (both locally, as well as in CI), the |
| 4 | OpenVMM project relies on [`flowey`](./flowey/flowey.md): a custom, in-house Rust library/framework |
| 5 | for writing maintainable, cross-platform automation. |
| 6 | |
| 7 | `cargo xflowey` is a cargo alias that makes it easy for developers to run |
| 8 | `flowey`-based pipelines locally. |
| 9 | |
| 10 | Some particularly notable pipelines: |
| 11 | |
| 12 | - `cargo xflowey build-igvm` - primarily dev-tool used to build OpenHCL IGVM files locally |
| 13 | - `cargo xflowey restore-packages` - restores external packages needed to compile and run OpenVMM / OpenHCL |
| 14 | - `cargo xflowey vmm-tests-run` - build and run VMM tests with automatic artifact discovery. Use `--filter "test(name)"` to run specific tests |
| 15 | - `cargo xflowey cca-tests` - build and run ARM64 CCA tests using software emulator |
| 16 | |
| 17 | ## `xflowey` vs `xtask` |
| 18 | |
| 19 | In a nutshell: |
| 20 | |
| 21 | - `cargo xtask`: implements novel, standalone tools/utilities |
| 22 | - `cargo xflowey`: orchestrates invoking a sequence of tools/utilities, without |
| 23 | doing any non-trivial data processing itself |
| 24 | |