mirror of
https://github.com/denoland/deno.git
synced 2024-12-12 18:42:18 -05:00
439 lines
12 KiB
Rust
439 lines
12 KiB
Rust
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
use std::collections::VecDeque;
|
|
use std::path::PathBuf;
|
|
|
|
use super::fmt::to_relative_path_or_remote_url;
|
|
use super::*;
|
|
|
|
pub struct JunitTestReporter {
|
|
cwd: Url,
|
|
output_path: String,
|
|
// Stores TestCases (i.e. Tests) by the Test ID
|
|
cases: IndexMap<usize, quick_junit::TestCase>,
|
|
// Stores nodes representing test cases in such a way that can be traversed
|
|
// from child to parent to build the full test name that reflects the test
|
|
// hierarchy.
|
|
test_name_tree: TestNameTree,
|
|
failure_format_options: TestFailureFormatOptions,
|
|
}
|
|
|
|
impl JunitTestReporter {
|
|
pub fn new(
|
|
cwd: Url,
|
|
output_path: String,
|
|
failure_format_options: TestFailureFormatOptions,
|
|
) -> Self {
|
|
Self {
|
|
cwd,
|
|
output_path,
|
|
cases: IndexMap::new(),
|
|
test_name_tree: TestNameTree::new(),
|
|
failure_format_options,
|
|
}
|
|
}
|
|
|
|
fn convert_status(
|
|
status: &TestResult,
|
|
failure_format_options: &TestFailureFormatOptions,
|
|
) -> quick_junit::TestCaseStatus {
|
|
match status {
|
|
TestResult::Ok => quick_junit::TestCaseStatus::success(),
|
|
TestResult::Ignored => quick_junit::TestCaseStatus::skipped(),
|
|
TestResult::Failed(failure) => quick_junit::TestCaseStatus::NonSuccess {
|
|
kind: quick_junit::NonSuccessKind::Failure,
|
|
message: Some(failure.overview()),
|
|
ty: None,
|
|
description: Some(failure.format(failure_format_options).into_owned()),
|
|
reruns: vec![],
|
|
},
|
|
TestResult::Cancelled => quick_junit::TestCaseStatus::NonSuccess {
|
|
kind: quick_junit::NonSuccessKind::Error,
|
|
message: Some("Cancelled".to_string()),
|
|
ty: None,
|
|
description: None,
|
|
reruns: vec![],
|
|
},
|
|
}
|
|
}
|
|
|
|
fn convert_step_status(
|
|
status: &TestStepResult,
|
|
failure_format_options: &TestFailureFormatOptions,
|
|
) -> quick_junit::TestCaseStatus {
|
|
match status {
|
|
TestStepResult::Ok => quick_junit::TestCaseStatus::success(),
|
|
TestStepResult::Ignored => quick_junit::TestCaseStatus::skipped(),
|
|
TestStepResult::Failed(failure) => {
|
|
quick_junit::TestCaseStatus::NonSuccess {
|
|
kind: quick_junit::NonSuccessKind::Failure,
|
|
message: Some(failure.overview()),
|
|
ty: None,
|
|
description: Some(
|
|
failure.format(failure_format_options).into_owned(),
|
|
),
|
|
reruns: vec![],
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TestReporter for JunitTestReporter {
|
|
fn report_register(&mut self, description: &TestDescription) {
|
|
let mut case = quick_junit::TestCase::new(
|
|
description.name.clone(),
|
|
quick_junit::TestCaseStatus::skipped(),
|
|
);
|
|
case.classname = Some(to_relative_path_or_remote_url(
|
|
&self.cwd,
|
|
&description.location.file_name,
|
|
));
|
|
case.extra.insert(
|
|
String::from("line"),
|
|
description.location.line_number.to_string(),
|
|
);
|
|
case.extra.insert(
|
|
String::from("col"),
|
|
description.location.column_number.to_string(),
|
|
);
|
|
self.cases.insert(description.id, case);
|
|
|
|
self.test_name_tree.add_node(description.clone().into());
|
|
}
|
|
|
|
fn report_plan(&mut self, _plan: &TestPlan) {}
|
|
|
|
fn report_slow(&mut self, _description: &TestDescription, _elapsed: u64) {}
|
|
fn report_wait(&mut self, _description: &TestDescription) {}
|
|
|
|
fn report_output(&mut self, _output: &[u8]) {
|
|
/*
|
|
TODO(skycoop): Right now I can't include stdout/stderr in the report because
|
|
we have a global pair of output streams that don't differentiate between the
|
|
output of different tests. This is a nice to have feature, so we can come
|
|
back to it later
|
|
*/
|
|
}
|
|
|
|
fn report_result(
|
|
&mut self,
|
|
description: &TestDescription,
|
|
result: &TestResult,
|
|
elapsed: u64,
|
|
) {
|
|
if let Some(case) = self.cases.get_mut(&description.id) {
|
|
case.status = Self::convert_status(result, &self.failure_format_options);
|
|
case.set_time(Duration::from_millis(elapsed));
|
|
}
|
|
}
|
|
|
|
fn report_uncaught_error(&mut self, _origin: &str, _error: Box<JsError>) {}
|
|
|
|
fn report_step_register(&mut self, description: &TestStepDescription) {
|
|
self.test_name_tree.add_node(description.clone().into());
|
|
let test_case_name =
|
|
self.test_name_tree.construct_full_test_name(description.id);
|
|
|
|
let mut case = quick_junit::TestCase::new(
|
|
test_case_name,
|
|
quick_junit::TestCaseStatus::skipped(),
|
|
);
|
|
case.classname = Some(to_relative_path_or_remote_url(
|
|
&self.cwd,
|
|
&description.location.file_name,
|
|
));
|
|
case.extra.insert(
|
|
String::from("line"),
|
|
description.location.line_number.to_string(),
|
|
);
|
|
case.extra.insert(
|
|
String::from("col"),
|
|
description.location.column_number.to_string(),
|
|
);
|
|
self.cases.insert(description.id, case);
|
|
}
|
|
|
|
fn report_step_wait(&mut self, _description: &TestStepDescription) {}
|
|
|
|
fn report_step_result(
|
|
&mut self,
|
|
description: &TestStepDescription,
|
|
result: &TestStepResult,
|
|
elapsed: u64,
|
|
_tests: &IndexMap<usize, TestDescription>,
|
|
_test_steps: &IndexMap<usize, TestStepDescription>,
|
|
) {
|
|
if let Some(case) = self.cases.get_mut(&description.id) {
|
|
case.status =
|
|
Self::convert_step_status(result, &self.failure_format_options);
|
|
case.set_time(Duration::from_millis(elapsed));
|
|
}
|
|
}
|
|
|
|
fn report_summary(
|
|
&mut self,
|
|
_elapsed: &Duration,
|
|
_tests: &IndexMap<usize, TestDescription>,
|
|
_test_steps: &IndexMap<usize, TestStepDescription>,
|
|
) {
|
|
}
|
|
|
|
fn report_sigint(
|
|
&mut self,
|
|
tests_pending: &HashSet<usize>,
|
|
tests: &IndexMap<usize, TestDescription>,
|
|
_test_steps: &IndexMap<usize, TestStepDescription>,
|
|
) {
|
|
for id in tests_pending {
|
|
if let Some(description) = tests.get(id) {
|
|
self.report_result(description, &TestResult::Cancelled, 0)
|
|
}
|
|
}
|
|
}
|
|
|
|
fn report_completed(&mut self) {
|
|
// TODO(mmastrac): This reporter does not handle stdout/stderr yet, and when we do, we may need to redirect
|
|
// pre-and-post-test output somewhere.
|
|
}
|
|
|
|
fn flush_report(
|
|
&mut self,
|
|
elapsed: &Duration,
|
|
tests: &IndexMap<usize, TestDescription>,
|
|
test_steps: &IndexMap<usize, TestStepDescription>,
|
|
) -> anyhow::Result<()> {
|
|
let mut suites: IndexMap<String, quick_junit::TestSuite> = IndexMap::new();
|
|
for (id, case) in &self.cases {
|
|
let abs_filename = match (tests.get(id), test_steps.get(id)) {
|
|
(Some(test), _) => &test.location.file_name,
|
|
(_, Some(step)) => &step.location.file_name,
|
|
(None, None) => {
|
|
unreachable!("Unknown test ID '{id}' provided");
|
|
}
|
|
};
|
|
|
|
let filename = to_relative_path_or_remote_url(&self.cwd, abs_filename);
|
|
|
|
suites
|
|
.entry(filename.clone())
|
|
.and_modify(|s| {
|
|
s.add_test_case(case.clone());
|
|
})
|
|
.or_insert_with(|| {
|
|
let mut suite = quick_junit::TestSuite::new(filename);
|
|
suite.add_test_case(case.clone());
|
|
suite
|
|
});
|
|
}
|
|
|
|
let mut report = quick_junit::Report::new("deno test");
|
|
report
|
|
.set_time(*elapsed)
|
|
.add_test_suites(suites.into_values());
|
|
|
|
if self.output_path == "-" {
|
|
report
|
|
.serialize(std::io::stdout())
|
|
.with_context(|| "Failed to write JUnit report to stdout")?;
|
|
} else {
|
|
let file =
|
|
crate::util::fs::create_file(&PathBuf::from(&self.output_path))
|
|
.context("Failed to open JUnit report file.")?;
|
|
report.serialize(file).with_context(|| {
|
|
format!("Failed to write JUnit report to {}", self.output_path)
|
|
})?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Default)]
|
|
struct TestNameTree(IndexMap<usize, TestNameTreeNode>);
|
|
|
|
impl TestNameTree {
|
|
fn new() -> Self {
|
|
// Pre-allocate some space to avoid excessive reallocations.
|
|
Self(IndexMap::with_capacity(256))
|
|
}
|
|
|
|
fn add_node(&mut self, node: TestNameTreeNode) {
|
|
self.0.insert(node.id, node);
|
|
}
|
|
|
|
/// Constructs the full test name by traversing the tree from the specified
|
|
/// node as a child to its parent nodes.
|
|
/// If the provided ID is not found in the tree, or the tree is broken (e.g.
|
|
/// a child node refers to a parent node that doesn't exist), this method
|
|
/// just panics.
|
|
fn construct_full_test_name(&self, id: usize) -> String {
|
|
let mut current_id = Some(id);
|
|
let mut name_pieces = VecDeque::new();
|
|
|
|
loop {
|
|
let Some(id) = current_id else {
|
|
break;
|
|
};
|
|
|
|
let Some(node) = self.0.get(&id) else {
|
|
// The ID specified as a parent node by the child node should exist in
|
|
// the tree, but it doesn't. In this case we give up constructing the
|
|
// full test name.
|
|
unreachable!("Unregistered test ID '{id}' provided");
|
|
};
|
|
|
|
name_pieces.push_front(node.test_name.as_str());
|
|
current_id = node.parent_id;
|
|
}
|
|
|
|
if name_pieces.is_empty() {
|
|
unreachable!("Unregistered test ID '{id}' provided");
|
|
}
|
|
|
|
let v: Vec<_> = name_pieces.into();
|
|
v.join(" > ")
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
struct TestNameTreeNode {
|
|
id: usize,
|
|
parent_id: Option<usize>,
|
|
test_name: String,
|
|
}
|
|
|
|
impl From<TestDescription> for TestNameTreeNode {
|
|
fn from(description: TestDescription) -> Self {
|
|
Self {
|
|
id: description.id,
|
|
parent_id: None,
|
|
test_name: description.name,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<TestStepDescription> for TestNameTreeNode {
|
|
fn from(description: TestStepDescription) -> Self {
|
|
Self {
|
|
id: description.id,
|
|
parent_id: Some(description.parent_id),
|
|
test_name: description.name,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn construct_full_test_name_one_node() {
|
|
let mut tree = TestNameTree::new();
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 0,
|
|
parent_id: None,
|
|
test_name: "root".to_string(),
|
|
});
|
|
|
|
assert_eq!(tree.construct_full_test_name(0), "root".to_string());
|
|
}
|
|
|
|
#[test]
|
|
fn construct_full_test_name_two_level_hierarchy() {
|
|
let mut tree = TestNameTree::new();
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 0,
|
|
parent_id: None,
|
|
test_name: "root".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 1,
|
|
parent_id: Some(0),
|
|
test_name: "child".to_string(),
|
|
});
|
|
|
|
assert_eq!(tree.construct_full_test_name(0), "root".to_string());
|
|
assert_eq!(tree.construct_full_test_name(1), "root > child".to_string());
|
|
}
|
|
|
|
#[test]
|
|
fn construct_full_test_name_three_level_hierarchy() {
|
|
let mut tree = TestNameTree::new();
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 0,
|
|
parent_id: None,
|
|
test_name: "root".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 1,
|
|
parent_id: Some(0),
|
|
test_name: "child".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 2,
|
|
parent_id: Some(1),
|
|
test_name: "grandchild".to_string(),
|
|
});
|
|
|
|
assert_eq!(tree.construct_full_test_name(0), "root".to_string());
|
|
assert_eq!(tree.construct_full_test_name(1), "root > child".to_string());
|
|
assert_eq!(
|
|
tree.construct_full_test_name(2),
|
|
"root > child > grandchild".to_string()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn construct_full_test_name_one_root_two_chains() {
|
|
// 0
|
|
// / \
|
|
// 1 2
|
|
// / \
|
|
// 3 4
|
|
let mut tree = TestNameTree::new();
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 0,
|
|
parent_id: None,
|
|
test_name: "root".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 1,
|
|
parent_id: Some(0),
|
|
test_name: "child 1".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 2,
|
|
parent_id: Some(0),
|
|
test_name: "child 2".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 3,
|
|
parent_id: Some(1),
|
|
test_name: "grandchild 1".to_string(),
|
|
});
|
|
tree.add_node(TestNameTreeNode {
|
|
id: 4,
|
|
parent_id: Some(1),
|
|
test_name: "grandchild 2".to_string(),
|
|
});
|
|
|
|
assert_eq!(tree.construct_full_test_name(0), "root".to_string());
|
|
assert_eq!(
|
|
tree.construct_full_test_name(1),
|
|
"root > child 1".to_string(),
|
|
);
|
|
assert_eq!(
|
|
tree.construct_full_test_name(2),
|
|
"root > child 2".to_string(),
|
|
);
|
|
assert_eq!(
|
|
tree.construct_full_test_name(3),
|
|
"root > child 1 > grandchild 1".to_string(),
|
|
);
|
|
assert_eq!(
|
|
tree.construct_full_test_name(4),
|
|
"root > child 1 > grandchild 2".to_string(),
|
|
);
|
|
}
|
|
}
|