dev_scripts/

cli.rs

use std::{fmt::Display, path::PathBuf};

use alpm_types::{MetadataFileName, PKGBUILD_FILE_NAME, SRCINFO_FILE_NAME};
use clap::{Parser, ValueEnum};

use crate::sync::PackageRepositories;

#[derive(Debug, Parser)]
#[clap(name = "dev-scripts", about = "Dev scripts for the ALPM project")]
pub struct Cli {
    /// Log verbosity level
    #[command(flatten)]
    pub verbose: clap_verbosity_flag::Verbosity,

    #[clap(subcommand)]
    pub cmd: Command,
}

#[derive(Debug, Parser)]
pub enum Command {
    /// Tests file formats with real-world files from official repositories.
    TestFiles {
        #[clap(subcommand)]
        cmd: TestFilesCmd,

        #[arg(
            help = "The directory to use for download and test artifacts",
            long,
            long_help = r#"The directory to use for download and test artifacts.

If unset, defaults to "$XDG_CACHE_HOME/alpm/testing/".
If "$XDG_CACHE_HOME" is unset, falls back to "~/.cache/alpm/testing/"."#,
            short,
            value_name = "DIR"
        )]
        cache_dir: Option<PathBuf>,
    },

    /// Run the `alpm-pkgbuild srcinfo format` command on a PKGBUILD and compare its output with a
    /// given .SRCINFO file.
    CompareSrcinfo {
        /// Path to the PKGBUILD file.
        #[arg(
            short,
            long = "pkgbuild",
            value_name = "PKGBUILD_PATH",
            default_value = format!("./{PKGBUILD_FILE_NAME}")
        )]
        pkgbuild_path: PathBuf,

        /// Path to the .SRCINFO file.
        #[arg(
            short,
            long = "srcinfo",
            value_name = "SRCINFO_PATH",
            default_value = format!("./{SRCINFO_FILE_NAME}")
        )]
        srcinfo_path: PathBuf,
    },
}

#[derive(Clone, Copy, Debug, Eq, Parser, PartialEq, ValueEnum)]
pub enum TestFileType {
    BuildInfo,
    SrcInfo,
    PackageInfo,
    MTree,
    RemoteDesc,
    RemoteFiles,
    LocalDesc,
    LocalFiles,
    Signatures,
}

impl Display for TestFileType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Self::BuildInfo => MetadataFileName::BuildInfo.as_ref(),
                Self::PackageInfo => MetadataFileName::PackageInfo.as_ref(),
                Self::SrcInfo => SRCINFO_FILE_NAME,
                Self::MTree => MetadataFileName::Mtree.as_ref(),
                Self::RemoteDesc | Self::LocalDesc => "desc",
                Self::RemoteFiles | Self::LocalFiles => "files",
                Self::Signatures => "sig",
            }
        )
    }
}

#[derive(Debug, Parser)]
pub enum TestFilesCmd {
    /// Run tests against a specific file type.
    ///
    /// The required data needs to be downloaded up front using "dev-scripts test-files download".
    Test {
        /// Package repositories to test.
        ///
        /// If not set, all official repositories are tested.
        #[arg(short, long)]
        repositories: Option<Vec<PackageRepositories>>,

        /// The type of file that should be tested.
        file_type: TestFileType,
    },

    /// Download/synchronize files for testing to this machine.
    ///
    /// Each type of file can be downloaded individually.
    Download {
        /// Package repositories to download.
        ///
        /// If not set, all official repositories are downloaded.
        #[arg(short, long)]
        repositories: Option<Vec<PackageRepositories>>,

        #[clap(subcommand)]
        source: DownloadCmd,
    },

    /// Remove or clean downloaded local testing files.
    Clean {
        #[clap(subcommand)]
        source: CleanCmd,
    },
}

#[derive(Debug, Parser)]
pub enum DownloadCmd {
    /// Download all official package source repositories
    ///
    /// This is done by querying all active repositories via the arch web API
    /// (<https://archlinux.org/packages/pkgbase-maintainer>) and cloning the respective
    /// package source repositories via git.
    ///
    /// This command differs from `pkgctl repo clone --universe` in so far that it
    /// also updates git repositories and removes repositories that're no longer used.
    ///
    /// The repositories contain the following file types for each package.
    /// - .SRCINFO
    PkgSrcRepositories {},

    /// Download all AUR packages metadata.
    ///
    /// AUR uses a monorepo that holds each package in a separate branch.
    /// This command first fetches a list of all packages from aurweb and clones aur.git mirror.
    /// The `.SRCINFO` and `PKGBUILD` files are then extracted from the git branches.
    Aur {},

    /// Create a copy of a mirror's pacman database.
    ///
    /// The database contains the following file types for each package.
    /// - `files`
    /// - `desc`
    Databases {
        /// The domain + base path under which the mirror can be found.
        ///
        /// The mirror must support the `rsync` protocol
        #[arg(short, long, env, default_value = "mirror.pseudoform.org/packages")]
        mirror: String,

        /// Force re-extraction of the files regardless of reported changes.
        ///
        /// This is useful for if the download is cancelled halfway, in which case
        /// `rsync` will not report changes for files that it downloaded last time.
        #[arg(short, long, default_value_t = false)]
        force_extract: bool,
    },
    /// The packages contain the following file types for each package.
    /// - `.INSTALL`
    /// - `.BUILDINFO`
    /// - `.MTREE`
    /// - `.PKGINFO`
    Packages {
        /// The domain + base path under which the mirror can be found.
        ///
        /// The mirror must support the `rsync` protocol
        #[arg(short, long, env, default_value = "mirror.pseudoform.org/packages")]
        mirror: String,

        /// Force re-extraction of the files regardless of reported changes.
        ///
        /// This is useful for if the download is cancelled halfway, in which case
        /// `rsync` will not report changes for files that it downloaded last time.
        #[arg(short, long, default_value_t = false)]
        force_extract: bool,
    },
}

#[derive(Debug, Parser)]
pub enum CleanCmd {
    /// Remove all package source repositories and .SRCINFO files
    PkgSrcRepositories,

    /// Remove extracted repository sync database files and tarballs.
    Databases,

    /// Remove all downloaded packages and any other files extracted from them.
    Packages,
}