pkgcruft 0.0.18

QA library and tools based on pkgcraft
Documentation 
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

use itertools::Itertools;
use pkgcraft::dep::{Cpn, Cpv};
use pkgcraft::restrict::Scope;

use crate::report::ReportKind::{IgnoreInvalid, IgnoreUnused};
use crate::report::ReportScope;
use crate::scan::ScannerRun;
use crate::source::SourceKind;

use super::Context::Optional;

super::register! {
    kind: super::CheckKind::Ignore,
    reports: &[IgnoreInvalid, IgnoreUnused],
    scope: Scope::Version,
    sources: &[SourceKind::Cpv, SourceKind::Cpn, SourceKind::Category],
    context: &[Optional],
    create,
}

pub(super) fn create(_run: &ScannerRun) -> super::Runner {
    Box::new(Check)
}

struct Check;

impl super::CheckRun for Check {
    fn finish_cpv(&self, cpv: &Cpv, run: &ScannerRun) {
        let scope = ReportScope::Version(cpv.clone(), None);

        // forciby populate the cache
        run.ignore.generate(&scope, Some(run)).count();

        // flag unused version scope ignore directives
        if let Some(sets) = run.ignore.unused(&scope) {
            let sets = sets.iter().join(", ");
            IgnoreUnused.version(cpv).message(sets).report(run);
        }
    }

    fn finish_cpn(&self, cpn: &Cpn, run: &ScannerRun) {
        let scope = ReportScope::Package(cpn.clone());

        // forciby populate the cache
        run.ignore.generate(&scope, Some(run)).count();

        // flag unused package scope ignore directives
        if let Some(sets) = run.ignore.unused(&scope) {
            let sets = sets.iter().join(", ");
            IgnoreUnused.package(cpn).message(sets).report(run);
        }
    }

    fn finish_category(&self, category: &str, run: &ScannerRun) {
        let scope = ReportScope::Category(category.to_string());

        // forciby populate the cache
        run.ignore.generate(&scope, Some(run)).count();

        if let Some(sets) = run.ignore.unused(&scope) {
            let sets = sets.iter().join(", ");
            IgnoreUnused.category(category).message(sets).report(run);
        }
    }

    fn finish(&self, run: &ScannerRun) {
        let scope = ReportScope::Repo(run.repo.to_string());
        if let Some(sets) = run.ignore.unused(&scope) {
            let sets = sets.iter().join(", ");
            IgnoreUnused.repo(&run.repo).message(sets).report(run);
        }
    }
}

#[cfg(test)]
mod tests {
    use itertools::Itertools;
    use pkgcraft::test::test_data;

    use crate::report::ReportSet;
    use crate::scan::Scanner;
    use crate::test::{assert_ordered_reports, glob_reports};

    use super::*;

    #[test]
    fn check() {
        let data = test_data();
        let repo = data.ebuild_repo("qa-primary").unwrap();
        let dir = repo.path().join(CHECK);
        let invalid = glob_reports!("{dir}/IgnoreInvalid.json");
        let unused = glob_reports!("{dir}/IgnoreUnused.json");
        let expected: Vec<_> = invalid.into_iter().interleave(unused).collect();

        // check isn't run by default
        let scanner = Scanner::new();
        let mut reports = scanner.run(repo, repo).unwrap();
        assert!(!reports.any(|r| CHECK.reports.contains(&r.kind)));

        // return all report variants in order to trigger ignore filtering
        let scanner = Scanner::new().reports([ReportSet::All]);

        // version scope
        let reports: Vec<_> = scanner
            .run(repo, "Ignore/IgnoreUnused-0")
            .unwrap()
            .collect();
        assert_ordered_reports!(&reports, &expected[..2]);

        // package scope
        let reports: Vec<_> = scanner.run(repo, "Ignore/IgnoreUnused").unwrap().collect();
        assert_ordered_reports!(&reports, &expected[..4]);

        // category scope
        let reports: Vec<_> = scanner.run(repo, "Ignore/*").unwrap().collect();
        assert_ordered_reports!(&reports, &expected[..6]);

        // repo scope
        let reports: Vec<_> = scanner
            .run(repo, repo)
            .unwrap()
            .filter(|x| CHECK.reports.contains(&x.kind))
            .collect();
        assert_ordered_reports!(&reports, &expected);
    }
}