Repository navigation
Expand file tree
/
Copy pathtesting.rs
More file actions
362 lines (301 loc) · 9.79 KB
/
Copy pathtesting.rs
File metadata and controls
362 lines (301 loc) · 9.79 KB
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
//! Test helpers for working with Salsa databases
use tracing_subscriber::EnvFilter;
use tracing_subscriber::layer::SubscriberExt;
pub fn assert_function_query_was_not_run<Db, Q, QDb, I, R>(
db: &Db,
query: Q,
input: I,
events: &[salsa::Event],
) where
Db: salsa::Database,
Q: Fn(QDb, I) -> R,
I: salsa::plumbing::AsId + std::fmt::Debug + Copy,
{
let id = input.as_id();
let (query_name, will_execute_event) = find_will_execute_event(db, query, input, events);
db.attach(|_| {
if let Some(will_execute_event) = will_execute_event {
panic!(
"Expected query {query_name}({id:?}) not to have run but it did: \
{will_execute_event:?}\n\n{events:#?}"
);
}
});
}
pub fn assert_const_function_query_was_not_run<Db, Q, QDb, R>(
db: &Db,
query: Q,
events: &[salsa::Event],
) where
Db: salsa::Database,
Q: Fn(QDb) -> R,
{
// Salsa now interns singleton ingredients. But we know that it is a singleton, so we can just search for
// any event of that ingredient.
let query_name = query_name(&query);
let event = find_will_execute_event_by_name(db, query_name, None, events);
db.attach(|_| {
if let Some(will_execute_event) = event {
panic!(
"Expected query {query_name}() not to have run but it did: \
{will_execute_event:?}\n\n{events:#?}"
);
}
});
}
pub fn assert_function_query_was_not_run_by_name<Db>(
db: &Db,
query_name: &str,
input: Option<salsa::Id>,
events: &[salsa::Event],
) where
Db: salsa::Database,
{
let will_execute_event = find_will_execute_event_by_name(db, query_name, input, events);
db.attach(|_| {
if let Some(will_execute_event) = will_execute_event {
match input {
Some(input) => {
panic!(
"Expected query {query_name}({input:?}) not to have run \
but it did: {will_execute_event:?}\n\n{events:#?}"
);
}
None => {
panic!(
"Expected query {query_name} not to have run for any input \
but it did: {will_execute_event:?}\n\n{events:#?}"
);
}
}
}
});
}
/// Assert that the Salsa query described by the generic parameter `C`
/// was executed at least once with the input `input`
/// in the history span represented by `events`.
pub fn assert_function_query_was_run<Db, Q, QDb, I, R>(
db: &Db,
query: Q,
input: I,
events: &[salsa::Event],
) where
Db: salsa::Database,
Q: Fn(QDb, I) -> R,
I: salsa::plumbing::AsId + std::fmt::Debug + Copy,
{
let id = input.as_id();
let (query_name, will_execute_event) = find_will_execute_event(db, query, input, events);
db.attach(|_| {
assert!(
will_execute_event.is_some(),
"Expected query {query_name}({id:?}) to have run but it did not:\n{events:#?}"
);
});
}
pub fn find_will_execute_event<'a, Q, I>(
db: &dyn salsa::Database,
query: Q,
input: I,
events: &'a [salsa::Event],
) -> (&'static str, Option<&'a salsa::Event>)
where
I: salsa::plumbing::AsId,
{
let query_name = query_name(&query);
let event = find_will_execute_event_by_name(db, query_name, Some(input.as_id()), events);
(query_name, event)
}
pub fn find_will_execute_event_by_name<'a>(
db: &dyn salsa::Database,
query_name: &str,
input: Option<salsa::Id>,
events: &'a [salsa::Event],
) -> Option<&'a salsa::Event> {
events.iter().find(|event| {
if let salsa::EventKind::WillExecute { database_key } = event.kind {
db.ingredient_debug_name(database_key.ingredient_index()) == query_name
&& input.is_none_or(|input| database_key.key_index() == input)
} else {
false
}
})
}
fn query_name<Q>(_query: &Q) -> &'static str {
let full_qualified_query_name = std::any::type_name::<Q>();
full_qualified_query_name
.rsplit_once("::")
.map(|(_, name)| name)
.unwrap_or(full_qualified_query_name)
}
/// Sets up logging for the current thread. It captures all `ty` and `ruff` events.
///
/// Useful for capturing the tracing output in a failing test.
///
/// # Examples
/// ```
/// use ruff_db::testing::setup_logging;
/// let _logging = setup_logging();
///
/// tracing::info!("This message will be printed to stderr");
/// ```
pub fn setup_logging() -> LoggingGuard {
LoggingBuilder::new().build()
}
/// Sets up logging for the current thread and uses the passed filter to filter the shown events.
/// Useful for capturing the tracing output in a failing test.
///
/// # Examples
/// ```
/// use ruff_db::testing::setup_logging_with_filter;
/// let _logging = setup_logging_with_filter("ty_module_resolver::resolver");
/// ```
///
/// # Filter
/// See [`tracing_subscriber::EnvFilter`] for the `filter`'s syntax.
///
pub fn setup_logging_with_filter(filter: &str) -> Option<LoggingGuard> {
LoggingBuilder::with_filter(filter).map(LoggingBuilder::build)
}
#[derive(Debug)]
pub struct LoggingBuilder {
filter: EnvFilter,
}
impl LoggingBuilder {
pub fn new() -> Self {
Self {
filter: EnvFilter::default()
.add_directive("ty=trace".parse().expect("Hardcoded directive to be valid"))
.add_directive(
"ruff=trace"
.parse()
.expect("Hardcoded directive to be valid"),
),
}
}
pub fn with_filter(filter: &str) -> Option<Self> {
let filter = EnvFilter::builder().parse(filter).ok()?;
Some(Self { filter })
}
pub fn build(self) -> LoggingGuard {
let registry = tracing_subscriber::registry().with(self.filter);
let subscriber = registry.with(
tracing_subscriber::fmt::layer()
.compact()
.with_writer(std::io::stderr)
.with_timer(tracing_subscriber::fmt::time()),
);
let guard = tracing::subscriber::set_default(subscriber);
LoggingGuard { _guard: guard }
}
}
impl Default for LoggingBuilder {
fn default() -> Self {
Self::new()
}
}
#[must_use = "Dropping the guard unregisters the tracing subscriber."]
pub struct LoggingGuard {
_guard: tracing::subscriber::DefaultGuard,
}
#[test]
fn query_was_not_run() {
use crate::tests::TestDb;
use salsa::prelude::*;
#[salsa::input(debug)]
struct Input {
#[returns(clone)]
text: String,
}
#[salsa::tracked(returns(copy))]
fn len(db: &dyn salsa::Database, input: Input) -> usize {
input.text(db).len()
}
let mut db = TestDb::new();
let hello = Input::new(&db, "Hello, world!".to_string());
let goodbye = Input::new(&db, "Goodbye!".to_string());
assert_eq!(len(&db, hello), 13);
assert_eq!(len(&db, goodbye), 8);
// Change the input of one query
goodbye.set_text(&mut db).to("Bye".to_string());
db.clear_salsa_events();
assert_eq!(len(&db, goodbye), 3);
let events = db.take_salsa_events();
assert_function_query_was_run(&db, len, goodbye, &events);
assert_function_query_was_not_run(&db, len, hello, &events);
}
#[test]
#[should_panic(expected = "Expected query len(Id(0)) not to have run but it did:")]
fn query_was_not_run_fails_if_query_was_run() {
use crate::tests::TestDb;
use salsa::prelude::*;
#[salsa::input(debug)]
struct Input {
#[returns(clone)]
text: String,
}
#[salsa::tracked(returns(copy))]
fn len(db: &dyn salsa::Database, input: Input) -> usize {
input.text(db).len()
}
let mut db = TestDb::new();
let hello = Input::new(&db, "Hello, world!".to_string());
assert_eq!(len(&db, hello), 13);
// Change the input
hello.set_text(&mut db).to("Hy".to_string());
db.clear_salsa_events();
assert_eq!(len(&db, hello), 2);
let events = db.take_salsa_events();
assert_function_query_was_not_run(&db, len, hello, &events);
}
#[test]
#[should_panic(expected = "Expected query len() not to have run but it did:")]
fn const_query_was_not_run_fails_if_query_was_run() {
use crate::tests::TestDb;
use salsa::prelude::*;
#[salsa::input]
struct Input {
#[returns(clone)]
text: String,
}
#[salsa::tracked(returns(copy))]
fn len(db: &dyn salsa::Database) -> usize {
db.report_untracked_read();
5
}
let mut db = TestDb::new();
let hello = Input::new(&db, "Hello, world!".to_string());
assert_eq!(len(&db), 5);
// Create a new revision
db.clear_salsa_events();
hello.set_text(&mut db).to("Hy".to_string());
assert_eq!(len(&db), 5);
let events = db.take_salsa_events();
assert_const_function_query_was_not_run(&db, len, &events);
}
#[test]
#[should_panic(expected = "Expected query len(Id(0)) to have run but it did not:")]
fn query_was_run_fails_if_query_was_not_run() {
use crate::tests::TestDb;
use salsa::prelude::*;
#[salsa::input(debug)]
struct Input {
#[returns(clone)]
text: String,
}
#[salsa::tracked(returns(copy))]
fn len(db: &dyn salsa::Database, input: Input) -> usize {
input.text(db).len()
}
let mut db = TestDb::new();
let hello = Input::new(&db, "Hello, world!".to_string());
let goodbye = Input::new(&db, "Goodbye!".to_string());
assert_eq!(len(&db, hello), 13);
assert_eq!(len(&db, goodbye), 8);
// Change the input of one query
goodbye.set_text(&mut db).to("Bye".to_string());
db.clear_salsa_events();
assert_eq!(len(&db, goodbye), 3);
let events = db.take_salsa_events();
assert_function_query_was_run(&db, len, hello, &events);
}