hardware_report 0.1.7

Hardware inventory reports for observability and cluster acceptance testing
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

/*
Copyright 2024 San Francisco Compute Company

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

use crate::domain::{DomainError, PublishConfig, ReportConfig};
use async_trait::async_trait;
use std::collections::HashMap;

/// Secondary port - Configuration provider abstraction
///
/// This interface abstracts how configuration is loaded and managed,
/// allowing for different sources (CLI args, files, environment, etc.)
#[async_trait]
pub trait ConfigurationProvider: Send + Sync {
    /// Get report generation configuration
    ///
    /// # Returns
    /// * `Ok(ReportConfig)` - Report configuration
    /// * `Err(DomainError)` - Error loading configuration
    async fn get_report_config(&self) -> Result<ReportConfig, DomainError>;

    /// Get publishing configuration if enabled
    ///
    /// # Returns
    /// * `Ok(Option<PublishConfig>)` - Publishing config if enabled
    /// * `Err(DomainError)` - Error loading configuration
    async fn get_publish_config(&self) -> Result<Option<PublishConfig>, DomainError>;

    /// Get output format preference
    ///
    /// # Returns
    /// * `Ok(OutputFormat)` - Preferred output format
    /// * `Err(DomainError)` - Error loading configuration
    async fn get_output_format(&self) -> Result<OutputFormat, DomainError>;

    /// Get command timeout in seconds
    ///
    /// # Returns
    /// * `Ok(u64)` - Timeout in seconds
    /// * `Err(DomainError)` - Error loading configuration
    async fn get_command_timeout(&self) -> Result<u64, DomainError>;

    /// Check if verbose logging is enabled
    ///
    /// # Returns
    /// * `Ok(bool)` - true if verbose logging enabled
    /// * `Err(DomainError)` - Error loading configuration
    async fn is_verbose_enabled(&self) -> Result<bool, DomainError>;

    /// Get additional labels/metadata
    ///
    /// # Returns
    /// * `Ok(HashMap<String, String>)` - Additional labels
    /// * `Err(DomainError)` - Error loading configuration
    async fn get_labels(&self) -> Result<HashMap<String, String>, DomainError>;
}

/// Output format options
#[derive(Debug, Clone, PartialEq, Default)]
pub enum OutputFormat {
    /// JSON format
    Json,
    /// TOML format
    Toml,
    /// Both JSON and TOML
    #[default]
    Both,
}