crates/xtask/src/common/instance/mod.rs - main - githubmirror/meilisearch

crates/xtask/src/common/instance/mod.rs
119 строк4 KB
Louis Dureuil
xtask: Add optional description for Command and Binary
19 фев 2026, 11:56
19 фев 2026, 11:562fc3e12
use std::fmt::Display;
use std::path::PathBuf;

use serde::{Deserialize, Serialize};

mod release;

pub use release::{add_releases_to_assets, Release};

/// A binary to execute on a temporary DB.
///
/// - The URL of the binary will be in the form <http://localhost:PORT>, where `PORT`
///   is selected by the runner.
/// - The database will be temporary, cleaned before use, and will be selected by the runner.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Binary {
    /// Describes why we are instantiating this binary
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Describes how this binary should be instantiated
    #[serde(flatten)]
    pub source: BinarySource,
    /// Extra CLI arguments to pass to the binary.
    ///
    /// Should be Meilisearch CLI options.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extra_cli_args: Vec<String>,
}

impl Display for Binary {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if let Some(description) = &self.description {
            write!(f, "description: {description}")?;
        }
        write!(f, "{}", self.source)?;
        if !self.extra_cli_args.is_empty() {
            write!(f, ", with arguments: {:?}", self.extra_cli_args)?;
        }
        Ok(())
    }
}

impl Binary {
    pub fn as_release(&self) -> Option<&Release> {
        if let BinarySource::Release(release) = &self.source {
            Some(release)
        } else {
            None
        }
    }

    pub fn binary_path(&self, asset_folder: &str) -> anyhow::Result<Option<PathBuf>> {
        self.source.binary_path(asset_folder)
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields, tag = "source")]
/// Description of how to get a binary to instantiate.
pub enum BinarySource {
    /// Compile and run the binary from the current repository.=
    Build {
        #[serde(default)]
        edition: Edition,
    },
    /// Get a release from GitHub
    Release(Release),
    /// Run the binary from the specified local path.
    Path(PathBuf),
}

impl Display for BinarySource {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            BinarySource::Build { edition: Edition::Community } => {
                f.write_str("git with community edition")
            }
            BinarySource::Build { edition: Edition::Enterprise } => {
                f.write_str("git with enterprise edition")
            }
            BinarySource::Release(release) => write!(f, "{release}"),
            BinarySource::Path(path) => write!(f, "binary at `{}`", path.display()),
        }
    }
}

impl Default for BinarySource {
    fn default() -> Self {
        Self::Build { edition: Default::default() }
    }
}

impl BinarySource {
    fn binary_path(&self, asset_folder: &str) -> anyhow::Result<Option<PathBuf>> {
        Ok(match self {
            Self::Release(release) => Some(release.binary_path(asset_folder)?),
            Self::Build { .. } => None,
            Self::Path(path) => Some(path.clone()),
        })
    }
}

#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub enum Edition {
    #[default]
    Community,
    Enterprise,
}

impl Edition {
    fn binary_base(&self) -> &'static str {
        match self {
            Edition::Community => "meilisearch",
            Edition::Enterprise => "meilisearch-enterprise",
        }
    }
}