Compare commits

...

3 commits

Author SHA1 Message Date
Aravinth Manivannan adaebe4e35
feat: CLI modes: verify, daemon and test
verify
    Checks ftest.toml for syntax
daemon
    Runs ftest server
cli
   Runs single ftest job
2023-10-04 18:33:38 +05:30
Aravinth Manivannan 3f4b8d363e
feat: define minimal app context for cli use 2023-10-04 18:33:34 +05:30
Aravinth Manivannan db161fe6f0
feat: add project metadata 2023-10-04 18:33:06 +05:30
5 changed files with 174 additions and 123 deletions

View file

@ -1,9 +1,16 @@
[package] [package]
name = "ftest" name = "ftest"
version = "0.1.0" version = "0.1.0"
description = "Compliance checker for the software forge federation ecosystem"
homepage = "https://docs.forgeflux.org/ftest/about"
repository = "https://git.batsense.net/ForgeFlux/ftest"
documentation = "https://docs.forgeflux.org/ftest/about"
license = "AGPLv3 or later version"
authors = ["realaravinth <realaravinth@batsense.net>"]
edition = "2021" edition = "2021"
default-run = "ftest"
build = "build.rs" build = "build.rs"
defalt-run ="./src/main.rs"
[[bin]] [[bin]]
name ="config_validator" name ="config_validator"

View file

@ -26,95 +26,6 @@ pub trait FullAppContext: std::marker::Send + std::marker::Sync + CloneFullAppCt
fn port(&self) -> u32; fn port(&self) -> u32;
} }
pub trait MinAppContext: std::marker::Send + std::marker::Sync {
fn docker_(&self) -> Arc<dyn DockerLike>;
fn results_(&self) -> &ResultStore;
fn port_(&self) -> u32;
}
impl MinAppContext for Arc<dyn FullAppContext> {
fn docker_(&self) -> Arc<dyn DockerLike> {
self.docker()
}
fn results_(&self) -> &ResultStore {
self.results()
}
fn port_(&self) -> u32 {
self.port()
}
}
#[derive(Clone)]
pub struct Ctx {
settings: Settings,
db: Database,
results: ResultStore,
docker: Arc<dyn DockerLike>,
}
impl FullAppContext for Ctx {
fn settings(&self) -> &Settings {
&self.settings
}
fn db(&self) -> &Database {
&self.db
}
fn docker(&self) -> Arc<dyn DockerLike> {
self.docker.clone()
}
fn results(&self) -> &ResultStore {
&self.results
}
fn port(&self) -> u32 {
self.settings.server.port
}
}
impl MinAppContext for Ctx {
fn docker_(&self) -> Arc<dyn DockerLike> {
self.docker()
}
fn results_(&self) -> &ResultStore {
self.results()
}
fn port_(&self) -> u32 {
self.port()
}
}
//impl MinAppContext for Arc<dyn MinAppContext> {
// fn docker_(&self) -> Arc<dyn DockerLike>{
// self.docker_()
// }
// fn results_(&self) -> &ResultStore {
// self.results_()
// }
// fn port_(&self) -> u32 {
// self.port_()
// }
//}
//
//impl FullAppContext for Arc<dyn FullAppContext> {
// fn settings(&self) -> &Settings {
// self.settings()
// }
// fn db(&self) -> &Database {
// self.db()
// }
//
// fn docker(&self) -> Arc<dyn DockerLike>{
// self.docker()
// }
// fn results(&self) -> &ResultStore {
// self.results()
// }
// fn port(&self) -> u32 {
// self.port()
// }
//
//
//}
pub trait CloneFullAppCtx { pub trait CloneFullAppCtx {
fn clone_f(&self) -> Box<dyn FullAppContext>; fn clone_f(&self) -> Box<dyn FullAppContext>;
} }
@ -134,28 +45,65 @@ impl Clone for Box<dyn FullAppContext> {
} }
} }
//pub trait CloneMinAppContext { pub trait MinAppContext: std::marker::Send + std::marker::Sync {
// fn clone_fi(&self) -> Box<dyn MinAppContext>; fn docker_(&self) -> Arc<dyn DockerLike>;
//} fn results_(&self) -> &ResultStore;
// fn port_(&self) -> u32;
//impl<T> CloneMinAppContext for T }
//where
// T: CloneMinAppContext + Clone + 'static, impl MinAppContext for Arc<dyn FullAppContext> {
//{ fn docker_(&self) -> Arc<dyn DockerLike> {
// fn clone_fi(&self) -> Box<dyn MinAppContext> { self.docker()
// Box::new(self.clone()) }
// } fn results_(&self) -> &ResultStore {
//} self.results()
// }
//impl Clone for Box<dyn MinAppContext> { fn port_(&self) -> u32 {
// fn clone(&self) -> Self { self.port()
// (**self).clone_fi() }
// } }
//}
#[derive(Clone)]
pub struct DaemonCtx {
settings: Settings,
db: Database,
results: ResultStore,
docker: Arc<dyn DockerLike>,
}
impl FullAppContext for DaemonCtx {
fn settings(&self) -> &Settings {
&self.settings
}
fn db(&self) -> &Database {
&self.db
}
fn docker(&self) -> Arc<dyn DockerLike> {
self.docker.clone()
}
fn results(&self) -> &ResultStore {
&self.results
}
fn port(&self) -> u32 {
self.settings.server.port
}
}
impl MinAppContext for DaemonCtx {
fn docker_(&self) -> Arc<dyn DockerLike> {
self.docker()
}
fn results_(&self) -> &ResultStore {
self.results()
}
fn port_(&self) -> u32 {
self.port()
}
}
pub type ResultStore = Arc<RwLock<HashMap<String, Sender<CResult>>>>; pub type ResultStore = Arc<RwLock<HashMap<String, Sender<CResult>>>>;
impl Ctx { impl DaemonCtx {
pub async fn new(settings: Settings) -> Self { pub async fn new(settings: Settings) -> Self {
let results = HashMap::default(); let results = HashMap::default();
let results = Arc::new(RwLock::new(results)); let results = Arc::new(RwLock::new(results));
@ -168,3 +116,32 @@ impl Ctx {
} }
} }
} }
#[derive(Clone)]
pub struct CliCtx {
results: ResultStore,
docker: Arc<dyn DockerLike>,
}
impl MinAppContext for CliCtx {
fn docker_(&self) -> Arc<dyn DockerLike> {
self.docker.clone()
}
fn results_(&self) -> &ResultStore {
&self.results
}
fn port_(&self) -> u32 {
29130
}
}
impl CliCtx {
pub fn new() -> Self {
let results = HashMap::default();
let results = Arc::new(RwLock::new(results));
Self {
results,
docker: Arc::new(Docker::new()),
}
}
}

View file

@ -4,19 +4,22 @@
// SPDX-License-Identifier: AGPL-3.0-or-later // SPDX-License-Identifier: AGPL-3.0-or-later
use std::env; use std::env;
use std::path::PathBuf;
use std::sync::Arc; use std::sync::Arc;
use actix_web::{ use actix_web::{
error::InternalError, http::StatusCode, middleware as actix_middleware, web::Data as WebData, error::InternalError, http::StatusCode, middleware as actix_middleware, web::Data as WebData,
web::JsonConfig, App, HttpServer, web::JsonConfig, App, HttpServer,
}; };
//use clap::{Parser, Subcommand}; use clap::{Args, Parser, Subcommand, ValueEnum};
//use static_assets::FileMap; //use static_assets::FileMap;
use tracing::info; use tracing::info;
use tracing_actix_web::TracingLogger; use tracing_actix_web::TracingLogger;
// //
//pub use crate::api::v1::ROUTES as V1_API_ROUTES; //pub use crate::api::v1::ROUTES as V1_API_ROUTES;
use ctx::Ctx; use ctx::CliCtx;
use ctx::DaemonCtx;
use ctx::MinAppContext;
pub use settings::Settings; pub use settings::Settings;
pub const CACHE_AGE: u32 = 604800; pub const CACHE_AGE: u32 = 604800;
@ -48,10 +51,19 @@ mod utils;
// //
//#[derive(Parser)] //#[derive(Parser)]
//#[clap(author, version, about, long_about = None)] //#[clap(author, version, about, long_about = None)]
//struct Cli { #[derive(Parser)]
// #[clap(subcommand)] #[clap(author, version, about, long_about = None)]
// command: Commands, struct Cli {
//} #[command(subcommand)]
command: Command,
}
#[derive(Subcommand)]
enum Command {
Daemon,
Verify { path: PathBuf },
Test { path: PathBuf },
}
#[actix_web::main] #[actix_web::main]
#[cfg(not(tarpaulin_include))] #[cfg(not(tarpaulin_include))]
@ -61,16 +73,46 @@ async fn main() -> std::io::Result<()> {
} }
pretty_env_logger::init(); pretty_env_logger::init();
// let cli = Cli::parse(); let cli = Cli::parse();
info!( info!(
"{}: {}.\nFor more information, see: {}\nBuild info:\nVersion: {} commit: {}", "{}: {}.\nFor more information, see: {}\nBuild info:\nVersion: {} commit: {}",
PKG_NAME, PKG_DESCRIPTION, PKG_HOMEPAGE, VERSION, GIT_COMMIT_HASH PKG_NAME, PKG_DESCRIPTION, PKG_HOMEPAGE, VERSION, GIT_COMMIT_HASH
); );
match cli.command {
Command::Daemon => run_daemon().await,
Command::Verify { path } => {
let s = std::fs::read_to_string(path).unwrap();
let _: complaince::target::Target = toml::from_str(&s).unwrap();
println!("Syntax OK");
Ok(())
}
Command::Test { path } => {
let ctx: Arc<dyn MinAppContext> = Arc::new(CliCtx::new());
crate::runner::suite::SuiteRunnerState::run_proxy(ctx.as_ref());
let (suite_results, init_containers) =
crate::runner::target::run_target(ctx.as_ref(), path.clone()).await;
let content = crate::runner::results::ArchivableResult {
commit: "".into(),
suites: suite_results,
init_containers,
};
let results_file = path.join("resuts.json");
println!("Writing results to: {:?}", path.canonicalize());
std::fs::write(results_file, serde_json::to_string(&content).unwrap()).unwrap();
crate::runner::suite::SuiteRunnerState::stop_proxy(ctx.as_ref());
Ok(())
}
}
}
async fn run_daemon() -> std::io::Result<()> {
let settings = Settings::new().unwrap(); let settings = Settings::new().unwrap();
settings.init(); settings.init();
let inner_ctx = Arc::new(Ctx::new(settings.clone()).await); let inner_ctx = Arc::new(DaemonCtx::new(settings.clone()).await);
let ctx = AppFullCtx::new(inner_ctx.clone()); let ctx = AppFullCtx::new(inner_ctx.clone());
let ctx2 = AppMinCtx::new(inner_ctx); let ctx2 = AppMinCtx::new(inner_ctx);
ctx.db().migrate().await.unwrap(); ctx.db().migrate().await.unwrap();
@ -79,14 +121,39 @@ async fn main() -> std::io::Result<()> {
crate::runner::suite::SuiteRunnerState::run_proxy(ctx.as_ref()); crate::runner::suite::SuiteRunnerState::run_proxy(ctx.as_ref());
} }
serve(ctx.clone(), ctx2).await?; daemon(ctx.clone(), ctx2).await?;
if ctx.settings().docker_proxy { if ctx.settings().docker_proxy {
crate::runner::suite::SuiteRunnerState::stop_proxy(ctx.as_ref()); crate::runner::suite::SuiteRunnerState::stop_proxy(ctx.as_ref());
} }
Ok(()) Ok(())
} }
async fn serve(ctx: AppFullCtx, ctx2: AppMinCtx) -> std::io::Result<()> { async fn basic(ctx2: AppMinCtx) -> std::io::Result<()> {
let ip = "0.0.0.0:29130";
info!("Starting server on: http://{}", ip);
HttpServer::new(move || {
App::new()
.wrap(TracingLogger::default())
.wrap(actix_middleware::Compress::default())
.app_data(ctx2.clone())
.app_data(get_json_err())
.wrap(
actix_middleware::DefaultHeaders::new()
.add(("Permissions-Policy", "interest-cohort=()")),
)
.wrap(actix_middleware::NormalizePath::new(
actix_middleware::TrailingSlash::Trim,
))
.configure(services)
})
.bind(ip)
.unwrap()
.run()
.await?;
Ok(())
}
async fn daemon(ctx: AppFullCtx, ctx2: AppMinCtx) -> std::io::Result<()> {
let ip = ctx.settings().server.get_ip(); let ip = ctx.settings().server.get_ip();
let workers = ctx.settings().server.workers.unwrap_or_else(num_cpus::get); let workers = ctx.settings().server.workers.unwrap_or_else(num_cpus::get);
let scheduler = runner::scheduler::Scheduler::spawn(ctx.clone()).await; let scheduler = runner::scheduler::Scheduler::spawn(ctx.clone()).await;

View file

@ -59,14 +59,14 @@ mod tests {
use super::*; use super::*;
use crate::docker_compose::DockerCompose; use crate::docker_compose::DockerCompose;
use crate::{AppMinCtx, Ctx, Settings}; use crate::{AppMinCtx, DaemonCtx, Settings};
use crate::complaince::suite::Test; use crate::complaince::suite::Test;
#[actix_rt::test] #[actix_rt::test]
async fn launch_init_containers_works() { async fn launch_init_containers_works() {
let settings = Settings::new().unwrap(); let settings = Settings::new().unwrap();
let ctx = AppMinCtx::new(Arc::new(Ctx::new(settings.clone()).await)); let ctx = AppMinCtx::new(Arc::new(DaemonCtx::new(settings.clone()).await));
// let base_dir = Path::new(&ctx.settings.repository.base_dir); // let base_dir = Path::new(&ctx.settings.repository.base_dir);
// let control = base_dir.join("control"); // let control = base_dir.join("control");

View file

@ -172,7 +172,7 @@ mod tests {
use crate::complaince::result::Result as CResult; use crate::complaince::result::Result as CResult;
use crate::complaince::suite::Test; use crate::complaince::suite::Test;
use crate::{AppMinCtx, Ctx, Settings}; use crate::{AppMinCtx, DaemonCtx, Settings};
use std::sync::Arc; use std::sync::Arc;
@ -240,7 +240,7 @@ mod tests {
const LOGS: &str = "SUITE RUNNER LOG STRING"; const LOGS: &str = "SUITE RUNNER LOG STRING";
let settings = Settings::new().unwrap(); let settings = Settings::new().unwrap();
let ctx = Ctx::new(settings.clone()).await; let ctx = DaemonCtx::new(settings.clone()).await;
// ctx.docker_ = Arc::new(Testdocker_::new()); // ctx.docker_ = Arc::new(Testdocker_::new());
let ctx = crate::AppFullCtx::new(Arc::new(ctx)); let ctx = crate::AppFullCtx::new(Arc::new(ctx));