[pve-devel] [PATCH proxmox-perl-rs v2 02/11] add Perl mapping for OCI container image parser/extractor

[Wolfgang Bumiller]

I recently started reorganizing this repository so that bindings are in
the `bindings` submodule and require documentation.

See any of the `update <foo> module to new code convention` commits.

Essentially, the generated docs for the bindings submodule should be
the "perl documentation", and anything else should be rust specific
documentation.

On Wed, Jun 11, 2025 at 04:48:54PM +0200, Filip Schauer wrote:
> Signed-off-by: Filip Schauer <f.schauer at proxmox.com>
> ---
>  pve-rs/Cargo.toml     |  2 ++
>  pve-rs/Makefile       |  1 +
>  pve-rs/debian/control |  2 ++
>  pve-rs/src/lib.rs     |  1 +
>  pve-rs/src/oci.rs     | 20 ++++++++++++++++++++
>  5 files changed, 26 insertions(+)
>  create mode 100644 pve-rs/src/oci.rs
> 
> diff --git a/pve-rs/Cargo.toml b/pve-rs/Cargo.toml
> index c7f11a3..00624c3 100644
> --- a/pve-rs/Cargo.toml
> +++ b/pve-rs/Cargo.toml
> @@ -20,6 +20,7 @@ hex = "0.4"
>  http = "1"
>  libc = "0.2"
>  nix = "0.29"
> +oci-spec = "0.8.1"
>  openssl = "0.10.40"
>  serde = "1.0"
>  serde_bytes = "0.11"
> @@ -37,6 +38,7 @@ proxmox-http = { version = "1", features = ["client-sync", "client-trait"] }
>  proxmox-http-error = "1"
>  proxmox-log = "1"
>  proxmox-notify = { version = "1", features = ["pve-context"] }
> +proxmox-oci = "0.1.0"
>  proxmox-openid = "1"
>  proxmox-resource-scheduling = "1"
>  proxmox-shared-cache = "1"
> diff --git a/pve-rs/Makefile b/pve-rs/Makefile
> index afe792a..d6a667f 100644
> --- a/pve-rs/Makefile
> +++ b/pve-rs/Makefile
> @@ -27,6 +27,7 @@ PERLMOD_GENPACKAGE := /usr/lib/perlmod/genpackage.pl \
>  
>  PERLMOD_PACKAGES := \
>  	  PVE::RS::Firewall::SDN \
> +	  PVE::RS::OCI \
>  	  PVE::RS::OpenId \
>  	  PVE::RS::ResourceScheduling::Static \
>  	  PVE::RS::TFA
> diff --git a/pve-rs/debian/control b/pve-rs/debian/control
> index 9e424ec..243b428 100644
> --- a/pve-rs/debian/control
> +++ b/pve-rs/debian/control
> @@ -10,6 +10,7 @@ Build-Depends: cargo:native <!nocheck>,
>                 librust-http-1+default-dev (>= 0.2.7-~~),
>                 librust-libc-0.2+default-dev,
>                 librust-nix-0.29+default-dev,
> +               librust-oci-spec-0.8+default-dev (>= 0.8.1-~~),
>                 librust-openssl-0.10+default-dev (>= 0.10.40-~~),
>                 librust-perlmod-0.14+default-dev (>= 0.13.5-~~),
>                 librust-perlmod-0.14+exporter-dev (>= 0.13.5-~~),
> @@ -24,6 +25,7 @@ Build-Depends: cargo:native <!nocheck>,
>                 librust-proxmox-log-1+default-dev,
>                 librust-proxmox-notify-1+default-dev (>= 0.5.4),
>                 librust-proxmox-notify-1+pve-context-dev,
> +               librust-proxmox-oci-0.1+default-dev,
>                 librust-proxmox-openid-1+default-dev (>= 0.10.4-~~),
>                 librust-proxmox-resource-scheduling-1+default-dev,
>                 librust-proxmox-shared-cache-1+default-dev,
> diff --git a/pve-rs/src/lib.rs b/pve-rs/src/lib.rs
> index bb979b9..1fe9e77 100644
> --- a/pve-rs/src/lib.rs
> +++ b/pve-rs/src/lib.rs
> @@ -12,6 +12,7 @@ use proxmox_notify::{Config, Notification, Severity};
>  mod common;
>  
>  pub mod firewall;
> +pub mod oci;
>  pub mod openid;
>  
>  pub mod bindings;
> diff --git a/pve-rs/src/oci.rs b/pve-rs/src/oci.rs
> new file mode 100644
> index 0000000..dd556aa
> --- /dev/null
> +++ b/pve-rs/src/oci.rs
> @@ -0,0 +1,20 @@
> +#[perlmod::package(name = "PVE::RS::OCI")]
> +mod export {
> +    use anyhow::{Error, bail};
> +    use oci_spec::image::Config;

I think `proxmox-oci` should re-export this type, then we only need to
depend on the one crate.

> +    use proxmox_oci::{ParseError, ProxmoxOciError};
> +
> +    #[export]
> +    pub fn parse_and_extract_image(
> +        oci_tar_path: &str,
> +        rootfs_path: &str,
> +    ) -> Result<Option<Config>, Error> {
> +        match proxmox_oci::parse_and_extract_image(oci_tar_path, rootfs_path) {
> +            Ok(config) => Ok(Some(config.unwrap_or_default())),
> +            Err(err) => match err {
> +                ProxmoxOciError::ParseError(ParseError::NotAnOciImage(_)) => Ok(None),

^ Why are we doing this?

> +                err => bail!("{err}"),
> +            },
> +        }
> +    }
> +}
> -- 
> 2.39.5