diff --git a/.clippy.toml b/.clippy.toml index 39a1dcb0..c8c25d34 100644 --- a/.clippy.toml +++ b/.clippy.toml @@ -1,15 +1,15 @@ excessive-nesting-threshold = 4 too-many-arguments-threshold = 10 -allowed-prefixes = ["..", "GPU", "Orca", "Local"] -min-ident-chars-threshold = 2 allowed-idents-below-min-chars = ["..", "k", "f", "re", "id", "Ok", "'_"] allowed-duplicate-crates = [ - "hashbrown", - "indexmap", - "windows-sys", - "thiserror", - "thiserror-impl", "bitflags", + "clap", + "clap_derive", + "clap_lex", + "hashbrown", "heck", + "indexmap", + "strsim", "syn", + "windows-sys", ] diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index d98b6b5d..6a0d22a1 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -20,6 +20,7 @@ RUN \ echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers && \ echo '. /etc/bash_completion' >> /home/vscode/.bashrc && \ echo 'export PS1="\[\e[32;1m\]\u\[\e[m\]@\[\e[34;1m\]\H\[\e[m\]:\[\e[33;1m\]\w\[\e[m\]$ "' >> /home/vscode/.bashrc && \ + chown vscode:nogroup /home/vscode/.bashrc && \ apt-get clean USER vscode @@ -37,4 +38,12 @@ RUN \ cargo install cargo-modules && \ # expand rust macros (useful in debugging) cargo install cargo-expand +RUN \ + # install python manager + curl -LsSf https://astral.sh/uv/install.sh | sh && \ + uv venv -p 3.9 ~/.local/share/base && \ + # pip package based on C lib/client + uv pip install cffi maturin ipykernel -p ~/.local/share/base && \ + echo '. ~/.local/share/base/bin/activate' >> ~/.bashrc +ENV VIRTUAL_ENV=/home/vscode/.local/share/base CMD ["bash", "-c", "sudo rm /var/run/docker.pid; sudo dockerd"] diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index e5f5a54d..95a1a1ae 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,7 +1,8 @@ { "name": "Development", "build": { - "dockerfile": "Dockerfile" + "dockerfile": "Dockerfile", + "context": ".." }, "overrideCommand": false, "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}", @@ -33,7 +34,10 @@ "eamodio.gitlens", // Git explorer in VSCode "streetsidesoftware.code-spell-checker", // Catch spelling errors in docs "GitHub.copilot-chat", // GitHub Copilot AI assistant - "tintinweb.graphviz-interactive-preview" // Graphviz DOT preview + "tintinweb.graphviz-interactive-preview", // Graphviz DOT preview + "ms-python.python", // Python IDE + "ms-toolsai.jupyter", // Jupyter IDE + "ms-python.black-formatter" // Python code formatter ] } } diff --git a/.devcontainer/gpu/Dockerfile b/.devcontainer/gpu/Dockerfile index dddb1829..f375d579 100644 --- a/.devcontainer/gpu/Dockerfile +++ b/.devcontainer/gpu/Dockerfile @@ -38,4 +38,12 @@ RUN apt-get update && curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs apt-get clean ENV PATH=${PATH}:/root/.local/bin +RUN \ + # install python manager + curl -LsSf https://astral.sh/uv/install.sh | sh && \ + uv venv -p 3.9 ~/.local/share/base && \ + # pip package based on C lib/client + uv pip install cffi maturin ipykernel -p ~/.local/share/base && \ + echo '. ~/.local/share/base/bin/activate' >> ~/.bashrc +ENV VIRTUAL_ENV=/root/.local/share/base CMD ["bash", "-c", "sudo rm /var/run/docker.pid; sudo dockerd"] diff --git a/.devcontainer/gpu/devcontainer.json b/.devcontainer/gpu/devcontainer.json index 137b69dc..ebbaba51 100644 --- a/.devcontainer/gpu/devcontainer.json +++ b/.devcontainer/gpu/devcontainer.json @@ -1,7 +1,8 @@ { "name": "Development (GPU)", "build": { - "dockerfile": "Dockerfile" + "dockerfile": "Dockerfile", + "context": "../.." }, "overrideCommand": false, "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}", @@ -32,7 +33,12 @@ "ms-vscode.hexeditor", // Binary preview in HEX "tamasfe.even-better-toml", // *.toml language support "eamodio.gitlens", // Git explorer in VSCode - "streetsidesoftware.code-spell-checker" // Catch spelling errors in docs + "streetsidesoftware.code-spell-checker", // Catch spelling errors in docs + "GitHub.copilot-chat", // GitHub Copilot AI assistant + "tintinweb.graphviz-interactive-preview", // Graphviz DOT preview + "ms-python.python", // Python IDE + "ms-toolsai.jupyter", // Jupyter IDE + "ms-python.black-formatter" // Python code formatter ] } }, diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..a72180d7 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,4 @@ +docs/ +target/ +.dockerignore +README.md diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 9a3e2f39..e885bc3b 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -21,18 +21,18 @@ jobs: token: ${{ steps.generate_app_token.outputs.token }} - name: Generate crate diagram run: | - mkdir -p docs + mkdir -p docs/images set -o pipefail cargo modules dependencies \ --no-uses --no-fns \ --focus-on "orcapod::uniffi::model::{Pod}" \ --layout dot | \ - dot -T svg > docs/crate_diagram.svg + dot -T svg > docs/images/crate_diagram.svg - name: Sync GitHub run: | git config user.name github-actions git config user.email github-actions@github.com - git add docs/crate_diagram.svg + git add docs/images/crate_diagram.svg git commit -m "Update crate diagram." || echo "Diagram unchanged, skipping commit." git push api: diff --git a/.vscode/launch.json b/.vscode/launch.json index 6d832068..5cf66bf2 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -94,5 +94,20 @@ "args": [], "cwd": "${workspaceFolder}", }, + { + "name": "Python: Debug File", + "type": "debugpy", + "request": "launch", + "console": "integratedTerminal", + "justMyCode": false, + "preLaunchTask": "package_orcapod_python", + "env": { + "RUST_BACKTRACE": "1" + }, + "program": "tests/extra/python/smoke_test.py", + "args": [ + "./tests/.tmp" + ] + } ] } diff --git a/.vscode/settings.json b/.vscode/settings.json index ba6fd8f2..48efb42c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,7 +2,6 @@ "editor.formatOnPaste": false, "editor.formatOnSave": true, "files.insertFinalNewline": true, - "notebook.formatOnSave.enabled": true, "editor.rulers": [ 100 ], @@ -18,4 +17,8 @@ "gitlens.showWelcomeOnInstall": false, "gitlens.showWhatsNewAfterUpgrades": false, "lldb.consoleMode": "evaluate", + "python.defaultInterpreterPath": "~/.local/share/base/bin/python3", + "python.terminal.activateEnvironment": false, + "notebook.formatOnSave.enabled": true, + "notebook.output.scrolling": true } diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..c1cdb2c9 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,10 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "package_orcapod_python", + "type": "shell", + "command": ". ~/.local/share/base/bin/activate && maturin develop --uv" + } + ] +} diff --git a/Cargo.toml b/Cargo.toml index 3a3c9e94..95d06535 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -23,26 +23,57 @@ categories = [ license = "MIT license" edition = "2024" +[lib] +crate-type = ["rlib", "cdylib"] + [dependencies] -bollard = "0.17.1" # docker API in orchestrator -chrono = "0.4.39" # datetime utilities -colored = "2.1.0" # font colors in printed strings -futures-util = "0.3.31" # chaining async calls and processing stream data in local docker orchestrator -glob = "0.3.1" # recursive walk of filesystem in filestore -heck = "0.5.0" # strings to snake_case -names = "0.14.0" # random name generator -regex = "1.11.0" # complex pattern matching in strings -serde = { version = "1.0.210", features = ["derive"] } # serialization/deserialization to/from filestore -serde_json = "1.0.137" # JSON in sharing memory with local docker orchestrator -serde_yaml = "0.9.34" # YAML in filestore -sha2 = "0.10.8" # checksums based on SHA256 -snafu = { version = "0.8.5", features = ["futures"] } # library error handling API -tokio = { version = "1.41.0", features = ["full"] } # a runtime for async applications -tokio-util = "0.7.13" # utilities for async calls +# make async fn in traits work with dyn traits +async-trait = "0.1.88" +# docker API in orchestrator +bollard = "0.17.1" +# datetime utilities +chrono = "0.4.39" +# font colors in printed strings +colored = "2.1.0" +# derive utilities for new types +derive_more = { version = "2.0.1", features = ["display"] } +# chaining async calls and processing stream data in local docker orchestrator +futures-util = "0.3.31" +# auto derive getter access methods on structs +getset = { version = "0.1.5", git = "https://github.com/guzman-raphael/getset.git", branch = "impl_attrs" } +# recursive walk of filesystem in filestore +glob = "0.3.1" +# strings to snake_case +heck = "0.5.0" +# random name generator +names = "0.14.0" +# complex pattern matching in strings +regex = "1.11.0" +# serialization/deserialization to/from filestore +serde = { version = "1.0.210", features = ["derive"] } +# JSON in sharing memory with local docker orchestrator +serde_json = "1.0.137" +# YAML in filestore +serde_yaml = "0.9.34" +# checksums based on SHA256 +sha2 = "0.10.8" +# library error handling API +snafu = { version = "0.8.5", features = ["futures"] } +# a runtime for async applications +tokio = { version = "1.41.0", features = ["full"] } +# utilities for async calls +tokio-util = "0.7.13" +# automated CFFI + bindings in other languages +uniffi = { version = "0.29.1", features = ["cli"] } + +[[bin]] +name = "uniffi-bindgen" [dev-dependencies] -indoc = "2.0.5" # pretty multiline strings -tempfile = "3.13.0" # creating temp directories +# pretty multiline strings +indoc = "2.0.5" +# creating temp directories +tempfile = "3.13.0" [lints.rust] non_ascii_idents = "deny" @@ -81,6 +112,7 @@ missing_asserts_for_indexing = { level = "allow", priority = 127 } # missing missing_docs_in_private_items = { level = "allow", priority = 127 } # missing docs on private ok missing_inline_in_public_items = { level = "allow", priority = 127 } # let rust compiler determine best inline logic missing_trait_methods = { level = "allow", priority = 127 } # allow in favor of rustc `implement the missing item` +module_name_repetitions = { level = "allow", priority = 127 } # allow use of module name in type names multiple_inherent_impl = { level = "allow", priority = 127 } # required in best practice to limit exposure over UniFFI must_use_candidate = { level = "allow", priority = 127 } # omitting #[must_use] ok mod_module_files = { level = "allow", priority = 127 } # mod directories ok diff --git a/README.md b/README.md index ec7cc17c..e290980d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # orcapod -![orcapod crate diagram](docs/crate_diagram.svg "Orcapod Crate Diagram") +![orcapod crate diagram](docs/images/crate_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 --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot > docs/crate_diagram.dot # orcapod diagram as DOT -cargo modules dependencies --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot | dot -T png > docs/crate_diagram.png # orcapod diagram as PNG -cargo modules dependencies --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot | dot -T svg > docs/crate_diagram.svg # orcapod diagram as SVG +cargo modules dependencies --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot > docs/images/crate_diagram.dot # orcapod diagram as DOT +cargo modules dependencies --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 --no-uses --no-fns --focus-on "orcapod::uniffi::model::{Pod}" --layout dot | dot -T svg > docs/images/crate_diagram.svg # orcapod diagram as SVG ``` ## Project Management diff --git a/cspell.json b/cspell.json index 483caed0..def9f11c 100644 --- a/cspell.json +++ b/cspell.json @@ -61,6 +61,16 @@ "tobytes", "bitflags", "peaceiris", - "tintinweb" + "tintinweb", + "rlib", + "cdylib", + "toolsai", + "bindgen", + "nogroup", + "venv", + "maturin", + "ipykernel", + "getset", + "strsim" ] } diff --git a/docs/crate_diagram.svg b/docs/crate_diagram.svg deleted file mode 100644 index 929e8ba2..00000000 --- a/docs/crate_diagram.svg +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - -%3 - -orcapod - - -orcapod - -crate - -orcapod - - - -orcapod::core - -pub mod - -orcapod::core - - - -orcapod->orcapod::core - - -owns - - - -orcapod::uniffi - -pub mod - -orcapod::uniffi - - - -orcapod->orcapod::uniffi - - -owns - - - -orcapod::core::model - -pub mod - -orcapod::core::model - - - -orcapod::core->orcapod::core::model - - -owns - - - -orcapod::core::orchestrator - -pub(crate) mod - -orcapod::core::orchestrator - - - -orcapod::core->orcapod::core::orchestrator - - -owns - - - -orcapod::core::store - -pub(crate) mod - -orcapod::core::store - - - -orcapod::core->orcapod::core::store - - -owns - - - -orcapod::core::orchestrator::docker - -pub mod - -orcapod::core::orchestrator::docker - - - -orcapod::core::orchestrator->orcapod::core::orchestrator::docker - - -owns - - - -orcapod::core::store::filestore - -pub mod - -orcapod::core::store::filestore - - - -orcapod::core::store->orcapod::core::store::filestore - - -owns - - - -orcapod::uniffi::model - -pub mod - -orcapod::uniffi::model - - - -orcapod::uniffi->orcapod::uniffi::model - - -owns - - - -orcapod::uniffi::orchestrator - -pub mod - -orcapod::uniffi::orchestrator - - - -orcapod::uniffi->orcapod::uniffi::orchestrator - - -owns - - - -orcapod::uniffi::store - -pub mod - -orcapod::uniffi::store - - - -orcapod::uniffi->orcapod::uniffi::store - - -owns - - - -orcapod::uniffi::model::Pod - -pub struct - -orcapod::uniffi::model::Pod - - - -orcapod::uniffi::model->orcapod::uniffi::model::Pod - - -owns - - - -orcapod::uniffi::model::PodJob - -pub struct - -orcapod::uniffi::model::PodJob - - - -orcapod::uniffi::model->orcapod::uniffi::model::PodJob - - -owns - - - -orcapod::uniffi::model::PodResult - -pub struct - -orcapod::uniffi::model::PodResult - - - -orcapod::uniffi::model->orcapod::uniffi::model::PodResult - - -owns - - - -orcapod::uniffi::orchestrator::PodRun - -pub struct - -orcapod::uniffi::orchestrator::PodRun - - - -orcapod::uniffi::orchestrator->orcapod::uniffi::orchestrator::PodRun - - -owns - - - -orcapod::uniffi::orchestrator::docker - -pub mod - -orcapod::uniffi::orchestrator::docker - - - -orcapod::uniffi::orchestrator->orcapod::uniffi::orchestrator::docker - - -owns - - - -orcapod::uniffi::orchestrator::docker::LocalDockerOrchestrator - -pub struct - -orcapod::uniffi::orchestrator::docker::LocalDockerOrchestrator - - - -orcapod::uniffi::orchestrator::docker->orcapod::uniffi::orchestrator::docker::LocalDockerOrchestrator - - -owns - - - -orcapod::uniffi::store::filestore - -pub mod - -orcapod::uniffi::store::filestore - - - -orcapod::uniffi::store->orcapod::uniffi::store::filestore - - -owns - - - -orcapod::uniffi::store::filestore::LocalFileStore - -pub struct - -orcapod::uniffi::store::filestore::LocalFileStore - - - -orcapod::uniffi::store::filestore->orcapod::uniffi::store::filestore::LocalFileStore - - -owns - - - diff --git a/docs/examples/install_from_source/Dockerfile b/docs/examples/install_from_source/Dockerfile new file mode 100644 index 00000000..cbd6b6fe --- /dev/null +++ b/docs/examples/install_from_source/Dockerfile @@ -0,0 +1,21 @@ +FROM python:slim +SHELL ["bash", "-lc"] + +## install Rust + Git +RUN \ + apt update && \ + apt install curl gcc git -y && \ + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | bash -s -- -y && \ + echo ". ~/.cargo/env" >> ~/.bashrc + +## install remote +RUN \ + pip install git+https://github.com/walkerlab/orcapod@dev + +## install locally +# COPY . /tmp/orcapod +# RUN \ +# pip install /tmp/orcapod && \ +# rm -R /tmp/orcapod + +WORKDIR /root diff --git a/docs/examples/install_from_source/docker-compose.yaml b/docs/examples/install_from_source/docker-compose.yaml new file mode 100644 index 00000000..e16246fa --- /dev/null +++ b/docs/examples/install_from_source/docker-compose.yaml @@ -0,0 +1,26 @@ +# docker compose down && docker compose up --build +services: + orcapod_python: + build: + context: ../../.. + dockerfile: ./docs/examples/install_from_source/Dockerfile + command: + - bash + - -lc + - | + set -e + echo "Install successful" + + # Try importing + python - <=1.0,<2.0"] +build-backend = "maturin" + +[tool.maturin] +features = ["uniffi/cli"] diff --git a/src/bin/uniffi-bindgen.rs b/src/bin/uniffi-bindgen.rs new file mode 100644 index 00000000..342d0fb1 --- /dev/null +++ b/src/bin/uniffi-bindgen.rs @@ -0,0 +1,6 @@ +//! `uniffi` CLI to generate client bindings e.g. for Python. +use uniffi; + +fn main() { + uniffi::uniffi_bindgen_main(); +} diff --git a/src/core/error.rs b/src/core/error.rs index ea324f35..0dd158e1 100644 --- a/src/core/error.rs +++ b/src/core/error.rs @@ -12,50 +12,67 @@ use std::{ impl From for OrcaError { fn from(error: BollardError) -> Self { - Self(Kind::BollardError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::BollardError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } } } impl From for OrcaError { fn from(error: glob::PatternError) -> Self { - Self(Kind::GlobPatternError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::GlobPatternError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } } } impl From for OrcaError { fn from(error: io::Error) -> Self { - Self(Kind::IoError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::IoError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } } } impl From for OrcaError { fn from(error: path::StripPrefixError) -> Self { - Self(Kind::PathPrefixError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::PathPrefixError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } } } impl From for OrcaError { fn from(error: serde_json::Error) -> Self { - Self(Kind::SerdeJsonError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::SerdeJsonError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } } } impl From for OrcaError { fn from(error: serde_yaml::Error) -> Self { - Self(Kind::SerdeYamlError { - source: error, - backtrace: Some(Backtrace::capture()), - }) + Self { + kind: Kind::SerdeYamlError { + source: error, + backtrace: Some(Backtrace::capture()), + }, + } + } +} +impl From for OrcaError { + fn from(error: Kind) -> Self { + Self { kind: error } } } fn format_stack(backtrace: Option<&Backtrace>) -> String { @@ -71,7 +88,7 @@ fn format_stack(backtrace: Option<&Backtrace>) -> String { } impl fmt::Debug for OrcaError { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - match &self.0 { + match &self.kind { Kind::EmptyResponseWhenLoadingContainerAltImage { backtrace, .. } | Kind::GeneratedNamesOverflow { backtrace, .. } | Kind::InvalidFilepath { backtrace, .. } @@ -88,7 +105,7 @@ impl fmt::Debug for OrcaError { | Kind::PathPrefixError { backtrace, .. } | Kind::SerdeJsonError { backtrace, .. } | Kind::SerdeYamlError { backtrace, .. } => { - write!(f, "{}{}", self.0, format_stack(backtrace.as_ref())) + write!(f, "{}{}", self.kind, format_stack(backtrace.as_ref())) } } } diff --git a/src/core/model.rs b/src/core/model.rs index 5e67c1ee..c58b31e0 100644 --- a/src/core/model.rs +++ b/src/core/model.rs @@ -11,6 +11,7 @@ use serde_yaml; use std::{ collections::{BTreeMap, HashMap}, result, + sync::Arc, }; /// Converts a model instance into a consistent yaml. /// @@ -59,14 +60,15 @@ where serializer.serialize_str(&pod.hash) } -pub(crate) fn deserialize_pod<'de, D>(deserializer: D) -> result::Result +pub(crate) fn deserialize_pod<'de, D>(deserializer: D) -> result::Result, D::Error> where D: Deserializer<'de>, { Ok(Pod { hash: String::deserialize(deserializer)?, ..Pod::default() - }) + } + .into()) } pub(crate) fn serialize_pod_job( @@ -79,12 +81,13 @@ where serializer.serialize_str(&pod_job.hash) } -pub(crate) fn deserialize_pod_job<'de, D>(deserializer: D) -> result::Result +pub(crate) fn deserialize_pod_job<'de, D>(deserializer: D) -> result::Result, D::Error> where D: Deserializer<'de>, { Ok(PodJob { hash: String::deserialize(deserializer)?, ..PodJob::default() - }) + } + .into()) } diff --git a/src/core/orchestrator/docker.rs b/src/core/orchestrator/docker.rs index 7a7e813b..64e533b0 100644 --- a/src/core/orchestrator/docker.rs +++ b/src/core/orchestrator/docker.rs @@ -131,7 +131,7 @@ impl LocalDockerOrchestrator { ("org.orcapod.pod.hash".to_owned(), pod_job.pod.hash.clone()), ( "org.orcapod.pod".to_owned(), - serde_json::to_string(&pod_job.pod)?, + serde_json::to_string(&*pod_job.pod)?, ), ( "org.orcapod.pod_job.annotation".to_owned(), diff --git a/src/core/orchestrator/mod.rs b/src/core/orchestrator/mod.rs index 1c62d47a..64fc75ae 100644 --- a/src/core/orchestrator/mod.rs +++ b/src/core/orchestrator/mod.rs @@ -9,7 +9,7 @@ use crate::{ impl PodRun { pub(crate) fn new(pod_job: &PodJob, assigned_name: String) -> Self { Self { - pod_job: pod_job.clone(), + pod_job: pod_job.clone().into(), orchestrator_source: get_type_name::(), assigned_name, } diff --git a/src/core/store/filestore.rs b/src/core/store/filestore.rs index 0548e22e..9f16ac64 100644 --- a/src/core/store/filestore.rs +++ b/src/core/store/filestore.rs @@ -1,9 +1,13 @@ use crate::{ - core::{model::to_yaml, util::get_type_name}, + core::{ + model::to_yaml, + store::MODEL_NAMESPACE, + util::{get_type_name, parse_debug_name}, + }, uniffi::{ error::{Result, selector}, model::Annotation, - store::{ModelID, ModelInfo, Store as _, filestore::LocalFileStore}, + store::{ModelID, ModelInfo, filestore::LocalFileStore}, }, }; use colored::Colorize as _; @@ -14,7 +18,7 @@ use serde::{Serialize, de::DeserializeOwned}; use serde_yaml; use snafu::OptionExt as _; use std::{ - fs, + fmt, fs, path::{Path, PathBuf}, sync::LazyLock, }; @@ -51,12 +55,17 @@ impl LocalFileStore { PathBuf::from(format!("annotation/{name}-{version}.yaml")) } /// Build the storage path with the model directory (`hash`) and a file's relative path. - pub fn make_path(&self, hash: &str, relpath: impl AsRef) -> PathBuf { + pub fn make_path( + &self, + model: &T, + hash: &str, + relpath: impl AsRef, + ) -> PathBuf { PathBuf::from(format!( "{}/{}/{}/{}", self.directory.to_string_lossy(), - Self::MODEL_NAMESPACE, - get_type_name::().to_snake_case(), + MODEL_NAMESPACE, + parse_debug_name(model).to_snake_case(), hash )) .join(relpath) @@ -81,13 +90,20 @@ impl LocalFileStore { /// # Errors /// /// Will return error if unable to find. - pub(crate) fn lookup_hash(&self, name: &str, version: &str) -> Result { - let model_info = Self::find_model_metadata( - &self.make_path::("*", Self::make_annotation_relpath(name, version)), - )? + pub(crate) fn lookup_hash( + &self, + model: &T, + name: &str, + version: &str, + ) -> Result { + let model_info = Self::find_model_metadata(&self.make_path( + model, + "*", + Self::make_annotation_relpath(name, version), + ))? .next() .context(selector::NoAnnotationFound { - class: get_type_name::().to_snake_case(), + class: parse_debug_name(model).to_snake_case(), name: name.to_owned(), version: version.to_owned(), })?; @@ -106,13 +122,13 @@ impl LocalFileStore { /// # Errors /// /// Will return `Err` if there is an issue storing the model. - pub(crate) fn save_model( + pub(crate) fn save_model( &self, model: &T, hash: &str, annotation: Option<&Annotation>, ) -> Result<()> { - let model_type = get_type_name::(); + let class = get_type_name::().to_snake_case(); // Save annotation if defined and doesn't collide globally i.e. model, name, version if let Some(provided_annotation) = annotation { let relpath = &Self::make_annotation_relpath( @@ -120,7 +136,7 @@ impl LocalFileStore { &provided_annotation.version, ); if let Some((found_hash, found_name, found_version)) = - Self::find_model_metadata(&self.make_path::("*", relpath))? + Self::find_model_metadata(&self.make_path(model, "*", relpath))? .next() .and_then(|model_info| { Some((model_info.hash, model_info.name?, model_info.version?)) @@ -130,7 +146,7 @@ impl LocalFileStore { "{}", format!( "Skip saving {} annotation since `{}`, `{}`, `{}` exists.", - model_type.bright_cyan(), + class.bright_cyan(), found_hash.bright_cyan(), found_name.bright_cyan(), found_version.bright_cyan(), @@ -139,19 +155,19 @@ impl LocalFileStore { ); } else { Self::save_file( - self.make_path::(hash, relpath), + self.make_path(model, hash, relpath), serde_yaml::to_string(provided_annotation)?, )?; } } // Save model specification and skip if it already exist e.g. on new annotations - let spec_file = &self.make_path::(hash, Self::SPEC_RELPATH); + let spec_file = &self.make_path(model, hash, Self::SPEC_RELPATH); if spec_file.exists() { println!( "{}", format!( "Skip saving {} model since `{}` exists.", - model_type.bright_cyan(), + class.bright_cyan(), hash.bright_cyan(), ) .yellow(), @@ -167,27 +183,33 @@ impl LocalFileStore { /// /// Will return `Err` if there is an issue loading the model from the store using `name` and /// `version`. - pub(crate) fn load_model( + pub(crate) fn load_model( &self, model_id: &ModelID, ) -> Result<(T, Option, String)> { match model_id { ModelID::Hash(hash) => Ok(( - serde_yaml::from_str(&fs::read_to_string( - self.make_path::(hash, Self::SPEC_RELPATH), - )?)?, + serde_yaml::from_str(&fs::read_to_string(self.make_path( + &T::default(), + hash, + Self::SPEC_RELPATH, + ))?)?, None, hash.to_owned(), )), ModelID::Annotation(name, version) => { - let hash = self.lookup_hash::(name, version)?; + let hash = self.lookup_hash(&T::default(), name, version)?; Ok(( - serde_yaml::from_str(&fs::read_to_string( - self.make_path::(&hash, Self::SPEC_RELPATH), - )?)?, - serde_yaml::from_str(&fs::read_to_string( - self.make_path::(&hash, &Self::make_annotation_relpath(name, version)), - )?)?, + serde_yaml::from_str(&fs::read_to_string(self.make_path( + &T::default(), + &hash, + Self::SPEC_RELPATH, + ))?)?, + serde_yaml::from_str(&fs::read_to_string(self.make_path( + &T::default(), + &hash, + Self::make_annotation_relpath(name, version), + ))?)?, hash, )) } @@ -198,8 +220,8 @@ impl LocalFileStore { /// # Errors /// /// Will return `Err` if there is an issue querying metadata from existing models in the store. - pub(crate) fn list_model(&self) -> Result> { - Ok(Self::find_model_metadata(&self.make_path::("**", "*"))?.collect()) + pub(crate) fn list_model(&self) -> Result> { + Ok(Self::find_model_metadata(&self.make_path(&T::default(), "**", "*"))?.collect()) } /// How to explicitly delete any stored model and all associated annotations (does not propagate). /// @@ -207,13 +229,15 @@ impl LocalFileStore { /// /// Will return `Err` if there is an issue deleting a model from the store using `name` and /// `version`. - pub(crate) fn delete_model(&self, model_id: &ModelID) -> Result<()> { + pub(crate) fn delete_model(&self, model_id: &ModelID) -> Result<()> { // assumes propagate = false let hash = match model_id { ModelID::Hash(hash) => hash, - ModelID::Annotation(name, version) => &self.lookup_hash::(name, version)?, + ModelID::Annotation(name, version) => { + &self.lookup_hash(&T::default(), name, version)? + } }; - let spec_dir = self.make_path::(hash, ""); + let spec_dir = self.make_path(&T::default(), hash, ""); fs::remove_dir_all(spec_dir)?; Ok(()) diff --git a/src/core/store/mod.rs b/src/core/store/mod.rs index fe5e8e56..544190f5 100644 --- a/src/core/store/mod.rs +++ b/src/core/store/mod.rs @@ -1 +1,4 @@ +/// Namespace where models will be stored. +const MODEL_NAMESPACE: &str = "orcapod_model"; + pub mod filestore; diff --git a/src/core/util.rs b/src/core/util.rs index cdf14033..e3a69a65 100644 --- a/src/core/util.rs +++ b/src/core/util.rs @@ -1,10 +1,10 @@ use crate::uniffi::error::{Result, selector}; use snafu::OptionExt as _; -use std::{any::type_name, collections::HashMap}; +use std::{any::type_name, collections::HashMap, fmt}; #[expect( clippy::unwrap_used, - reason = "`last()` cannot return `None` since `type_name` always returns `&str`." + reason = "Cannot return `None` since `type_name` always returns `&str`." )] pub fn get_type_name() -> String { type_name::() @@ -14,6 +14,18 @@ pub fn get_type_name() -> String { .unwrap() } +#[expect( + clippy::unwrap_used, + reason = "Cannot return `None` since debug format always returns `String`." +)] +pub fn parse_debug_name(instance: &T) -> String { + format!("{instance:?}") + .split(' ') + .map(str::to_owned) + .next() + .unwrap() +} + pub fn get<'map, T>(map: &'map HashMap, key: &str) -> Result<&'map T> { Ok(map.get(key).context(selector::KeyMissing { key: key.to_owned(), diff --git a/src/lib.rs b/src/lib.rs index e2d52d43..94e8829a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,29 @@ //! Intuitive compute pipeline orchestration with reproducibility, performance, and scalability in //! mind. - +extern crate uniffi as uniffi_external; +uniffi_external::setup_scaffolding!(); /// Pure Rust source. pub mod core; -/// Exposed `CFFI` client based on `UniFFI`. +/// Exposed CFFI client based on [uniffi](https://crates.io/crates/uniffi). +/// +/// `uniffi` brings a lot of convenience in creating a CFFI but we also must meet several +/// requirements. This means there are several design implications to be aware of. +/// +/// For instance, anything exposed over the CFFI boundary with `uniffi` (i.e. children of this +/// `mod`) needs to respect several rules (not exhaustive). +/// 1. No use of Rust generics +/// 1. No use of `const` values in traits +/// 1. Primitives must be owned by the client e.g., `String`, `u8`, `bool`, `f32`, etc. +/// 1. `BtreeMap` isn't supported but `HashMap` is. +/// 1. `async` functions must use the custom derive attribute from the +/// [async-trait](https://crates.io/crates/async-trait) crate +/// 1. Custom types that are to be owned by client: +/// 1. are passed by value i.e. as a move +/// 1. cannot export any methods associated with them i.e. can't be invoked on client side +/// 1. Custom types that are to be owned by Rust: +/// 1. are passed by reference using `Arc` +/// 1. can have methods exported i.e. can be invoked on client side +/// 1. require exporting constructor methods +/// 1. require exporting getter methods (e.g. for each field on a `struct`) since the underlying +/// values are owned by Rust pub mod uniffi; diff --git a/src/uniffi/error.rs b/src/uniffi/error.rs index 34ad3d83..3ef9daff 100644 --- a/src/uniffi/error.rs +++ b/src/uniffi/error.rs @@ -14,11 +14,13 @@ use std::{ path::{self, PathBuf}, result, }; +use uniffi; /// Shorthand for a Result that returns an `OrcaError`. pub type Result = result::Result; /// Possible errors you may encounter. -#[derive(Snafu, Debug)] +#[derive(Snafu, Debug, uniffi::Error)] #[snafu(module(selector), visibility(pub(crate)), context(suffix(false)))] +#[uniffi(flat_error)] pub(crate) enum Kind { #[snafu(display( "Received an empty response when attempting to load the alternate container image file: {path:?}." @@ -103,16 +105,21 @@ pub(crate) enum Kind { }, } /// A stable error API interface. -#[derive(Snafu)] -pub struct OrcaError(pub(crate) Kind); +#[derive(Snafu, uniffi::Object)] +#[snafu(display("{self:?}"))] +#[uniffi::export(Display)] +pub struct OrcaError { + pub(crate) kind: Kind, +} +#[uniffi::export] impl OrcaError { /// Returns `true` if the error was caused by an invalid model annotation. pub const fn is_invalid_annotation(&self) -> bool { - matches!(self.0, Kind::NoAnnotationFound { .. }) + matches!(self.kind, Kind::NoAnnotationFound { .. }) } /// Returns `true` if the error was caused by querying a purged pod run. pub const fn is_purged_pod_run(&self) -> bool { - matches!(self.0, Kind::NoMatchingPodRun { .. }) + matches!(self.kind, Kind::NoMatchingPodRun { .. }) } } diff --git a/src/uniffi/model.rs b/src/uniffi/model.rs index 9337cf66..b2aeb24b 100644 --- a/src/uniffi/model.rs +++ b/src/uniffi/model.rs @@ -8,13 +8,32 @@ use crate::{ }, uniffi::{error::Result, orchestrator::Status}, }; +use derive_more::Display; +use getset::CloneGetters; use serde::{Deserialize, Serialize}; -use std::{collections::HashMap, path::PathBuf}; +use std::{collections::HashMap, path::PathBuf, sync::Arc}; +use uniffi; + +/// Available models. +#[derive(uniffi::Enum, Debug)] +pub enum ModelType { + /// A reusable, containerized computational unit. + Pod, + /// A compute job that specifies resource requests and input/output targets. + PodJob, + /// Result from a compute job run. + PodResult, +} // --- core model structs --- /// A reusable, containerized computational unit. -#[derive(Serialize, Deserialize, Debug, PartialEq, Default, Clone)] +#[derive( + uniffi::Object, Serialize, Deserialize, Debug, PartialEq, Default, Clone, Display, CloneGetters, +)] +#[getset(get_clone, impl_attrs = "#[uniffi::export]")] +#[display("{self:#?}")] +#[uniffi::export(Display)] pub struct Pod { /// Metadata that doesn't affect reproducibility. #[serde(skip)] @@ -44,12 +63,14 @@ pub struct Pod { pub required_gpu: Option, } +#[uniffi::export] impl Pod { /// Construct a new pod instance. /// /// # Errors /// /// Will return `Err` if there is an issue initializing a `Pod` instance. + #[uniffi::constructor] pub fn new( annotation: Option, image: String, @@ -83,7 +104,12 @@ impl Pod { } /// A compute job that specifies resource requests and input/output targets. -#[derive(Serialize, Deserialize, Debug, PartialEq, Clone, Default)] +#[derive( + uniffi::Object, Serialize, Deserialize, Debug, PartialEq, Clone, Default, Display, CloneGetters, +)] +#[getset(get_clone, impl_attrs = "#[uniffi::export]")] +#[display("{self:#?}")] +#[uniffi::export(Display)] pub struct PodJob { /// Metadata that doesn't affect reproducibility. #[serde(skip)] @@ -93,7 +119,7 @@ pub struct PodJob { pub hash: String, /// A pod to base the pod job on. #[serde(serialize_with = "serialize_pod", deserialize_with = "deserialize_pod")] - pub pod: Pod, + pub pod: Arc, /// Attached, external input streams. #[serde(serialize_with = "serialize_hashmap")] pub input_stream: HashMap, @@ -108,15 +134,17 @@ pub struct PodJob { pub env_vars: Option>, } +#[uniffi::export] impl PodJob { /// Construct a new pod job instance. /// /// # Errors /// /// Will return `Err` if there is an issue initializing a `PodJob` instance. + #[uniffi::constructor] pub fn new( annotation: Option, - pod: Pod, + pod: Arc, mut input_stream: HashMap, output_dir: OrcaPath, cpu_limit: f32, @@ -160,7 +188,7 @@ impl PodJob { } /// Result from a compute job run. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Default)] pub struct PodResult { /// Metadata that doesn't affect reproducibility. #[serde(skip)] @@ -173,7 +201,7 @@ pub struct PodResult { serialize_with = "serialize_pod_job", deserialize_with = "deserialize_pod_job" )] - pub pod_job: PodJob, + pub pod_job: Arc, /// Name given by orchestrator. pub assigned_name: String, /// Status of compute run when terminated. @@ -192,7 +220,7 @@ impl PodResult { /// Will return `Err` if there is an issue initializing a `PodResult` instance. pub fn new( annotation: Option, - pod_job: PodJob, + pod_job: Arc, assigned_name: String, status: Status, created: u64, @@ -217,7 +245,7 @@ impl PodResult { // --- util types --- /// Standard metadata structure for all model instances. -#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, PartialEq, Eq, Clone)] pub struct Annotation { /// A unique name. pub name: String, @@ -227,7 +255,7 @@ pub struct Annotation { pub description: String, } /// Specification for GPU requirements in computation. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] pub struct GPURequirement { /// GPU model specification. pub model: GPUModel, @@ -237,7 +265,7 @@ pub struct GPURequirement { pub count: u16, } /// GPU model specification. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] +#[derive(uniffi::Enum, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] pub enum GPUModel { /// NVIDIA-manufactured card where `String` is the specific model e.g. ??? NVIDIA(String), @@ -246,7 +274,7 @@ pub enum GPUModel { } /// Streams are named and represent an abstraction for the file(s) that represent some particular /// data. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] pub struct StreamInfo { /// Path to stream file or directory. pub path: PathBuf, @@ -254,7 +282,7 @@ pub struct StreamInfo { pub match_pattern: String, } /// Input options. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] +#[derive(uniffi::Enum, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] #[serde(untagged)] pub enum Input { /// A single BLOB. @@ -263,7 +291,7 @@ pub enum Input { Collection(Vec), } /// Location of BLOB data. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] pub struct OrcaPath { /// Namespace alias. pub namespace: String, @@ -272,7 +300,7 @@ pub struct OrcaPath { } /// BLOB with metadata. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] +#[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] pub struct Blob { /// BLOB available options. pub kind: BlobKind, @@ -282,7 +310,7 @@ pub struct Blob { pub checksum: String, } /// File or directory options for BLOBs. -#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] +#[derive(uniffi::Enum, Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)] pub enum BlobKind { /// A single file. #[default] @@ -290,3 +318,11 @@ pub enum BlobKind { /// A single directory. Directory, } + +// --- utils ---- + +uniffi::custom_type!(PathBuf, String, { + remote, + try_lift: |val| Ok(PathBuf::from(&val)), + lower: |obj| obj.display().to_string(), +}); diff --git a/src/uniffi/orchestrator/docker.rs b/src/uniffi/orchestrator/docker.rs index 5f997a2b..7a2e75e1 100644 --- a/src/uniffi/orchestrator/docker.rs +++ b/src/uniffi/orchestrator/docker.rs @@ -6,28 +6,35 @@ use crate::{ orchestrator::{ImageKind, Orchestrator, PodRun, RunInfo}, }, }; +use async_trait; use bollard::{ Docker, container::{RemoveContainerOptions, StartContainerOptions, WaitContainerOptions}, image::{CreateImageOptions, ImportImageOptions}, }; +use derive_more::Display; use futures_util::stream::{StreamExt as _, TryStreamExt as _}; use snafu::{OptionExt as _, futures::TryFutureExt as _}; -use std::{collections::HashMap, path::PathBuf}; +use std::{collections::HashMap, path::PathBuf, sync::Arc}; use tokio::{fs::File, runtime::Runtime}; use tokio_util::{ bytes::{Bytes, BytesMut}, codec::{BytesCodec, FramedRead}, }; +use uniffi; /// Support for an orchestration engine using a local docker installation. -#[derive(Debug)] +#[derive(uniffi::Object, Debug, Display)] +#[display("{self:#?}")] +#[uniffi::export(Display)] pub struct LocalDockerOrchestrator { /// API to interact with Docker daemon. pub api: Docker, async_driver: Runtime, } +#[uniffi::export] +#[async_trait::async_trait] impl Orchestrator for LocalDockerOrchestrator { fn start_with_altimage_blocking( &self, @@ -161,7 +168,7 @@ impl Orchestrator for LocalDockerOrchestrator { pod_job .hash .clone_from(get(&run_info.labels, "org.orcapod.pod_job.hash")?); - pod_job.pod = pod; + pod_job.pod = pod.into(); Ok(PodRun::new::(&pod_job, assigned_name)) }) .collect() @@ -204,7 +211,7 @@ impl Orchestrator for LocalDockerOrchestrator { let result_info = self.get_info(pod_run).await?; PodResult::new( None, - pod_run.pod_job.clone(), + Arc::clone(&pod_run.pod_job), pod_run.assigned_name.clone(), result_info.status, result_info.created, @@ -217,6 +224,7 @@ impl Orchestrator for LocalDockerOrchestrator { } } +#[uniffi::export] impl LocalDockerOrchestrator { /// How to create a local docker orchestrator with an absolute path on docker host where binds /// will be mounted from. @@ -224,6 +232,7 @@ impl LocalDockerOrchestrator { /// # Errors /// /// Will return `Err` if there is an issue creating a local docker orchestrator. + #[uniffi::constructor] pub fn new() -> Result { Ok(Self { api: Docker::connect_with_local_defaults()?, diff --git a/src/uniffi/orchestrator/mod.rs b/src/uniffi/orchestrator/mod.rs index e247c0fa..82431906 100644 --- a/src/uniffi/orchestrator/mod.rs +++ b/src/uniffi/orchestrator/mod.rs @@ -3,8 +3,10 @@ use crate::uniffi::{ model::{OrcaPath, PodJob, PodResult}, }; use serde::{Deserialize, Serialize}; -use std::{collections::HashMap, future::Future, path::PathBuf}; +use std::{collections::HashMap, path::PathBuf, sync::Arc}; +use uniffi; /// Options for sourcing compute environment images. +#[derive(uniffi::Enum)] pub enum ImageKind { /// A published compute environment image in a container registry. Argument formatted as /// `{server.com/}{name}:{tag}`. Server is optional e.g. (`alpine:latest`). @@ -13,7 +15,7 @@ pub enum ImageKind { Tarball(OrcaPath), } /// Status of a particular compute run. -#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)] +#[derive(uniffi::Enum, Serialize, Deserialize, Debug, PartialEq, Eq, Clone, Default)] pub enum Status { /// Run is ongoing. Running, @@ -21,9 +23,12 @@ pub enum Status { Completed, /// Run failed with the provided error code. Failed(i16), + /// No status set. + #[default] + Unset, } /// Run metadata -#[derive(Debug)] +#[derive(uniffi::Record, Debug)] pub struct RunInfo { /// Environment utilized. pub image: String, @@ -47,10 +52,10 @@ pub struct RunInfo { pub memory_limit: u64, } /// Current computation managed by orchestrator. -#[derive(Debug)] +#[derive(uniffi::Record, Debug)] pub struct PodRun { /// Original compute request. - pub pod_job: PodJob, + pub pod_job: Arc, /// Name of orchestrator that created the run. pub orchestrator_source: String, /// Name given by orchestrator. @@ -58,7 +63,9 @@ pub struct PodRun { } /// API for standard behavior of any container orchestration engine supported. -pub trait Orchestrator { +#[uniffi::export] +#[async_trait::async_trait] +pub trait Orchestrator: Send + Sync { /// How to synchronously start containers with an alternate image. /// /// # Errors @@ -109,46 +116,46 @@ pub trait Orchestrator { /// # Errors /// /// Will return `Err` if there is an issue starting the container. - fn start_with_altimage( + async fn start_with_altimage( &self, namespace_lookup: &HashMap, pod_job: &PodJob, image: &ImageKind, - ) -> impl Future> + Send; + ) -> Result; /// How to asynchronously start containers. Assumes `PodJob` image is published. /// /// # Errors /// /// Will return `Err` if there is an issue starting the container. - fn start( + async fn start( &self, namespace_lookup: &HashMap, pod_job: &PodJob, - ) -> impl Future> + Send; + ) -> Result; /// How to asynchronously query containers. /// /// # Errors /// /// Will return `Err` if there is an issue querying metadata from containers. - fn list(&self) -> impl Future>> + Send; + async fn list(&self) -> Result>; /// How to asynchronously delete containers. /// /// # Errors /// /// Will return `Err` if there is an issue deleting a container. - fn delete(&self, pod_run: &PodRun) -> impl Future> + Send; + async fn delete(&self, pod_run: &PodRun) -> Result<()>; /// How to asynchronously get container info if still in orchestrator memory. /// /// # Errors /// /// Will return `Err` if there is an issue accessing container info. - fn get_info(&self, pod_run: &PodRun) -> impl Future> + Send; + async fn get_info(&self, pod_run: &PodRun) -> Result; /// How to asynchronously wait for pod result to be ready. /// /// # Errors /// /// Will return `Err` if there is an issue creating a pod result. - fn get_result(&self, pod_run: &PodRun) -> impl Future> + Send; + async fn get_result(&self, pod_run: &PodRun) -> Result; } /// Orchestration implementation for Docker backend. diff --git a/src/uniffi/store/filestore.rs b/src/uniffi/store/filestore.rs index a6023adf..8ac90e30 100644 --- a/src/uniffi/store/filestore.rs +++ b/src/uniffi/store/filestore.rs @@ -1,19 +1,23 @@ use crate::uniffi::{ error::Result, - model::{Pod, PodJob, PodResult}, + model::{ModelType, Pod, PodJob, PodResult}, store::{ModelID, ModelInfo, Store}, }; -use std::{ - fs, - path::{Path, PathBuf}, -}; +use derive_more::Display; +use getset::CloneGetters; +use std::{fs, path::PathBuf}; +use uniffi; /// Support for a storage backend on a local filesystem directory. -#[derive(Debug)] +#[derive(uniffi::Object, Debug, Display, CloneGetters)] +#[getset(get_clone, impl_attrs = "#[uniffi::export]")] +#[display("{self:#?}")] +#[uniffi::export(Display)] pub struct LocalFileStore { /// A local path to a directory where store will be located. pub directory: PathBuf, } +#[uniffi::export] impl Store for LocalFileStore { fn save_pod(&self, pod: &Pod) -> Result<()> { self.save_model(pod, &pod.hash, pod.annotation.as_ref()) @@ -38,7 +42,9 @@ impl Store for LocalFileStore { let (mut pod_job, annotation, hash) = self.load_model::(model_id)?; pod_job.annotation = annotation; pod_job.hash = hash; - pod_job.pod = self.load_pod(&ModelID::Hash(pod_job.pod.hash))?; + pod_job.pod = self + .load_pod(&ModelID::Hash(pod_job.pod.hash.clone()))? + .into(); Ok(pod_job) } fn list_pod_job(&self) -> Result> { @@ -55,7 +61,9 @@ impl Store for LocalFileStore { let (mut pod_result, annotation, hash) = self.load_model::(model_id)?; pod_result.annotation = annotation; pod_result.hash = hash; - pod_result.pod_job = self.load_pod_job(&ModelID::Hash(pod_result.pod_job.hash))?; + pod_result.pod_job = self + .load_pod_job(&ModelID::Hash(pod_result.pod_job.hash.clone()))? + .into(); Ok(pod_result) } fn list_pod_result(&self) -> Result> { @@ -64,21 +72,23 @@ impl Store for LocalFileStore { fn delete_pod_result(&self, model_id: &ModelID) -> Result<()> { self.delete_model::(model_id) } - fn delete_annotation(&self, name: &str, version: &str) -> Result<()> { - let hash = self.lookup_hash::(name, version)?; - let annotation_file = - self.make_path::(&hash, Self::make_annotation_relpath(name, version)); + fn delete_annotation(&self, model_type: &ModelType, name: &str, version: &str) -> Result<()> { + let annotation_file = self.make_path( + model_type, + &self.lookup_hash(model_type, name, version)?, + Self::make_annotation_relpath(name, version), + ); fs::remove_file(&annotation_file)?; Ok(()) } } +#[uniffi::export] impl LocalFileStore { /// Construct a local file store instance in a specific directory. - pub fn new(directory: impl AsRef) -> Self { - Self { - directory: directory.as_ref().into(), - } + #[uniffi::constructor] + pub const fn new(directory: PathBuf) -> Self { + Self { directory } } } diff --git a/src/uniffi/store/mod.rs b/src/uniffi/store/mod.rs index 5464393e..22486126 100644 --- a/src/uniffi/store/mod.rs +++ b/src/uniffi/store/mod.rs @@ -1,9 +1,10 @@ use crate::uniffi::{ error::Result, - model::{Pod, PodJob, PodResult}, + model::{ModelType, Pod, PodJob, PodResult}, }; +use uniffi; /// Options for identifying a model. -#[derive(Debug, Clone)] +#[derive(uniffi::Enum, Debug, Clone)] pub enum ModelID { /// Identifying by the hash value of a model as a string. Hash(String), @@ -12,7 +13,7 @@ pub enum ModelID { } /// Metadata for a model. -#[derive(Debug, PartialEq, Eq)] +#[derive(uniffi::Record, Debug, PartialEq, Eq)] pub struct ModelInfo { /// A model's name. pub name: Option, @@ -23,9 +24,8 @@ pub struct ModelInfo { } /// Standard behavior of any store backend supported. -pub trait Store { - /// Namespace where models will be stored. - const MODEL_NAMESPACE: &str = "orcapod_model"; +#[uniffi::export] +pub trait Store: Send + Sync { /// How a pod is stored. /// /// # Errors @@ -114,7 +114,7 @@ pub trait Store { /// /// Will return `Err` if there is an issue deleting an annotation from the store using `name` /// and `version`. - fn delete_annotation(&self, name: &str, version: &str) -> Result<()>; + fn delete_annotation(&self, model_type: &ModelType, name: &str, version: &str) -> Result<()>; } /// Store implementation on a local filesystem. pub mod filestore; diff --git a/tests/crypto.rs b/tests/crypto.rs index c348bdd2..cbb1f54f 100644 --- a/tests/crypto.rs +++ b/tests/crypto.rs @@ -8,7 +8,7 @@ use std::fs::read; #[test] fn consistent_hash() -> Result<()> { - let filepath = "./tests/data/images/subject.jpeg"; + let filepath = "./tests/extra/data/images/subject.jpeg"; assert_eq!( hash_file(filepath)?, hash_buffer(&read(filepath)?), @@ -19,7 +19,7 @@ fn consistent_hash() -> Result<()> { #[test] fn complex_hash() -> Result<()> { - let dirpath = "./tests/data/images"; + let dirpath = "./tests/extra/data/images"; assert_eq!( hash_dir(dirpath)?, "6c96a478ea25e34fab045bc82858a2980b2cfb22db32e83c01349a8e7ed3b42c".to_owned(), diff --git a/tests/error.rs b/tests/error.rs index 537ee374..3c9f82e6 100644 --- a/tests/error.rs +++ b/tests/error.rs @@ -12,7 +12,7 @@ use orcapod::{ }; use serde_json; use serde_yaml; -use std::{collections::HashMap, fs, path::PathBuf}; +use std::{collections::HashMap, fs, ops::Deref as _, path::PathBuf, sync::Arc}; fn contains_debug(error: impl Into) -> bool { !format!("{:?}", error.into()).is_empty() @@ -22,7 +22,9 @@ fn contains_debug(error: impl Into) -> bool { fn external_bollard() -> Result<()> { let orch = LocalDockerOrchestrator::new()?; let mut pod_job = pod_job_style(&NAMESPACE_LOOKUP_READ_ONLY)?; - pod_job.pod.image = "nonexistent_image".to_owned(); + let mut pod = pod_job.pod.deref().clone(); + pod.image = "nonexistent_image".to_owned(); + pod_job.pod = Arc::new(pod); assert!( orch.start_blocking(&NAMESPACE_LOOKUP_READ_ONLY, &pod_job) .is_err_and(contains_debug), diff --git a/tests/data/images/subject.jpeg b/tests/extra/data/images/subject.jpeg similarity index 100% rename from tests/data/images/subject.jpeg rename to tests/extra/data/images/subject.jpeg diff --git a/tests/data/styles/mosaic.t7 b/tests/extra/data/styles/mosaic.t7 similarity index 100% rename from tests/data/styles/mosaic.t7 rename to tests/extra/data/styles/mosaic.t7 diff --git a/tests/data/styles/style1.t7 b/tests/extra/data/styles/style1.t7 similarity index 100% rename from tests/data/styles/style1.t7 rename to tests/extra/data/styles/style1.t7 diff --git a/tests/example_pod/style_transfer/Dockerfile b/tests/extra/example_pod/style_transfer/Dockerfile similarity index 61% rename from tests/example_pod/style_transfer/Dockerfile rename to tests/extra/example_pod/style_transfer/Dockerfile index 8e053704..f9a20801 100644 --- a/tests/example_pod/style_transfer/Dockerfile +++ b/tests/extra/example_pod/style_transfer/Dockerfile @@ -1,4 +1,4 @@ -# docker build ./tests/example_pod/style_transfer -t example.server.com/user/style-transfer:1.0.0 +# docker build ./tests/extra/example_pod/style_transfer -t example.server.com/user/style-transfer:1.0.0 # docker run --rm -d \ # -l orcapod=true \ # -l orcapod.pod_job.model_id.type=annotation \ @@ -6,9 +6,9 @@ # -l orcapod.pod_job.model_id.version=0.1.0 \ # --entrypoint python \ # -e DELAY=60 \ -# -v ./tests/data/images/dog.jpeg:/input/image.jpeg:ro \ -# -v ./tests/data/styles/mosaic.t7:/input/style.t7:ro \ -# -v ./tests/data/output:/output \ +# -v ./tests/extra/data/images/dog.jpeg:/input/image.jpeg:ro \ +# -v ./tests/extra/data/styles/mosaic.t7:/input/style.t7:ro \ +# -v ./tests/extra/data/output:/output \ # --cpus=0.5 \ # --memory=2g \ # example.server.com/user/style-transfer:1.0.0 \ @@ -17,4 +17,4 @@ FROM python:3.9-slim RUN pip install opencv-python-headless numpy imutils COPY ./run.py /run.py -CMD ["python", "/run.py"] \ No newline at end of file +CMD ["python", "/run.py"] diff --git a/tests/example_pod/style_transfer/run.py b/tests/extra/example_pod/style_transfer/run.py similarity index 100% rename from tests/example_pod/style_transfer/run.py rename to tests/extra/example_pod/style_transfer/run.py diff --git a/tests/extra/python/smoke_test.py b/tests/extra/python/smoke_test.py new file mode 100755 index 00000000..7ace5a30 --- /dev/null +++ b/tests/extra/python/smoke_test.py @@ -0,0 +1,164 @@ +#!/usr/bin/env python3 + +# build: maturin develop --uv +# debugger: select "Python: Debug File" + F5 +# script: /path/to/this/test/file.py /path/to/directory (must exist, will create subdirectory) +import shutil +from pathlib import Path +import argparse +from orcapod import ( + Pod, + PodJob, + Annotation, + OrcaPath, + LocalDockerOrchestrator, + LocalFileStore, + ModelId, + ModelType, +) + + +def create_pod(data, _): + data["pod"] = Pod( + annotation=Annotation( + name="simple", + description="This is an example pod.", + version="1.0.0", + ), + image="alpine:3.14", + command="sleep 1", + input_stream={}, + output_dir="/tmp/output", + output_stream={}, + source_commit_url="https://github.com/user/simple", + recommended_cpus=0.1, + recommended_memory=10 << 20, + required_gpu=None, + ) + return data["pod"], data + + +def create_pod_job(data, config): + data["pod_job"] = PodJob( + annotation=Annotation( + name="simple", + description="This is an example pod job.", + version="0.1.0", + ), + pod=data["pod"], + input_stream={}, + output_dir=OrcaPath( + namespace="default", + path=".", + ), + cpu_limit=0.1, + memory_limit=10 << 20, + env_vars=None, + namespace_lookup=config["namespace_lookup"], + ) + return data["pod_job"], data + + +def create_orch(data, _): + data["orch"] = LocalDockerOrchestrator() + return data["orch"], data + + +def start_pod_job(data, config): + data["pod_run"] = data["orch"].start_blocking( + namespace_lookup=config["namespace_lookup"], pod_job=data["pod_job"] + ) + return data["pod_run"], data + + +def wait_for_pod_result(data, _): + print([str(p) for p in data["orch"].list_blocking()]) + print("waiting to finish...") + data["pod_result"] = data["orch"].get_result_blocking(pod_run=data["pod_run"]) + return data["pod_result"], data + + +def delete_pod_run(data, _): + print([str(p) for p in data["orch"].list_blocking()]) + data["orch"].delete_blocking(pod_run=data["pod_run"]) + return [str(p) for p in data["orch"].list_blocking()], data + + +def create_store(data, config): + data["store"] = LocalFileStore(directory=config["store_dir"]) + return data["store"], data + + +def save_pod(data, _): + data["store"].save_pod(data["pod"]) + return [str(p) for p in data["store"].list_pod()], data + + +def load_pod(data, _): + data["loaded_pod"] = data["store"].load_pod( + model_id=ModelId.ANNOTATION( + data["pod"].annotation().name, data["pod"].annotation().version + ) + ) + return data["loaded_pod"], data + + +def delete_annotation(data, _): + data["store"].delete_annotation( + model_type=ModelType.POD, + name=data["pod"].annotation().name, + version=data["pod"].annotation().version, + ) + return [str(p) for p in data["store"].list_pod()], data + + +def delete_pod(data, _): + data["store"].delete_pod(model_id=ModelId.HASH(data["pod"].hash())) + return [str(p) for p in data["store"].list_pod()], data + + +def test(test_dir, steps): + config = { + "namespace_lookup": { + "default": f"{test_dir}/default", + }, + "store_dir": f"{test_dir}/store", + } + data = {} + try: + for step in steps: + print(f"\n==================== {step.__name__} ====================\n") + result, data = step(data, config) + print(result) + except Exception as e: + raise e + finally: + shutil.rmtree(test_dir) + + +if __name__ == "__main__": + parser = argparse.ArgumentParser( + description="Basic tests for orcapod's Python API." + ) + parser.add_argument("test_dir", help="Root directory for tests.") + args = parser.parse_args() + + test( + test_dir=f"{args.test_dir}/{Path(__file__).stem}", + steps=[ + # Orchestrator DEMO + create_pod, + create_pod_job, + create_orch, + start_pod_job, + wait_for_pod_result, + delete_pod_run, + # Store DEMO + create_store, + save_pod, + load_pod, + delete_annotation, + delete_pod, + delete_pod, # force error to check output + ], + ) diff --git a/tests/fixture/mod.rs b/tests/fixture/mod.rs index 405fbb5c..7ffab244 100644 --- a/tests/fixture/mod.rs +++ b/tests/fixture/mod.rs @@ -27,7 +27,7 @@ use tempfile::TempDir; // --- fixtures --- pub static NAMESPACE_LOOKUP_READ_ONLY: LazyLock> = - LazyLock::new(|| HashMap::from([("default".to_owned(), PathBuf::from("./tests/data"))])); + LazyLock::new(|| HashMap::from([("default".to_owned(), PathBuf::from("./tests/extra/data"))])); pub fn pod_style() -> Result { Pod::new( @@ -76,7 +76,7 @@ pub fn pod_job_style(namespace_lookup: &HashMap) - description: "This is an example pod job.".to_owned(), version: "0.1.0".to_owned(), }), - pod_style()?, + pod_style()?.into(), HashMap::from([ ( "extra-style".to_owned(), @@ -134,7 +134,7 @@ pub fn pod_result_style( description: "This is an example pod result.".to_owned(), version: "0.0.0".to_owned(), }), - pod_job_style(namespace_lookup)?, + pod_job_style(namespace_lookup)?.into(), "simple-endeavour".to_owned(), Status::Completed, 1_737_922_307, @@ -143,7 +143,7 @@ pub fn pod_result_style( } pub fn container_image_style(binary_location: impl AsRef) -> Result { - let build_context_location = PathBuf::from("./tests/example_pod/style_transfer"); + let build_context_location = PathBuf::from("./tests/extra/example_pod/style_transfer"); if let Some(parent) = binary_location.as_ref().parent() { fs::create_dir_all(parent)?; diff --git a/tests/orchestrator.rs b/tests/orchestrator.rs index fa4c9620..193a8c8e 100644 --- a/tests/orchestrator.rs +++ b/tests/orchestrator.rs @@ -7,7 +7,7 @@ use orcapod::uniffi::{ model::OrcaPath, orchestrator::{ImageKind, Orchestrator as _, PodRun, Status, docker::LocalDockerOrchestrator}, }; -use std::{collections::HashMap, path::PathBuf}; +use std::{collections::HashMap, ops::Deref as _, path::PathBuf, sync::Arc}; fn basic_test(start: T) -> Result<()> where @@ -18,7 +18,7 @@ where { let test_dirs = TestDirs::new(&HashMap::from([( "default".to_owned(), - Some("./tests/data/"), + Some("./tests/extra/data/"), )]))?; let namespace_lookup = test_dirs.namespace_lookup(); let orchestrator = LocalDockerOrchestrator::new()?; @@ -95,7 +95,7 @@ fn offline_container_image_basic() -> Result<()> { &pod_job, &container_image_kind, )?, - pod_job.pod.command, + pod_job.pod.command.clone(), Some(container_image), )) }) @@ -105,13 +105,15 @@ fn offline_container_image_basic() -> Result<()> { fn remote_container_image_basic() -> Result<()> { basic_test(|namespace_lookup, orchestrator| { let mut pod_job = pod_job_style(namespace_lookup)?; - pod_job.pod.image = "alpine:3.14".to_owned(); - pod_job.pod.command = "sleep 5".to_owned(); - pod_job.pod.input_stream = HashMap::new(); + let mut pod = pod_job.pod.deref().clone(); + pod.image = "alpine:3.14".to_owned(); + pod.command = "sleep 5".to_owned(); + pod.input_stream = HashMap::new(); + pod_job.pod = Arc::new(pod); pod_job.input_stream = HashMap::new(); Ok(( orchestrator.start_blocking(namespace_lookup, &pod_job)?, - pod_job.pod.command, + pod_job.pod.command.clone(), None, )) }) diff --git a/tests/store.rs b/tests/store.rs index 782140c0..c5536c3c 100644 --- a/tests/store.rs +++ b/tests/store.rs @@ -14,11 +14,11 @@ use orcapod::{ core::{crypto::hash_buffer, model::to_yaml}, uniffi::{ error::Result, - model::{Annotation, Pod}, + model::{Annotation, ModelType}, store::{ModelID, ModelInfo, Store as _, filestore::LocalFileStore}, }, }; -use std::{collections::HashMap, fmt::Debug, path::Path}; +use std::{collections::HashMap, fmt::Debug, ops::Deref as _, path::Path, sync::Arc}; fn is_dir_empty(file: &Path, levels_up: usize) -> Option { Some( @@ -33,7 +33,7 @@ fn is_dir_empty(file: &Path, levels_up: usize) -> Option { fn basic_test(model: &T, expected_model: &T) -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); model.save(&store)?; let annotation = model.get_annotation().expect("Annotation missing."); assert_eq!( @@ -72,7 +72,9 @@ fn pod_basic() -> Result<()> { #[test] fn pod_job_basic() -> Result<()> { let mut expected_model = pod_job_style(&NAMESPACE_LOOKUP_READ_ONLY)?; - expected_model.pod.annotation = None; + let mut pod = expected_model.pod.deref().clone(); + pod.annotation = None; + expected_model.pod = Arc::new(pod); basic_test( &pod_job_style(&NAMESPACE_LOOKUP_READ_ONLY)?, &expected_model, @@ -83,8 +85,12 @@ fn pod_job_basic() -> Result<()> { #[test] fn pod_result_basic() -> Result<()> { let mut expected_model = pod_result_style(&NAMESPACE_LOOKUP_READ_ONLY)?; - expected_model.pod_job.annotation = None; - expected_model.pod_job.pod.annotation = None; + let mut pod_job = expected_model.pod_job.deref().clone(); + let mut pod = expected_model.pod_job.pod.deref().clone(); + pod_job.annotation = None; + pod.annotation = None; + pod_job.pod = Arc::new(pod); + expected_model.pod_job = Arc::new(pod_job); basic_test( &pod_result_style(&NAMESPACE_LOOKUP_READ_ONLY)?, &expected_model, @@ -95,23 +101,27 @@ fn pod_result_basic() -> Result<()> { #[test] fn pod_files() -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); let pod_style = pod_style()?; let annotation = pod_style .annotation .as_ref() .expect("Annotation missing from `pod_style`"); - let annotation_file = store.make_path::( + let annotation_file = store.make_path( + &pod_style, &pod_style.hash, - &LocalFileStore::make_annotation_relpath(&annotation.name, &annotation.version), + LocalFileStore::make_annotation_relpath(&annotation.name, &annotation.version), ); - let spec_file = store.make_path::(&pod_style.hash, LocalFileStore::SPEC_RELPATH); + let spec_file = store.make_path(&pod_style, &pod_style.hash, LocalFileStore::SPEC_RELPATH); store.save_pod(&pod_style)?; assert!(spec_file.exists(), "Spec file missing."); assert!(annotation_file.exists(), "Annotation file missing."); - store.delete_pod(&ModelID::Hash(pod_style.hash))?; + store.delete_pod(&ModelID::Annotation( + annotation.name.clone(), + annotation.version.clone(), + ))?; assert!(!spec_file.exists(), "Spec file wasn't cleaned up."); assert!( !annotation_file.exists(), @@ -129,7 +139,7 @@ fn pod_files() -> Result<()> { #[test] fn pod_list_empty() -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); assert_eq!(store.list_pod()?, vec![], "Pod list is not empty."); Ok(()) } @@ -137,7 +147,7 @@ fn pod_list_empty() -> Result<()> { #[test] fn pod_load_from_hash() -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); let mut pod = pod_style()?; store.save_pod(&pod)?; pod.annotation = None; @@ -152,7 +162,7 @@ fn pod_load_from_hash() -> Result<()> { #[test] fn pod_annotation_delete() -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); let mut pod = pod_style()?; store.save_pod(&pod)?; let model_version = &pod.annotation.as_ref().map(|x| x.version.clone()); @@ -186,7 +196,7 @@ fn pod_annotation_delete() -> Result<()> { "Pod list didn't return 3 expected entries." ); // case 2: delete new annotation, assert list gives 2 entries: hash, annotation (original). - store.delete_annotation::("new-name", "0.5.0")?; + store.delete_annotation(&ModelType::Pod, "new-name", "0.5.0")?; assert_eq!( store.list_pod()?, vec![ @@ -204,7 +214,8 @@ fn pod_annotation_delete() -> Result<()> { "Pod list didn't return 2 expected entry." ); // case 3: delete original annotation, assert list gives 1 entry: hash. - store.delete_annotation::( + store.delete_annotation( + &ModelType::Pod, "style-transfer", &model_version .to_owned() @@ -222,7 +233,7 @@ fn pod_annotation_delete() -> Result<()> { // case 4: delete invalid annotation, error should be returned. assert!( store - .delete_annotation::("style-transfer", "9.9.9") + .delete_annotation(&ModelType::Pod, "style-transfer", "9.9.9") .is_err_and(|error| error.is_invalid_annotation() && !format!("{error:?}").is_empty()), "Did not raise an invalid annotation error." ); @@ -232,7 +243,7 @@ fn pod_annotation_delete() -> Result<()> { #[test] fn pod_annotation_unique() -> Result<()> { let test_dirs = TestDirs::new(&HashMap::from([("default".to_owned(), None::)]))?; - let store = LocalFileStore::new(&test_dirs.0["default"]); + let store = LocalFileStore::new(test_dirs.0["default"].path().to_path_buf()); let original_annotation = Annotation { name: "example".to_owned(), version: "1.0.0".to_owned(), diff --git a/uniffi.toml b/uniffi.toml new file mode 100644 index 00000000..0884c3f3 --- /dev/null +++ b/uniffi.toml @@ -0,0 +1,2 @@ +[bindings.python] +cdylib_name = "uniffi_orcapod"