1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
// SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
// SPDX-License-Identifier: BSD-2-Clause
//! Generate the test shell program.
use anyhow::{Context as _, Result};
use handlebars::{Context, Handlebars, Helper, HelperResult, Output, RenderContext, RenderError};
use tracing::debug;
use crate::defs::TestData;
const TEMPLATE_NAME: &str = "run-tests";
const TEMPLATE_PATH: &str = "tests/test-data/run-test.sh.hbs";
fn helper_datafile(
helper: &Helper<'_, '_>,
_: &Handlebars<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>,
out: &mut (dyn Output),
) -> HelperResult {
let value = helper
.param(0)
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: datafile: no parameter in {helper:?}"
))
})?
.value()
.as_str()
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: datafile: not a string parameter in {helper:?}"
))
})?;
let res = if value == "-" {
"-".to_owned()
} else if value.starts_with('/') {
shell_words::quote(value).to_string()
} else {
format!("\"$datadir/{value}\"")
};
out.write(&res)?;
Ok(())
}
fn helper_shell_quote(
helper: &Helper<'_, '_>,
_: &Handlebars<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>,
out: &mut (dyn Output),
) -> HelperResult {
let value = helper
.param(0)
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: shell_quote: no parameter in {helper:?}"
))
})?
.value()
.as_str()
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: shell_quote: not a string parameter in {helper:?}"
))
})?;
let res = shell_words::quote(value);
out.write(&res)?;
Ok(())
}
fn helper_shell_join(
helper: &Helper<'_, '_>,
_: &Handlebars<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>,
out: &mut (dyn Output),
) -> HelperResult {
let arr = helper
.param(0)
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: shell_join: no parameter in {helper:?}"
))
})?
.value()
.as_array()
.ok_or_else(|| {
RenderError::new(format!(
"Internal error: shell_join: not an array parameter in {helper:?}"
))
})?
.iter()
.map(|item| {
item.as_str().ok_or_else(|| {
RenderError::new(format!(
"Internal error: shell_join: not a string: {item:?}"
))
})
})
.collect::<Result<Vec<_>, _>>()?;
let res = shell_words::join(arr);
out.write(&res)?;
Ok(())
}
/// Build a handlebars renderer, load the template, etc.
pub fn generate(test_data: &TestData) -> Result<String> {
let mut renderer = Handlebars::new();
renderer.set_strict_mode(true);
renderer.register_escape_fn(ToOwned::to_owned);
renderer.register_helper("datafile", Box::new(helper_datafile));
renderer.register_helper("shell_quote", Box::new(helper_shell_quote));
renderer.register_helper("shell_join", Box::new(helper_shell_join));
renderer
.register_template_file(TEMPLATE_NAME, TEMPLATE_PATH)
.with_context(|| format!("Could not parse the {TEMPLATE_PATH} template"))?;
debug!("Rendering {count} tests", count = test_data.tests().len());
renderer
.render(TEMPLATE_NAME, test_data)
.with_context(|| format!("Could not render the {TEMPLATE_NAME} template"))
}
|