testtrim 0.14.8

Intelligently select automated tests to run via code coverage analysis
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

// SPDX-FileCopyrightText: 2024 Mathieu Fenniak <mathieu@fenniak.net>
//
// SPDX-License-Identifier: GPL-3.0-or-later

use num_enum::{IntoPrimitive, TryFromPrimitive};
use std::fmt::Debug;
use tracing::field::Visit;

#[derive(Default, Debug)]
pub struct RawUiInformation {
    // FIXME: make a ".into()" for RawUiInformation, which has to collect data field-by-field, to collapse data into a
    // more Rust-y data structure where data fields are unifieid and standardized.  Then RawUiInformation's fields can
    // be !pub
    pub ui_stage: Option<UiStage>,
    pub is_subcommand: bool,
    pub subcommand_binary: Option<String>,
    pub subcommand_args: Option<String>,
    pub test_count: Option<u64>,
    pub test_case: Option<String>,
    pub commit_count: Option<u64>,
    pub commit_identifier: Option<String>,
}

impl Visit for RawUiInformation {
    fn record_debug(&mut self, field: &tracing::field::Field, value: &dyn std::fmt::Debug) {
        if field.name() == "subcommand_args" {
            self.subcommand_args = Some(format!("{value:?}"));
        }
        if field.name() == "test_case" {
            self.test_case = Some(format!("{value:?}"));
        }
    }

    fn record_u64(&mut self, field: &tracing::field::Field, value: u64) {
        if field.name() == "ui_stage" {
            self.ui_stage = UiStage::try_from(value).ok();
        }
        if field.name() == "test_count" {
            self.test_count = Some(value);
        }
        if field.name() == "commit_count" {
            self.commit_count = Some(value);
        }
    }

    fn record_str(&mut self, field: &tracing::field::Field, value: &str) {
        if field.name() == "subcommand_binary" {
            self.subcommand_binary = Some(String::from(value));
        }
        if field.name() == "subcommand_args" {
            self.subcommand_args = Some(String::from(value));
        }
        if field.name() == "commit_identifier" {
            self.commit_identifier = Some(String::from(value));
        }
    }

    fn record_bool(&mut self, field: &tracing::field::Field, value: bool) {
        if field.name() == "subcommand" {
            self.is_subcommand = value;
        }
    }
}

// FIXME: In the future maybe we should use `valuable` to store these in the traces
// (https://docs.rs/tracing/latest/tracing/field/index.html#using-valuable), but currently it is unstable and I don't
// want to jump on that.
#[derive(Debug, Eq, PartialEq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum UiStage {
    // GetTestIdentifiers...
    Compiling,
    ListingTests,
    FindingAncestorCommit,
    ComputeTestCases,

    // RunTests...
    RunTests,
    RunSingleTest,
    WriteCoverageData,

    // SimulateHistory...
    ClearProjectData,
    IdentifyTestCommits,
    SimulateCommits,
    SimulateSingleCommit,
}