test(cheddar): Add simple Markdown rendering tests

Covers some of the odd things we do, specifically callouts and code
rendering.

Change-Id: Ib8542373b434b53d277b0d8c9ddb78ac7c5176a5
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2689
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
This commit is contained in:
Vincent Ambo 2021-03-27 17:47:49 +02:00 committed by tazjin
parent 58cca2faaa
commit c710509078
3 changed files with 66 additions and 1 deletions

View file

@ -3,7 +3,6 @@
pkgs.naersk.buildPackage {
src = ./.;
doDoc = false;
doCheck = false;
override = x: {
# Use our custom bat syntax set, which is everything from upstream,

View file

@ -25,6 +25,9 @@ use syntect::html::{
append_highlighted_html_for_styled_line, start_highlighted_html_snippet, IncludeBackground,
};
#[cfg(test)]
mod tests;
lazy_static! {
// Load syntaxes & themes lazily. Initialisation might not be
// required in the case of Markdown rendering (if there's no code

View file

@ -0,0 +1,63 @@
use super::*;
use std::io::BufReader;
// Markdown rendering expectation, ignoring leading and trailing
// whitespace in the input and output.
fn expect_markdown(input: &str, expected: &str) {
let mut input_buf = BufReader::new(input.trim().as_bytes());
let mut out_buf: Vec<u8> = vec![];
format_markdown(&mut input_buf, &mut out_buf);
let out_string = String::from_utf8(out_buf).expect("output should be UTF8");
assert_eq!(out_string.trim(), expected.trim());
}
#[test]
fn renders_simple_markdown() {
expect_markdown("hello", "<p>hello</p>\n");
}
#[test]
fn renders_callouts() {
expect_markdown(
"TODO some task.",
r#"<p class="cheddar-callout cheddar-todo">
TODO some task.
</p>
"#,
);
expect_markdown(
"WARNING: be careful",
r#"<p class="cheddar-callout cheddar-warning">
WARNING: be careful
</p>
"#,
);
expect_markdown(
"TIP: note the thing",
r#"<p class="cheddar-callout cheddar-tip">
TIP: note the thing
</p>
"#,
);
}
#[test]
fn renders_code_snippets() {
expect_markdown(
r#"
Code:
```nix
toString 42
```
"#,
r#"
<p>Code:</p>
<pre style="background-color:#f6f8fa;padding:16px;">
<span style="color:#62a35c;">toString </span><span style="color:#0086b3;">42
</span></pre>
"#,
);
}