1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
use std::path::PathBuf;
use clap::{Parser, Subcommand};
use regex::Regex;
/// Typst's test runner.
#[derive(Debug, Clone, Parser)]
#[command(bin_name = "cargo test --workspace --test tests --")]
#[clap(name = "typst-test", author)]
pub struct CliArguments {
/// The command to run.
#[command(subcommand)]
pub command: Option<Command>,
/// All the tests whose names match the test name pattern will be run.
#[arg(value_parser = Regex::new)]
pub pattern: Vec<Regex>,
/// Restricts test selection within the given path.
#[arg(short, long, value_parser = |s: &str| PathBuf::from(s).canonicalize())]
pub path: Vec<PathBuf>,
/// Only selects the test that matches with the test name verbatim.
#[arg(short, long)]
pub exact: bool,
/// Lists what tests will be run, without actually running them.
#[arg(long, group = "action")]
pub list: bool,
/// Updates the reference images of non-passing tests.
#[arg(short, long, group = "action")]
pub update: bool,
/// The scaling factor to render the output image with.
///
/// Does not affect the comparison or the reference image.
#[arg(short, long, default_value_t = 1.0)]
pub scale: f32,
/// Whether to run the tests in extended mode, including PDF and SVG
/// export.
///
/// This is used in CI.
#[arg(long, env = "TYPST_TESTS_EXTENDED")]
pub extended: bool,
/// Runs PDF export.
#[arg(long)]
pub pdf: bool,
/// Runs SVG export.
#[arg(long)]
pub svg: bool,
/// Displays the syntax tree before running tests.
///
/// Note: This is ignored if using '--syntax-compare'.
#[arg(long)]
pub syntax: bool,
/// Displays only one line per test, hiding details about failures.
#[arg(short, long)]
pub compact: bool,
/// Prevents the terminal from being cleared of test names.
#[arg(short, long)]
pub verbose: bool,
/// How many threads to spawn when running the tests.
#[arg(short = 'j', long)]
pub num_threads: Option<usize>,
/// Changes testing behavior for debugging the parser: With no argument,
/// outputs the concrete syntax trees of tests as files in
/// 'tests/store/syntax/'. With a directory as argument, will treat it as a
/// reference of correct syntax tree files and will print which output
/// syntax trees differ (viewing the diffs is on you).
///
/// This overrides the normal testing system. It parses, but does not run
/// the test suite.
///
/// If `cargo test` is run with `--no-default-features`, then compiling will
/// not include Typst's core crates, only typst-syntax, greatly speeding up
/// debugging when changing the parser.
///
/// You can generate a correct reference directory by running on a known
/// good commit and copying the generated outputs to a new directory.
/// `_things` may be a good location as it is in the top-level gitignore.
///
/// You can view diffs in VS Code with: `code --diff <ref_dir>/<test>.syntax
/// tests/store/syntax/<test>.syntax`
#[arg(long)]
pub parser_compare: Option<Option<PathBuf>>,
// ^ I'm not using a subcommand here because then test patterns don't parse
// how you would expect and I'm too lazy to try to fix it.
}
impl CliArguments {
/// Whether to run PDF export.
pub fn pdf(&self) -> bool {
self.pdf || self.extended
}
/// Whether to run SVG export.
pub fn svg(&self) -> bool {
self.svg || self.extended
}
}
/// What to do.
#[derive(Debug, Clone, Subcommand)]
#[command()]
pub enum Command {
/// Clears the on-disk test artifact store.
Clean,
/// Deletes all dangling reference images.
Undangle,
}
|
