docker_pose/

parse.rs

use crate::verbose::Verbosity;
use crate::{DockerCommand, get_slug};
use clap_num::number_range;
use colored::*;
use regex::Regex;
use serde_yaml::{Error, Mapping, Value, to_string};
use std::cmp::{max, min};
use std::collections::BTreeMap;
use std::path::Path;
use std::sync::mpsc::{Receiver, Sender};
use std::sync::{Arc, LazyLock, Mutex, mpsc};
use std::{process, thread};

static EMPTY_MAP: LazyLock<Mapping> = LazyLock::new(Mapping::default);
static ENV_NAME_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^\w+$").unwrap());
static QUOTED_NUM_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^'[0-9]+'$").unwrap());

pub struct ComposeYaml {
    map: BTreeMap<String, Value>,
}

#[derive(Clone)]
pub struct ReplaceTag {
    /// replace tag with local or remote tag if exists
    pub tag: String,
    /// don't replace with tag unless this regex matches the image name / tag,
    /// in case the bool is false, the replacing is done if the regex doesn't match
    pub tag_filter: Option<(Regex, bool)>,
    /// docker may require to be logged-in to fetch some images info, with
    /// `true` unauthorized errors are ignored
    pub ignore_unauthorized: bool,
    /// Don't slugify the value from tag.
    pub no_slug: bool,
    /// only check tag with the local docker registry
    pub offline: bool,
    /// verbosity used when fetching remote images info
    pub verbosity: Verbosity,
    /// show tags found while they are fetched
    pub progress_verbosity: Verbosity,
    /// max number of threads used to fetch remote images info
    pub threads: u8,
}

impl ReplaceTag {
    pub fn get_remote_tag(&self) -> String {
        match self.no_slug {
            true => self.tag.clone(),
            false => get_slug(&self.tag),
        }
    }
}

impl ComposeYaml {
    pub fn new(yaml: &str) -> Result<ComposeYaml, Error> {
        let map = serde_yaml::from_str(yaml)?;
        Ok(ComposeYaml { map })
    }

    pub fn to_string(&self) -> Result<String, Error> {
        let yaml_string = to_string(&self.map)?;
        Ok(yaml_string)
    }

    pub fn get_root_element(&self, element_name: &str) -> Option<&Mapping> {
        let value = self.map.get(element_name);
        value.map(|v| v.as_mapping()).unwrap_or_default()
    }

    pub fn get_root_element_names(&self, element_name: &str) -> Vec<&str> {
        let elements = self.get_root_element(element_name).unwrap_or(&EMPTY_MAP);
        elements
            .keys()
            .map(|k| k.as_str().unwrap())
            .collect::<Vec<_>>()
    }

    pub fn get_services(&self) -> Option<&Mapping> {
        self.get_root_element("services")
    }

    pub fn get_profiles_names(&self) -> Option<Vec<&str>> {
        let services = self.get_services()?;
        let mut profiles = services
            .values()
            .flat_map(|v| v.as_mapping())
            .flat_map(|s| s.get("profiles"))
            .flat_map(|p| p.as_sequence())
            .flat_map(|seq| seq.iter())
            .flat_map(|e| e.as_str())
            .collect::<Vec<_>>();
        profiles.sort();
        profiles.dedup();
        Some(profiles)
    }

    pub fn get_images(
        &self,
        filter_by_tag: Option<&str>,
        tag: Option<&ReplaceTag>,
    ) -> Option<Vec<String>> {
        let services = self.get_services()?;
        let mut images = services
            .values()
            .flat_map(|v| v.as_mapping())
            .flat_map(|s| s.get("image"))
            .flat_map(|p| p.as_str())
            .filter(|image| match filter_by_tag {
                None => true,
                Some(tag) => {
                    let image_parts = image.split(':').collect::<Vec<_>>();
                    let image_tag = if image_parts.len() > 1 {
                        *image_parts.get(1).unwrap()
                    } else {
                        "latest"
                    };
                    tag == image_tag
                }
            })
            .collect::<Vec<_>>();
        images.sort();
        images.dedup();
        if let Some(replace_tag) = tag {
            let show_progress = matches!(replace_tag.verbosity, Verbosity::Verbose)
                || matches!(replace_tag.progress_verbosity, Verbosity::Verbose);
            let input = Arc::new(Mutex::new(
                images
                    .iter()
                    .rev()
                    .map(|e| e.to_string())
                    .collect::<Vec<String>>(),
            ));
            let replace_arc = Arc::new(replace_tag.clone());
            let mut updated_images: Vec<String> = Vec::with_capacity(images.len());
            let (tx, rx): (Sender<String>, Receiver<String>) = mpsc::channel();
            let mut thread_children = Vec::new();
            let nthreads = max(1, min(images.len(), replace_tag.threads as usize));
            if matches!(replace_tag.verbosity, Verbosity::Verbose) {
                eprintln!(
                    "{}: spawning {} threads to fetch remote info from {} images",
                    "DEBUG".green(),
                    nthreads,
                    images.len()
                )
            }
            for _ in 0..nthreads {
                let input = Arc::clone(&input);
                let replace = Arc::clone(&replace_arc);
                let thread_tx = tx.clone();
                let child = thread::spawn(move || {
                    loop {
                        let last: Option<String>;
                        {
                            let mut v = input.lock().unwrap();
                            last = v.pop(); // take one element out from the vec and free
                        } // the vector lock so other threads can get it (drop of v happens here)
                        if let Some(image) = last {
                            let image_parts = image.split(':').collect::<Vec<_>>();
                            let image_name = *image_parts.first().unwrap();
                            let remote_image =
                                format!("{}:{}", image_name, replace.get_remote_tag());
                            if replace
                                .tag_filter
                                .as_ref()
                                .map(|r| (r.1, r.0.is_match(&image)))
                                .map(|(affirmative_expr, is_match)| {
                                    (affirmative_expr && is_match)
                                        || (!affirmative_expr && !is_match)
                                })
                                .unwrap_or(true)
                            {
                                // check whether the image:<tag> exists or not locally
                                match Self::has_image(&replace, &remote_image, show_progress) {
                                    true => thread_tx.send(remote_image).unwrap(),
                                    false => match replace.offline {
                                        true => thread_tx.send(image).unwrap(),
                                        // if not exists locally, check remote registry
                                        false => match Self::has_manifest(
                                            &replace,
                                            &remote_image,
                                            show_progress,
                                        ) {
                                            true => thread_tx.send(remote_image).unwrap(),
                                            false => thread_tx.send(image).unwrap(),
                                        },
                                    },
                                }
                            } else {
                                // skip the remote check and add it as it is into the list
                                if show_progress {
                                    eprintln!(
                                        "{}: manifest for image {} ... {} ",
                                        "DEBUG".green(),
                                        image_name.yellow(),
                                        "skipped".bright_black()
                                    );
                                }
                                thread_tx.send(image.to_string()).unwrap();
                            }
                        } else {
                            break; // The vector got empty, all elements were processed
                        }
                    }
                });
                thread_children.push(child);
            }
            for _ in 0..images.len() {
                let out = rx.recv().unwrap();
                updated_images.push(out);
            }
            for child in thread_children {
                child.join().unwrap_or_else(|e| {
                    eprintln!(
                        "{}: child thread panicked while fetching remote images info: {:?}",
                        "ERROR".red(),
                        e
                    );
                });
            }
            updated_images.sort();
            return Some(updated_images);
        }
        Some(images.iter().map(|i| i.to_string()).collect::<Vec<_>>())
    }

    /// Returns whether the image exists locally, handling possible errors.
    /// When the image exists, means the image exists for the
    /// particular tag passed in the local registry.
    fn has_image(replace_tag: &ReplaceTag, remote_image: &str, show_progress: bool) -> bool {
        let command = DockerCommand::new(replace_tag.verbosity.clone());
        let inspect_output = command.get_image_inspect(remote_image).unwrap_or_else(|e| {
            eprintln!(
                "{}: fetching image manifest locally for {}: {}",
                "ERROR".red(),
                remote_image,
                e
            );
            process::exit(151);
        });
        if inspect_output.status.success() {
            if show_progress {
                eprintln!(
                    "{}: manifest for image {} ... {} ",
                    "DEBUG".green(),
                    remote_image.yellow(),
                    "found".green()
                );
            }
            true
        } else {
            let exit_code = command.exit_code(&inspect_output);
            let stderr = String::from_utf8(inspect_output.stderr).unwrap();
            if stderr.to_lowercase().contains("no such image") {
                if show_progress && replace_tag.offline {
                    eprintln!(
                        "{}: manifest for image {} ... {}",
                        "DEBUG".green(),
                        remote_image.yellow(),
                        "not found".purple()
                    );
                }
                false
            } else {
                eprintln!(
                    "{}: fetching local image manifest for {}: {}",
                    "ERROR".red(),
                    remote_image,
                    stderr
                );
                process::exit(exit_code);
            }
        }
    }

    /// Returns whether the manifest exists, handling possible errors.
    /// When the manifest exists, means the image exists for the
    /// particular tag passed in the remote registry.
    fn has_manifest(replace_tag: &ReplaceTag, remote_image: &str, show_progress: bool) -> bool {
        let command = DockerCommand::new(replace_tag.verbosity.clone());
        let inspect_output = command
            .get_manifest_inspect(remote_image)
            .unwrap_or_else(|e| {
                eprintln!(
                    "{}: fetching image manifest for {}: {}",
                    "ERROR".red(),
                    remote_image,
                    e
                );
                process::exit(151);
            });
        if inspect_output.status.success() {
            if show_progress {
                eprintln!(
                    "{}: manifest for image {} ... {} ",
                    "DEBUG".green(),
                    remote_image.yellow(),
                    "found".green()
                );
            }
            true
        } else {
            let exit_code = command.exit_code(&inspect_output);
            let stderr = String::from_utf8(inspect_output.stderr).unwrap();
            if stderr.to_lowercase().contains("no such manifest")
                || (replace_tag.ignore_unauthorized && stderr.contains("unauthorized:"))
            {
                if show_progress {
                    eprintln!(
                        "{}: manifest for image {} ... {}",
                        "DEBUG".green(),
                        remote_image.yellow(),
                        "not found".purple()
                    );
                }
                false
            } else {
                eprintln!(
                    "{}: fetching image manifest for {}: {}",
                    "ERROR".red(),
                    remote_image,
                    stderr
                );
                process::exit(exit_code);
            }
        }
    }

    /// Update all services' image attributes with the tag passed if the
    /// tag exists locally or in the remote registry, otherwise
    /// the image value is untouched.
    pub fn update_images_tag(&mut self, replace_tag: &ReplaceTag) {
        if let Some(images_with_remote) = self.get_images(None, Some(replace_tag)) {
            let services_names = self
                .get_root_element_names("services")
                .iter()
                .map(|s| s.to_string())
                .collect::<Vec<_>>();
            let services_op = self
                .map
                .get_mut("services")
                .and_then(|v| v.as_mapping_mut());
            if let Some(services) = services_op {
                for service_name in services_names {
                    let service = services.entry(Value::String(service_name.to_string()));
                    service.and_modify(|serv| {
                        if let Some(image_value) = serv.get_mut("image") {
                            let image = image_value
                                .as_str()
                                .map(|i| i.to_string())
                                .unwrap_or_default();
                            let image_name = image.split(':').next().unwrap_or_default();
                            let remote_image_op = images_with_remote.iter().find(|i| {
                                let remote_image_name = i.split(':').next().unwrap_or_default();
                                image_name == remote_image_name
                            });
                            if let Some(remote_image) = remote_image_op
                                && remote_image != &image
                                && let Value::String(string) = image_value
                            {
                                string.replace_range(.., remote_image);
                            }
                        }
                    });
                }
            }
        }
    }

    pub fn get_service(&self, service_name: &str) -> Option<&Mapping> {
        let services = self.get_services()?;
        let service = services.get(service_name);
        service.map(|v| v.as_mapping()).unwrap_or_default()
    }

    /// Return the list of services found in a vector of tuples (name, service).
    /// If the list is smaller than `service_names.len()`, means one or more
    /// services don't exist
    pub fn filter_services_by_names(&self, service_names: &[String]) -> Vec<(String, &Mapping)> {
        let services = self.get_services();
        let services = services.unwrap_or_else(|| &*EMPTY_MAP);
        let mut list: Vec<(String, &Mapping)> = Vec::new();
        for name in service_names {
            let service = services.get(name);
            if let Some(s) = service.and_then(|s| s.as_mapping()) {
                list.push((name.to_string(), s));
            }
        }
        list
    }

    /// Return the list of services found in a vector of tuples (name, service),
    /// filtering by image tag name.
    pub fn filter_services_by_image_tag(&self, filter_by_tag: &str) -> Vec<(String, &Mapping)> {
        let services = self.get_services().unwrap_or_else(|| &*EMPTY_MAP);
        let mut list: Vec<(String, &Mapping)> = Vec::new();
        for service_name in services.keys().flat_map(|k| k.as_str()) {
            let service = services
                .get(service_name)
                .and_then(|s| s.as_mapping())
                .unwrap_or(&*EMPTY_MAP);
            if let Some(img) = service.get("image").and_then(|v| v.as_str()) {
                let image_parts = img.split(':').collect::<Vec<_>>();
                let image_tag = if image_parts.len() > 1 {
                    *image_parts.get(1).unwrap()
                } else {
                    "latest"
                };
                if image_tag == filter_by_tag {
                    list.push((service_name.to_string(), service));
                }
            }
        }
        list
    }

    /// Like `filter_services_by_names`, but return the list of services if all
    /// elements exist, otherwise it fails with a list of services not found.
    pub fn get_services_by_names(
        &self,
        service_names: &[String],
    ) -> Result<Vec<(String, &Mapping)>, Vec<String>> {
        let services = self.filter_services_by_names(service_names);
        if services.len() < service_names.len() {
            let not_found = service_names
                .iter()
                .filter(|s| !services.iter().any(|(name, _)| *s == name))
                .map(|s| s.to_string())
                .collect::<Vec<_>>();
            return Err(not_found);
        }
        Ok(services)
    }

    /// List of services that are dependencies of the list of services passed.
    /// If some of the service names passed don't exist, return a list
    /// of services not found as an error.
    pub fn get_services_depends_on(
        &self,
        service_names: &[String],
    ) -> Result<Vec<String>, Vec<String>> {
        let services_list = self.get_services_by_names(service_names)?;
        let mut all_deps_op: Vec<String> = vec![];
        for (_, serv) in services_list {
            let deps_op = self.get_service_depends_on(serv);
            if let Some(deps) = deps_op {
                deps.iter().for_each(|dep| {
                    if !all_deps_op.contains(dep) && !service_names.contains(dep) {
                        all_deps_op.push(dep.to_string())
                    }
                });
            }
        }
        all_deps_op.sort();
        Ok(all_deps_op)
    }

    /// Return the list of services that are dependents of the list of services passed.
    pub fn get_services_dependants(&self, service_names: &[String]) -> Option<Vec<String>> {
        let services = self.get_services()?;
        let mut all_dependants: Vec<String> = vec![];
        for (service_name, serv) in services {
            if let Some(serv) = serv.as_mapping()
                && let Some(service_name) = service_name.as_str().map(|s| s.to_string())
                && !service_names.contains(&service_name)
            {
                let deps_op = self.get_service_depends_on(serv);
                if let Some(deps) = deps_op {
                    for dep in deps.iter() {
                        if !all_dependants.contains(dep) && service_names.contains(dep) {
                            all_dependants.push(service_name.clone())
                        }
                    }
                }
            }
        }
        all_dependants.sort();
        Some(all_dependants)
    }

    pub fn get_service_envs(&self, service: &Mapping) -> Option<Vec<String>> {
        let envs = service.get("environment")?;
        match envs.as_sequence() {
            Some(seq) => Some(
                seq.iter()
                    .map(|v| {
                        let val = v.as_str().unwrap_or("");
                        if ENV_NAME_REGEX.captures(val).is_some() {
                            // Env variable without a value or "=" at the end
                            format!("{val}=")
                        } else {
                            String::from(val)
                        }
                    })
                    .collect::<Vec<_>>(),
            ),
            None => Some(
                envs.as_mapping()
                    .unwrap_or(&EMPTY_MAP)
                    .into_iter()
                    .map(|(k, v)| {
                        let env = k.as_str().unwrap_or("".as_ref());
                        let val = to_string(v).unwrap_or("".to_string());
                        let val = val.trim_end();
                        if val.contains(' ') {
                            if val.contains('"') {
                                format!("{env}='{val}'")
                            } else {
                                format!("{env}=\"{val}\"")
                            }
                        } else if QUOTED_NUM_REGEX.captures(val).is_some() {
                            // remove unnecessary quotes
                            let val = &val[1..val.len() - 1];
                            format!("{env}={val}")
                        } else {
                            format!("{env}={val}")
                        }
                    })
                    .collect::<Vec<_>>(),
            ),
        }
    }

    pub fn get_service_depends_on(&self, service: &Mapping) -> Option<Vec<String>> {
        let depends = service.get("depends_on")?;
        match depends.as_sequence() {
            Some(seq) => Some(
                seq.iter()
                    .map(|el| el.as_str().unwrap_or(""))
                    .filter(|o| !o.is_empty())
                    .map(String::from)
                    .collect::<Vec<_>>(),
            ),
            None => Some(
                depends
                    .as_mapping()
                    .unwrap_or(&EMPTY_MAP)
                    .keys()
                    .map(|k| k.as_str().unwrap_or(""))
                    .filter(|o| !o.is_empty())
                    .map(String::from)
                    .collect::<Vec<_>>(),
            ),
        }
    }
}

// where to look for the compose file when the user
// don't provide a path
static COMPOSE_PATHS: [&str; 4] = [
    "compose.yaml",
    "compose.yml",
    "docker-compose.yaml",
    "docker-compose.yml",
];

pub fn get_compose_filename(
    filename: Option<&str>,
    verbosity: Verbosity,
) -> Result<String, String> {
    match filename {
        Some(name) => {
            if Path::new(&name).exists() {
                Ok(String::from(name))
            } else {
                Err(format!("{}: no such file or directory", name))
            }
        }
        None => {
            let files = COMPOSE_PATHS.into_iter().filter(|f| Path::new(f).exists());
            let files_count = files.clone().count();
            match files_count {
                0 => Err(format!(
                    "Can't find a suitable configuration file in this directory.\n\
                    Are you in the right directory?\n\n\
                    Supported filenames: {}",
                    COMPOSE_PATHS.into_iter().collect::<Vec<&str>>().join(", ")
                )),
                1 => {
                    let filename_0 = files.map(String::from).next().unwrap();
                    if matches!(verbosity, Verbosity::Verbose) {
                        eprintln!("{}: Filename not provided", "DEBUG".green());
                        eprintln!("{}: Using {}", "DEBUG".green(), filename_0);
                    }
                    Ok(filename_0)
                }
                _ => {
                    let filenames = files.into_iter().collect::<Vec<&str>>();
                    let filename = filenames.first().map(|s| s.to_string()).unwrap();
                    if !matches!(verbosity, Verbosity::Quiet) {
                        eprintln!(
                            "{}: Found multiple config files with supported names: {}\n\
                            {}: Using {}",
                            "WARN".yellow(),
                            filenames.join(", "),
                            "WARN".yellow(),
                            filename
                        );
                    }
                    Ok(filename)
                }
            }
        }
    }
}

pub fn positive_less_than_32(s: &str) -> Result<u8, String> {
    number_range(s, 1, 32)
}

pub fn string_no_empty(s: &str) -> Result<String, &'static str> {
    if s.is_empty() {
        return Err("must be at least 1 character long");
    }
    Ok(s.to_string())
}

/// Parser of strings in the form of "text1:text2".
/// Return a tuple of 2 strings: ("text1, "text2").
///
/// ```
/// use docker_pose::string_script;
///
/// assert_eq!(string_script("abc:def"), Ok(("abc".to_string(), "def".to_string())));
/// assert_eq!(string_script("abc:"), Ok(("abc".to_string(), "".to_string())));
/// assert_eq!(
///     string_script("abc:def:more after->:"),
///     Ok(("abc".to_string(), "def:more after->:".to_string()))
/// );
/// assert_eq!(string_script(""), Err("must be at least 2 characters long"));
/// assert_eq!(string_script("a"), Err("must be at least 2 characters long"));
/// assert_eq!(string_script("abc"), Err("separator symbol : not found in the expression"));
/// assert_eq!(string_script(":def"), Err("empty left expression"));
pub fn string_script(s: &str) -> Result<(String, String), &'static str> {
    if s.len() < 2 {
        return Err("must be at least 2 characters long");
    }
    let mut split = s.splitn(2, ':');
    let left = split.next();
    let right = split.next();
    if let Some(left_text) = left {
        if left_text == s {
            return Err("separator symbol : not found in the expression");
        }
        if left_text.is_empty() {
            return Err("empty left expression");
        }
        if let Some(right_text) = right {
            return Ok((left_text.to_string(), right_text.to_string()));
        }
    }
    // should never end here
    Err("wrong expression")
}

/// Parser of headers in the form of "Name: value".
/// Return a tuple of 2 strings: ("text1, "text2").
///
/// ```
/// use docker_pose::header;
///
/// assert_eq!(header("abc: def"), Ok(("abc".to_string(), "def".to_string())));
/// assert_eq!(header("a:b"), header("a: b"));
/// assert_eq!(header("abc:"), Ok(("abc".to_string(), "".to_string())));
/// assert_eq!(
///     header("abc: def:more after->:"),
///     Ok(("abc".to_string(), "def:more after->:".to_string()))
/// );
/// assert_eq!(header(""), Err("must be at least 3 characters long"));
/// assert_eq!(header("a"), Err("must be at least 3 characters long"));
/// assert_eq!(header("abc"), Err("separator symbol : not found in the header expression"));
/// assert_eq!(header(":def"), Err("empty header name"));
pub fn header(s: &str) -> Result<(String, String), &'static str> {
    if s.len() < 3 {
        return Err("must be at least 3 characters long");
    }
    let mut split = s.splitn(2, ':');
    let left = split.next();
    let right = split.next();
    if let Some(left_text) = left {
        if left_text == s {
            return Err("separator symbol : not found in the header expression");
        }
        if left_text.is_empty() {
            return Err("empty header name");
        }
        if let Some(right_text) = right {
            return Ok((
                left_text.trim_start().to_string(),
                right_text.trim_start().to_string(),
            ));
        }
    }
    // should never end here
    Err("wrong header expression")
}