mirror of
https://github.com/martinvonz/jj.git
synced 2024-10-24 15:43:12 +00:00
d66fcf2ca0
this greatly speeds up the time to run all tests, at the cost of slightly larger recompile times for individual tests. this unfortunately adds the requirement that all tests are listed in `runner.rs` for the crate. to avoid forgetting, i've added a new test that ensures the directory is in sync with the file. ## benchmarks before this change, recompiling all tests took 32-50 seconds and running a single test took 3.5 seconds: ``` ; hyperfine 'touch lib/src/lib.rs && cargo t --test test_working_copy' Time (mean ± σ): 3.543 s ± 0.168 s [User: 2.597 s, System: 1.262 s] Range (min … max): 3.400 s … 3.847 s 10 runs ``` after this change, recompiling all tests take 4 seconds: ``` ; hyperfine 'touch lib/src/lib.rs ; cargo t --test runner --no-run' Time (mean ± σ): 4.055 s ± 0.123 s [User: 3.591 s, System: 1.593 s] Range (min … max): 3.804 s … 4.159 s 10 runs ``` and running a single test takes about the same: ``` ; hyperfine 'touch lib/src/lib.rs && cargo t --test runner -- test_working_copy' Time (mean ± σ): 4.129 s ± 0.120 s [User: 3.636 s, System: 1.593 s] Range (min … max): 3.933 s … 4.346 s 10 runs ``` about 1.4 seconds of that is the time for the runner, of which .4 is the time for the linker. so there may be room for further improving the times.
50 lines
2 KiB
Rust
50 lines
2 KiB
Rust
// Copyright 2024 The Jujutsu Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
use insta::assert_snapshot;
|
|
|
|
use crate::common::TestEnvironment;
|
|
|
|
const PREAMBLE: &str = r#"
|
|
!!! warning
|
|
|
|
This CLI reference is experimental. It is automatically generated, but
|
|
does not match the `jj help` output exactly.
|
|
|
|
<!-- See also https://github.com/ConnorGray/clap-markdown/issues -->
|
|
|
|
"#;
|
|
|
|
#[test]
|
|
fn test_generate_markdown_docs_in_docs_dir() {
|
|
let test_env = TestEnvironment::default();
|
|
let mut markdown_help = PREAMBLE.to_string();
|
|
markdown_help
|
|
.push_str(&test_env.jj_cmd_success(test_env.env_root(), &["util", "markdown-help"]));
|
|
// Validate partial snapshot, redacting any lines nested 2+ indent levels.
|
|
insta::with_settings!({
|
|
snapshot_path => ".",
|
|
snapshot_suffix => ".md",
|
|
prepend_module_to_snapshot => false,
|
|
omit_expression => true,
|
|
description => "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated as an \
|
|
`insta` snapshot. MkDocs follows they symlink from docs/cli-reference.md \
|
|
to the snap. Unfortunately, `insta` unavoidably creates this header. Luckily, \
|
|
MkDocs ignores the header since it has the same format as Markdown headers. \
|
|
TODO: MkDocs may fail on Windows if symlinks are not enabled in the OS \
|
|
settings",
|
|
},
|
|
{ assert_snapshot!("cli-reference", markdown_help) });
|
|
}
|