Add harness for test and release
Sayan Nandan
3 years ago
parent
732a89a43e
commit
b018f14e1c
@ -0,0 +1,12 @@
|
||||
[package]
|
||||
name = "harness"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
libsky = { path = "../libsky" }
|
||||
env_logger = "0.9.0"
|
||||
log = "0.4.14"
|
||||
zip = { version = "0.5.13", features = ["deflate"] }
|
||||
@ -0,0 +1,135 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
use crate::{util, HarnessError, HarnessResult};
|
||||
use libsky::VERSION;
|
||||
use std::fs;
|
||||
use std::io::Read;
|
||||
use std::io::Write;
|
||||
use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
use std::process::Command;
|
||||
use zip::{write::FileOptions, ZipWriter};
|
||||
|
||||
const BINARIES: [&str; 4] = ["skyd", "sky-bench", "skysh", "sky-migrate"];
|
||||
|
||||
fn concat_path(binary_name: &str, body: impl AsRef<Path>) -> PathBuf {
|
||||
let mut pb = PathBuf::from(body.as_ref());
|
||||
#[cfg(windows)]
|
||||
let binary_name = format!("{}.exe", binary_name);
|
||||
pb.push(binary_name);
|
||||
pb
|
||||
}
|
||||
|
||||
fn get_files_index(target_folder: &PathBuf) -> Vec<PathBuf> {
|
||||
let mut paths = Vec::with_capacity(3);
|
||||
for binary in BINARIES {
|
||||
paths.push(concat_path(binary, target_folder));
|
||||
}
|
||||
paths
|
||||
}
|
||||
|
||||
fn get_bundle_name() -> String {
|
||||
let mut filename = format!("sky-bundle-v{VERSION}");
|
||||
match util::get_var(util::VAR_ARTIFACT) {
|
||||
Some(artifact) => {
|
||||
filename.push('-');
|
||||
filename.push_str(&artifact);
|
||||
}
|
||||
None => {}
|
||||
}
|
||||
filename.push_str(".zip");
|
||||
filename
|
||||
}
|
||||
|
||||
pub fn run_bundle() -> HarnessResult<()> {
|
||||
let mut build_args = vec!["build".to_owned()];
|
||||
let mut target_folder = PathBuf::from("target");
|
||||
match util::get_var(util::VAR_TARGET) {
|
||||
Some(t) => {
|
||||
build_args.push("--target".to_owned());
|
||||
build_args.push(t.to_string());
|
||||
target_folder.push(&t);
|
||||
}
|
||||
None => {}
|
||||
};
|
||||
target_folder.push("release");
|
||||
|
||||
// assemble build args
|
||||
build_args.extend([
|
||||
"-p".into(),
|
||||
"skyd".into(),
|
||||
"-p".into(),
|
||||
"sky-bench".into(),
|
||||
"-p".into(),
|
||||
"skysh".into(),
|
||||
"-p".into(),
|
||||
"sky-migrate".into(),
|
||||
"--release".into(),
|
||||
]);
|
||||
let mut cmd = Command::new("cargo");
|
||||
cmd.args(&build_args);
|
||||
util::handle_child("build release binaries", cmd)?;
|
||||
|
||||
// now package
|
||||
package_binaries(target_folder)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn package_binaries(target_folder: PathBuf) -> HarnessResult<()> {
|
||||
// get the file index
|
||||
let file_index = get_files_index(&target_folder);
|
||||
// get the bundle file name
|
||||
let bundle_file_name = get_bundle_name();
|
||||
// create the bundle file
|
||||
let bundle_file = fs::File::create(&bundle_file_name)
|
||||
.map_err(|e| HarnessError::Other(format!("Failed to create ZIP file with error: {e}")))?;
|
||||
// init zip writer
|
||||
let mut zip = ZipWriter::new(bundle_file);
|
||||
// create a temp buffer
|
||||
let mut buffer = Vec::new();
|
||||
// ZIP settings
|
||||
let options = FileOptions::default()
|
||||
.compression_method(zip::CompressionMethod::Deflated)
|
||||
.unix_permissions(0o755);
|
||||
for file in file_index {
|
||||
let path = file.as_path();
|
||||
let name = path.strip_prefix(Path::new(&target_folder)).unwrap();
|
||||
#[allow(deprecated)]
|
||||
zip.start_file_from_path(name, options).unwrap();
|
||||
let mut f = fs::File::open(path).map_err(|e| {
|
||||
HarnessError::Other(format!(
|
||||
"Failed to add file `{}` to ZIP with error: {e}",
|
||||
path.to_string_lossy()
|
||||
))
|
||||
})?;
|
||||
f.read_to_end(&mut buffer).unwrap();
|
||||
zip.write_all(&*buffer).unwrap();
|
||||
buffer.clear();
|
||||
}
|
||||
zip.finish().unwrap();
|
||||
Ok(())
|
||||
}
|
||||
@ -0,0 +1,75 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
use crate::{HarnessError, HarnessResult};
|
||||
use std::{env, process};
|
||||
|
||||
const HELP: &str = "\
|
||||
harness
|
||||
A harness for Skytable's test suite
|
||||
|
||||
OPTIONS:
|
||||
harness [SUBCOMMAND]
|
||||
|
||||
SUBCOMMANDS:
|
||||
test Run the full test suite
|
||||
bundle Build the bundle\
|
||||
";
|
||||
|
||||
pub enum HarnessWhat {
|
||||
Test,
|
||||
Bundle,
|
||||
}
|
||||
|
||||
impl HarnessWhat {
|
||||
const CLI_TEST: &'static str = "test";
|
||||
const CLI_BUNDLE: &'static str = "bundle";
|
||||
const CLI_ARG_HELP: &'static str = "--help";
|
||||
const CLI_ARG_HELP_SHORT: &'static str = "-h";
|
||||
pub fn from_env() -> HarnessResult<Self> {
|
||||
let args: Vec<String> = env::args().skip(1).collect();
|
||||
if args.is_empty() {
|
||||
display_help();
|
||||
} else if args.len() != 1 {
|
||||
return Err(HarnessError::BadArguments(format!(
|
||||
"expected one argument. found {} args",
|
||||
args.len()
|
||||
)));
|
||||
}
|
||||
let ret = match args[0].as_str() {
|
||||
Self::CLI_TEST => HarnessWhat::Test,
|
||||
Self::CLI_BUNDLE => HarnessWhat::Bundle,
|
||||
Self::CLI_ARG_HELP_SHORT | Self::CLI_ARG_HELP => display_help(),
|
||||
unknown_arg => return Err(HarnessError::UnknownCommand(unknown_arg.to_string())),
|
||||
};
|
||||
Ok(ret)
|
||||
}
|
||||
}
|
||||
|
||||
fn display_help() -> ! {
|
||||
println!("{}", HELP);
|
||||
process::exit(0x00)
|
||||
}
|
||||
@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
use crate::util::ExitCode;
|
||||
use std::fmt;
|
||||
|
||||
pub type HarnessResult<T> = Result<T, HarnessError>;
|
||||
#[derive(Debug)]
|
||||
pub enum HarnessError {
|
||||
UnknownCommand(String),
|
||||
BadArguments(String),
|
||||
ChildError(&'static str, ExitCode),
|
||||
Other(String),
|
||||
}
|
||||
|
||||
impl fmt::Display for HarnessError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match self {
|
||||
HarnessError::BadArguments(arg) => write!(f, "Bad arguments: `{}`", arg),
|
||||
HarnessError::UnknownCommand(cmd) => write!(f, "Unknown command: `{}`", cmd),
|
||||
HarnessError::ChildError(desc, code) => match code {
|
||||
Some(code) => write!(f, "The child (`{desc}`) exited with code {code}"),
|
||||
None => write!(f, "The child (`{desc}`) exited with a non-zero code"),
|
||||
},
|
||||
HarnessError::Other(other) => write!(f, "{other}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#[macro_use]
|
||||
extern crate log;
|
||||
#[macro_use]
|
||||
mod util;
|
||||
mod bundle;
|
||||
mod cli;
|
||||
mod error;
|
||||
mod test;
|
||||
use crate::{
|
||||
cli::HarnessWhat,
|
||||
error::{HarnessError, HarnessResult},
|
||||
};
|
||||
use env_logger::Builder;
|
||||
use std::{env, process};
|
||||
|
||||
fn main() {
|
||||
Builder::new()
|
||||
.parse_filters(&env::var("SKYHARNESS_LOG").unwrap_or_else(|_| "info".to_owned()))
|
||||
.init();
|
||||
if let Err(e) = runner() {
|
||||
eprintln!("harness failed with: {}", e);
|
||||
process::exit(0x01);
|
||||
}
|
||||
}
|
||||
|
||||
fn runner() -> HarnessResult<()> {
|
||||
let harness = cli::HarnessWhat::from_env()?;
|
||||
match harness {
|
||||
HarnessWhat::Test => test::run_test()?,
|
||||
HarnessWhat::Bundle => bundle::run_bundle()?,
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
@ -0,0 +1,129 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
use crate::{util, HarnessError, HarnessResult};
|
||||
use std::fs;
|
||||
use std::process::Child;
|
||||
use std::process::Command;
|
||||
|
||||
const WORKSPACE_ROOT: &str = env!("ROOT_DIR");
|
||||
|
||||
pub fn get_run_server_cmd(server_id: &'static str, cmd_payload: &[String]) -> Command {
|
||||
let mut cmd = Command::new("cargo");
|
||||
cmd.args(cmd_payload);
|
||||
cmd.arg("--");
|
||||
cmd.arg("--withconfig");
|
||||
cmd.arg(format!("{WORKSPACE_ROOT}ci/{server_id}.toml"));
|
||||
cmd.current_dir(server_id);
|
||||
cmd
|
||||
}
|
||||
|
||||
pub fn start_servers(s1_cmd: Command, s2_cmd: Command) -> HarnessResult<(Child, Child)> {
|
||||
info!("Starting server1 ...");
|
||||
let s1 = util::get_child("start server1", s1_cmd)?;
|
||||
util::sleep_sec(10);
|
||||
info!("Starting server2 ...");
|
||||
let s2 = util::get_child("start server2", s2_cmd)?;
|
||||
util::sleep_sec(10);
|
||||
Ok((s1, s2))
|
||||
}
|
||||
|
||||
fn kill_servers() -> HarnessResult<()> {
|
||||
util::handle_child("kill servers", cmd!("pkill", "skyd"))?;
|
||||
// sleep
|
||||
util::sleep_sec(10);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn run_test() -> HarnessResult<()> {
|
||||
let ret = run_test_inner();
|
||||
kill_servers()?;
|
||||
|
||||
// clean up
|
||||
fs::remove_dir_all("server1").map_err(|e| {
|
||||
HarnessError::Other(format!("Failed to remove dir `server1` with error: {e}"))
|
||||
})?;
|
||||
fs::remove_dir_all("server2").map_err(|e| {
|
||||
HarnessError::Other(format!("Failed to remove dir `server1` with error: {e}"))
|
||||
})?;
|
||||
ret
|
||||
}
|
||||
|
||||
pub fn run_test_inner() -> HarnessResult<()> {
|
||||
// first create the TLS keys
|
||||
info!("Creating TLS key+cert");
|
||||
util::handle_child("generate TLS key+cert", cmd!("bash", "ci/ssl.sh"))?;
|
||||
util::handle_child(
|
||||
"create server1 directory",
|
||||
cmd!("mkdir", "-p", "server1", "server2"),
|
||||
)?;
|
||||
|
||||
// assemble commands
|
||||
let mut cmd: Vec<String> = vec!["run".to_string(), "-p".to_string(), "skyd".to_string()];
|
||||
let standard_test_suite;
|
||||
let persist_test_suite;
|
||||
let build_cmd;
|
||||
match util::get_var(util::VAR_TARGET) {
|
||||
Some(target) => {
|
||||
cmd.push("--target".into());
|
||||
cmd.push(target.to_string());
|
||||
standard_test_suite = cmd!("cargo", "test", "--target", &target);
|
||||
persist_test_suite = cmd!(
|
||||
"cargo",
|
||||
"test",
|
||||
"--target",
|
||||
&target,
|
||||
"--features",
|
||||
"persist-suite"
|
||||
);
|
||||
build_cmd = cmd!("cargo", "build", "-p", "skyd", "--target", &target);
|
||||
}
|
||||
None => {
|
||||
standard_test_suite = cmd!("cargo", "test");
|
||||
persist_test_suite = cmd!("cargo", "test", "--features", "persist-suite");
|
||||
build_cmd = cmd!("cargo", "build", "-p", "skyd");
|
||||
}
|
||||
}
|
||||
|
||||
// build skyd
|
||||
util::handle_child("build skyd", build_cmd)?;
|
||||
let s1_cmd = get_run_server_cmd("server1", &cmd);
|
||||
let s2_cmd = get_run_server_cmd("server2", &cmd);
|
||||
|
||||
// start the servers, run tests and kill
|
||||
let (_s1, _s2) = start_servers(s1_cmd, s2_cmd)?;
|
||||
info!("All servers started. Now running standard test suite ...");
|
||||
util::handle_child("standard test suite", standard_test_suite)?;
|
||||
kill_servers()?;
|
||||
|
||||
// start server up again, run tests and kill
|
||||
let s1_cmd = get_run_server_cmd("server1", &cmd);
|
||||
let s2_cmd = get_run_server_cmd("server2", &cmd);
|
||||
let (_s1, _s2) = start_servers(s1_cmd, s2_cmd)?;
|
||||
util::handle_child("standard test suite", persist_test_suite)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@ -0,0 +1,84 @@
|
||||
/*
|
||||
* Created on Thu Mar 17 2022
|
||||
*
|
||||
* This file is a part of Skytable
|
||||
* Skytable (formerly known as TerrabaseDB or Skybase) is a free and open-source
|
||||
* NoSQL database written by Sayan Nandan ("the Author") with the
|
||||
* vision to provide flexibility in data modelling without compromising
|
||||
* on performance, queryability or scalability.
|
||||
*
|
||||
* Copyright (c) 2022, Sayan Nandan <ohsayan@outlook.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
use crate::process::ExitStatus;
|
||||
use crate::{HarnessError, HarnessResult};
|
||||
use std::env;
|
||||
use std::io::Result as IoResult;
|
||||
use std::process::Child;
|
||||
use std::process::Command;
|
||||
pub type ExitCode = Option<i32>;
|
||||
|
||||
pub const VAR_TARGET: &str = "TARGET";
|
||||
pub const VAR_ARTIFACT: &str = "ARTIFACT";
|
||||
|
||||
pub fn get_var(var: &str) -> Option<String> {
|
||||
env::var_os(var).map(|v| v.to_string_lossy().to_string())
|
||||
}
|
||||
|
||||
pub fn handle_exitstatus(desc: &'static str, status: IoResult<ExitStatus>) -> HarnessResult<()> {
|
||||
match status {
|
||||
Ok(status) => {
|
||||
if status.success() {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(HarnessError::ChildError(desc, status.code()))
|
||||
}
|
||||
}
|
||||
Err(e) => Err(HarnessError::Other(format!(
|
||||
"Failed to get exitcode while running `{desc}`. this error happened: {e}"
|
||||
))),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_child(desc: impl ToString, mut input: Command) -> HarnessResult<Child> {
|
||||
let desc = desc.to_string();
|
||||
match input.spawn() {
|
||||
Ok(child) => Ok(child),
|
||||
Err(e) => Err(HarnessError::Other(format!(
|
||||
"Failed to spawn process for `{desc}` with error: {e}"
|
||||
))),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn handle_child(desc: &'static str, input: Command) -> HarnessResult<()> {
|
||||
self::handle_exitstatus(desc, self::get_child(desc, input)?.wait())
|
||||
}
|
||||
|
||||
pub fn sleep_sec(secs: u64) {
|
||||
std::thread::sleep(std::time::Duration::from_secs(secs))
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! cmd {
|
||||
($base:expr, $($cmd:expr),*) => {{
|
||||
let mut cmd = ::std::process::Command::new($base);
|
||||
$(
|
||||
cmd.arg($cmd);
|
||||
)*
|
||||
cmd
|
||||
}};
|
||||
}
|
||||
Loading…
Reference in New Issue