kcheck 0.2.1

A library for working with kernel configuration information.
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

// Copyright (c) 2023 Jake Swensen
// SPDX-License-Identifier: MPL-2.0
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

use serde::{Deserialize, Serialize};

/// The state of a kernel config option.
///
/// This enumeration expands the tristate system used by the kernel config into
/// a system that allows for more granular control over the desired state of
/// the kernel config. This is useful when there is a desire to check the
/// explicit state of the kernel rather than depending on the implied state.
///
/// For example, there could be a requirement that a kernel config option be
/// `Enabled` meaning that is present in the system but there is no desire to
/// force it to be set to `y` or `m`.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub enum KconfigState {
    /// Kernel config option is not found
    #[default]
    NotFound,
    /// Kernel config option is set to `is not set`
    NotSet,
    /// The kernel config option is set to `n`
    Off,
    /// The kernel config option is either `NotFound`, `NotSet`, or `Off`
    Disabled,
    /// Kernel config is set to `y`
    On,
    /// Kernel config is set to `m`
    Module,
    /// Kernel config is either `y` or `m`
    Enabled,
    /// Kernel config is set to a text string
    Text(String),
}

impl KconfigState {
    pub fn check(&self, other: KconfigState) -> bool {
        match self {
            KconfigState::NotFound
            | KconfigState::NotSet
            | KconfigState::Off
            | KconfigState::Disabled => {
                other == KconfigState::NotFound
                    || other == KconfigState::NotSet
                    || other == KconfigState::Off
                    || other == KconfigState::Disabled
            }
            KconfigState::On => other == KconfigState::On,
            KconfigState::Module => other == KconfigState::Module,
            KconfigState::Enabled => {
                other == KconfigState::On
                    || other == KconfigState::Module
                    || other == KconfigState::Enabled
            }
            KconfigState::Text(t) => other == KconfigState::Text(t.clone()),
        }
    }
}

impl std::fmt::Display for KconfigState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let text: &str = match self {
            KconfigState::NotFound => "NotFound",
            KconfigState::NotSet => "NotSet",
            KconfigState::Off => "Off",
            KconfigState::Disabled => "Disabled (NotFound, NotSet, or Off)",
            KconfigState::On => "On",
            KconfigState::Module => "Module",
            KconfigState::Enabled => "Enabled (On or Module)",
            KconfigState::Text(t) => t,
        };

        write!(f, "{text}")
    }
}

/// A Kconfig option.
///
/// Used to describe the desired state or value of kernel config options.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct KconfigOption {
    /// The name of the kernel config option.
    name: String,
    /// A state representing the value of the kernel config option.
    state: KconfigState,
}

impl std::fmt::Display for KconfigOption {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}: {}", self.name, self.state)
    }
}

impl KconfigOption {
    /// Create a new `KconfigOption`
    pub fn new(name: &str, state: KconfigState) -> Self {
        KconfigOption {
            name: name.to_string(),
            state,
        }
    }

    /// Get the name of the kernel config option.
    pub fn name(&self) -> String {
        self.name.clone()
    }

    /// Get the state of the kernel config option.
    pub fn state(&self) -> KconfigState {
        self.state.clone()
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn success_new() {
        let test_array = [
            ("CONFIG_TEST_NOT_FOUND", KconfigState::NotFound),
            ("CONFIG_TEST_NOT_SET", KconfigState::NotSet),
            ("CONFIG_TEST_OFF", KconfigState::Off),
            ("CONFIG_TEST_DISABLED", KconfigState::Disabled),
            ("CONFIG_TEST_ON", KconfigState::On),
            ("CONFIG_TEST_MODULE", KconfigState::Module),
            ("CONFIG_TEST_ENABLED", KconfigState::Enabled),
            ("CONFIG_TEST_TEXT", KconfigState::Text("test".to_string())),
        ];

        for (option, state) in test_array {
            let kconfig_option = KconfigOption::new(option, state.clone());
            assert_eq!(kconfig_option.name(), option);
            assert_eq!(kconfig_option.state(), state);
            insta::assert_snapshot!(kconfig_option);
        }
    }
}