Files
radicle-ci-broker/src/config.rs
T
Lars Wirzenius d1db5e96ac feat: allow configuring adapters in the cib configuration file
This makes it easier to specify several adapters, with varying
configurations, by not having to put the configuration for each
specification in a separate file.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-06-12 14:44:39 +03:00

242 lines
6.3 KiB
Rust

//! Configuration for the CI broker and related programs.
use std::{
collections::HashMap,
path::{Path, PathBuf},
time::Duration,
};
use duration_str::deserialize_duration;
use serde::{Deserialize, Serialize};
use crate::{
adapter::{Adapter, AdapterError, Adapters},
filter::{EventFilter, Trigger},
sensitive::Sensitive,
};
const DEFAULT_MAX_RUN_TIME: Duration = Duration::from_secs(3600);
const DEFAULT_QUEUE_LEN_INTERVAL: Duration = Duration::from_secs(3600);
const DEFAULT_STATUS_PAGE_UPDATE_INTERVAL: u64 = 10;
#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Config {
default_adapter: Option<String>,
adapters: HashMap<String, AdapterSpec>,
filters: Option<Vec<EventFilter>>,
triggers: Option<Vec<TriggerConfig>>,
report_dir: Option<PathBuf>,
status_update_interval_seconds: Option<u64>,
db: PathBuf,
#[serde(deserialize_with = "deserialize_duration")]
#[serde(default = "default_max_run_time")]
max_run_time: Duration,
#[serde(deserialize_with = "deserialize_duration")]
#[serde(default = "default_queue_len_interval")]
queue_len_interval: Duration,
#[serde(default)]
concurrent_adapters: Option<usize>,
}
fn default_max_run_time() -> Duration {
DEFAULT_MAX_RUN_TIME
}
fn default_queue_len_interval() -> Duration {
DEFAULT_QUEUE_LEN_INTERVAL
}
impl Config {
pub fn load(filename: &Path) -> Result<Self, ConfigError> {
let config =
std::fs::read(filename).map_err(|e| ConfigError::ReadConfig(filename.into(), e))?;
let config: Config = serde_yml::from_slice(&config)
.map_err(|e| ConfigError::ParseConfig(filename.into(), e))?;
config.check()?;
Ok(config)
}
fn check(&self) -> Result<(), ConfigError> {
if let Some(triggers) = &self.triggers {
for trigger in triggers.iter() {
if !self.adapters.contains_key(&trigger.adapter) {
return Err(ConfigError::UnknownAdapter(trigger.adapter.clone()));
}
}
}
Ok(())
}
pub fn report_dir(&self) -> Option<&Path> {
self.report_dir.as_deref()
}
pub fn concurrent_adapters(&self) -> usize {
match self.concurrent_adapters {
None | Some(0) => 1,
Some(n) => n,
}
}
pub fn to_adapters(&self) -> Result<Adapters, AdapterError> {
Adapters::new(&self.adapters, self.default_adapter.as_deref())
}
pub fn filters(&self) -> &[EventFilter] {
self.filters.as_deref().unwrap_or(&[])
}
pub fn to_triggers(&self) -> Vec<Trigger> {
self.triggers
.as_deref()
.unwrap_or(&[])
.iter()
.map(Trigger::from)
.collect()
}
pub fn status_page_update_interval(&self) -> u64 {
self.status_update_interval_seconds
.unwrap_or(DEFAULT_STATUS_PAGE_UPDATE_INTERVAL)
}
pub fn max_run_time(&self) -> Duration {
self.max_run_time
}
pub fn queue_len_interval(&self) -> Duration {
self.queue_len_interval
}
pub fn db(&self) -> &Path {
&self.db
}
pub fn to_json(&self) -> Result<String, ConfigError> {
serde_json::to_string_pretty(self).map_err(ConfigError::ToJson)
}
}
#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct AdapterSpec {
pub command: PathBuf,
#[serde(default)]
env: HashMap<String, String>,
#[serde(default)]
sensitive_env: HashMap<String, Sensitive>,
/// Configuration for the adapter. If the `Self::config_env` field
/// is set, the configuration is serialize into YAML and written
/// to a temporary file. The environment variable named in
/// `config_env` is set to the path of the temporary file.
#[serde(default)]
config: HashMap<String, serde_yml::Value>,
config_env: Option<String>,
}
impl AdapterSpec {
pub fn config_env(&self) -> Option<&str> {
self.config_env.as_deref()
}
pub fn config(&self) -> &HashMap<String, serde_yml::Value> {
&self.config
}
pub fn envs(&self) -> &HashMap<String, String> {
&self.env
}
pub fn sensitive_envs(&self) -> &HashMap<String, Sensitive> {
&self.sensitive_env
}
}
impl From<&AdapterSpec> for Adapter {
fn from(config: &AdapterSpec) -> Self {
let adapter = Self::new(&config.command)
.with_environment(config.envs())
.with_sensitive_environment(config.sensitive_envs())
.with_config(config.config.clone());
if let Some(x) = &config.config_env {
adapter.with_config_env(x)
} else {
adapter
}
}
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TriggerConfig {
pub adapter: String,
pub filters: Vec<EventFilter>,
}
/// All possible errors from configuration handling.
#[derive(Debug, thiserror::Error)]
pub enum ConfigError {
/// Can't read config file.
#[error("could not read config file {0}")]
ReadConfig(PathBuf, #[source] std::io::Error),
/// Can't parse config file as YAML.
#[error("failed to parse configuration file as YAML: {0}")]
ParseConfig(PathBuf, #[source] serde_yml::Error),
/// Can't convert configuration into JSON.
#[error("failed to convert configuration into JSON")]
ToJson(#[source] serde_json::Error),
/// No default adapter.
#[error("the default adapter is not defined in the configuration")]
NoDefaultAdapter,
/// Unknown adapter.
#[error("'triggers' refers to adapter that hasn't been defined: {0}")]
UnknownAdapter(String),
}
#[cfg(test)]
mod test {
use super::*;
#[test]
#[allow(clippy::unwrap_used)]
fn parse_config_yaml() {
const YAML: &str = r#"---
default_adapter: foo
adapters: {}
filters: []
db: "foo.db"
max_run_time: 1min
...
"#;
let cfg: Config = serde_yml::from_str(YAML).unwrap();
assert_eq!(cfg.max_run_time(), Duration::from_secs(60));
}
#[test]
#[allow(clippy::unwrap_used)]
fn parse_config_yaml_without_max_run_time() {
const YAML: &str = r#"---
default_adapter: foo
adapters: {}
filters: []
db: "foo.db"
...
"#;
let cfg: Config = serde_yml::from_str(YAML).unwrap();
assert_eq!(cfg.max_run_time(), DEFAULT_MAX_RUN_TIME);
}
}