oci2git 0.2.5

A tool to convert OCI images to Git repositories
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use anyhow::Result;
use std::path::PathBuf;
use tempfile::TempDir;

use crate::notifier::Notifier;

/// Source trait for getting OCI images from different container sources
pub trait Source {
    /// Returns the name of the source for identification purposes
    fn name(&self) -> &str;

    /// Retrieves an OCI image tarball and returns the path to it along with temp directory if created
    /// The image_name parameter can be an image reference (for registry sources)
    /// or a filesystem path (for local sources)
    ///
    /// Returns a tuple with the path to the tarball and an optional TempDir that needs to be kept alive
    /// for the duration of the tarball use
    fn get_image_tarball(
        &self,
        image_name: &str,
        notifier: &Notifier,
    ) -> Result<(PathBuf, Option<TempDir>)>;

    /// Generates a Git branch name from the image name/path
    /// Each source type implements its own naming strategy
    /// The os_arch and image_digest parameters are mandatory and provided by the processor after extracting metadata
    fn branch_name(&self, image_name: &str, os_arch: &str, image_digest: &str) -> String;
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sources::{DockerSource, TarSource};

    #[test]
    fn test_polymorphic_branch_naming() {
        // Test Docker source - os_arch and digest are always provided by processor
        let docker_source = DockerSource::new().unwrap();
        assert_eq!(
            docker_source.branch_name(
                "hello-world:latest",
                "linux-amd64",
                "sha256:1234567890abcdef"
            ),
            "hello-world#latest#linux-amd64#1234567890ab"
        );
        assert_eq!(
            docker_source.branch_name("nginx/nginx:1.21", "linux-arm64", "sha256:9876543210fedcba"),
            "nginx-nginx#1.21#linux-arm64#9876543210fe"
        );

        // Test Tar source - os_arch and digest are always provided by processor
        let tar_source = TarSource::new().unwrap();
        assert_eq!(
            tar_source.branch_name(
                "/path/to/my-image.tar",
                "linux-amd64",
                "sha256:1234567890abcdef"
            ),
            "my-image#linux-amd64#1234567890ab"
        );
        assert_eq!(
            tar_source.branch_name(
                "ubuntu 20.04.tar",
                "windows-amd64",
                "sha256:abcdef123456789"
            ),
            "ubuntu-20-04#windows-amd64#abcdef123456"
        );
    }
}