Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add "chained" integ tests #170

Merged
merged 4 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ fn generate_integ_test_cases(out_dir: &String) -> Result<(), String> {
let spec_file_parsed: TestSpecFile =
toml::from_str(&contents).map_err(|e| spec_file.err_string(e)).unwrap();

let chained_needed = spec_file_parsed.chained.map(|ch| ch.needed).unwrap_or(true);

out.write("const MD: &str = indoc::indoc! {r#\"");
out.with_indent(|out| {
let mut iter = spec_file_parsed.given.md.trim().split('\n').peekable();
Expand All @@ -44,9 +46,23 @@ fn generate_integ_test_cases(out_dir: &String) -> Result<(), String> {
}
});

let mut found_chained_case = false;
for case in spec_file_parsed.get_cases() {
found_chained_case |= case.case_name.eq("chained");
case.write_test_fn_to(out);
}

match (chained_needed, found_chained_case) {
(true, false) => Case::write_failing_test(out, "chained", "missing 'chained' test case"),
(false, true) => Case::write_failing_test(
out,
"chained__extra",
"provided 'chained' test case even though it was marked as not needed",
),
_ => {}
}

if !found_chained_case {}
});

out.writeln("}");
Expand Down Expand Up @@ -102,6 +118,7 @@ impl DirEntryHelper {
struct TestSpecFile {
given: TestGiven,
expect: HashMap<String, TestExpect>,
chained: Option<Chained>,
}

#[derive(Deserialize)]
Expand All @@ -117,6 +134,11 @@ struct TestExpect {
ignore: Option<String>,
}

#[derive(Deserialize, Copy, Clone)]
struct Chained {
needed: bool,
}

impl TestSpecFile {
fn get_cases(self) -> Vec<Case> {
let mut results = Vec::with_capacity(self.expect.len());
Expand All @@ -143,6 +165,15 @@ struct Case {
}

impl Case {
fn write_failing_test(out: &mut Writer, name: &str, err_msg: &str) {
out.writeln("#[test]");
out.writes(&["fn ", name, "() {"]);
out.with_indent(|out| {
out.writes(&["panic!(\"", err_msg, "\");"]);
});
out.writeln("}");
}

fn write_test_fn_to(&self, out: &mut Writer) {
let fn_name = self.case_name.replace(|ch: char| !ch.is_alphanumeric(), "_");
if self.ignored {
Expand Down
3 changes: 3 additions & 0 deletions tests/md_cases/link_placement.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Some section text.
[1]: https://example.com/interesting
'''

[chained]
needed = false


[expect."standard link placement"]
cli_args = []
Expand Down
4 changes: 4 additions & 0 deletions tests/md_cases/links_references.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ md = '''
[shortcut link]: https://example.com/shortcut
'''

[chained]
needed = false


[expect."default"]
cli_args = []
Expand Down Expand Up @@ -72,3 +75,4 @@ output = '''
- a [link with a title](https://example.com "my title")
- a [link with a title that contains double-quotes](https://example.com 'my "alleged" title')
'''

2 changes: 2 additions & 0 deletions tests/md_cases/matchers.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ md = '''
- lorem ipsum dolor sit amet.
'''

[chained]
needed = false

[expect."bareword"]
cli_args = ['- world '] # note: trailing space is ignored
Expand Down
3 changes: 3 additions & 0 deletions tests/md_cases/output_format.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Test _one_ [two][1] three.
[1]: https://example.com/1
'''

[chained]
needed = false


[expect."default"]
cli_args = []
Expand Down
3 changes: 3 additions & 0 deletions tests/md_cases/select_exit_code.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ md = '''
[fizz](https://example.com/buzz)
'''

[chained]
needed = false


[expect."match and output"]
cli_args = ["--link-format", "keep", "[]()"]
Expand Down
7 changes: 7 additions & 0 deletions tests/md_cases/select_html.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,10 @@ output = '''
<div
class="block>
'''


[expect."chained"]
cli_args = ['</> span | </> "<span>"']
output = '''
<span>
'''
7 changes: 7 additions & 0 deletions tests/md_cases/select_link.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,10 @@ output = '''
![image alt text](https://example.com/hylas-and-nymphs.png)'''


[expect."chained"]
cli_args = ['[inline]() | [](example.com)']
output = '''
[an inline link][1]

[1]: https://example.com/inline
'''
7 changes: 7 additions & 0 deletions tests/md_cases/select_lists.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,10 @@ cli_args = ['1. [?]']
output = '''
1. [ ] ordered tasks are possible, too
'''


[expect."chained"]
cli_args = ['- a point | - a point']
output = '''
- a point
'''
7 changes: 7 additions & 0 deletions tests/md_cases/select_paragraphs.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,10 @@ cli_args = ["P : *"]
expect_success = false
output = '''
'''


[expect."chained"]
cli_args = ['P: hello | P: world']
output = '''
Hello, world.
'''
9 changes: 9 additions & 0 deletions tests/md_cases/select_sections.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,12 @@ Hello, world.

My second section.
'''


[expect."chained"]
cli_args = ['# bravo | # bravo']
output = '''
# Bravo

My second section.
'''
2 changes: 0 additions & 2 deletions tests/md_cases/select_tables.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ output = '''


[expect."chained"]
# chaining onen all-cells selector into another; the second should be a noop
# TODO need to add "chained" tests for all! And maybe even require it in the build.rs code
cli_args = [":-: * :-: * | :-: * :-: * | "]
output = '''
| Name | Description | |
Expand Down
Loading