Class: Bolt::PAL::YamlPlan::Step

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/pal/yaml_plan/step.rb,
lib/bolt/pal/yaml_plan/step/eval.rb,
lib/bolt/pal/yaml_plan/step/plan.rb,
lib/bolt/pal/yaml_plan/step/task.rb,
lib/bolt/pal/yaml_plan/step/script.rb,
lib/bolt/pal/yaml_plan/step/upload.rb,
lib/bolt/pal/yaml_plan/step/command.rb,
lib/bolt/pal/yaml_plan/step/message.rb,
lib/bolt/pal/yaml_plan/step/download.rb,
lib/bolt/pal/yaml_plan/step/resources.rb

Direct Known Subclasses

Command, Download, Eval, Message, Plan, Resources, Script, Task, Upload

Defined Under Namespace

Classes: Command, Download, Eval, Message, Plan, Resources, Script, Task, Upload

Constant Summary collapse

STEP_KEYS = 
%w[
  command
  destination
  download
  eval
  message
  plan
  resources
  script
  source
  task
  upload
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(step_body) ⇒ Step

Returns a new instance of Step.



51
52
53
54
55
56
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 51

def initialize(step_body)
  @name = step_body['name']
  @description = step_body['description']
  @targets = step_body['targets'] || step_body['target']
  @body = step_body
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



9
10
11
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 9

def body
  @body
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



9
10
11
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 9

def name
  @name
end

#targets ⇒ Object (readonly)

Returns the value of attribute targets.



9
10
11
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 9

def targets
  @targets
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



9
10
11
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 9

def type
  @type
end

Class Method Details

.allowed_keys ⇒ Object 



11
12
13
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 11

def self.allowed_keys
  Set['name', 'description', 'target', 'targets']
end

.create(step_body, step_number) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 29

def self.create(step_body, step_number)
  type_keys = (STEP_KEYS & step_body.keys)
  case type_keys.length
  when 0
    raise step_error("No valid action detected", step_body['name'], step_number)
  when 1
    type = type_keys.first
  else
    if [Set['source', 'destination'], Set['upload', 'destination']].include?(type_keys.to_set)
      type = 'upload'
    elsif type_keys.to_set == Set['download', 'destination']
      type = 'download'
    else
      raise step_error("Multiple action keys detected: #{type_keys.inspect}", step_body['name'], step_number)
    end
  end

  step_class = const_get("Bolt::PAL::YamlPlan::Step::#{type.capitalize}")
  step_class.validate(step_body, step_number)
  step_class.new(step_body)
end

.parse_code_string(code, quote = false) ⇒ Object

Parses the an evaluable string, optionally quote it before parsing



154
155
156
157
158
159
160
161
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 154

def self.parse_code_string(code, quote = false)
  if quote
    quoted = Puppet::Pops::Parser::EvaluatingParser.quote(code)
    Puppet::Pops::Parser::EvaluatingParser.new.parse_string(quoted)
  else
    Puppet::Pops::Parser::EvaluatingParser.new.parse_string(code)
  end
end

.step_error(message, name, step_number) ⇒ Object 



147
148
149
150
151
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 147

def self.step_error(message, name, step_number)
  identifier = name ? name.inspect : "number #{step_number}"
  error = "Parse error in step #{identifier}: \n #{message}"
  Bolt::Error.new(error, 'bolt/invalid-plan')
end

.validate(body, step_number) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 62

def self.validate(body, step_number)
  validate_step_keys(body, step_number)

  begin
    body.each { |k, v| validate_puppet_code(k, v) }
  rescue Bolt::Error => e
    raise step_error(e.msg, body['name'], step_number)
  end

  unless body.fetch('parameters', {}).is_a?(Hash)
    msg = "Parameters key must be a hash"
    raise step_error(msg, body['name'], step_number)
  end

  if body.key?('name')
    name = body['name']
    unless name.is_a?(String) && name.match?(Bolt::PAL::YamlPlan::VAR_NAME_PATTERN)
      error_message = "Invalid step name: #{name.inspect}"
      raise step_error(error_message, body['name'], step_number)
    end
  end
end

.validate_puppet_code(step_key, value) ⇒ Object

Recursively ensure all puppet code can be parsed



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
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 120

def self.validate_puppet_code(step_key, value)
  case value
  when Array
    value.map { |element| validate_puppet_code(step_key, element) }
  when Hash
    value.each_with_object({}) do |(k, v), o|
      key = k.is_a?(Bolt::PAL::YamlPlan::EvaluableString) ? k.value : k
      o[key] = validate_puppet_code(key, v)
    end
    # CodeLiterals can be parsed directly
  when Bolt::PAL::YamlPlan::CodeLiteral
    parse_code_string(value.value)
    # BareString is parsed directly if it starts with '$'
  when Bolt::PAL::YamlPlan::BareString
    if value.value.start_with?('$')
      parse_code_string(value.value)
    else
      parse_code_string(value.value, true)
    end
  when Bolt::PAL::YamlPlan::EvaluableString
    # Must quote parsed strings to evaluate them
    parse_code_string(value.value, true)
  end
rescue Puppet::Error => e
  raise Bolt::Error.new("Error parsing #{step_key.inspect}: #{e.basic_message}", "bolt/invalid-plan")
end

.validate_step_keys(body, step_number) ⇒ Object 



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
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 85

def self.validate_step_keys(body, step_number)
  step_type = name.split('::').last.downcase

  # For validated step action, ensure only valid keys
  illegal_keys = body.keys.to_set - allowed_keys
  if illegal_keys.any?
    error_message = "The #{step_type.inspect} step does not support: #{illegal_keys.to_a.inspect} key(s)"
    err = step_error(error_message, body['name'], step_number)
    raise Bolt::Error.new(err, "bolt/invalid-plan")
  end

  # Ensure all required keys are present
  missing_keys = required_keys - body.keys

  # Handle cases where steps with a required 'targets' key are using the deprecated
  # 'target' key instead.
  # TODO: Remove this when 'target' is removed
  if body.include?('target')
    missing_keys -= ['targets']
  end

  # Handle cases where upload step uses deprecated 'source' key instead of 'upload'
  # TODO: Remove when 'source' is removed
  if body.include?('source')
    missing_keys -= ['upload']
  end

  if missing_keys.any?
    error_message = "The #{step_type.inspect} step requires: #{missing_keys.to_a.inspect} key(s)"
    err = step_error(error_message, body['name'], step_number)
    raise Bolt::Error.new(err, "bolt/invalid-plan")
  end
end

Instance Method Details

#function_call(function, args) ⇒ Object 



163
164
165
166
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 163

def function_call(function, args)
  code_args = args.map { |arg| Bolt::Util.to_code(arg) }
  "#{function}(#{code_args.join(', ')})"
end

#transpile ⇒ Object

Raises:

  • (NotImplementedError) 


58
59
60
 
# File 'lib/bolt/pal/yaml_plan/step.rb', line 58

def transpile
  raise NotImplementedError, "Step #{@name} does not supported conversion to Puppet plan language"
end