Class: GeneratePuppetfile::Bin

Inherits:
Object
  • Object
show all
Defined in:
lib/generate_puppetfile/bin.rb

Overview

Internal: The Bin class contains the logic for calling generate_puppetfile at the command line

Constant Summary collapse

Module_Regex = 
%r{^\s*mod ['"]([a-z0-9_]+[/-][a-z0-9_]+)['"](,\s+['"](\d+\.\d+\.\d+)['"])?\s*(?:#.*)?$}i
Repository_Regex = 
%r{^\s*mod\s+['"](\w+)['"]\s*,\s*(?:#.*)?$}i
Location_Only_Regex = 
%r{^\s+:git\s+=>\s+['"](\S+)['"]\s*(?:#.*)?$}i
Location_Plus_Regex = 
%r{^\s+:git\s+=>\s+['"](\S+)['"]\s*,\s*(?:#.*)?$}i
Type_ID_Regex = 
%r{^\s+:(\w+)\s+=>\s+['"](\S+)['"]\s*(?:#.*)?$}i
Forge_Regex = 
%r{^forge}
Blanks_Regex = 
%r{^\s*$}
Comments_Regex = 
%r{^\s*#}
Skipall_Regex = 
%r{^forge|^\s*$|^#}
Silence = 
('>' + File::NULL.to_str + ' 2>&1 ').freeze
Puppetfile_Header = 
'# Modules discovered by generate-puppetfile'.freeze
Extras_Note = 
'# Discovered elements from existing Puppetfile'.freeze

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Bin

Public: Initialize a new GeneratePuppetfile::Bin

args - Array of command line arguments as Strings to be passed to GeneratePuppetfile::OptParser.parse

Example:

GeneratePuppetfile::Bin.new(ARGV).run



35
36
37
38
39
40
41
42
 
# File 'lib/generate_puppetfile/bin.rb', line 35

def initialize(args)
  @args = args
  @options = {}         # Options hash
  @workspace = nil      # Working directory for module download and inspection
  @module_data = {}     # key: modulename, value: version number
  @repository_data = [] # Non-forge modules. Array of hashes containing name, location, type, and ID
  @download_errors = '' # A list of errors encountered while downloading modules. Should remain empty.
end

Instance Method Details

#_download_module(name) ⇒ Object

Private: Download an individual module

_download_module



268
269
270
271
272
273
274
 
# File 'lib/generate_puppetfile/bin.rb', line 268

def _download_module(name)
  command  = "puppet module install #{name} "
  command += @modulepath + Silence

  puts "Calling '#{command}'" if @options[:debug]
  system(command)
end

#cleanup_workspace ⇒ Object

Public: Remove the workspace (with prejudice)



419
420
421
 
# File 'lib/generate_puppetfile/bin.rb', line 419

def cleanup_workspace
  FileUtils.rm_rf(@workspace)
end

#create_puppetfile(puppetfile_contents) ⇒ Object

Public: Create a Puppetfile on disk The Puppetfile will be called ‘Puppetfile’ in the current working directory



155
156
157
158
159
 
# File 'lib/generate_puppetfile/bin.rb', line 155

def create_puppetfile(puppetfile_contents)
  File.open('Puppetfile', 'w') do |file|
    file.write puppetfile_contents
  end
end

#create_workspace ⇒ Object

Public: Create a temporary workspace for module manipulation



414
415
416
 
# File 'lib/generate_puppetfile/bin.rb', line 414

def create_workspace
  @workspace = Dir.mktmpdir.chomp
end

#display_puppetfile(puppetfile_contents) ⇒ Object

Public: Display the generated Puppetfile to STDOUT with delimiters



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/generate_puppetfile/bin.rb', line 142

def display_puppetfile(puppetfile_contents)
  puts <<-EOF

Your Puppetfile has been generated. Copy and paste between the markers:

=======================================================================
#{puppetfile_contents.chomp}
=======================================================================
  EOF
end

#download_modules(module_list) ⇒ Object

Public: Download the list of modules and their dependencies to @workspace

module_list is an array of forge module names to be downloaded



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/generate_puppetfile/bin.rb', line 250

def download_modules(module_list)
  puts "\nInstalling modules. This may take a few minutes.\n\n" unless @options[:silent]

  @download_errors = ''
  module_list.each do |name|
    next if _download_module(name)
    @download_errors << "There was a problem with the module name '#{name}'.".red + "\n"
  end

  if @download_errors != ''
    @download_errors << '  Check that modules exist as under the listed name, and/or your connectivity to the puppet forge.'.red + "\n\n"
    @download_errors << 'Here is the PARTIAL Puppetfile that would have been generated.'.red + "\n\n\n"
  end
end

#generate_fixtures_data ⇒ Object

Public: Generate a simple fixtures file.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/generate_puppetfile/bin.rb', line 424

def generate_fixtures_data
  # Determine if there are symlinks, either for the default modulename, or for anything in the modulepath
  symlinks = []
  modulepath = ''
  if (File.exists?('environment.conf') and environment_conf = File.read('environment.conf'))
    puts "\nGenerating .fixtures.yml for a controlrepo." unless @options[:silent]

    environment_conf.split("\n").each do |line|
      modulepath = (line.split('='))[1].gsub(/\s+/,'') if line =~ /^modulepath/
    end

    paths = modulepath.split(':').delete_if { |path| path =~ /^\$/ }
    paths.each do |path|
      Dir["#{path}/*"].each do |module_location|
        next unless File.directory?(module_location)
        module_name = File.basename(module_location)
        module_path = module_location
        symlinks << {
          :name => module_name,
          :path => '"#{source_dir}/' + module_path + '"',
        }
      end
    end
  else
    puts "\nGenerating .fixtures.yml using module name #{@options[:modulename]}." unless @options[:silent]

    symlinks << { 
      :name => @options[:modulename],
      :path => '"#{source_dir}"',
    }
  end

  # Header for fixtures file creates symlinks for the controlrepo's modulepath, or for the current module"
  fixtures_data = "fixtures:\n"
  if symlinks
    fixtures_data += "  symlinks:\n"
    symlinks.sort_by!{|symlink| symlink[:name]}.each do |symlink|
      fixtures_data += "    #{symlink[:name]}: #{symlink[:path]}\n"
    end
  end

  unless @repository_data.empty?
    fixtures_data += "  repositories:\n"
    @repository_data.sort_by!{|repo| repo[:name]}.each do |repodata|
      # Each repository has two or  pieces of data
      #   Mandatory: the module name, the URI/location
      #   Optional: the type (ref, branch, commit, etc.) and ID (tag, branch name, commit hash, etc.)
      name      = repodata[:name]
      location  = repodata[:location]
      type      = repodata[:type]
      id        = repodata[:id]

      data = <<-EOF
#{name}:
  repo: "#{location}"
      EOF
      data += "      #{type}: \"#{id}\"\n" unless @options[:latest_versions] || !type || !id

      fixtures_data += data
    end
  end


  unless @module_data.empty?
    fixtures_data += "  forge_modules:\n"
    @module_data.keys.sort_by!{|mod| mod.split(/[\/-]/)[1]}.each do |modulename|
      shortname = modulename.split(/[\/-]/)[1]
      version = @module_data[modulename] 
      data = <<-EOF
#{shortname}:
  repo: "#{modulename}"
      EOF
      data += "      ref: \"#{version}\"\n" unless @options[:latest_versions] || version.nil?

      fixtures_data += data
    end
  end

  fixtures_data
end

#generate_forge_module_output ⇒ Object

Public: generate the list of modules in Puppetfile format from the @workspace



377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/generate_puppetfile/bin.rb', line 377

def generate_forge_module_output
  return '' if @module_data.empty?

  max_length    = @module_data.keys.max_by {|mod| mod.length}.length + 3 # room for extra chars
  module_output = ''

  @module_data.each do |modulename, version|
    module_output += sprintf("mod %-#{max_length}s '%s'\n", "'#{modulename}',", version)
  end
  module_output
end

#generate_module_data_from_modulepath ⇒ Object

Public: generate the module data from the modulepath (@workspace)



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/generate_puppetfile/bin.rb', line 277

def generate_module_data_from_modulepath
  command = "puppet module list #{@modulepath} 2>#{File::NULL}"
  puts "Calling '#{command}'" if @options[:debug]
  module_output = `#{command}`

  module_output.gsub!(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/, '') # Strips ANSI color codes
  modules = {}
  module_output.each_line do |line|
    next unless line =~ / \(v/
    line.tr!('-', '/')
    line.gsub!(/^\S* /, '')
    line += line
    name, version = line.match(/(\S+) \(v(.+)\)/).captures
    modules[name] = version
    $stderr.puts "Module #{name} has a version of #{version}, it may be deprecated. For more information, visit https://forge.puppet.com/#{name}".blue if version =~ /999/ and ! @options[:silent]
  end
  modules
end

#generate_module_data_from_Puppetfile ⇒ Object

Public: generate the module data from an existing Puppetfile



297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/generate_puppetfile/bin.rb', line 297

def generate_module_data_from_Puppetfile
  puppetfile_contents = read_puppetfile_with_versions(@options[:puppetfile])

  modules = {}
  puppetfile_contents[:modules].each do |name, version|
    modules[name] = version
    $stderr.puts "Module #{name} has a version of #{version}, it may be deprecated. For more information, visit https://forge.puppet.com/#{name}".blue if version =~ /999/ and ! @options[:silent]
  end

  modules
end

#generate_puppetfile_contents(extras) ⇒ Object

Public: Generate a new Puppetfile’s contents based on a list of modules and any extras found in an existing Puppetfile.

extras is an array of strings



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/generate_puppetfile/bin.rb', line 393

def generate_puppetfile_contents(extras)
  puppetfile_contents = <<-EOF
forge 'https://forge.puppet.com'

#{Puppetfile_Header}
  EOF

  puppetfile_contents += generate_forge_module_output

  puppetfile_contents += "#{Extras_Note}\n" unless extras == []
  extras.each do |line|
    puppetfile_contents += line.to_s
  end unless extras == []

  # Strip out all contents with --ignore_comments
  puppetfile_contents.gsub!(/^#.*$\n/, '') if @options[:ignore_comments]

  puppetfile_contents
end

#generate_repository_data_from_Puppetfile ⇒ Object

Public: generate the ad hoc repository (non-forge module) data from an existing Puppetfile

Returns an array of hashes with keys name, location, type, id



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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/generate_puppetfile/bin.rb', line 311

def generate_repository_data_from_Puppetfile
  repositories = []

  # Open the Puppetfile
  File.open(@options[:puppetfile], 'r') do |fh|
    while (line = fh.gets) != nil
      # Skip blank lines, comments, anything that looks like a forge module
      next if line =~ Skipall_Regex
      next if Module_Regex.match(line)
      # When we see /mod 'modulename',/ it is possibly a properly formatted fixture
      if Repository_Regex.match(line)
        complete = false
        name = Regexp.last_match(1)
        while (line = fh.gets) != nil
          next if line =~ Skipall_Regex
          if Location_Only_Regex.match(line)
            # The Puppetfile may specify just a location /:git => 'https://github.com/author/puppet-modulename'/
            # We do not validate the URI protocol, just that it is a valid URI
            location = Regexp.last_match(1)
            puts "Found module #{name} with location #{location}" if @options[:debug]
            unless location.match(URI.regexp)
              puts "#{location} is not a valid URI, skipping this repo" if @options[:debug]
              break
            end
            repositories << {name: name, location: location}
            complete = true
          elsif Location_Plus_Regex.match(line)
            # Or it may provide more, with a trailing comma
            #   :git => 'https://github.com/author/puppet-modulename',
            #   :ref => '1.0.0'
            location = Regexp.last_match(1)
            while (line = fh.gets) != nil
              next if line =~ Skipall_Regex
              if Type_ID_Regex.match(line)
                type = Regexp.last_match(1)
                id   = Regexp.last_match(2)
                puts "Found module #{name} with location #{location}, #{type} of #{id}" if @options[:debug]
                unless location.match(URI.regexp)
                  puts "#{location} is not a valid URI, skipping this repo" if @options[:debug]
                  break
                end
                repositories << {name: name, location: location, type: type, id: id}
                complete = true
              else
                # If the :git line ends with a comma but no type/ID is found, ignore it, we cannot properly determine the fixture
                puts "Found module #{name} at location #{location}. Expected type/ID information but did not find any, skipping." if @options[:debug]
                complete = true
              end
              break if complete
            end
          else
            # If the /mod 'modulename',/ line is not followed with a :git string, ignore it, we cannot properly determine the fixture
            puts "Found a reference to module #{name} but no location (:git) was provided, skipping." if @options[:debug]
            complete = true
          end
          break if complete
        end
      end
    end
  end

  repositories
end

#list_extras(extras) ⇒ Object

Public: Display the list of extra statements found in the Puppetfile.



180
181
182
183
184
185
186
187
188
 
# File 'lib/generate_puppetfile/bin.rb', line 180

def list_extras(extras)
  unless @options[:silent] || (extras == [])
    puts "\nExtras found in the existing Puppetfile:\n\n"
    extras.each do |line|
      puts "    #{line}"
    end
    puts ''
  end
end

#list_forge_modules(module_list) ⇒ Object

Public: Display the list of Forge modules collected.



169
170
171
172
173
174
175
176
177
 
# File 'lib/generate_puppetfile/bin.rb', line 169

def list_forge_modules(module_list)
  unless @options[:silent]
    puts "\nListing discovered modules from CLI and/or Puppetfile:\n\n"
    module_list.each do |name|
      puts "    #{name}"
    end
    puts ''
  end
end

#read_puppetfile(puppetfile) ⇒ Object

Public: Read and parse the contents of an existing Puppetfile



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/generate_puppetfile/bin.rb', line 191

def read_puppetfile(puppetfile)
  puppetfile_contents = {
    modules: [],
    extras: []
  }

  File.foreach(puppetfile) do |line|
    if Module_Regex.match(line)
      name = Regexp.last_match(1)
      print "    #{name} looks like a forge module.\n" if @options[:debug]
      puppetfile_contents[:modules].push(name)
    else
      next if line =~ Forge_Regex
      next if line =~ Blanks_Regex
      next if line =~ /#{Puppetfile_Header}/
      next if line =~ /#{Extras_Note}/

      puppetfile_contents[:extras].push(line)
    end
  end

  puppetfile_contents
end

#read_puppetfile_with_versions(puppetfile) ⇒ Object

Public: Read and parse the contents of an existing Puppetfile



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/generate_puppetfile/bin.rb', line 216

def read_puppetfile_with_versions(puppetfile)
  puppetfile_contents = {
    modules: [],
    extras: []
  }

  File.foreach(puppetfile) do |line|
    if Module_Regex.match(line)
      name    = Regexp.last_match(1)
      version = Regexp.last_match(3)
      print "    #{name} looks like a forge module.\n" if @options[:debug]
      puppetfile_contents[:modules].push([name, version])
    else
      next if line =~ Forge_Regex
      next if line =~ Blanks_Regex
      next if line =~ /#{Puppetfile_Header}/
      next if line =~ /#{Extras_Note}/

      puppetfile_contents[:extras].push(line)
    end
  end

  puppetfile_contents
end

#run ⇒ Object

Public: Run generate-puppetfile at the command line.

Returns an Integer exit code for the shell ($?)



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
 
# File 'lib/generate_puppetfile/bin.rb', line 47

def run
  @options = GeneratePuppetfile::OptParser.parse(@args)

  helpmsg = "generate-puppetfile: try 'generate-puppetfile --help' for more information."

  if (@options[:fixtures_only] && ! @options[:puppetfile] )
    $stderr.puts "generate-puppetfile: --fixtures-only is only valid when a '-p <Puppetfile>' is used as well.\n".red
    puts helpmsg
    return 1
  end

  if @args[0].nil? && (! @options[:puppetfile])
    $stderr.puts "generate-puppetfile: No modules or existing Puppetfile specified.\n".red
    puts helpmsg
    return 1
  end

  unless verify_puppet_exists
    $stderr.puts "generate-puppetfile: Could not find a 'puppet' executable.".red
    $stderr.puts "  Please make puppet available in your path before trying again.\n".red
    return 1
  end


  forge_module_list = []

  # When using --fixtures-only, simply parse the provided Puppetfile and get out
  if @options[:fixtures_only] && @options[:puppetfile]
    @module_data = generate_module_data_from_Puppetfile
    @repository_data = generate_repository_data_from_Puppetfile
    fixtures_data = generate_fixtures_data
    write_fixtures_data(fixtures_data)
    return 0
  end

  # For everything else, run through the whole thing
  if @args
    puts "\nProcessing modules from the command line...\n\n" if @options[:debug]
    cli_modules = []
    @args.each do |modulename|
      validate(modulename) && cli_modules.push(modulename)
    end
    if cli_modules == [] && ! @options[:puppetfile]
      $stderr.puts "No valid modules were found to process.".red
      return 1
    end
  end

  puppetfile_contents = {}
  # Currently, ALL statements not including a forge module are listed as extras. The @repository_data should be removed from the extras eventually (#54)
  extras = []
  if @options[:puppetfile]
    puts "\nProcessing the puppetfile '#{@options[:puppetfile]}'...\n\n" if @options[:debug]
    puppetfile_contents = read_puppetfile(@options[:puppetfile])
    extras = puppetfile_contents[:extras]
  end

  forge_module_list.push(*cli_modules) if @args
  forge_module_list.push(*puppetfile_contents[:modules]) if puppetfile_contents[:modules]
  list_forge_modules(forge_module_list) if puppetfile_contents && @options[:debug]
  list_extras(puppetfile_contents[:extras]) if puppetfile_contents[:extras] && @options[:debug]

  unless forge_module_list != [] || puppetfile_contents[:extras] != []
    $stderr.puts "\nNo valid modules or existing Puppetfile content was found. Exiting.\n\n".red
    return 1
  end

  create_workspace
  @modulepath = "--modulepath #{@workspace} "

  return 2 if download_modules(forge_module_list) == 2
  @module_data = generate_module_data_from_modulepath
  puppetfile_contents = generate_puppetfile_contents(extras)

  if @download_errors == ''
    create_puppetfile(puppetfile_contents) if @options[:create_puppetfile]
    display_puppetfile(puppetfile_contents) unless @options[:silent]

    if @options[:create_fixtures]
      @repository_data = generate_repository_data_from_Puppetfile if @options[:puppetfile]
      fixtures_data = generate_fixtures_data
      write_fixtures_data(fixtures_data)
    end

    cleanup_workspace
  else
    $stderr.puts @download_errors
    display_puppetfile(puppetfile_contents) unless @options[:silent]
    return 2
  end

  0
end

#validate(modulename) ⇒ Object

Public: Validates that a provided module name is valid.



162
163
164
165
166
 
# File 'lib/generate_puppetfile/bin.rb', line 162

def validate(modulename)
  success = (modulename =~ /[a-z0-9_][\/-][a-z0-9_]/i)
  $stderr.puts "'#{modulename}' is not a valid module name. Skipping.".red unless success
  success
end

#verify_puppet_exists ⇒ Object

Public: Verify that Puppet is available in the path



242
243
244
245
 
# File 'lib/generate_puppetfile/bin.rb', line 242

def verify_puppet_exists
  MakeMakefile::Logging.instance_variable_set(:@logfile, File::NULL)
  find_executable0('puppet')
end

#write_fixtures_data(data) ⇒ Object 



505
506
507
508
509
 
# File 'lib/generate_puppetfile/bin.rb', line 505

def write_fixtures_data(data)
  File.open('.fixtures.yml', 'w') do |file|
    file.write data
  end
end