ghaction_version_gen 0.17.0

// Copyright (C) 2021 Leandro Lisboa Penz <lpenz@lpenz.org>
// This file is subject to the terms and conditions defined in
// file 'LICENSE', which is part of this source code package.

pub mod git;
pub mod python;
pub mod rust;

use std::env;
use std::error::Error;
use std::fs;
use std::io::Write;
use std::path::Path;
use std::str;

use clap::Parser;

use color_eyre::Result;
use color_eyre::eyre::bail;

use regex::Regex;

#[derive(Debug, Default, Clone)]
pub struct Info {
    pub pwd_basename: String,
    pub is_push: Option<bool>,
    pub is_tag: Option<bool>,
    pub is_main: Option<bool>,
    pub is_push_tag: Option<bool>,
    pub is_push_main: Option<bool>,
    pub commit: String,
    pub commit_main: Option<String>,
    pub is_main_here: Option<bool>,
    pub git_describe_tags: String,
    pub tag_latest: String,
    pub distance: Option<String>,
    pub dash_distance: Option<String>,
    pub tag_distance: Option<String>,
    pub tag_head: Option<String>,
    pub tag_latest_ltrimv: Option<String>,
    pub tag_distance_ltrimv: Option<String>,
    pub tag_head_ltrimv: Option<String>,
    pub rust_crate_name: Option<String>,
    pub rust_crate_version: Option<String>,
    pub python_module_version: Option<String>,
    pub version_mismatch: Option<String>,
    pub version_tagged: Option<String>,
    pub version_commit: Option<String>,
    pub version_docker_ci: String,
    pub override_version_tagged: Option<String>,
    pub override_version_commit: Option<String>,
    pub override_version_docker_ci: Option<String>,
    pub name: String,
    pub rpm_basename: String,
    pub deb_basename: String,
}

impl Info {
    pub fn parse_env(&mut self, enviter: impl Iterator<Item = (String, String)>) {
        for (k, v) in enviter {
            match k.as_str() {
                "PWD" => {
                    let path = Path::new(&v);
                    self.pwd_basename = path
                        .file_name()
                        .expect("PWD basename")
                        .display()
                        .to_string();
                }
                "GITHUB_EVENT_NAME" => {
                    self.is_push = Some(v == "push");
                }
                "GITHUB_REF" => {
                    self.is_tag = Some(v.starts_with("refs/tags/"));
                    self.is_main = Some(v == "refs/heads/main" || v == "refs/heads/master");
                }
                "OVERRIDE_VERSION_TAGGED" => {
                    self.override_version_tagged = Some(v);
                }
                "OVERRIDE_VERSION_COMMIT" => {
                    self.override_version_commit = Some(v);
                }
                "OVERRIDE_VERSION_DOCKER_CI" => {
                    self.override_version_docker_ci = Some(v);
                }
                _ => {}
            }
        }
    }

    pub fn parse_files<P: AsRef<Path>>(&mut self, repo: P) -> Result<()> {
        if let Some(cratedata) = rust::crate_data(&repo)? {
            self.rust_crate_name = Some(cratedata.name);
            self.rust_crate_version = Some(cratedata.version);
        }
        if let Some(version) = python::module_version(&repo)? {
            self.python_module_version = Some(version);
        }
        Ok(())
    }

    pub fn parse_describe(&mut self, s0: impl AsRef<str>) -> Result<()> {
        let s = s0.as_ref();
        self.git_describe_tags = s.into();
        let re = Regex::new(r"^(?P<tag_latest>.*)-(?P<distance>\d+)-g[0-9a-f]+$")?;
        if let Some(m) = re.captures(s) {
            self.tag_latest = m.name("tag_latest").unwrap().as_str().into();
            self.distance = Some(m.name("distance").unwrap().as_str().into());
        } else {
            self.tag_latest = s.into();
            self.distance = Some("0".into());
            self.tag_head = Some(s.into());
        }
        Ok(())
    }

    pub fn eval(&mut self) -> Result<()> {
        // Evaluate trivial parameters:
        self.is_push_tag = match (self.is_push, self.is_tag) {
            (Some(a), Some(b)) => Some(a && b),
            _ => None,
        };
        self.is_push_main = match (self.is_push, self.is_main) {
            (Some(a), Some(b)) => Some(a && b),
            _ => None,
        };
        let re = Regex::new(r"^v?(?P<tag_ltrimv>.*)$")?;
        if let Some(ref distance) = self.distance {
            let dash_distance = format!("-{distance}");
            self.dash_distance = Some(dash_distance.clone());
            let tag_distance = format!("{}{}", self.tag_latest, dash_distance);
            self.tag_distance = Some(tag_distance.clone());
            self.tag_latest_ltrimv = Some(re.replace(&self.tag_latest, "$tag_ltrimv").into());
            self.tag_distance_ltrimv = Some(re.replace(&tag_distance, "$tag_ltrimv").into());
        }
        if let Some(ref tag_head) = self.tag_head {
            self.tag_head_ltrimv = Some(re.replace(tag_head, "$tag_ltrimv").into());
        }
        // Evaluate version outputs, correlating the previous variables
        self.name = if let Some(name) = &self.rust_crate_name {
            name.clone()
        } else {
            self.pwd_basename.clone()
        };
        if self.is_push_tag == Some(true) {
            self.version_tagged = self
                .override_version_tagged
                .as_ref()
                .or(self.tag_head_ltrimv.as_ref())
                .cloned();
            self.version_commit = self
                .override_version_commit
                .as_ref()
                .or(self.tag_latest_ltrimv.as_ref())
                .cloned();
            self.version_docker_ci = self
                .override_version_docker_ci
                .as_ref()
                .or(self.tag_latest_ltrimv.as_ref())
                .cloned()
                .unwrap();
        } else if self.is_push_main == Some(true) {
            if let Some(distance_str) = &self.distance {
                if let Ok(distance) = distance_str.parse::<u32>() {
                    if distance > 0 {
                        // Only set version_commit if we are not putting the
                        // commit over a tag.
                        // If we are, then we already had a version_commit on
                        // the tag itself, or we don't have a tag at all.
                        self.version_commit = self
                            .override_version_commit
                            .as_ref()
                            .or(self.tag_distance_ltrimv.as_ref())
                            .cloned();
                    }
                }
            }
            self.version_docker_ci = self
                .override_version_docker_ci
                .as_ref()
                .unwrap_or(&String::from("latest"))
                .clone();
        } else {
            self.version_docker_ci = self
                .override_version_docker_ci
                .as_ref()
                .unwrap_or(&String::from("null"))
                .clone();
        }
        if let Some(version_commit) = &self.version_commit {
            // If we have a full version_commit, use it.
            // (i.e. we are pushing a tag or main after a tag)
            self.rpm_basename = format!("{}-{}", self.name, version_commit);
            self.deb_basename = format!("{}_{}", self.name, version_commit);
        } else if let Some(tag_distance_ltrimv) = &self.tag_distance_ltrimv {
            // If we are pushing non-main after a tag, add the tag-distance and the commit:
            self.rpm_basename = format!("{}-{}-{}", self.name, tag_distance_ltrimv, self.commit);
            self.deb_basename = format!("{}_{}-{}", self.name, tag_distance_ltrimv, self.commit);
        } else {
            // Last-resort: if we never had a tag, use the name.
            self.rpm_basename = self.name.clone();
            self.deb_basename = self.name.clone();
        }
        // Warnings
        if let Some(tag_latest_ltrimv) = &self.tag_latest_ltrimv {
            if self.is_push_tag == Some(true) || self.is_push_main == Some(true) {
                if let Some(ref version) = self.rust_crate_version {
                    if version != tag_latest_ltrimv {
                        self.version_mismatch = Some(format!(
                            "file=Cargo.toml::Version mismatch: tag {tag_latest_ltrimv} != {version} from Cargo.toml",
                        ));
                    }
                }
                if let Some(ref version) = self.python_module_version {
                    if version != tag_latest_ltrimv {
                        self.version_mismatch = Some(format!(
                            "file=setup.cfg::Version mismatch: tag {tag_latest_ltrimv} != {version} from setup.cfg",
                        ));
                    }
                }
            }
            if self.is_push_tag == Some(true) && self.is_main_here != Some(true) {
                self.version_mismatch = Some(format!(
                    "file=.git::Version mismatch::Version tag {} pushed over {}, but main branch is at {:?}",
                    tag_latest_ltrimv, self.commit, self.commit_main
                ));
            }
        }
        Ok(())
    }

    pub fn from_workspace<P: AsRef<Path>>(
        repo: P,
        enviter: impl Iterator<Item = (String, String)>,
    ) -> Result<Info> {
        let _ = git::unshallow(&repo);
        let commit = git::head_commit(&repo)?;
        let commit_main = git::ref_commit(&repo, "refs/remotes/origin/main")
            .or_else(|_| git::ref_commit(&repo, "refs/remotes/origin/master"))
            .or_else(|_| git::ref_commit(&repo, "refs/heads/main"))
            .or_else(|_| git::ref_commit(&repo, "refs/heads/master"))
            .ok();
        let is_main_here = commit_main.as_ref().map(|c| c == &commit);
        let mut info = Info {
            commit,
            commit_main,
            is_main_here,
            ..Info::default()
        };
        info.parse_env(enviter);
        info.parse_files(&repo)?;
        if let Ok(gitdescr) = git::describe(&repo) {
            info.parse_describe(gitdescr)?;
        }
        info.eval()?;
        Ok(info)
    }
}

pub fn bool2str(b: bool) -> &'static str {
    if b { "true" } else { "false" }
}

impl<'a> IntoIterator for &'a Info {
    type Item = (&'static str, &'a str);
    type IntoIter = std::vec::IntoIter<(&'static str, &'a str)>;
    fn into_iter(self) -> Self::IntoIter {
        let mut vec: Vec<(&'static str, &'a str)> = vec![
            ("name", &self.name),
            ("commit", &self.commit),
            ("git_describe_tags", &self.git_describe_tags),
            ("tag_latest", &self.tag_latest),
            ("version_docker_ci", &self.version_docker_ci),
            ("rpm_basename", &self.rpm_basename),
            ("deb_basename", &self.deb_basename),
        ];
        if let Some(ref v) = self.is_push {
            vec.push(("is_push", bool2str(*v)));
        }
        if let Some(ref v) = self.is_tag {
            vec.push(("is_tag", bool2str(*v)));
        }
        if let Some(ref v) = self.is_main {
            vec.push(("is_main", bool2str(*v)));
        }
        if let Some(ref v) = self.is_push_tag {
            vec.push(("is_push_tag", bool2str(*v)));
        }
        if let Some(ref v) = self.is_push_main {
            vec.push(("is_push_main", bool2str(*v)));
        }
        if let Some(ref v) = self.commit_main {
            vec.push(("commit_main", v));
        }
        if let Some(ref v) = self.is_main_here {
            vec.push(("is_main_here", bool2str(*v)));
        }
        if let Some(ref t) = self.tag_head {
            vec.push(("tag_head", t));
        }
        if let Some(ref t) = self.tag_head_ltrimv {
            vec.push(("tag_head_ltrimv", t));
        }
        if let Some(ref t) = self.distance {
            vec.push(("distance", t));
        }
        if let Some(ref t) = self.dash_distance {
            vec.push(("dash_distance", t));
        }
        if let Some(ref t) = self.tag_distance {
            vec.push(("tag_distance", t));
        }
        if let Some(ref t) = self.tag_latest_ltrimv {
            vec.push(("tag_latest_ltrimv", t));
        }
        if let Some(ref t) = self.tag_distance_ltrimv {
            vec.push(("tag_distance_ltrimv", t));
        }
        if let Some(ref t) = self.rust_crate_version {
            vec.push(("rust_crate_version", t));
        }
        if let Some(ref t) = self.python_module_version {
            vec.push(("python_module_version", t));
        }
        if let Some(ref t) = self.version_mismatch {
            vec.push(("version_mismatch", t));
        }
        if let Some(ref t) = self.version_tagged {
            vec.push(("version_tagged", t));
        }
        if let Some(ref t) = self.version_commit {
            vec.push(("version_commit", t));
        }
        if let Some(ref t) = self.override_version_tagged {
            vec.push(("override_version_tagged", t));
        }
        if let Some(ref t) = self.override_version_commit {
            vec.push(("override_version_commit", t));
        }
        if let Some(ref t) = self.override_version_docker_ci {
            vec.push(("override_version_docker_ci", t));
        }
        vec.into_iter()
    }
}

fn write_github_output(output_filename: &Path, info: &Info) -> Result<()> {
    let mut output = fs::File::options().append(true).open(output_filename)?;
    for (k, v) in info {
        writeln!(output, "{k}={v}")?;
    }
    Ok(())
}

pub fn process_repo(repo: Option<&Path>) -> Result<()> {
    let curr_dir = env::current_dir()?;
    let workspace = if let Some(path) = repo {
        path
    } else {
        &curr_dir
    };
    let info = Info::from_workspace(workspace, env::vars())?;
    for (k, v) in &info {
        println!("Setting {k}={v}");
    }
    if let Ok(output_filename) = env::var("GITHUB_OUTPUT") {
        write_github_output(Path::new(&output_filename), &info)?;
    }
    if let Some(ref message) = info.version_mismatch {
        if info.is_push_tag == Some(true) {
            println!("::error {message}");
            bail!("Version mismatch while pushing tag");
        } else {
            println!("::warning {message}");
        }
    }
    Ok(())
}

#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
pub struct Args {}

pub fn main() -> Result<(), Box<dyn Error>> {
    color_eyre::install()?;
    Args::parse();
    process_repo(None)?;
    Ok(())
}