ognibuild 0.2.11

//! Support for Perl dependencies.
//!
//! This module provides functionality for working with Perl dependencies,
//! including Perl modules, pre-declared dependencies, and file dependencies.

use crate::dependency::Dependency;
use crate::installer::{Error, Explanation, InstallationScope, Installer};
use crate::session::Session;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
/// A dependency on a Perl module.
///
/// This represents a dependency on a Perl module that needs to be installed
/// for the code to function properly.
pub struct PerlModuleDependency {
    /// The name of the Perl module.
    pub module: String,
    /// The optional filename that contains the module.
    pub filename: Option<String>,
    /// Optional include paths for finding the module.
    pub inc: Option<Vec<String>>,
}

impl PerlModuleDependency {
    /// Create a new Perl module dependency with filename and include paths.
    ///
    /// # Arguments
    /// * `module` - The name of the Perl module
    /// * `filename` - Optional filename that contains the module
    /// * `inc` - Optional include paths for finding the module
    ///
    /// # Returns
    /// A new PerlModuleDependency
    pub fn new(module: &str, filename: Option<&str>, inc: Option<Vec<&str>>) -> Self {
        Self {
            module: module.to_string(),
            filename: filename.map(|s| s.to_string()),
            inc: inc.map(|v| v.iter().map(|s| s.to_string()).collect()),
        }
    }

    /// Create a simple Perl module dependency with just a module name.
    ///
    /// # Arguments
    /// * `module` - The name of the Perl module
    ///
    /// # Returns
    /// A new PerlModuleDependency with no filename or include paths
    pub fn simple(module: &str) -> Self {
        Self {
            module: module.to_string(),
            filename: None,
            inc: None,
        }
    }
}

impl Dependency for PerlModuleDependency {
    fn family(&self) -> &'static str {
        "perl-module"
    }

    fn present(&self, session: &dyn Session) -> bool {
        let mut cmd = vec!["perl".to_string(), "-M".to_string(), self.module.clone()];
        if let Some(filename) = &self.filename {
            cmd.push(filename.to_string());
        }
        if let Some(inc) = &self.inc {
            cmd.push("-I".to_string());
            cmd.push(inc.join(":"));
        }
        cmd.push("-e".to_string());
        cmd.push("1".to_string());
        session
            .command(cmd.iter().map(|s| s.as_str()).collect())
            .stdout(std::process::Stdio::null())
            .stderr(std::process::Stdio::null())
            .run()
            .unwrap()
            .success()
    }

    fn project_present(&self, _session: &dyn Session) -> bool {
        todo!()
    }
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

#[cfg(feature = "upstream")]
impl crate::upstream::FindUpstream for PerlModuleDependency {
    fn find_upstream(&self) -> Option<crate::upstream::UpstreamMetadata> {
        let rt = tokio::runtime::Runtime::new().unwrap();
        rt.block_on(upstream_ontologist::providers::perl::remote_cpan_data(
            &self.module,
        ))
        .ok()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
/// A dependency on a predeclared Perl module.
///
/// This represents a dependency on a Perl module that is known by name but
/// may map to a different actual module name.
pub struct PerlPreDeclaredDependency {
    name: String,
}

/// Map a predeclared module name to an actual module name.
///
/// # Arguments
/// * `name` - The predeclared module name
///
/// # Returns
/// The actual module name if known
fn known_predeclared_module(name: &str) -> Option<&str> {
    // TODO(jelmer): Can we obtain this information elsewhere?
    match name {
        "auto_set_repository" => Some("Module::Install::Repository"),
        "author_tests" => Some("Module::Install::AuthorTests"),
        "recursive_author_tests" => Some("Module::Install::AuthorTests"),
        "author_requires" => Some("Module::Install::AuthorRequires"),
        "readme_from" => Some("Module::Install::ReadmeFromPod"),
        "catalyst" => Some("Module::Install::Catalyst"),
        "githubmeta" => Some("Module::Install::GithubMeta"),
        "use_ppport" => Some("Module::Install::XSUtil"),
        "pod_from" => Some("Module::Install::PodFromEuclid"),
        "write_doap_changes" => Some("Module::Install::DOAPChangeSets"),
        "use_test_base" => Some("Module::Install::TestBase"),
        "jsonmeta" => Some("Module::Install::JSONMETA"),
        "extra_tests" => Some("Module::Install::ExtraTests"),
        "auto_set_bugtracker" => Some("Module::Install::Bugtracker"),
        _ => None,
    }
}

impl PerlPreDeclaredDependency {
    /// Create a new predeclared Perl module dependency.
    ///
    /// # Arguments
    /// * `name` - The name of the predeclared module
    ///
    /// # Returns
    /// A new PerlPreDeclaredDependency
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
        }
    }
}

impl Dependency for PerlPreDeclaredDependency {
    fn family(&self) -> &'static str {
        "perl-predeclared"
    }

    fn present(&self, session: &dyn Session) -> bool {
        if let Some(module) = known_predeclared_module(&self.name) {
            PerlModuleDependency::simple(module).present(session)
        } else {
            todo!()
        }
    }

    fn project_present(&self, _session: &dyn Session) -> bool {
        todo!()
    }
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

#[cfg(feature = "debian")]
impl crate::dependencies::debian::IntoDebianDependency for PerlPreDeclaredDependency {
    fn try_into_debian_dependency(
        &self,
        apt: &crate::debian::apt::AptManager,
    ) -> std::option::Option<std::vec::Vec<crate::dependencies::debian::DebianDependency>> {
        if let Some(module) = known_predeclared_module(&self.name) {
            PerlModuleDependency::simple(module).try_into_debian_dependency(apt)
        } else {
            None
        }
    }
}

impl crate::buildlog::ToDependency
    for buildlog_consultant::problems::common::MissingPerlPredeclared
{
    fn to_dependency(&self) -> Option<Box<dyn Dependency>> {
        match known_predeclared_module(self.0.as_str()) {
            Some(_module) => Some(Box::new(PerlModuleDependency::simple(self.0.as_str()))),
            None => {
                log::warn!("Unknown predeclared function: {}", self.0);
                None
            }
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
/// A dependency on a Perl file.
///
/// This represents a dependency on a specific Perl file rather than a module.
pub struct PerlFileDependency {
    filename: String,
}

impl PerlFileDependency {
    /// Create a new Perl file dependency.
    ///
    /// # Arguments
    /// * `filename` - The path to the Perl file
    ///
    /// # Returns
    /// A new PerlFileDependency
    pub fn new(filename: &str) -> Self {
        Self {
            filename: filename.to_string(),
        }
    }
}

impl Dependency for PerlFileDependency {
    fn family(&self) -> &'static str {
        "perl-file"
    }

    fn present(&self, session: &dyn Session) -> bool {
        session
            .command(vec!["perl", "-e", &format!("require '{}'", self.filename)])
            .stdout(std::process::Stdio::null())
            .stderr(std::process::Stdio::null())
            .run()
            .unwrap()
            .success()
    }

    fn project_present(&self, _session: &dyn Session) -> bool {
        false
    }
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

impl crate::buildlog::ToDependency for buildlog_consultant::problems::common::MissingPerlFile {
    fn to_dependency(&self) -> Option<Box<dyn Dependency>> {
        Some(Box::new(PerlFileDependency {
            filename: self.filename.clone(),
        }))
    }
}

/// A resolver for Perl module dependencies using CPAN.
///
/// This resolver installs Perl modules from CPAN using the cpan command.
pub struct CPAN<'a> {
    session: &'a dyn Session,
    skip_tests: bool,
}

impl<'a> CPAN<'a> {
    /// Create a new CPAN resolver.
    ///
    /// # Arguments
    /// * `session` - The session to use for executing commands
    /// * `skip_tests` - Whether to skip tests when installing modules
    ///
    /// # Returns
    /// A new CPAN resolver
    pub fn new(session: &'a dyn Session, skip_tests: bool) -> Self {
        Self {
            session,
            skip_tests,
        }
    }

    fn cmd(
        &self,
        reqs: &[&PerlModuleDependency],
        _scope: InstallationScope,
    ) -> Result<Vec<String>, Error> {
        let mut ret = vec!["cpan".to_string(), "-i".to_string()];
        if self.skip_tests {
            ret.push("-T".to_string());
        }
        ret.extend(reqs.iter().map(|req| req.module.clone()));
        Ok(ret)
    }
}

impl<'a> Installer for CPAN<'a> {
    fn explain(
        &self,
        dep: &dyn Dependency,
        scope: InstallationScope,
    ) -> Result<Explanation, Error> {
        if let Some(dep) = dep.as_any().downcast_ref::<PerlModuleDependency>() {
            let cmd = self.cmd(&[dep], scope)?;
            let explanation = Explanation {
                message: "Install the following Perl modules".to_string(),
                command: Some(cmd),
            };
            Ok(explanation)
        } else {
            Err(Error::UnknownDependencyFamily)
        }
    }

    fn install(&self, dep: &dyn Dependency, scope: InstallationScope) -> Result<(), Error> {
        let env = maplit::hashmap! {
            "PERL_MM_USE_DEFAULT".to_string() => "1".to_string(),
            "PERL_MM_OPT".to_string() => "".to_string(),
            "PERL_MB_OPT".to_string() => "".to_string(),
        };

        let user = match scope {
            InstallationScope::User => None,
            InstallationScope::Global => Some("root"),
            InstallationScope::Vendor => {
                return Err(Error::UnsupportedScope(scope));
            }
        };

        let dep = dep
            .as_any()
            .downcast_ref::<PerlModuleDependency>()
            .ok_or(Error::UnknownDependencyFamily)?;
        let cmd = self.cmd(&[dep], scope)?;
        log::info!("CPAN: running {:?}", cmd);

        let mut cmd = self
            .session
            .command(cmd.iter().map(|s| s.as_str()).collect())
            .env(env);

        if let Some(user) = user {
            cmd = cmd.user(user);
        }

        cmd.run_detecting_problems()?;

        Ok(())
    }

    fn explain_some(
        &self,
        deps: Vec<Box<dyn Dependency>>,
        scope: InstallationScope,
    ) -> Result<(Vec<Explanation>, Vec<Box<dyn Dependency>>), Error> {
        let mut explanations = Vec::new();
        let mut failed = Vec::new();
        for dep in deps {
            match self.explain(&*dep, scope) {
                Ok(explanation) => explanations.push(explanation),
                Err(Error::UnknownDependencyFamily) => failed.push(dep),
                Err(e) => {
                    return Err(e);
                }
            }
        }
        Ok((explanations, failed))
    }

    fn install_some(
        &self,
        deps: Vec<Box<dyn Dependency>>,
        scope: InstallationScope,
    ) -> Result<(Vec<Box<dyn Dependency>>, Vec<Box<dyn Dependency>>), Error> {
        let mut installed = Vec::new();
        let mut failed = Vec::new();

        for dep in deps {
            match self.install(&*dep, scope) {
                Ok(()) => installed.push(dep),
                Err(Error::UnknownDependencyFamily) => failed.push(dep),
                Err(e) => {
                    return Err(e);
                }
            }
        }
        Ok((installed, failed))
    }
}

/// Default paths where Perl modules can be installed.
pub const DEFAULT_PERL_PATHS: &[&str] = &[
    "/usr/share/perl5",
    "/usr/lib/.*/perl5/.*",
    "/usr/lib/.*/perl-base",
    "/usr/lib/.*/perl/[^/]+",
    "/usr/share/perl/[^/]+",
];

#[cfg(feature = "debian")]
impl crate::dependencies::debian::IntoDebianDependency for PerlModuleDependency {
    fn try_into_debian_dependency(
        &self,
        apt: &crate::debian::apt::AptManager,
    ) -> std::option::Option<std::vec::Vec<crate::dependencies::debian::DebianDependency>> {
        use std::path::Path;

        let (regex, paths) = if let (Some(inc), Some(filename)) =
            (self.inc.as_ref(), self.filename.as_ref())
        {
            (
                false,
                inc.iter().map(|s| Path::new(s).join(filename)).collect(),
            )
        } else if let Some(filename) = &self.filename {
            if !Path::new(filename).is_absolute() {
                (
                    true,
                    DEFAULT_PERL_PATHS
                        .iter()
                        .map(|s| Path::new(s).join(filename))
                        .collect(),
                )
            } else {
                (false, vec![Path::new(filename).to_path_buf()])
            }
        } else {
            (
                true,
                DEFAULT_PERL_PATHS
                    .iter()
                    .map(|s| Path::new(s).join(format!("{}.pm", &self.module.replace("::", "/"))))
                    .collect(),
            )
        };

        let packages = apt
            .get_packages_for_paths(
                paths
                    .iter()
                    .map(|s| s.to_str().unwrap())
                    .collect::<Vec<_>>(),
                regex,
                false,
            )
            .unwrap();

        Some(
            packages
                .into_iter()
                .map(|p| crate::dependencies::debian::DebianDependency::simple(&p))
                .collect(),
        )
    }
}

#[cfg(feature = "debian")]
impl crate::dependencies::debian::IntoDebianDependency for PerlFileDependency {
    fn try_into_debian_dependency(
        &self,
        apt: &crate::debian::apt::AptManager,
    ) -> std::option::Option<std::vec::Vec<crate::dependencies::debian::DebianDependency>> {
        let packages = apt
            .get_packages_for_paths(vec![&self.filename], false, false)
            .unwrap();

        Some(
            packages
                .into_iter()
                .map(|p| crate::dependencies::debian::DebianDependency::simple(&p))
                .collect(),
        )
    }
}

impl crate::buildlog::ToDependency for buildlog_consultant::problems::common::MissingPerlModule {
    fn to_dependency(&self) -> Option<Box<dyn Dependency>> {
        Some(Box::new(PerlModuleDependency {
            module: self.module.clone(),
            filename: self.filename.clone(),
            inc: self.inc.clone(),
        }))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::buildlog::ToDependency;

    #[test]
    fn test_perl_module_dependency_new() {
        let dependency = PerlModuleDependency::new(
            "Test::More",
            Some("Test/More.pm"),
            Some(vec!["/usr/share/perl5"]),
        );
        assert_eq!(dependency.module, "Test::More");
        assert_eq!(dependency.filename, Some("Test/More.pm".to_string()));
        assert_eq!(dependency.inc, Some(vec!["/usr/share/perl5".to_string()]));
    }

    #[test]
    fn test_perl_module_dependency_simple() {
        let dependency = PerlModuleDependency::simple("Test::More");
        assert_eq!(dependency.module, "Test::More");
        assert_eq!(dependency.filename, None);
        assert_eq!(dependency.inc, None);
    }

    #[test]
    fn test_perl_module_dependency_family() {
        let dependency = PerlModuleDependency::simple("Test::More");
        assert_eq!(dependency.family(), "perl-module");
    }

    #[test]
    fn test_perl_module_dependency_as_any() {
        let dependency = PerlModuleDependency::simple("Test::More");
        let any_dep = dependency.as_any();
        assert!(any_dep.downcast_ref::<PerlModuleDependency>().is_some());
    }

    #[test]
    fn test_missing_perl_module_to_dependency() {
        let problem = buildlog_consultant::problems::common::MissingPerlModule {
            module: "Test::More".to_string(),
            filename: Some("Test/More.pm".to_string()),
            inc: None,
            minimum_version: None,
        };
        let dependency = problem.to_dependency();
        assert!(dependency.is_some());
        let dep = dependency.unwrap();
        assert_eq!(dep.family(), "perl-module");
        let perl_dep = dep.as_any().downcast_ref::<PerlModuleDependency>().unwrap();
        assert_eq!(perl_dep.module, "Test::More");
        assert_eq!(perl_dep.filename, Some("Test/More.pm".to_string()));
    }

    #[test]
    fn test_perl_predeclared_dependency_new() {
        let dependency = PerlPreDeclaredDependency::new("auto_set_repository");
        assert_eq!(dependency.name, "auto_set_repository");
    }

    #[test]
    fn test_perl_predeclared_dependency_family() {
        let dependency = PerlPreDeclaredDependency::new("auto_set_repository");
        assert_eq!(dependency.family(), "perl-predeclared");
    }

    #[test]
    fn test_perl_predeclared_dependency_as_any() {
        let dependency = PerlPreDeclaredDependency::new("auto_set_repository");
        let any_dep = dependency.as_any();
        assert!(any_dep
            .downcast_ref::<PerlPreDeclaredDependency>()
            .is_some());
    }

    #[test]
    fn test_known_predeclared_module() {
        assert_eq!(
            known_predeclared_module("auto_set_repository"),
            Some("Module::Install::Repository")
        );
        assert_eq!(
            known_predeclared_module("author_tests"),
            Some("Module::Install::AuthorTests")
        );
        assert_eq!(known_predeclared_module("unknown_function"), None);
    }

    #[test]
    fn test_perl_file_dependency_new() {
        let dependency = PerlFileDependency::new("Test/More.pm");
        assert_eq!(dependency.filename, "Test/More.pm");
    }

    #[test]
    fn test_perl_file_dependency_family() {
        let dependency = PerlFileDependency::new("Test/More.pm");
        assert_eq!(dependency.family(), "perl-file");
    }

    #[test]
    fn test_perl_file_dependency_as_any() {
        let dependency = PerlFileDependency::new("Test/More.pm");
        let any_dep = dependency.as_any();
        assert!(any_dep.downcast_ref::<PerlFileDependency>().is_some());
    }

    #[test]
    fn test_missing_perl_file_to_dependency() {
        let problem = buildlog_consultant::problems::common::MissingPerlFile {
            filename: "Test/More.pm".to_string(),
            inc: None,
        };
        let dependency = problem.to_dependency();
        assert!(dependency.is_some());
        let dep = dependency.unwrap();
        assert_eq!(dep.family(), "perl-file");
        let perl_file_dep = dep.as_any().downcast_ref::<PerlFileDependency>().unwrap();
        assert_eq!(perl_file_dep.filename, "Test/More.pm");
    }

    #[test]
    fn test_cpan_new() {
        let session = crate::session::plain::PlainSession::new();
        let cpan = CPAN::new(&session, true);
        assert!(cpan.skip_tests);
    }

    #[test]
    fn test_cpan_cmd() {
        let session = crate::session::plain::PlainSession::new();
        let cpan = CPAN::new(&session, true);
        let dependency = PerlModuleDependency::simple("Test::More");
        let cmd = cpan.cmd(&[&dependency], InstallationScope::User).unwrap();
        assert_eq!(cmd, vec!["cpan", "-i", "-T", "Test::More"]);
    }
}