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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#[cfg(test)]
pub(crate) use test_utils::*;
// We this file's contents from prod by putting them in a submodule guarded by cfg(test), but then "pub(crate) use" it to
// export its contents.
#[cfg(test)]
mod test_utils {
use crate::output::InlineElemOptions;
use crate::output::LinkTransform;
use crate::output::{MdWriterOptions, ReferencePlacement};
use std::fmt::Debug;
impl LinkTransform {
pub(crate) fn default_for_tests() -> Self {
Self::Keep
}
}
impl ReferencePlacement {
pub(crate) fn default_for_tests() -> Self {
Self::Section
}
}
impl MdWriterOptions {
pub(crate) fn default_for_tests() -> Self {
Self {
link_reference_placement: ReferencePlacement::default_for_tests(),
footnote_reference_placement: ReferencePlacement::default_for_tests(),
inline_options: InlineElemOptions {
link_format: LinkTransform::default_for_tests(),
renumber_footnotes: false,
},
include_thematic_breaks: true,
text_width: None,
}
}
pub(crate) fn new_with<F>(init: F) -> Self
where
F: FnOnce(&mut MdWriterOptions),
{
let mut mdo = Self::default_for_tests();
init(&mut mdo);
mdo
}
}
pub(crate) fn get_only<T: Debug, C: IntoIterator<Item = T>>(col: C) -> T {
let mut iter = col.into_iter();
let Some(result) = iter.next() else {
panic!("expected an element, but was empty");
};
match iter.next() {
None => result,
Some(extra) => {
let mut all = Vec::new();
all.push(result);
all.push(extra);
all.extend(iter);
panic!("expected exactly one element, but found {}: {all:?}", all.len());
}
}
}
/// Turn a pattern match into an `if let ... { else panic! }`.
macro_rules! unwrap {
($enum_value:expr, $enum_variant:pat) => {
let node = $enum_value;
let node_debug = format!("{:?}", node);
let $enum_variant = node else {
panic!("Expected {} but saw {}", stringify!($enum_variant), node_debug);
};
};
}
pub(crate) use unwrap;
macro_rules! test_delay_ms {
($i:literal) => {{
time::Duration::from_millis(
$i * option_env!("TEST_TIMEOUT_MULTIPLIER")
.map(|s| s.parse::<u64>().expect("bad value for TEST_TIMEOUT_MULTIPLIER"))
.unwrap_or(1),
)
}};
}
pub(crate) use test_delay_ms;
/// Match the expression against a pattern, and then either return the expression or panic.
macro_rules! match_or_panic {
($input:expr => $variant:pat) => {{
let elem = $input;
if !matches!(elem, $variant) {
panic!(
"{} should have been {}, was {:?}",
stringify!($input),
stringify!($variant),
elem
);
}
elem
}};
}
pub(crate) use match_or_panic;
/// Creates a static object named `$name` that looks for all the variants of enum `E`.
///
/// ```
/// use mdq::variants_checker;
///
/// enum MyEnum {
/// Variant1,
/// Variant2(usize)
/// }
/// variants_checker!(CHECKER_NAME = MyEnum { Variant1, Variant2(_) });
/// ```
///
/// You can also mark some variants as ignored; these will be added to the pattern match, but not be required to
/// be seen:
///
/// ```
/// use mdq::variants_checker;
///
/// enum MyEnum {
/// Variant1,
/// Variant2(usize)
/// }
/// variants_checker!(CHECKER_NAME = MyEnum { Variant1 } ignore { Variant2(_) });
/// ```
///
/// If you see a compilation failure here, it means the call site is missing variants (or has an unknown
/// variant).
///
/// We can't use strum to do this for mdast::Node, because we don't own the Node code. Instead, we rely on a bit of
/// trickery: we pass in a bunch of arms, and each gets [stringify!]'d and added to a set. Whenever we [see] an
/// item, we remove the corresponding string from the set.
///
/// This requires that each pattern matches exactly one shape of item; in other words, that there aren't any
/// dead-code branches.
macro_rules! variants_checker {
($name:ident = $enum_type:ty { $($variant:pat),* $(,)? } $(ignore { $($ignore_variant:pat),* $(,)? })?) => {
paste::paste!{
pub(crate) struct [<VariantsChecker $name:lower:camel>] {
require: std::sync::Arc<std::sync::Mutex<std::collections::HashSet<String>>>,
}
impl [<VariantsChecker $name:lower:camel>] {
fn see(&self, node: &$enum_type) {
let node_str = match node {
$($enum_type::$variant => stringify!($variant),)*
$($($enum_type::$ignore_variant => {
panic!("unexpected variant: {}", stringify!($ignore_variant));
},)*)?
};
self.require.lock().map(|mut set| set.remove(node_str)).unwrap();
}
fn wait_for_all(&self) {
use std::{thread, time};
let timeout = crate::util::utils_for_test::test_delay_ms!(500);
let retry_delay = time::Duration::from_millis(50);
let start = time::Instant::now();
loop {
if self.require.lock().map(|set| set.is_empty()).unwrap() {
break;
}
if start.elapsed() >= timeout {
let mut remaining: Vec<String> = self
.require
.lock()
.map(|set| set.iter().map(|s| s.to_owned()).collect())
.unwrap();
remaining.sort();
panic!(
"Timed out, and missing {} variants:\n- {}",
remaining.len(),
remaining.join("\n- ")
)
}
thread::sleep(retry_delay);
}
}
}
lazy_static::lazy_static! {
static ref $name: [<VariantsChecker $name:lower:camel>] = [<VariantsChecker $name:lower:camel>] {
require: std::sync::Arc::new(
std::sync::Mutex::new(
vec![$(stringify!($variant).to_string(),)*].into_iter().collect()
)
)
};
}
#[test]
fn [<all_variants_checked_for_ $name:lower:snake>]() {
$name.wait_for_all();
}
}
};
}
pub(crate) use variants_checker;
}