use std::path::{Path, PathBuf};
use std::process::{Command, Output};
use telar_project::protocol::{TEST_OUT_DIR, TEST_REPORT_FILE};
#[test]
#[ignore = "builds telar with its previews: run it with `cargo test -p cargo-telar --test library_previews -- --ignored`"]
fn a_library_placing_its_rsx_from_several_modules_has_every_preview_tested_once() {
let run = test_library(
"several-modules",
"telar::rsx_modules!();\ntelar::library_previews!();\nmod ui;\n",
BADGE_RSX,
&[],
);
let shown = shown(&run.output);
assert!(
run.output.status.success(),
"cargo telar test failed with {}\n{shown}",
run.output.status
);
let report_path = run.target_dir.join(TEST_OUT_DIR).join(TEST_REPORT_FILE);
let report: serde_json::Value =
serde_json::from_str(&std::fs::read_to_string(&report_path).unwrap_or_else(|e| {
panic!("the run wrote no {}: {e}\n{shown}", report_path.display())
}))
.expect("the report is JSON");
let preview_ids: Vec<&str> = report["test"]["previews"]
.as_array()
.expect("the report lists its previews")
.iter()
.filter_map(|preview| preview["id"].as_str())
.collect();
assert_eq!(preview_ids, ["several_modules--badge--plain"], "{shown}");
assert_eq!(shown.matches("running 1 preview(s)").count(), 1, "{shown}");
}
#[test]
#[ignore = "builds telar with its previews: run it with `cargo test -p cargo-telar --test library_previews -- --ignored`"]
fn a_library_without_library_previews_fails_naming_the_macro() {
let run = test_library(
"without-macro",
"telar::rsx_modules!();\nmod ui;\n",
BADGE_RSX,
&[],
);
let shown = shown(&run.output);
assert!(!run.output.status.success(), "{shown}");
assert!(
String::from_utf8_lossy(&run.output.stderr).contains("`telar::library_previews!();`"),
"{shown}"
);
}
#[test]
#[ignore = "builds telar with its previews: run it with `cargo test -p cargo-telar --test library_previews -- --ignored`"]
fn an_error_level_accessibility_finding_fails_the_run_unless_asked_only_to_warn() {
let lib_rs = "telar::rsx_modules!();\ntelar::library_previews!();\nmod ui;\n";
let failed = test_library("faint", lib_rs, FAINT_RSX, &[]);
let shown_failed = shown(&failed.output);
assert!(!failed.output.status.success(), "{shown_failed}");
assert!(
shown_failed.contains("FAIL faint--badge--plain"),
"{shown_failed}"
);
assert!(shown_failed.contains("contrast"), "{shown_failed}");
let warned = test_library("faint", lib_rs, FAINT_RSX, &["--a11y", "warn"]);
let shown_warned = shown(&warned.output);
assert!(warned.output.status.success(), "{shown_warned}");
}
struct LibraryRun {
output: Output,
target_dir: PathBuf,
}
fn shown(output: &Output) -> String {
format!(
"--- stdout\n{}\n--- stderr\n{}",
String::from_utf8_lossy(&output.stdout),
String::from_utf8_lossy(&output.stderr)
)
}
fn test_library(name: &str, lib_rs: &str, badge_rsx: &str, args: &[&str]) -> LibraryRun {
let repo = repo_root();
let work = Path::new(env!("CARGO_TARGET_TMPDIR")).join("library-previews");
let target_dir = work.join(format!("target-{name}"));
let library = work.join(name);
if library.exists() {
std::fs::remove_dir_all(&library).expect("remove the previous run");
}
write_library(&library, &repo, name, lib_rs, badge_rsx);
let output = Command::new(env!("CARGO_BIN_EXE_cargo-telar"))
.args(["test", "--no-snapshots"])
.args(args)
.current_dir(&library)
.env("CARGO_TARGET_DIR", &target_dir)
.env("CARGO_NET_OFFLINE", "true")
.output()
.expect("could not start cargo-telar");
LibraryRun { output, target_dir }
}
fn repo_root() -> PathBuf {
Path::new(env!("CARGO_MANIFEST_DIR"))
.ancestors()
.nth(3)
.expect("cargo-telar sits three levels below the repository root")
.to_path_buf()
}
fn write_library(dir: &Path, repo: &Path, name: &str, lib_rs: &str, badge_rsx: &str) {
let manifest = format!(
r#"[package]
name = "{name}"
version = "0.1.0"
edition = "2024"
publish = false
[dependencies]
telar = {{ path = {telar}, default-features = false, features = ["runtime", "shaper"] }}
[workspace]
"#,
telar = toml::Value::String(repo.join("crates/telar").display().to_string()),
);
let files = [
("Cargo.toml", manifest.as_str()),
("telar.toml", "[telar]\nlibrary = true\n"),
("src/lib.rs", lib_rs),
("src/ui/mod.rs", "telar::rsx_modules!();\n"),
("src/ui/badge.rsx", badge_rsx),
];
for (relative, contents) in files {
let path = dir.join(relative);
std::fs::create_dir_all(path.parent().expect("a file has a parent"))
.expect("create a library directory");
std::fs::write(&path, contents).expect("write a library file");
}
std::fs::copy(repo.join("Cargo.lock"), dir.join("Cargo.lock")).expect("copy Cargo.lock");
}
const BADGE_RSX: &str = r#"[view]
text "Nested" font_size:14
[previews "Nested/Badge"]
A badge placed from a nested `mod.rs`.
[preview "Plain"]
badge
"#;
const FAINT_RSX: &str = r#"[view]
box fill:#ffffff
text "Faint" font_size:14 color:#bbbbbb
[previews "Faint/Badge"]
A badge too faint to read.
[preview "Plain"]
badge
"#;