Module: PDK::CLI::Util

Defined in:
lib/pdk/cli/util.rb,
lib/pdk/cli/util/interview.rb,
lib/pdk/cli/util/option_validator.rb,
lib/pdk/cli/util/option_normalizer.rb,
lib/pdk/cli/util/command_redirector.rb

Defined Under Namespace

Classes: CommandRedirector, Interview, OptionNormalizer, OptionValidator

Class Method Summary collapse

Class Method Details

.analytics_screen_view(screen_name, opts = {}) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/pdk/cli/util.rb', line 263

def analytics_screen_view(screen_name, opts = {})
  require 'pdk/analytics'

  dimensions = {
    ruby_version: RUBY_VERSION,
  }

  cmd_opts = opts.dup.reject do |_, v|
    v.nil? || (v.respond_to?(:empty?) && v.empty?)
  end

  if (format_args = cmd_opts.delete(:format))
    formats = PDK::CLI::Util::OptionNormalizer.report_formats(format_args)
    dimensions[:output_format] = formats.map { |r| r[:method].to_s.gsub(%r{\Awrite_}, '') }.sort.uniq.join(',')
  else
    dimensions[:output_format] = 'default'
  end

  safe_opts = [:'puppet-version', :'pe-version']
  redacted_opts = cmd_opts.map do |k, v|
    value = if [true, false].include?(v) || safe_opts.include?(k)
              v
            else
              'redacted'
            end
    "#{k}=#{value}"
  end
  dimensions[:cli_options] = redacted_opts.join(',') unless redacted_opts.empty?

  ignored_env_vars = %w[PDK_ANALYTICS_CONFIG PDK_DISABLE_ANALYTICS]
  env_vars = PDK::Util::Env.select { |k, _| k.start_with?('PDK_') && !ignored_env_vars.include?(k) }.map { |k, v| "#{k}=#{v}" }
  dimensions[:env_vars] = env_vars.join(',') unless env_vars.empty?

  PDK.analytics.screen_view(screen_name, dimensions)
end

.check_for_deprecated_puppet(version) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/pdk/cli/util.rb', line 118

def check_for_deprecated_puppet(version)
  return unless version.is_a?(Gem::Version)

  deprecated_below = Gem::Version.new('5.0.0')
  return unless version < deprecated_below

  deprecated_msg = _(
    'Support for Puppet versions older than %{version} is ' \
    'deprecated and will be removed in a future version of PDK.',
  ) % { version: deprecated_below.to_s }
  PDK.logger.warn(deprecated_msg)
end

.ci_environment? ⇒ Boolean

Uses environment variables to detect if the current process is running in common Continuous Integration (CI) environments

Returns:

  • (Boolean) —

    Whether the PDK is in a CI based environment



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pdk/cli/util.rb', line 64

def ci_environment?
  [
    'CI',                     # Generic
    'CONTINUOUS_INTEGRATION', # Generic
    'APPVEYOR_BUILD_FOLDER',  # AppVeyor CI
    'GITLAB_CI',              # GitLab CI
    'JENKINS_URL',            # Jenkins
    'BUILD_DEFINITIONNAME',   # Azure Pipelines
    'TEAMCITY_VERSION',       # Team City
    'BAMBOO_BUILDKEY',        # Bamboo
    'GOCD_SERVER_URL',        # Go CD
    'TRAVIS',                 # Travis CI
    'GITHUB_WORKFLOW',        # GitHub Actions
  ].any? { |name| PDK::Util::Env.key?(name) }
end

.ensure_in_module!(opts = {}) ⇒ Object

Ensures the calling code is being run from inside a module directory.

Parameters:

  • opts (Hash) (defaults to: {}) —

    options to change the behavior of the check logic.

Options Hash (opts):

  • :check_module_layout (Boolean) —

    Set to true to check for stardard module folder layout if the module does not contain a metadata.json file.

Raises:



21
22
23
24
25
26
27
 
# File 'lib/pdk/cli/util.rb', line 21

def ensure_in_module!(opts = {})
  return unless PDK::Util.module_root.nil?
  return if opts[:check_module_layout] && PDK::Util.in_module_root?

  message = opts.fetch(:message, _('This command must be run from inside a valid module (no metadata.json found).'))
  raise PDK::CLI::ExitWithError.new(message, opts)
end

.interactive? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
84
85
86
87
88
89
90
 
# File 'lib/pdk/cli/util.rb', line 81

def interactive?
  require 'pdk/logger'

  return false if PDK.logger.debug?
  return !PDK::Util::Env['PDK_FRONTEND'].casecmp('noninteractive').zero? if PDK::Util::Env['PDK_FRONTEND']
  return false if ci_environment?
  return false unless $stderr.isatty

  true
end

.module_version_check ⇒ Object

Raises:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/pdk/cli/util.rb', line 93

def module_version_check
  module_pdk_ver = PDK::Util.module_pdk_version

  # This means the module does not have a pdk-version tag in the metadata.json
  # and will require a pdk convert.
  raise PDK::CLI::ExitWithError, _('This module is not PDK compatible. Run `pdk convert` to make it compatible with your version of PDK.') if module_pdk_ver.nil?

  # This checks that the version of pdk in the module's metadata is older
  # than 1.3.1, which means the module will need to run pdk convert to the
  # new templates.
  if Gem::Version.new(module_pdk_ver) < Gem::Version.new('1.3.1')
    PDK.logger.warn _('This module template is out of date. Run `pdk convert` to make it compatible with your version of PDK.')
  # This checks if the version of the installed PDK is older than the
  # version in the module's metadata, and advises the user to upgrade to
  # their install of PDK.
  elsif Gem::Version.new(PDK::VERSION) < Gem::Version.new(module_pdk_ver)
    PDK.logger.warn _('This module is compatible with a newer version of PDK. Upgrade your version of PDK to ensure compatibility.')
  # This checks if the version listed in the module's metadata is older
  # than the installed PDK, and advises the user to run pdk update.
  elsif Gem::Version.new(PDK::VERSION) > Gem::Version.new(module_pdk_ver)
    PDK.logger.warn _('This module is compatible with an older version of PDK. Run `pdk update` to update it to your version of PDK.')
  end
end

.prompt_for_yes(question_text, opts = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/pdk/cli/util.rb', line 41

def prompt_for_yes(question_text, opts = {})
  require 'tty/prompt'

  prompt = opts[:prompt] || TTY::Prompt.new(help_color: :cyan)
  validator = proc { |value| [true, false].include?(value) || value =~ %r{\A(?:yes|y|no|n)\Z}i }
  response = nil

  begin
    response = prompt.yes?(question_text) do |q|
      q.default opts[:default] unless opts[:default].nil?
      q.validate(validator, _('Answer "Y" to continue or "n" to cancel.'))
    end
  rescue PDK::CLI::Util::Interview::READER::InputInterrupt
    PDK.logger.info opts[:cancel_message] if opts[:cancel_message]
  end

  response
end

.puppet_from_opts_or_env(opts, logging_disabled = false) ⇒ Hash

Returns - return hash of { gemset: <>, ruby_version: 2.x.x }.

Parameters:

  • opts (Hash) —

    • the pdk options ot use, defaults to empty hash

  • logging_disabled (Boolean) (defaults to: false) —

    • disable logging of PDK info

Options Hash (opts):

  • :'puppet-dev' (String) —

    Use the puppet development version, default to PDK_PUPPET_DEV env

  • :'puppet-version' (String) —

    Puppet version to use, default to PDK_PUPPET_VERSION env

  • :'pe-version' (String) —

    PE Puppet version to use, default to PDK_PE_VERSION env

Returns:

  • (Hash) —

    • return hash of { gemset: <>, ruby_version: 2.x.x }



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/pdk/cli/util.rb', line 138

def puppet_from_opts_or_env(opts, logging_disabled = false)
  opts ||= {}
  use_puppet_dev = opts.fetch(:'puppet-dev', PDK::Util::Env['PDK_PUPPET_DEV'])
  desired_puppet_version = opts.fetch(:'puppet-version', PDK::Util::Env['PDK_PUPPET_VERSION'])
  desired_pe_version = opts.fetch(:'pe-version', PDK::Util::Env['PDK_PE_VERSION'])

  begin
    puppet_env =
      if use_puppet_dev
        PDK::Util::PuppetVersion.fetch_puppet_dev(run: :once)
        PDK::Util::PuppetVersion.puppet_dev_env
      elsif desired_puppet_version
        PDK::Util::PuppetVersion.find_gem_for(desired_puppet_version)
      elsif desired_pe_version
        PDK::Util::PuppetVersion.from_pe_version(desired_pe_version)
      else
        PDK::Util::PuppetVersion.from_module_metadata || PDK::Util::PuppetVersion.latest_available
      end
  rescue ArgumentError => e
    raise PDK::CLI::ExitWithError, e.message
  end

  # Notify user of what Ruby version will be used.
  unless logging_disabled
    PDK.logger.info(_('Using Ruby %{version}') % {
      version: puppet_env[:ruby_version],
    })
  end

  check_for_deprecated_puppet(puppet_env[:gem_version])

  gemset = { puppet: puppet_env[:gem_version].to_s }

  # Notify user of what gems are being activated.
  unless logging_disabled
    gemset.each do |gem, version|
      next if version.nil?

      PDK.logger.info(_('Using %{gem} %{version}') % {
        gem: gem.to_s.capitalize,
        version: version,
      })
    end
  end

  {
    gemset: gemset,
    ruby_version: puppet_env[:ruby_version],
  }
end

.spinner_opts_for_platform ⇒ Object 



30
31
32
33
34
35
36
37
38
 
# File 'lib/pdk/cli/util.rb', line 30

def 
  windows_opts = {
    success_mark: '*',
    error_mark: 'X',
  }

  return windows_opts if Gem.win_platform?
  {}
end

.validate_puppet_version_opts(opts) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/pdk/cli/util.rb', line 190

def validate_puppet_version_opts(opts)
  puppet_ver_specs = []
  puppet_ver_specs << '--puppet-version option' if opts[:'puppet-version']
  puppet_ver_specs << 'PDK_PUPPET_VERSION environment variable' if PDK::Util::Env['PDK_PUPPET_VERSION'] && !PDK::Util::Env['PDK_PUPPET_VERSION'].empty?

  pe_ver_specs = []
  pe_ver_specs << '--pe-version option' if opts[:'pe-version']
  pe_ver_specs << 'PDK_PE_VERSION environment variable' if PDK::Util::Env['PDK_PE_VERSION'] && !PDK::Util::Env['PDK_PE_VERSION'].empty?

  puppet_dev_specs = []
  puppet_dev_specs << '--puppet-dev flag' if opts[:'puppet-dev']
  puppet_dev_specs << 'PDK_PUPPET_DEV environment variable' if PDK::Util::Env['PDK_PUPPET_DEV'] && !PDK::Util::Env['PDK_PUPPET_DEV'].empty?

  puppet_dev_specs.each do |pup_dev_spec|
    [puppet_ver_specs, pe_ver_specs].each do |offending|
      next if offending.empty?

      raise PDK::CLI::ExitWithError, _('You cannot specify a %{first} and %{second} at the same time.') % {
        first: pup_dev_spec,
        second: offending.first,
      }
    end
  end

  puppet_ver_specs.each do |pup_ver_spec|
    next if pe_ver_specs.empty?

    offending = [pup_ver_spec, pe_ver_specs[0]].sort

    raise PDK::CLI::ExitWithError, _('You cannot specify a %{first} and %{second} at the same time.') % {
      first: offending[0],
      second: offending[1],
    }
  end

  if puppet_dev_specs.size == 2
    warning_str = 'Puppet dev flag from command line: "--puppet-dev" '
    warning_str += 'overrides value from environment: "PDK_PUPPET_DEV=true". You should not specify both.'

    PDK.logger.warn(_(warning_str) % {
      pup_ver_opt: opts[:'puppet-dev'],
      pup_ver_env: PDK::Util::Env['PDK_PUPPET_DEV'],
    })
  elsif puppet_ver_specs.size == 2
    warning_str = 'Puppet version option from command line: "--puppet-version=%{pup_ver_opt}" '
    warning_str += 'overrides value from environment: "PDK_PUPPET_VERSION=%{pup_ver_env}". You should not specify both.'

    PDK.logger.warn(_(warning_str) % {
      pup_ver_opt: opts[:'puppet-version'],
      pup_ver_env: PDK::Util::Env['PDK_PUPPET_VERSION'],
    })
  elsif pe_ver_specs.size == 2
    warning_str = 'Puppet Enterprise version option from command line: "--pe-version=%{pe_ver_opt}" '
    warning_str += 'overrides value from environment: "PDK_PE_VERSION=%{pe_ver_env}". You should not specify both.'

    PDK.logger.warn(_(warning_str) % {
      pup_ver_opt: opts[:'pe-version'],
      pup_ver_env: PDK::Util::Env['PDK_PE_VERSION'],
    })
  end
end

.validate_template_opts(opts) ⇒ Object

Raises:



253
254
255
256
257
258
259
260
 
# File 'lib/pdk/cli/util.rb', line 253

def validate_template_opts(opts)
  if opts[:'template-ref'] && opts[:'template-url'].nil?
    raise PDK::CLI::ExitWithError, _('--template-ref requires --template-url to also be specified.')
  end

  return unless opts[:'template-url'] && opts[:'template-url'].include?('#')
  raise PDK::CLI::ExitWithError, _('--template-url may not be used to specify paths containing #\'s.')
end