risingwave_regress_test/
opts.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::ffi::OsStr;
16use std::path::{Path, PathBuf};
17
18use anyhow::Context;
19use clap::{Parser, ValueHint};
20use path_absolutize::*;
21
22#[derive(Debug, Clone, Copy, Eq, PartialEq)]
23pub(crate) enum DatabaseMode {
24    Postgres,
25    Risingwave,
26}
27
28impl From<&OsStr> for DatabaseMode {
29    fn from(mode: &OsStr) -> Self {
30        let mode = mode
31            .to_str()
32            .expect("Expect utf-8 string for database mode");
33        match mode.to_lowercase().as_str() {
34            "postgres" | "pg" | "postgresql" => DatabaseMode::Postgres,
35            "risingwave" | "rw" => DatabaseMode::Risingwave,
36            _ => unreachable!("Unrecognized database mode. Support PostgreSQL or Risingwave only."),
37        }
38    }
39}
40
41#[derive(Parser, Debug, Clone)]
42pub(crate) struct Opts {
43    /// Database name used to connect to pg.
44    #[clap(name = "DB", long = "database", default_value = "dev")]
45    pg_db_name: String,
46    /// Username used to connect to postgresql.
47    #[clap(name = "PG_USERNAME", short = 'u', long = "user", default_value="postgres", value_hint=ValueHint::Username)]
48    pg_user_name: String,
49    /// Postgresql server address to test against.
50    #[clap(name = "PG_SERVER_ADDRESS", long = "host", default_value = "localhost")]
51    pg_server_host: String,
52    /// Postgresql server port to test against.
53    #[clap(name = "PG_SERVER_PORT", short = 'p', long = "port")]
54    pg_server_port: u16,
55    /// Input directory containing sqls, expected outputs.
56    #[clap(name = "INPUT_DIR", short = 'i', long = "input", value_parser, value_hint = ValueHint::DirPath)]
57    input_dir: PathBuf,
58    /// Output directory containing output files, diff reuslts.
59    #[clap(name = "OUTPUT_DIR", short = 'o', long = "output", value_parser, value_hint = ValueHint::DirPath)]
60    output_dir: PathBuf,
61    /// Schedule file containing each parallel schedule.
62    #[clap(name = "SCHEDULE", short = 's', long = "schedule", value_parser, value_hint = ValueHint::FilePath)]
63    schedule: PathBuf,
64    /// Location for customized log file.
65    #[clap(long, value_parser, default_value = "config/log4rs.yaml", value_hint=ValueHint::FilePath)]
66    log4rs_config: PathBuf,
67    /// Database mode
68    #[clap(name = "DATABASE_MODE", long = "mode", value_parser)]
69    database_mode: DatabaseMode,
70}
71
72impl Opts {
73    pub(crate) fn pg_user_name(&self) -> &str {
74        &self.pg_user_name
75    }
76
77    pub(crate) fn log4rs_config_path(&self) -> &Path {
78        self.log4rs_config.as_path()
79    }
80
81    pub(crate) fn absolutized_input_dir(&self) -> anyhow::Result<PathBuf> {
82        self.input_dir
83            .absolutize()
84            .map(|c| c.into_owned())
85            .with_context(|| {
86                format!(
87                    "Failed to canonicalize input dir: {:?}",
88                    self.input_dir.as_path()
89                )
90            })
91    }
92
93    pub(crate) fn absolutized_output_dir(&self) -> anyhow::Result<PathBuf> {
94        self.output_dir
95            .absolutize()
96            .map(|c| c.into_owned())
97            .with_context(|| {
98                format!(
99                    "Failed to canonicalize output dir: {:?}",
100                    self.output_dir.as_path()
101                )
102            })
103    }
104
105    pub(crate) fn database_name(&self) -> &str {
106        self.pg_db_name.as_str()
107    }
108
109    pub(crate) fn schedule_file_path(&self) -> &Path {
110        self.schedule.as_path()
111    }
112
113    pub(crate) fn host(&self) -> String {
114        self.pg_server_host.clone()
115    }
116
117    pub(crate) fn port(&self) -> u16 {
118        self.pg_server_port
119    }
120
121    pub(crate) fn database_mode(&self) -> DatabaseMode {
122        self.database_mode
123    }
124}
risingwave_regress_test/opts.rs

risingwave_regress_test/
opts.rs
