peace_resources 0.0.13

Runtime resources for the peace automation framework.
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

//! Types for well-known directories.
//!
//! # Design
//!
//! The designed structure of directories and their contents is as follows:
//!
//! ```bash
//! WorkspaceDir
//! |- PeaceDir
//!     |- ProfileDir  # "profile_name", multiple
//!         |- HistoryDir
//!         |   |- CmdExecution0
//!         |   |- ..
//!         |   |- CmdExecutionN
//!         |
//!         |- ProfileParams
//!         |
//!         |- FlowDir  # "flow_name", multiple
//!             |- StatesMeta
//!             |- StatesCurrent
//!             |- StatesGoal
//! ```
//!
//! Concrete folder structure example:
//!
//! ```bash
//! workspace
//! |- .peace
//!     |- profile1 / main / default
//!     |   |- .history
//!     |   |   |- 00000000_2022-08-21T20_48_02_init.yaml
//!     |   |   |- 00000001_2022-08-21T20_48_07_dev_env_discover.yaml
//!     |   |   |- 00000002_2022-08-21T20_50_32_dev_env_deploy.yaml  # dry
//!     |   |   |- 00000003_2022-08-21T20_50_43_dev_env_deploy.yaml
//!     |   |   |- 00000004_2022-08-22T08_16_09_dev_env_clean.yaml   # dry
//!     |   |   |- 00000005_2022-08-22T08_16_29_dev_env_clean.yaml
//!     |   |   |- 00000006_2022-08-23T13_02_14_artifact_discover.yaml
//!     |   |   |- 00000007_2022-08-23T13_07_31_artifact_publish.yaml
//!     |   |
//!     |   |- .meta.yaml  # Store the last discovered time so we can inform the user.
//!     |   |              # Should time be stored per item, or per invocation?
//!     |   |
//!     |   |- dev_env  # flow name
//!     |   |   |- states_goal.yaml
//!     |   |   |- states_current.yaml
//!     |   |
//!     |   |- artifact
//!     |   |   |- states_goal.yaml
//!     |   |   |- states_current.yaml
//!     |   |
//!     |   |- profile_params.yaml  # Parameters used to initialize this profile
//!     |                           # We write to this so that each time the user re-`init`s,
//!     |                           # if they version control it, they can rediscover the
//!     |                           # states from previous inits, and clean them up.
//!     |
//!     |- production
//!     |   |- .history
//!     |   |   |- 00000000_2022-08-21T20_48_02_init.yaml
//!     |   |   |- 00000001_2022-08-21T20_48_07_discover.yaml
//!     |   |
//!     |   |- customer_one
//!     |   |   |- flow_params.yaml
//!     |   |   |- states_goal.yaml
//!     |   |   |- states_current.yaml
//!     |   |
//!     |   |- .meta.yaml
//!     |   |- profile_params.yaml
//!     |
//!     |- workspace_params.yaml
//! ```

pub use self::{
    flow_dir::FlowDir, params_specs_file::ParamsSpecsFile, peace_app_dir::PeaceAppDir,
    peace_dir::PeaceDir, profile_dir::ProfileDir, profile_history_dir::ProfileHistoryDir,
    states_current_file::StatesCurrentFile, states_goal_file::StatesGoalFile,
    workspace_dir::WorkspaceDir,
};

mod flow_dir;
mod params_specs_file;
mod peace_app_dir;
mod peace_dir;
mod profile_dir;
mod profile_history_dir;
mod states_current_file;
mod states_goal_file;
mod workspace_dir;

/// Common impl logic for `PathBuf` newtypes.
///
/// This does not include declaring the type, as it may prevent IDEs from
/// discovering the type declaration, making those types harder to discover.
macro_rules! pathbuf_newtype {
    ($ty_name:ident) => {
        impl $ty_name {
            #[doc = concat!("Returns a new [`", stringify!($ty_name), "`].")]
            pub fn new(path: std::path::PathBuf) -> Self {
                Self(path)
            }

            /// Returns the inner [`PathBuf`].
            ///
            /// [`PathBuf`]: std::path::PathBuf
            pub fn into_inner(self) -> std::path::PathBuf {
                self.0
            }
        }

        impl From<std::path::PathBuf> for $ty_name {
            fn from(path_buf: std::path::PathBuf) -> Self {
                Self(path_buf)
            }
        }

        impl AsRef<std::ffi::OsStr> for $ty_name {
            fn as_ref(&self) -> &std::ffi::OsStr {
                self.0.as_ref()
            }
        }

        impl AsRef<std::path::Path> for $ty_name {
            fn as_ref(&self) -> &std::path::Path {
                &self.0
            }
        }

        impl std::ops::Deref for $ty_name {
            type Target = std::path::Path;

            fn deref(&self) -> &Self::Target {
                &self.0
            }
        }
    };
}

pub(crate) use pathbuf_newtype;