starship/src/modules/opa.rs
AppleTheGolden 865e68da3a
feat: Open Policy Agent module (#1740) (#4441)
* feat: Open Policy Agent module (#1740)

* Format documentation

* Fix typo, `ropa` -> `rego`

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>

* Update presets for OPA module

* Add extra space to OPA module symbol

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2022-10-15 18:15:33 +02:00

111 lines
3.4 KiB
Rust

/// Creates a module with the current Open Policy Agent version
use super::{Context, Module, ModuleConfig};
use crate::configs::opa::OpaConfig;
use crate::formatter::StringFormatter;
use crate::formatter::VersionFormatter;
use crate::utils::get_command_string_output;
/// Creates a module with the current Open Policy Agent version
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
let mut module = context.new_module("opa");
let config = OpaConfig::try_load(module.config);
let is_opa_project = context
.try_begin_scan()?
.set_files(&config.detect_files)
.set_extensions(&config.detect_extensions)
.set_folders(&config.detect_folders)
.is_match();
if !is_opa_project {
return None;
}
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
formatter
.map_meta(|var, _| match var {
"symbol" => Some(config.symbol),
_ => None,
})
.map_style(|variable| match variable {
"style" => Some(Ok(config.style)),
_ => None,
})
.map(|variable| match variable {
"version" => {
let opa_version = get_opa_version(context)?;
VersionFormatter::format_module_version(
module.get_name(),
&opa_version,
config.version_format,
)
.map(Ok)
}
_ => None,
})
.parse(None, Some(context))
});
module.set_segments(match parsed {
Ok(segments) => segments,
Err(error) => {
log::warn!("Error in module `opa`:\n{}", error);
return None;
}
});
Some(module)
}
fn get_opa_version(context: &Context) -> Option<String> {
let version_output: String = context
.exec_cmd("opa", &["version"])
.map(get_command_string_output)?;
parse_opa_version(version_output)
}
fn parse_opa_version(version_output: String) -> Option<String> {
Some(version_output.split_whitespace().nth(1)?.to_string())
}
#[cfg(test)]
mod tests {
use crate::test::ModuleRenderer;
use nu_ansi_term::Color;
use std::fs::File;
use std::io;
#[test]
fn folder_without_opa_files() -> io::Result<()> {
let dir = tempfile::tempdir()?;
let actual = ModuleRenderer::new("opa").path(dir.path()).collect();
let expected = None;
assert_eq!(expected, actual);
dir.close()
}
#[test]
fn folder_with_opa_file() -> io::Result<()> {
let dir = tempfile::tempdir()?;
File::create(dir.path().join("test.rego"))?.sync_all()?;
let actual = ModuleRenderer::new("opa").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Blue.bold().paint("🪖 v0.44.0 ")));
assert_eq!(expected, actual);
dir.close()
}
#[test]
fn no_opa_installed() -> io::Result<()> {
let dir = tempfile::tempdir()?;
File::create(dir.path().join("test.rego"))?.sync_all()?;
let actual = ModuleRenderer::new("opa")
.path(dir.path())
.cmd("opa version", None)
.collect();
let expected = Some(format!("via {}", Color::Blue.bold().paint("🪖 ")));
assert_eq!(expected, actual);
dir.close()
}
}