core-dockpack 0.1.3

A library for unpacking files from Docker images
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Defines the actions around downloading and unpacking docker images to access the files.
use std::process::Command;
use tar::Archive;
use std::fs::File;
use super::cache::process_image_name;


/// Pulls a docker image from the docker registry.
///
/// # Arguments
/// * `image_name` - A string slice that holds the name of the docker image to pull.
///
/// # Returns
/// None
pub fn pull_docker_image(image_name: &str) -> Result<(), String> {
    let status = Command::new("docker")
        .args(["pull", image_name])
        .status().map_err(|e| e.to_string())?;

    if status.success() {
        Ok(())
    } else {
        Err("Failed to pull Docker image".to_string())
    }
}


/// Pushes a Docker image to the Docker registry.
/// 
/// # Arguments
/// * `image_name` - The name of the Docker image to push.
/// 
/// # Returns
/// A result indicating if the Docker image was pushed successfully or an error message
pub fn push_docker_image(image_name: &str) -> Result<(), String> {
    let status = Command::new("docker")
        .args(["push", image_name])
        .status().map_err(|e| e.to_string())?;

    if status.success() {
        Ok(())
    } else {
        Err("Failed to push Docker image".to_string())
    }
}


/// Extracts the Tar file from the Docker image, and saves it to the specified path.
///
/// # Notes
/// The pulling of the Docker image is also handled in this function.
///
/// # Arguments
/// * `image_name` - The name of the Docker image to pull and unpack.
/// * `tar_path` - The path to save the unpacked Docker image.
///
/// # Returns
/// The path to where the compressed Docker image files are stored
pub fn save_docker_image(image_name: &str, tar_path: &str) -> Result<String, String> {
    pull_docker_image(image_name)?; // Ensure the image is pulled before saving it

    let tar_path = std::path::Path::new(tar_path);
    let tar_file = image_name;
    let tar_file = process_image_name(&tar_file.to_string());

    let binding = tar_path.join(format!("{}.tar", tar_file));
    let unpack_tar_path = match binding.to_str() {
        Some(v) => v,
        None => {
            return Err("Failed to convert path to string".to_string())
        }
    };
    let package_path = tar_path.join(tar_file);

    println!("Tar path: {:?}", tar_path);

    let _ = Command::new("docker")
        .args(["save", "-o", unpack_tar_path, image_name])
        .status().map_err(|e| e.to_string())?;

    let tar_file = File::open(unpack_tar_path).map_err(|e| e.to_string())?;
    let mut archive = Archive::new(tar_file);

    archive.unpack(&package_path).map_err(|e| e.to_string())?;

    // return statement
    Ok(match package_path.to_str() {
        Some(v) => v.to_string(),
        None => {
            return Err("Failed to convert path to string".to_string())
        }
    })
}


/// Builds a Docker image from a given build context directory.
/// 
/// # Arguments
/// * `image` - A string slice that holds the name of the Docker image to build
/// * `file_path` - A string slice that holds the path to the Dockerfile
/// 
/// # Returns
/// * `Result<(), String>` - A result that indicates if the Docker image was built successfully or an error message
pub fn build_docker_image(image: &str, file_path: &str) -> Result<(), String> {
    let platforms = "linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6,linux/s390x,linux/ppc64le";
    let status = Command::new("docker")
    .args(["build", "--platform", platforms, "-t", image, "-f", file_path, "."])
    // .arg(directory) // Add the directory as a separate argument
    .status().map_err(|e| e.to_string())?;

    if status.success() {
        Ok(())
    } else {
        Err("Failed to build Docker image".to_string())
    }
}