coverage_tests.rs

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

use deno_core::serde_json;
use test_util as util;
use test_util::TempDir;
use util::assert_contains;
use util::assert_starts_with;
use util::env_vars_for_npm_tests;
use util::PathRef;
use util::TestContext;
use util::TestContextBuilder;

#[test]
fn branch() {
  run_coverage_text("branch", "ts");
}

#[test]
fn complex() {
  run_coverage_text("complex", "ts");
}

#[test]
fn final_blankline() {
  run_coverage_text("final_blankline", "js");
}

#[test]
fn no_snaps() {
  no_snaps_included("no_snaps_included", "ts");
}

// TODO(mmastrac): The exclusion to make this test pass doesn't seem to work on windows.
#[cfg_attr(windows, ignore)]
#[test]
fn no_tests() {
  no_tests_included("foo", "mts");
  no_tests_included("foo", "ts");
  no_tests_included("foo", "js");
}

#[test]
fn error_if_invalid_cache() {
  let context = TestContextBuilder::new().use_temp_cwd().build();
  let temp_dir_path = context.temp_dir().path();
  let other_temp_dir = TempDir::new();
  let other_tempdir = other_temp_dir.path().join("cov");

  let invalid_cache_path = util::testdata_path().join("coverage/invalid_cache");
  let mod_before_path = util::testdata_path()
    .join(&invalid_cache_path)
    .join("mod_before.ts");
  let mod_after_path = util::testdata_path()
    .join(&invalid_cache_path)
    .join("mod_after.ts");
  let mod_test_path = util::testdata_path()
    .join(&invalid_cache_path)
    .join("mod.test.ts");

  let mod_temp_path = temp_dir_path.join("mod.ts");
  let mod_test_temp_path = temp_dir_path.join("mod.test.ts");

  // Write the initial mod.ts file
  mod_before_path.copy(&mod_temp_path);
  // And the test file
  mod_test_path.copy(&mod_test_temp_path);

  // Generate coverage
  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", other_tempdir),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  // Modify the file between deno test and deno coverage, thus invalidating the cache
  mod_after_path.copy(&mod_temp_path);

  let output = context
    .new_command()
    .args_vec(vec!["coverage".to_string(), format!("{}/", other_tempdir)])
    .run();

  output.assert_exit_code(1);
  let out = output.combined_output();

  // Expect error
  let error = util::strip_ansi_codes(out).to_string();
  assert_contains!(error, "error: Missing transpiled source code");
  assert_contains!(error, "Before generating coverage report, run `deno test --coverage` to ensure consistent state.");
}

fn run_coverage_text(test_name: &str, extension: &str) {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "-A".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      format!("coverage/{test_name}_test.{extension}"),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .split_output()
    .run();

  // Verify there's no "Check" being printed
  assert!(output.stderr().is_empty());

  output.assert_stdout_matches_file(
    util::testdata_path().join(format!("coverage/{test_name}_expected.out")),
  );

  output.assert_exit_code(0);

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--quiet".to_string(),
      "--lcov".to_string(),
      format!("{}/", tempdir),
    ])
    .run();

  output.assert_matches_file(
    util::testdata_path().join(format!("coverage/{test_name}_expected.lcov")),
  );

  output.assert_exit_code(0);
}

#[test]
fn multifile_coverage() {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      format!("coverage/multifile/"),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .split_output()
    .run();

  // Verify there's no "Check" being printed
  assert!(output.stderr().is_empty());

  output.assert_stdout_matches_file(
    util::testdata_path().join("coverage/multifile/expected.out"),
  );
  output.assert_exit_code(0);

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--quiet".to_string(),
      "--lcov".to_string(),
      format!("{}/", tempdir),
    ])
    .run();

  output.assert_matches_file(
    util::testdata_path().join("coverage/multifile/expected.lcov"),
  );

  output.assert_exit_code(0);
}

fn no_snaps_included(test_name: &str, extension: &str) {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--allow-read".to_string(),
      format!("--coverage={}", tempdir),
      format!("coverage/no_snaps_included/{test_name}_test.{extension}"),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--include=no_snaps_included.ts".to_string(),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .split_output()
    .run();

  // Verify there's no "Check" being printed
  assert!(output.stderr().is_empty());

  output.assert_stdout_matches_file(
    util::testdata_path().join("coverage/no_snaps_included/expected.out"),
  );

  output.assert_exit_code(0);
}

fn no_tests_included(test_name: &str, extension: &str) {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--allow-read".to_string(),
      format!("--coverage={}", tempdir),
      format!("coverage/no_tests_included/{test_name}.test.{extension}"),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      format!("--exclude={}", util::std_path().canonicalize()),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .split_output()
    .run();

  // Verify there's no "Check" being printed
  assert!(output.stderr().is_empty());

  output.assert_stdout_matches_file(
    util::testdata_path().join("coverage/no_tests_included/expected.out"),
  );

  output.assert_exit_code(0);
}

#[test]
fn no_npm_cache_coverage() {
  let context = TestContext::with_http_server();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--allow-read".to_string(),
      format!("--coverage={}", tempdir),
      format!("coverage/no_npm_coverage/no_npm_coverage_test.ts"),
    ])
    .envs(env_vars_for_npm_tests())
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .split_output()
    .run();

  // Verify there's no "Check" being printed
  assert!(output.stderr().is_empty());

  output.assert_stdout_matches_file(
    util::testdata_path().join("coverage/no_npm_coverage/expected.out"),
  );

  output.assert_exit_code(0);
}

#[test]
fn no_transpiled_lines() {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/no_transpiled_lines/".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--include=no_transpiled_lines/index.ts".to_string(),
      "--detailed".to_string(),
      format!("{}/", tempdir),
    ])
    .run();

  output.assert_matches_file(
    util::testdata_path().join("coverage/no_transpiled_lines/expected.out"),
  );

  output.assert_exit_code(0);

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--lcov".to_string(),
      "--include=no_transpiled_lines/index.ts".to_string(),
      format!("{}/", tempdir),
    ])
    .run();

  output.assert_matches_file(
    util::testdata_path().join("coverage/no_transpiled_lines/expected.lcov"),
  );
  output.assert_exit_code(0);
}

#[test]
fn no_internal_code() {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/no_internal_code_test.ts".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  // Check that coverage files contain no internal urls
  let paths = tempdir.read_dir();
  for path in paths {
    let unwrapped = PathRef::new(path.unwrap().path());
    let data = unwrapped.read_to_string();

    let value: serde_json::Value = serde_json::from_str(&data).unwrap();
    let url = value["url"].as_str().unwrap();
    assert_starts_with!(url, "file:");
  }
}

#[test]
fn no_internal_node_code() {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--no-check".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/no_internal_node_code_test.ts".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  // Check that coverage files contain no internal urls
  let paths = tempdir.read_dir();
  for path in paths {
    let unwrapped = PathRef::new(path.unwrap().path());
    let data = unwrapped.read_to_string();

    let value: serde_json::Value = serde_json::from_str(&data).unwrap();
    let url = value["url"].as_str().unwrap();
    assert_starts_with!(url, "file:");
  }
}

#[test]
fn no_http_coverage_data() {
  let _http_server_guard = test_util::http_server();
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--no-check".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/no_http_coverage_data_test.ts".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  // Check that coverage files contain no http urls
  let paths = tempdir.read_dir();
  for path in paths {
    let unwrapped = PathRef::new(path.unwrap().path());
    let data = unwrapped.read_to_string();

    let value: serde_json::Value = serde_json::from_str(&data).unwrap();
    let url = value["url"].as_str().unwrap();
    assert_starts_with!(url, "file:");
  }
}

#[test]
fn test_html_reporter() {
  // This test case generates a html coverage report of test cases in /tests/testdata/coverage/multisource
  // You can get the same reports in ./cov_html by running the following command:
  // ```
  // ./target/debug/deno test --coverage=cov_html tests/testdata/coverage/multisource
  // ./target/debug/deno coverage --html cov_html
  // ```
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/multisource".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  let output = context
    .new_command()
    .args_vec(vec![
      "coverage".to_string(),
      "--html".to_string(),
      format!("{}/", tempdir),
    ])
    .run();

  output.assert_exit_code(0);
  output.assert_matches_text("HTML coverage report has been generated at [WILDCARD]/cov/html/index.html\n");

  let index_html = tempdir.join("html").join("index.html").read_to_string();
  assert_contains!(index_html, "<h1>Coverage report for all files</h1>");
  assert_contains!(index_html, "baz/");
  assert_contains!(index_html, "href='baz/index.html'");
  assert_contains!(index_html, "foo.ts");
  assert_contains!(index_html, "href='foo.ts.html'");
  assert_contains!(index_html, "bar.ts");
  assert_contains!(index_html, "href='bar.ts.html'");

  let foo_ts_html = tempdir.join("html").join("foo.ts.html").read_to_string();
  assert_contains!(foo_ts_html, "<h1>Coverage report for foo.ts</h1>");
  // Check that line count has correct title attribute
  assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 1 time'>x1</span>");
  assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 3 times'>x3</span>");

  let bar_ts_html = tempdir.join("html").join("bar.ts.html").read_to_string();
  assert_contains!(bar_ts_html, "<h1>Coverage report for bar.ts</h1>");
  // Check <T> in source code is escaped to &lt;T&gt;
  assert_contains!(bar_ts_html, "&lt;T&gt;");
  // Check that line anchors are correctly referenced by line number links
  assert_contains!(bar_ts_html, "<a name='L1'></a>");
  assert_contains!(bar_ts_html, "<a href='#L1'>1</a>");

  let baz_index_html = tempdir
    .join("html")
    .join("baz")
    .join("index.html")
    .read_to_string();
  assert_contains!(baz_index_html, "<h1>Coverage report for baz/</h1>");
  assert_contains!(baz_index_html, "qux.ts");
  assert_contains!(baz_index_html, "href='qux.ts.html'");
  assert_contains!(baz_index_html, "quux.ts");
  assert_contains!(baz_index_html, "href='quux.ts.html'");

  let baz_qux_ts_html = tempdir
    .join("html")
    .join("baz")
    .join("qux.ts.html")
    .read_to_string();
  assert_contains!(baz_qux_ts_html, "<h1>Coverage report for baz/qux.ts</h1>");

  let baz_quux_ts_html = tempdir
    .join("html")
    .join("baz")
    .join("quux.ts.html")
    .read_to_string();
  assert_contains!(
    baz_quux_ts_html,
    "<h1>Coverage report for baz/quux.ts</h1>"
  );
}

#[test]
fn test_summary_reporter() {
  let context = TestContext::default();
  let tempdir = context.temp_dir();
  let tempdir = tempdir.path().join("cov");

  let output = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      format!("--coverage={}", tempdir),
      "coverage/multisource".to_string(),
    ])
    .run();

  output.assert_exit_code(0);
  output.skip_output_check();

  {
    let output = context
      .new_command()
      .args_vec(vec!["coverage".to_string(), format!("{}/", tempdir)])
      .run();

    output.assert_exit_code(0);
    output.assert_matches_text(
      "----------------------------------
File         | Branch % | Line % |
----------------------------------
 bar.ts      |      0.0 |   57.1 |
 baz/quux.ts |      0.0 |   28.6 |
 baz/qux.ts  |    100.0 |  100.0 |
 foo.ts      |     50.0 |   76.9 |
----------------------------------
 All files   |     40.0 |   61.0 |
----------------------------------
",
    );
  }

  // test --ignore flag works
  {
    let output = context
      .new_command()
      .args_vec(vec![
        "coverage".to_string(),
        format!("{}/", tempdir),
        "--ignore=**/bar.ts,**/quux.ts".to_string(),
      ])
      .run();

    output.assert_exit_code(0);
    output.assert_matches_text(
      "---------------------------------
File        | Branch % | Line % |
---------------------------------
 baz/qux.ts |    100.0 |  100.0 |
 foo.ts     |     50.0 |   76.9 |
---------------------------------
 All files  |     66.7 |   85.0 |
---------------------------------
",
    );
  }
}

#[test]
fn test_collect_summary_with_no_matches() {
  let context: TestContext = TestContext::default();
  let temp_dir: &TempDir = context.temp_dir();
  let temp_dir_path: PathRef = PathRef::new(temp_dir.path().join("cov"));

  let empty_test_dir: PathRef = temp_dir_path.join("empty_dir");
  empty_test_dir.create_dir_all();

  let output: util::TestCommandOutput = context
    .new_command()
    .args_vec(vec![
      "test".to_string(),
      "--quiet".to_string(),
      "--allow-read".to_string(),
      format!("--coverage={}", temp_dir_path.as_path().display()),
      empty_test_dir.as_path().to_str().unwrap().to_string(),
    ])
    .run();

  output.assert_exit_code(1);

  let actual: &str = output.combined_output();
  let expected_message: &str = "error: No test modules found";
  assert_contains!(actual, expected_message);

  // Check the contents of the coverage directory, ignoring 'empty_dir'
  let mut unexpected_contents: Vec<std::path::PathBuf> = Vec::new();
  for entry in std::fs::read_dir(temp_dir_path.as_path())
    .unwrap()
    .flatten()
  {
    if entry.file_name() != "empty_dir" {
      // Ignore the 'empty_dir'
      unexpected_contents.push(entry.path());
    }
  }

  // Report unexpected contents
  if !unexpected_contents.is_empty() {
    eprintln!("Unexpected files or directories in the coverage directory:");
    for path in &unexpected_contents {
      eprintln!("{:?}", path);
    }
  }

  // Assert that the coverage directory is otherwise empty
  assert!(
    unexpected_contents.is_empty(),
    "Expected the coverage directory to be empty except for 'empty_dir', but found: {:?}",
    unexpected_contents
  );
}