// 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 test_html_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(), "--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, "

Coverage report for all files

"); 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, "

Coverage report for foo.ts

"); let bar_ts_html = tempdir.join("html").join("bar.ts.html").read_to_string(); assert_contains!(bar_ts_html, "

Coverage report for bar.ts

"); // Check in source code is escaped to <T> assert_contains!(bar_ts_html, "<T>"); let baz_index_html = tempdir .join("html") .join("baz") .join("index.html") .read_to_string(); assert_contains!(baz_index_html, "

Coverage report for baz/

"); 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, "

Coverage report for baz/qux.ts

"); let baz_quux_ts_html = tempdir .join("html") .join("baz") .join("quux.ts.html") .read_to_string(); assert_contains!( baz_quux_ts_html, "

Coverage report for baz/quux.ts

" ); } #[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 | ---------------------------------- ", ); }