Class: PDK::Generate::Module

Inherits:
Object
  • Object
show all
Extended by:
Util::Filesystem
Defined in:
lib/pdk/generate/module.rb

Class Method Summary collapse

Methods included from Util::Filesystem

directory?, exist?, expand_path, file?, fnmatch, glob, mkdir_p, read_file, readable?, rm, write_file

Class Method Details

.invoke(opts = {}) ⇒ Object



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
# File 'lib/pdk/generate/module.rb', line 23

def self.invoke(opts = {})
  require 'pdk/module/templatedir'
  require 'pdk/util'
  require 'pdk/util/template_uri'
  require 'fileutils'
  require 'pathname'

  validate_options(opts) unless opts[:module_name].nil?

   = (opts)

  target_dir = File.expand_path(opts[:target_dir] || opts[:module_name])
  parent_dir = File.dirname(target_dir)

  begin
    test_file = File.join(parent_dir, '.pdk-test-writable')
    write_file(test_file, 'This file was created by the Puppet Development Kit to test if this folder was writable, you can safely remove this file.')
    FileUtils.rm_f(test_file)
  rescue Errno::EACCES
    raise PDK::CLI::FatalError, _("You do not have permission to write to '%{parent_dir}'") % {
      parent_dir: parent_dir,
    }
  end

  temp_target_dir = PDK::Util.make_tmpdir_name('pdk-module-target')

  prepare_module_directory(temp_target_dir)

  template_uri = PDK::Util::TemplateURI.new(opts)

  begin
    PDK::Module::TemplateDir.new(template_uri, .data, true) do |templates|
      templates.render do |file_path, file_content, file_status|
        next if file_status == :delete
        file = Pathname.new(temp_target_dir) + file_path
        file.dirname.mkpath
        write_file(file, file_content)
      end

      # Add information about the template used to generate the module to the
      # metadata (for a future update command).
      .update!(templates.)

      .write!(File.join(temp_target_dir, 'metadata.json'))
    end
  rescue ArgumentError => e
    raise PDK::CLI::ExitWithError, e
  end

  # Only update the answers files after metadata has been written.
  require 'pdk/answer_file'
  if template_uri.default?
    # If the user specifies our default template url via the command
    # line, remove the saved template-url answer so that the template_uri
    # resolution can find new default URLs in the future.
    PDK.answers.update!('template-url' => nil) if opts.key?(:'template-url')
  else
    # Save the template-url answers if the module was generated using a
    # template/reference other than ours.
    PDK.answers.update!('template-url' => template_uri.)
  end

  begin
    if FileUtils.mv(temp_target_dir, target_dir)
      unless opts[:'skip-bundle-install']
        Dir.chdir(target_dir) do
          require 'pdk/util/bundler'
          PDK::Util::Bundler.ensure_bundle!
        end
      end

      PDK.logger.info _('Module \'%{name}\' generated at path \'%{path}\', from template \'%{url}\'.') % { name: opts[:module_name], path: target_dir, url: template_uri.git_remote }
      PDK.logger.info(_('In your module directory, add classes with the \'pdk new class\' command.'))
    end
  rescue Errno::EACCES => e
    raise PDK::CLI::FatalError, _("Failed to move '%{source}' to '%{target}': %{message}") % {
      source:  temp_target_dir,
      target:  target_dir,
      message: e.message,
    }
  end
end

.module_interview(metadata, opts = {}) ⇒ Object



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
188
189
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
251
252
253
254
255
256
257
258
259
260
261
262
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/pdk/generate/module.rb', line 162

def self.module_interview(, opts = {})
  require 'pdk/module/metadata'
  require 'pdk/cli/util/interview'

  questions = [
    {
      name:             'module_name',
      question:         _('If you have a name for your module, add it here.'),
      help:             _('This is the name that will be associated with your module, it should be relevant to the modules content.'),
      required:         true,
      validate_pattern: %r{\A[a-z][a-z0-9_]*\Z}i,
      validate_message: _('Module names must begin with a lowercase letter and can only include lowercase letters, numbers, and underscores.'),
    },
    {
      name:             'forge_username',
      question:         _('If you have a Puppet Forge username, add it here.'),
      help:             _('We can use this to upload your module to the Forge when it\'s complete.'),
      required:         true,
      validate_pattern: %r{\A[a-z0-9]+\Z}i,
      validate_message: _('Forge usernames can only contain lowercase letters and numbers'),
      default:          opts[:username],
    },
    {
      name:             'version',
      question:         _('What version is this module?'),
      help:             _('Puppet uses Semantic Versioning (semver.org) to version modules.'),
      required:         true,
      validate_pattern: %r{\A[0-9]+\.[0-9]+\.[0-9]+},
      validate_message: _('Semantic Version numbers must be in the form MAJOR.MINOR.PATCH'),
      default:          .data['version'],
      forge_only:       true,
    },
    {
      name:     'author',
      question: _('Who wrote this module?'),
      help:     _('This is used to credit the module\'s author.'),
      required: true,
      default:  .data['author'],
    },
    {
      name:     'license',
      question: _('What license does this module code fall under?'),
      help:     _('This should be an identifier from https://spdx.org/licenses/. Common values are "Apache-2.0", "MIT", or "proprietary".'),
      required: true,
      default:  .data['license'],
    },
    {
      name:     'operatingsystem_support',
      question: _('What operating systems does this module support?'),
      help:     _('Use the up and down keys to move between the choices, space to select and enter to continue.'),
      required: true,
      type:     :multi_select,
      choices:  PDK::Module::Metadata::OPERATING_SYSTEMS,
      default:  PDK::Module::Metadata::DEFAULT_OPERATING_SYSTEMS.map do |os_name|
        # tty-prompt uses a 1-index
        PDK::Module::Metadata::OPERATING_SYSTEMS.keys.index(os_name) + 1
      end,
    },
    {
      name:       'summary',
      question:   _('Summarize the purpose of this module in a single sentence.'),
      help:       _('This helps other Puppet users understand what the module does.'),
      required:   true,
      default:    .data['summary'],
      forge_only: true,
    },
    {
      name:       'source',
      question:   _('If there is a source code repository for this module, enter the URL here.'),
      help:       _('Skip this if no repository exists yet. You can update this later in the metadata.json.'),
      required:   true,
      default:    .data['source'],
      forge_only: true,
    },
    {
      name:       'project_page',
      question:   _('If there is a URL where others can learn more about this module, enter it here.'),
      help:       _('Optional. You can update this later in the metadata.json.'),
      default:    .data['project_page'],
      forge_only: true,
    },
    {
      name:       'issues_url',
      question:   _('If there is a public issue tracker for this module, enter its URL here.'),
      help:       _('Optional. You can update this later in the metadata.json.'),
      default:    .data['issues_url'],
      forge_only: true,
    },
  ]

  prompt = TTY::Prompt.new(help_color: :cyan)

  interview = PDK::CLI::Util::Interview.new(prompt)

  if opts[:only_ask]
    questions.reject! do |question|
      if %w[module_name forge_username].include?(question[:name])
        .data['name'] && .data['name'] =~ %r{\A[a-z0-9]+-[a-z][a-z0-9_]*\Z}i
      else
        !opts[:only_ask].include?(question[:name])
      end
    end
  else
    questions.reject! { |q| q[:name] == 'module_name' } if opts.key?(:module_name)
    questions.reject! { |q| q[:name] == 'license' } if opts.key?(:license)
    questions.reject! { |q| q[:forge_only] } unless opts[:'full-interview']
  end

  interview.add_questions(questions)

  if File.file?('metadata.json')
    puts _(
      "\nWe need to update the metadata.json file for this module, so we\'re going to ask you %{count} " \
      "questions.\n",
    ) % {
      count: interview.num_questions,
    }
  else
    puts _(
      "\nWe need to create the metadata.json file for this module, so we\'re going to ask you %{count} " \
      "questions.\n",
    ) % {
      count: interview.num_questions,
    }
  end

  puts _(
    'If the question is not applicable to this module, accept the default option ' \
    'shown after each question. You can modify any answers at any time by manually updating ' \
    "the metadata.json file.\n\n",
  )

  answers = interview.run

  if answers.nil?
    PDK.logger.info _('No answers given, interview cancelled.')
    exit 0
  end

  unless answers['forge_username'].nil?
    opts[:username] = answers['forge_username']

    unless answers['module_name'].nil?
      opts[:module_name] = answers['module_name']

      answers.delete('module_name')
    end

    answers['name'] = "#{opts[:username]}-" + (opts[:module_name])
    answers.delete('forge_username')
  end

  answers['license'] = opts[:license] if opts.key?(:license)
  answers['operatingsystem_support'].flatten! if answers.key?('operatingsystem_support')

  .update!(answers)

  if opts[:prompt].nil? || opts[:prompt]
    require 'pdk/cli/util'

    continue = PDK::CLI::Util.prompt_for_yes(
      _('Metadata will be generated based on this information, continue?'),
      prompt:         prompt,
      cancel_message: _('Interview cancelled; exiting.'),
    )

    unless continue
      PDK.logger.info _('Process cancelled; exiting.')
      exit 0
    end
  end

  require 'pdk/answer_file'
  PDK.answers.update!(
    {
      'forge_username' => opts[:username],
      'author'         => answers['author'],
      'license'        => answers['license'],
    }.delete_if { |_key, value| value.nil? },
  )
end

.prepare_metadata(opts = {}) ⇒ Object



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/pdk/generate/module.rb', line 122

def self.(opts = {})
  require 'pdk/answer_file'
  require 'pdk/module/metadata'

  opts[:username] = (opts[:username] || PDK.answers['forge_username'] || ).downcase

  defaults = PDK::Module::Metadata::DEFAULTS.dup

  defaults['name'] = "#{opts[:username]}-#{opts[:module_name]}" unless opts[:module_name].nil?
  defaults['author'] = PDK.answers['author'] unless PDK.answers['author'].nil?
  defaults['license'] = PDK.answers['license'] unless PDK.answers['license'].nil?
  defaults['license'] = opts[:license] if opts.key?(:license)

   = PDK::Module::Metadata.new(defaults)
  module_interview(, opts) unless opts[:'skip-interview']

  
end

.prepare_module_directory(target_dir) ⇒ Object



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/pdk/generate/module.rb', line 141

def self.prepare_module_directory(target_dir)
  require 'fileutils'

  [
    File.join(target_dir, 'examples'),
    File.join(target_dir, 'files'),
    File.join(target_dir, 'manifests'),
    File.join(target_dir, 'templates'),
    File.join(target_dir, 'tasks'),
  ].each do |dir|
    begin
      FileUtils.mkdir_p(dir)
    rescue SystemCallError => e
      raise PDK::CLI::FatalError, _("Unable to create directory '%{dir}': %{message}") % {
        dir:     dir,
        message: e.message,
      }
    end
  end
end

.username_from_loginObject



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/pdk/generate/module.rb', line 106

def self.
  require 'etc'

   = Etc.getlogin || ''
   = .downcase.gsub(%r{[^0-9a-z]}i, '')
   = 'username' if .empty?

  if  != 
    PDK.logger.debug _('Your username is not a valid Forge username. Proceeding with the username %{username}. You can fix this later in metadata.json.') % {
      username: ,
    }
  end

  
end

.validate_options(opts) ⇒ Object



8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/pdk/generate/module.rb', line 8

def self.validate_options(opts)
  require 'pdk/cli/util/option_validator'

  unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[:module_name])
    error_msg = _(
      "'%{module_name}' is not a valid module name.\n" \
      'Module names must begin with a lowercase letter and can only include lowercase letters, digits, and underscores.',
    ) % { module_name: opts[:module_name] }
    raise PDK::CLI::ExitWithError, error_msg
  end

  target_dir = File.expand_path(opts[:target_dir])
  raise PDK::CLI::ExitWithError, _("The destination directory '%{dir}' already exists") % { dir: target_dir } if File.exist?(target_dir)
end