Struct CompatCommand 

pub struct CompatCommand {
    from_version: Option<String>,
    from_bins_dir: Option<PathBuf>,
    to_bins_dir: Option<PathBuf>,
    case_dir: Option<PathBuf>,
    test_filter: String,
    fail_fast: bool,
    preserve_state: bool,
    pull_version_on_need: bool,
    setup_etcd: bool,
    dry_run: bool,
}

Run compatibility tests in bare distributed mode.

Starts an old-version distributed cluster, runs setup SQLs, then restarts the cluster with a new version on preserved state, and runs verify SQLs comparing results against verify.result files.

PR1 notes:

• Sqlness interceptor comments are supported for each statement.
• The runner starts the full distributed topology, including flownode.

Fields

from_version: Option<String>

Version of the “from” GreptimeDB binary (e.g. “v0.9.5”) or “current”. If neither –from-version nor –from-bins-dir is specified, the current debug build is used for both from and to.

from_bins_dir: Option<PathBuf>

Path to the directory containing the “from” GreptimeDB binary.

to_bins_dir: Option<PathBuf>

Path to the directory containing the “to” GreptimeDB binary. Defaults to the current debug build.

case_dir: Option<PathBuf>

Directory of compatibility test cases. Defaults to tests/compatibility/cases relative to workspace root.

test_filter: String

Name of test cases to run. Accepts a regexp.

fail_fast: bool

Fail this run as soon as one case fails.

preserve_state: bool

Preserve persistent state in the temporary directory after run. Etcd is always cleaned up regardless of this flag.

pull_version_on_need: bool

Pull different versions of GreptimeDB on need.

setup_etcd: bool

Whether to set up etcd via Docker. Required for PR1 distributed compat. External metadata stores are not supported by the compat MVP yet.

dry_run: bool

Perform discovery and filtering only; print what would run without starting any services, mutating files, or running setup/verify.

Implementations

impl CompatCommand

pub async fn run(self)

Trait Implementations

impl Args for CompatCommand

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for CompatCommand

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CompatCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for CompatCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CompatCommand

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.