deflake-rs 0.1.0

cargo-deflake is a command that detects flaky tests based on what tests fail and what code has changed
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
use core::panic;
use std::collections::HashSet;

use duplicate::duplicate_item;
use proc_macro2::Span;
use quote::quote;
use syn::{
    spanned::Spanned,
    visit::{self, Visit},
    File,
};

use crate::git::{Edit, EditType};

pub trait SpanHelpers {
    fn has_line(&self, line: usize) -> bool;
}
impl SpanHelpers for Span {
    fn has_line(&self, line: usize) -> bool {
        let line = line;
        self.start().line <= line && self.end().line >= line
    }
}

pub trait ItemFnHelpers {
    fn attr_lines(&self) -> HashSet<usize>;
    fn trackable_lines(&self) -> HashSet<usize>;
}

#[duplicate_item(
    func_type;
    [syn::ItemFn];
    [syn::ImplItemFn]
)]
impl ItemFnHelpers for func_type {
    fn attr_lines(&self) -> HashSet<usize> {
        let mut lines = HashSet::new();

        // Function attributes
        for attr in &self.attrs {
            let span = attr.span();
            lines.extend(span.start().line..=span.end().line);
        }

        lines
    }

    fn trackable_lines(&self) -> HashSet<usize> {
        let mut lines = HashSet::new();

        // Statement lines
        for stmt in &self.block.stmts {
            let span = stmt.span();
            lines.extend(span.start().line..=span.end().line);
        }

        lines.extend(self.attr_lines());

        // Function signature and braces
        lines.extend(self.sig.span().start().line..=self.sig.span().end().line);

        let braces = self.block.brace_token.span.span();
        lines.insert(braces.start().line);
        lines.insert(braces.end().line);

        lines
    }
}

pub struct AST {}

impl AST {
    pub fn line_in_span(span: Span, line: u32) -> bool {
        let line = line as usize;

        return span.start().line <= line && span.end().line >= line;
    }

    pub fn parse_file(file: &str) -> File {
        let syntax = syn::parse_str::<File>(file).unwrap();

        syntax
    }
}

pub struct AddedVisitor {
    pub functions: Vec<ItemFn>,
    //pub track: Vec<Track>,
}
impl AddedVisitor {
    pub fn new() -> AddedVisitor {
        AddedVisitor { functions: vec![] }
    }
}
impl<'ast> Visit<'ast> for AddedVisitor {
    fn visit_item_fn(&mut self, i: &'ast syn::ItemFn) {
        let span = i.span();
        let fn_name = i.sig.ident.to_string();

        let sig = &i.sig;
        let sig = quote!(#sig).to_string();

        let func = ItemFn {
            name: fn_name,
            span,
            sig,
            ident_line: i.sig.ident.span().start().line,
            trackable_lines: i.trackable_lines(),
            attr_lines: i.attr_lines(),
        };

        self.functions.push(func.clone());
    }

    fn visit_impl_item_fn(&mut self, i: &'ast syn::ImplItemFn) {
        let span = i.span();
        let fn_name = i.sig.ident.to_string();

        let sig = &i.sig;
        let sig = quote!(#sig).to_string();

        let func = ItemFn {
            name: fn_name,
            span,
            sig,
            ident_line: i.sig.ident.span().start().line,
            trackable_lines: i.trackable_lines(),
            attr_lines: i.attr_lines(),
        };

        self.functions.push(func.clone());
    }
}

// Could be anything Rust AST wise, deal with functions, impl blocks and such
#[derive(Debug, Clone)]
pub struct ItemFn {
    pub name: String,
    pub span: Span,
    pub sig: String,
    pub ident_line: usize,
    pub trackable_lines: HashSet<usize>, // lists all the trackable lines in the function
    pub attr_lines: HashSet<usize>,
}

#[derive(Debug, Clone)]
enum Item {
    Fn(ItemFn, Span),
}

impl Item {
    fn difference(a: &Vec<Item>, b: &Vec<Item>) -> Vec<Item> {
        let mut c = vec![];
        for item in a {
            let other_item = (b).into_iter().find(|i| i.eq(&item));

            if None == other_item {
                c.push(item.clone());
            }
        }

        c
    }

    fn functions(v: &Vec<Item>) -> Vec<ItemFn> {
        let mut funcs = vec![];
        for item in v {
            match item {
                Item::Fn(f, _) => funcs.push(f.clone()),
            }
        }

        return funcs;
    }
}

impl PartialEq for ItemFn {
    fn eq(&self, other: &Self) -> bool {
        // TODO: add more fields
        self.name == other.name
    }
}

impl PartialEq for Item {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (Item::Fn(x, _), Item::Fn(y, _)) => x.eq(y),
            _ => false,
        }
    }
}

#[derive(Debug, Clone)]
struct Module {
    name: String,
    span: Option<Span>,

    items: Vec<Item>,

    sub_modules: Vec<NestedItem>,
    //stack: Stack,
}

impl Module {
    fn new(name: impl ToString, span: Option<Span>) -> Module {
        Module {
            name: name.to_string(),
            span,
            items: vec![],
            sub_modules: vec![],
            //stack: Stack(vec![]),
        }
    }

    fn difference(a: &Self, b: &Self) -> (Vec<Item>, Vec<NestedItem>) {
        (
            Item::difference(&a.items, &b.items),
            NestedItem::difference(&a.sub_modules, &b.sub_modules),
        )
    }

    fn functions(&self) -> Vec<ItemFn> {
        let mut funcs = vec![];

        funcs.append(&mut Item::functions(&self.items));
        funcs.append(&mut NestedItem::functions(&self.sub_modules));

        funcs
    }
}

impl PartialEq for Module {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name
            && vec_eq(&self.items, &other.items)
            && vec_eq(&self.sub_modules, &other.sub_modules)
    }
}

#[derive(Debug, Clone)]
struct Impl {
    name: String,
    span: Span,
    items: Vec<Item>,
}

impl Impl {
    fn new(name: impl ToString, span: Span) -> Impl {
        Impl {
            name: name.to_string(),
            span,
            items: vec![],
        }
    }

    fn difference(a: &Self, b: &Self) -> Vec<Item> {
        let mut c = vec![];
        for item in &a.items {
            let other_item = (&b.items).into_iter().find(|i| i.eq(&item));

            if None == other_item {
                c.push(item.clone());
            }
        }

        c
    }

    fn functions(&self) -> Vec<ItemFn> {
        Item::functions(&self.items)
    }
}

impl PartialEq for Impl {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name && vec_eq(&self.items, &other.items)
    }
}

// TODO: store more info about each module / impl block
#[derive(Debug, Clone)]
pub enum NestedItem {
    Module(Module), // span, mod name, attribute list
    Impl(Impl),     // span, struct name, trait?
}

impl NestedItem {
    fn items(&mut self) -> &mut Vec<Item> {
        match self {
            NestedItem::Impl(i) => &mut i.items,
            NestedItem::Module(m) => &mut m.items,
        }
    }

    fn sub_modules(&mut self) -> &mut Vec<NestedItem> {
        match self {
            NestedItem::Module(m) => &mut m.sub_modules,
            NestedItem::Impl(i) => panic!("Unexpected"),
        }
    }

    fn shallow_eq(&self, other: &Self) -> bool {
        match (self, other) {
            (NestedItem::Module(a), NestedItem::Module(b)) => a.name == b.name,
            (NestedItem::Impl(a), NestedItem::Impl(b)) => a.name == b.name,
            _ => false,
        }
    }

    // Find everything in a but not in b
    fn difference(a: &Vec<Self>, b: &Vec<Self>) -> Vec<Self> {
        let mut c = vec![];
        for item in a {
            // Find matching nested item (based on name)
            let other_item = b.into_iter().find(|m| m.shallow_eq(&item));
            if let Some(other_item) = other_item {
                match (item, other_item) {
                    (NestedItem::Module(a), NestedItem::Module(b)) => {
                        let mut new_item = a.clone();
                        let (items, nested_items) = Module::difference(a, b);

                        if items.len() > 0 || nested_items.len() > 0 {
                            new_item.items = items;
                            new_item.sub_modules = nested_items;
                            c.push(NestedItem::Module(new_item));
                        }
                    }
                    (NestedItem::Impl(a), NestedItem::Impl(b)) => {
                        let mut new_item = a.clone();

                        let items = Impl::difference(a, b);
                        if items.len() > 0 {
                            new_item.items = items;
                            c.push(NestedItem::Impl(new_item));
                        }
                    }
                    _ => (),
                };

                //item.difference(&other_item)
            } else {
                c.push(item.clone());
            }
        }

        c
    }

    pub fn functions(v: &Vec<NestedItem>) -> Vec<ItemFn> {
        let mut f = vec![];

        for i in v {
            let mut item_funcs = match i {
                NestedItem::Impl(imp) => imp.functions(),
                NestedItem::Module(module) => module.functions(),
            };
            f.append(&mut item_funcs);
        }

        f
    }
}

impl PartialEq for NestedItem {
    // TODO: this is really bad. should use a hash table instead for storing items and sub
    // modules IMO
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (NestedItem::Impl(s), NestedItem::Impl(i)) => s.eq(i),
            (NestedItem::Module(s), NestedItem::Module(i)) => s.eq(i),
            _ => false,
        }
    }
}

#[derive(Debug)]
pub struct ModificationVisitor {
    //pub highlevel_track: Vec<Track>,
    new_version: bool,
    pub functions: Vec<ItemFn>, // used for fast detection of if an edit in a function or not
    modules: Vec<NestedItem>,
}
impl ModificationVisitor {
    pub fn new(is_new: bool) -> ModificationVisitor {
        ModificationVisitor {
            //track: vec![],
            new_version: is_new,
            functions: vec![],
            modules: vec![NestedItem::Module(Module::new("_", None))], // Top level functions grouped in a module
        }
    }

    fn current_module(&mut self) -> &mut NestedItem {
        self.modules.last_mut().unwrap()
    }

    // Get items in a but not b
    pub fn difference(&self, other: &Self) -> Vec<NestedItem> {
        let ab = NestedItem::difference(&self.modules, &other.modules);
        //let ba = NestedItem::difference(&other.modules, &self.modules);
        //dbg!(ab);
        //dbg!(ba);
        ab
    }

    // NOTE: uses assumption that we aren't tracking nested functions, so only ever returns highest
    // level function
    pub fn find_function(&self, line: usize) -> Option<ItemFn> {
        for func in &self.functions {
            if func.span.has_line(line) {
                return Some(func.clone());
            }
        }

        None
    }
}

// TODO: very inefficient. hash map compare should be used instead I think
fn vec_eq<T: PartialEq>(a: &Vec<T>, b: &Vec<T>) -> bool {
    let mut a = a.into_iter();
    let mut b = b.into_iter();
    a.all(|x| b.any(|y| x.eq(y))) && b.all(|x| a.any(|y| x.eq(y)))
}

impl PartialEq for ModificationVisitor {
    fn eq(&self, other: &Self) -> bool {
        vec_eq(&self.modules, &other.modules)
    }
}

impl<'ast> Visit<'ast> for ModificationVisitor {
    // TODO: find a way to combine with visit_impl_item_fn
    fn visit_item_fn(&mut self, i: &'ast syn::ItemFn) {
        let span = i.span();
        let fn_name = i.sig.ident.to_string();

        // TODO: hacky for now
        let sig = &i.sig;
        let sig = quote!(#sig).to_string();

        let func = ItemFn {
            name: fn_name,
            span,
            sig,
            ident_line: i.sig.ident.span().start().line,
            trackable_lines: i.trackable_lines(),
            attr_lines: i.attr_lines(),
        };

        self.functions.push(func.clone());

        self.current_module().items().push(Item::Fn(func, span));
    }

    fn visit_impl_item_fn(&mut self, i: &'ast syn::ImplItemFn) {
        let span = i.span();
        let fn_name = i.sig.ident.to_string();

        // TODO: hacky for now
        let sig = &i.sig;
        let sig = quote!(#sig).to_string();

        let func = ItemFn {
            name: fn_name,
            span,
            sig,
            ident_line: i.sig.ident.span().start().line,
            trackable_lines: i.trackable_lines(),
            attr_lines: i.attr_lines(),
        };

        self.functions.push(func.clone());

        self.current_module().items().push(Item::Fn(func, span));
    }

    fn visit_item_mod(&mut self, i: &'ast syn::ItemMod) {
        let ident = &i.ident;
        let mod_name = quote!(#ident).to_string();

        // TODO: store attirbutes too?
        //i.attrs.iter().map(|a| quote!(#a).to_string()).collect(),
        self.modules.push(NestedItem::Module(Module::new(
            mod_name,
            Some(i.span().clone()),
        )));

        visit::visit_item_mod(self, i);

        // Add the finished module to its parent module
        let finished_mod = self.modules.pop().unwrap();
        self.modules
            .last_mut()
            .unwrap()
            .sub_modules()
            .push(finished_mod);
    }

    fn visit_item_impl(&mut self, i: &'ast syn::ItemImpl) {
        let ty = &i.self_ty;
        let ty_name = quote!(#ty).to_string();

        self.modules
            .push(NestedItem::Impl(Impl::new(ty_name, i.span().clone())));

        visit::visit_item_impl(self, i);

        let finished_mod = self.modules.pop().unwrap();
        self.modules
            .last_mut()
            .unwrap()
            .sub_modules()
            .push(finished_mod);
    }
}

// TODO: add a test suite using a local file to create the AST?