Skip to content

Commit 4a03f98

Browse files
a-frantza-frantz
committed
feat: better tests
1 parent 78b04cf commit 4a03f98

11 files changed

+19
-14
lines changed

‎wdl-doc/tests/doc.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,6 @@ async fn main() {
7272
}
7373

7474
// Compare the generated docs with the expected output
75-
// For now, check that the paths exist as expected.
76-
// TODO: check HTML content.
7775
let mut success = true;
7876
for entry in fs::read_dir(docs_dir).unwrap() {
7977
let entry = entry.unwrap();
@@ -86,6 +84,13 @@ async fn main() {
8684
if !expected_path.exists() {
8785
eprintln!("Expected path does not exist: {}", expected_path.display());
8886
success = false;
87+
continue;
88+
}
89+
let expected = fs::read_to_string(expected_path).unwrap();
90+
let actual = fs::read_to_string(&path).unwrap();
91+
if expected != actual {
92+
eprintln!("Mismatch in file: {}", path.display());
93+
success = false;
8994
}
9095
}
9196

‎wdl-doc/tests/output_docs/data_structures/flag_filter/FlagFilter-struct.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="dark size-full"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>FlagFilter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex dark size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border left-0 h-full w-1/6 p-4 dark:bg-slate-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4"><div class="table-auto border-collapse"><h1>FlagFilter</h1><h2>Members</h2><ul><li><b>include_if_all:</b> <code>String</code></li><li><b>exclude_if_any:</b> <code>String</code></li><li><b>include_if_any:</b> <code>String</code></li><li><b>exclude_if_all:</b> <code>String</code></li></ul></div></div></body></html>
1+
<!DOCTYPE html><html class="dark"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>FlagFilter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border h-fit left-0 min-w-[269px] w-[269px] p-4 dark:bg-slate-900 dark:text-white overflow-x-scroll"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4 flex grow"><div class="table-auto border-collapse"><h1>FlagFilter</h1><h2>Members</h2><ul><li><b>include_if_all:</b> <code>String</code></li><li><b>exclude_if_any:</b> <code>String</code></li><li><b>include_if_any:</b> <code>String</code></li><li><b>exclude_if_all:</b> <code>String</code></li></ul></div></div><div class="top-0 border h-screen sticky right-0 min-w-[240px] w-[240px] p-4 bottom-4 object-right dark:bg-red-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">Right Sidebar</p></div></body></html>

‎wdl-doc/tests/output_docs/data_structures/flag_filter/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!DOCTYPE html><html class="dark size-full"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>flag_filter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex dark size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border left-0 h-full w-1/6 p-4 dark:bg-slate-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4"><div><h1>flag_filter</h1><h3>WDL Version: 1.1</h3><div><h1>FlagFilter</h1>
1+
<!DOCTYPE html><html class="dark"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>flag_filter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border h-fit left-0 min-w-[269px] w-[269px] p-4 dark:bg-slate-900 dark:text-white overflow-x-scroll"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4 flex grow"><div><h1>flag_filter</h1><h3>WDL Version: 1.1</h3><div><h1>FlagFilter</h1>
22
<p>A struct to represent the filtering flags used in various <code>samtools</code> commands.
33
The order of precedence is <code>include_if_all</code>, <code>exclude_if_any</code>, <code>include_if_any</code>,
44
and <code>exclude_if_all</code>.
@@ -48,4 +48,4 @@ <h3>Explanation</h3>
4848
In short, those are all flags corresponding to the quality of the read
4949
and them being <code>true</code> may indicate that the read is of low quality and
5050
should be excluded.</p>
51-
</div><div class="flex flex-col items-center text-left"><h2>Table of Contents</h2><table class="border"><thead class="border"><tr><th class="">Page</th><th class="">Type</th><th class="">Description</th></tr></thead><tbody class="border"><tr class="border"><td class="border"><a href="FlagFilter-struct.html">FlagFilter</a></td><td class="border">Struct</td><td class="border">N/A</td></tr><tr class="border"><td class="border"><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></td><td class="border">Task</td><td class="border">Validates that a string is a octal, decimal, or hexadecimal number and less than 2^12.</td></tr><tr class="border"><td class="border"><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></td><td class="border">Workflow</td><td class="border">Validates a FlagFilter struct.</td></tr></tbody></table></div></div></div></body></html>
51+
</div><div class="flex flex-col items-center text-left"><h2>Table of Contents</h2><table class="border"><thead class="border"><tr><th class="">Page</th><th class="">Type</th><th class="">Description</th></tr></thead><tbody class="border"><tr class="border"><td class="border"><a href="FlagFilter-struct.html">FlagFilter</a></td><td class="border">Struct</td><td class="border">N/A</td></tr><tr class="border"><td class="border"><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></td><td class="border">Task</td><td class="border">Validates that a string is a octal, decimal, or hexadecimal number and less than 2^12.</td></tr><tr class="border"><td class="border"><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></td><td class="border">Workflow</td><td class="border">Validates a FlagFilter struct.</td></tr></tbody></table></div></div></div><div class="top-0 border h-screen sticky right-0 min-w-[240px] w-[240px] p-4 bottom-4 object-right dark:bg-red-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">Right Sidebar</p></div></body></html>

‎wdl-doc/tests/output_docs/data_structures/flag_filter/validate_flag_filter-workflow.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="dark size-full"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>validate_flag_filter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex dark size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border left-0 h-full w-1/6 p-4 dark:bg-slate-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4"><div class="table-auto border-collapse"><h1>validate_flag_filter</h1>Validates a FlagFilter struct.<h2>Inputs</h2><h3>Required Inputs</h3><table class="border"><thead class="border"><tr><th>Name</th><th>Type</th><th>Description</th><th>Additional Meta</th></tr></thead><tbody class="border"><tr class="border"><td class="border">flags</td><td class="border"><code>FlagFilter</code></td><td class="border">FlagFilter struct to validate</td><td class="border"></td></tr></tbody></table><h2>Outputs</h2><table><thead class="border"><tr><th>Name</th><th>Type</th><th>Expression</th><th>Description</th><th>Additional Meta</th></tr></thead><tbody class="border"><tr class="border"><td class="border">check</td><td class="border"><code>String</code></td><td class="border"><code>&quot;passed&quot;</code></td><td class="border">Dummy output to enable caching.</td><td class="border"></td></tr></tbody></table></div></div></body></html>
1+
<!DOCTYPE html><html class="dark"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>validate_flag_filter</title><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&amp;display=swap" rel="stylesheet"></head><body class="flex size-full dark:bg-slate-950 dark:text-white p-4"><div class="top-0 border h-fit left-0 min-w-[269px] w-[269px] p-4 dark:bg-slate-900 dark:text-white overflow-x-scroll"><h1 class="text-2xl text-center">Sidebar</h1><p class="">docs</p><ul class=""><li class="px-2"><p class="">data_structures</p><ul class=""><li class="px-2"><p><a href="index.html">flag_filter</a></p><ul class=""><li class="px-2"><p><a href="FlagFilter-struct.html">FlagFilter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_flag_filter-workflow.html">validate_flag_filter</a></p><ul class=""></ul></li><li class="px-2"><p><a href="validate_string_is_12bit_oct_dec_or_hex-task.html">validate_string_is_12bit_oct_dec_or_hex</a></p><ul class=""></ul></li></ul></li><li class="px-2"><p><a href="../read_group/index.html">read_group</a></p><ul class=""><li class="px-2"><p><a href="../read_group/ReadGroup-struct.html">ReadGroup</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/get_read_groups-task.html">get_read_groups</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/read_group_to_string-task.html">read_group_to_string</a></p><ul class=""></ul></li><li class="px-2"><p><a href="../read_group/validate_read_group-task.html">validate_read_group</a></p><ul class=""></ul></li></ul></li></ul></li></ul></div><div class="p-4 flex grow"><div class="table-auto border-collapse"><h1>validate_flag_filter</h1>Validates a FlagFilter struct.<h2>Inputs</h2><h3>Required Inputs</h3><table class="border"><thead class="border"><tr><th>Name</th><th>Type</th><th>Description</th><th>Additional Meta</th></tr></thead><tbody class="border"><tr class="border"><td class="border">flags</td><td class="border"><code>FlagFilter</code></td><td class="border">FlagFilter struct to validate</td><td class="border"></td></tr></tbody></table><h2>Outputs</h2><table><thead class="border"><tr><th>Name</th><th>Type</th><th>Expression</th><th>Description</th><th>Additional Meta</th></tr></thead><tbody class="border"><tr class="border"><td class="border">check</td><td class="border"><code>String</code></td><td class="border"><code>&quot;passed&quot;</code></td><td class="border">Dummy output to enable caching.</td><td class="border"></td></tr></tbody></table></div></div><div class="top-0 border h-screen sticky right-0 min-w-[240px] w-[240px] p-4 bottom-4 object-right dark:bg-red-900 dark:text-white"><h1 class="text-2xl text-center">Sidebar</h1><p class="">Right Sidebar</p></div></body></html>

0 commit comments

Comments
 (0)