mirror of
https://github.com/denoland/deno
synced 2024-08-27 12:00:17 +00:00
![Yusuke Tanaka](/assets/img/avatar_default.png)
This patch gets JUnit reporter to output more detailed information for test steps (subtests). ## Issue with previous implementation In the previous implementation, the test hierarchy was represented using several XML tags like the following: - `<testsuites>` corresponds to the entire test (one execution of `deno test` has exactly one `<testsuites>` tag) - `<testsuite>` corresponds to one file, such as `main_test.ts` - `<testcase>` corresponds to one `Deno.test(...)` - `<property>` corresponds to one `t.step(...)` This structure describes the test layers but one problem is that `<property>` tag is used for any use cases so some tools that can ingest a JUnit XML file might not be able to interpret `<property>` as subtests. ## How other tools address it Some of the testing frameworks in the ecosystem address this issue by fitting subtests into the `<testcase>` layer. For instance, take a look at the following Go test file: ```go package main_test import "testing" func TestMain(t *testing.T) { t.Run("child 1", func(t *testing.T) { // OK }) t.Run("child 2", func(t *testing.T) { // Error t.Fatal("error") }) } ``` Running [gotestsum], we can get the output like this: ```xml <?xml version="1.0" encoding="UTF-8"?> <testsuites tests="3" failures="2" errors="0" time="1.013694"> <testsuite tests="3" failures="2" time="0.510000" name="example/gosumtest" timestamp="2024-03-11T12:26:39+09:00"> <properties> <property name="go.version" value="go1.22.1 darwin/arm64"></property> </properties> <testcase classname="example/gosumtest" name="TestMain/child_2" time="0.000000"> <failure message="Failed" type="">=== RUN TestMain/child_2
 main_test.go:12: error
--- FAIL: TestMain/child_2 (0.00s)
</failure> </testcase> <testcase classname="example/gosumtest" name="TestMain" time="0.000000"> <failure message="Failed" type="">=== RUN TestMain
--- FAIL: TestMain (0.00s)
</failure> </testcase> <testcase classname="example/gosumtest" name="TestMain/child_1" time="0.000000"></testcase> </testsuite> </testsuites> ``` This output shows that nested test cases are squashed into the `<testcase>` layer by treating them as the same layer as their parent, `TestMain`. We can still distinguish nested ones by their `name` attributes that look like `TestMain/<subtest_name>`. As described in #22795, [vitest] solves the issue in the same way as [gotestsum]. One downside of this would be that one test failure that happens in a nested test case will end up being counted multiple times, because not only the subtest but also its wrapping container(s) are considered to be failures. In fact, in the [gotestsum] output above, `TestMain/child_2` failed (which is totally expected) while its parent, `TestMain`, was also counted as failure. As https://github.com/denoland/deno/pull/20273#discussion_r1307558757 pointed out, there is a test runner that offers flexibility to prevent this, but I personally don't think the "duplicate failure count" issue is a big deal. ## How to fix the issue in this patch This patch fixes the issue with the same approach as [gotestsum] and [vitest]. More specifically, nested test cases are put into the `<testcase>` level and their names are now represented as squashed test names concatenated by `>` (e.g. `parent 2 > child 1 > grandchild 1`). This change also allows us to put a detailed error message as `<failure>` tag within the `<testcase>` tag, which should be handled nicely by third-party tools supporting JUnit XML. ## Extra fix Also, file paths embedded into XML outputs are changed from absolute path to relative path, which is helpful when running the test suites in several different environments like CI. Resolves #22795 [gotestsum]: https://github.com/gotestyourself/gotestsum [vitest]: https://vitest.dev/ --------- Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
164 lines
4.6 KiB
Rust
164 lines
4.6 KiB
Rust
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
use crate::args::Flags;
|
|
use crate::args::JupyterFlags;
|
|
use crate::ops;
|
|
use crate::tools::jupyter::server::StdioMsg;
|
|
use crate::tools::repl;
|
|
use crate::tools::test::create_single_test_event_channel;
|
|
use crate::tools::test::reporters::PrettyTestReporter;
|
|
use crate::tools::test::TestEventWorkerSender;
|
|
use crate::util::logger;
|
|
use crate::CliFactory;
|
|
use deno_core::anyhow::Context;
|
|
use deno_core::error::generic_error;
|
|
use deno_core::error::AnyError;
|
|
use deno_core::located_script_name;
|
|
use deno_core::resolve_url_or_path;
|
|
use deno_core::serde::Deserialize;
|
|
use deno_core::serde_json;
|
|
use deno_core::url::Url;
|
|
use deno_runtime::deno_io::Stdio;
|
|
use deno_runtime::deno_io::StdioPipe;
|
|
use deno_runtime::permissions::Permissions;
|
|
use deno_runtime::permissions::PermissionsContainer;
|
|
use deno_terminal::colors;
|
|
use tokio::sync::mpsc;
|
|
use tokio::sync::mpsc::UnboundedSender;
|
|
|
|
mod install;
|
|
pub(crate) mod jupyter_msg;
|
|
pub(crate) mod server;
|
|
|
|
pub async fn kernel(
|
|
flags: Flags,
|
|
jupyter_flags: JupyterFlags,
|
|
) -> Result<(), AnyError> {
|
|
log::info!(
|
|
"{} \"deno jupyter\" is unstable and might change in the future.",
|
|
colors::yellow("Warning"),
|
|
);
|
|
|
|
if !jupyter_flags.install && !jupyter_flags.kernel {
|
|
install::status()?;
|
|
return Ok(());
|
|
}
|
|
|
|
if jupyter_flags.install {
|
|
install::install()?;
|
|
return Ok(());
|
|
}
|
|
|
|
let connection_filepath = jupyter_flags.conn_file.unwrap();
|
|
|
|
// This env var might be set by notebook
|
|
if std::env::var("DEBUG").is_ok() {
|
|
logger::init(Some(log::Level::Debug));
|
|
}
|
|
|
|
let factory = CliFactory::from_flags(flags)?;
|
|
let cli_options = factory.cli_options();
|
|
let main_module =
|
|
resolve_url_or_path("./$deno$jupyter.ts", cli_options.initial_cwd())
|
|
.unwrap();
|
|
// TODO(bartlomieju): should we run with all permissions?
|
|
let permissions = PermissionsContainer::new(Permissions::allow_all());
|
|
let npm_resolver = factory.npm_resolver().await?.clone();
|
|
let resolver = factory.resolver().await?.clone();
|
|
let worker_factory = factory.create_cli_main_worker_factory().await?;
|
|
let (stdio_tx, stdio_rx) = mpsc::unbounded_channel();
|
|
|
|
let conn_file =
|
|
std::fs::read_to_string(&connection_filepath).with_context(|| {
|
|
format!("Couldn't read connection file: {:?}", connection_filepath)
|
|
})?;
|
|
let spec: ConnectionSpec =
|
|
serde_json::from_str(&conn_file).with_context(|| {
|
|
format!(
|
|
"Connection file is not a valid JSON: {:?}",
|
|
connection_filepath
|
|
)
|
|
})?;
|
|
let (worker, test_event_receiver) = create_single_test_event_channel();
|
|
let TestEventWorkerSender {
|
|
sender: test_event_sender,
|
|
stdout,
|
|
stderr,
|
|
} = worker;
|
|
|
|
let mut worker = worker_factory
|
|
.create_custom_worker(
|
|
main_module.clone(),
|
|
permissions,
|
|
vec![
|
|
ops::jupyter::deno_jupyter::init_ops(stdio_tx.clone()),
|
|
ops::testing::deno_test::init_ops(test_event_sender.clone()),
|
|
],
|
|
// FIXME(nayeemrmn): Test output capturing currently doesn't work.
|
|
Stdio {
|
|
stdin: StdioPipe::inherit(),
|
|
stdout: StdioPipe::file(stdout),
|
|
stderr: StdioPipe::file(stderr),
|
|
},
|
|
)
|
|
.await?;
|
|
worker.setup_repl().await?;
|
|
worker.execute_script_static(
|
|
located_script_name!(),
|
|
"Deno[Deno.internal].enableJupyter();",
|
|
)?;
|
|
let worker = worker.into_main_worker();
|
|
let mut repl_session = repl::ReplSession::initialize(
|
|
cli_options,
|
|
npm_resolver,
|
|
resolver,
|
|
worker,
|
|
main_module,
|
|
test_event_sender,
|
|
test_event_receiver,
|
|
)
|
|
.await?;
|
|
struct TestWriter(UnboundedSender<StdioMsg>);
|
|
impl std::io::Write for TestWriter {
|
|
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
|
|
self
|
|
.0
|
|
.send(StdioMsg::Stdout(String::from_utf8_lossy(buf).into_owned()))
|
|
.ok();
|
|
Ok(buf.len())
|
|
}
|
|
fn flush(&mut self) -> std::io::Result<()> {
|
|
Ok(())
|
|
}
|
|
}
|
|
let cwd_url =
|
|
Url::from_directory_path(cli_options.initial_cwd()).map_err(|_| {
|
|
generic_error(format!(
|
|
"Unable to construct URL from the path of cwd: {}",
|
|
cli_options.initial_cwd().to_string_lossy(),
|
|
))
|
|
})?;
|
|
repl_session.set_test_reporter_factory(Box::new(move || {
|
|
Box::new(
|
|
PrettyTestReporter::new(false, true, false, true, cwd_url.clone())
|
|
.with_writer(Box::new(TestWriter(stdio_tx.clone()))),
|
|
)
|
|
}));
|
|
|
|
server::JupyterServer::start(spec, stdio_rx, repl_session).await?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
pub struct ConnectionSpec {
|
|
ip: String,
|
|
transport: String,
|
|
control_port: u32,
|
|
shell_port: u32,
|
|
stdin_port: u32,
|
|
hb_port: u32,
|
|
iopub_port: u32,
|
|
key: String,
|
|
}
|