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
144
145

// Copyright (c) 2021-2022 Miguel Barreto and others
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//! This module contains the base trait for all [Action]s.

use std::path::Path;

use strict_yaml_rust::StrictYaml;

use crate::{
  directive::HasDirectiveData, error::DotfilesError, yaml_util::map_yaml_array, Settings,
};

/// Skip this whole action in CI environments.
pub const SKIP_IN_CI_SETTING: &str = "skip_in_ci";
/// An action to be run by a the dotfiles runtime.
pub trait Action<'a> {
  /// Executes the action.
  ///
  /// Returns an error String describing the issue, this string can be used
  /// to log or display to the user.
  fn execute(&self) -> Result<(), DotfilesError>;
}

/// Whether the execution environment is presumed to be CI
///
/// The presence of any of the following Environment Variables is assumed to
/// mean that this action is running in a CI Environment:
///
/// * `TF_BUILD`
/// * `BUILDKITE`
/// * `BUILD_ID`
/// * `CI`
/// * `CIRCLECI`
/// * `CIRRUS_CI`
/// * `CODEBUILD_BUILD_ID`
/// * `GITLAB_CI`
/// * `GITHUB_ACTIONS`
/// * `HEROKU_TEST_RUN_ID`
/// * `TEAMCITY_VERSION`
/// * `TRAVIS`
pub fn is_running_in_ci() -> bool {
  if std::env::var("DOTFILES_TESTING_ENV_VAR").is_ok() {
    return std::env::var("TESTING_ONLY_FAKE_CI").is_ok();
  }
  let env_vars = vec![
    "TF_BUILD",
    "BUILDKITE",
    "BUILD_ID",
    "CI",
    "CIRCLECI",
    "CIRRUS_CI",
    "CODEBUILD_BUILD_ID",
    "GITHUB_ACTIONS",
    "GITLAB_CI",
    "HEROKU_TEST_RUN_ID",
    "TEAMCITY_VERSION",
    "TRAVIS",
  ];
  for var in env_vars.iter() {
    if std::env::var(var).is_ok() {
      return true;
    }
  }
  false
}
/// Trait for actions to be skippable under certain conditions.
///
/// For now the only supported condition is whether to skip on CI environments.
pub trait ConditionalAction<'a>: Action<'a> {
  /// Whether to skip this action in Continuous Integration environments.
  ///
  /// See [is_running_in_ci()]
  fn skip_in_ci(&self) -> bool;

  /// Checks that the conditions allow for executing this action, and if so executes it according to
  /// [execute(&self)].
  ///
  /// If conditions don't pass it simply skips and returns `Ok(())`
  ///
  /// At this moment the only condition that is supported is whether the action should be skipped in
  /// CI, see [skip_in_ci(&self)].
  fn check_conditions_and_execute(&self) -> Result<(), DotfilesError> {
    if ConditionalAction::skip_in_ci(self) && is_running_in_ci() {
      Ok(())
    } else {
      self.execute()
    }
  }
}

/// Trait to parse a specific action type from StrictYaml.
pub trait ActionParser<'a>: HasDirectiveData<'a> {
  /// The action type this object parses
  type ActionType: Action<'a>;

  /// Builds a single action of type [ActionParser::ActionType] from StrictYaml tree object
  /// that represents the action's configuration and a default settings object.
  ///
  /// Returns an Error containing a human readable string in case there
  /// was an issue building the action.
  fn parse_action(
    &'a self,
    settings: &Settings,
    yaml: &StrictYaml,
    current_dir: &Path,
  ) -> Result<Self::ActionType, DotfilesError>;

  /// Builds a list of actions of type [ActionParser::ActionType] from StrictYaml tree object
  /// that represents the actions' configurations and a default settings object.
  ///
  /// Returns an Error containing a human readable string in case there
  /// was an issue building the action.
  ///
  /// The default implementation assumes there must be StrictYaml array whose items each
  /// represent an individual action
  fn parse_action_list(
    &'a self,
    settings: &Settings,
    yaml: &StrictYaml,
    current_dir: &Path,
  ) -> Result<Vec<Self::ActionType>, DotfilesError> {
    map_yaml_array(yaml, |yaml_item| {
      self.parse_action(settings, yaml_item, current_dir)
    })
  }
}