generate-puppetfile 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20ff01c403b03aacd1a849c841fef1723543d739
-  data.tar.gz: 2571ee7127adad7638a9e0cf2f1f773cc7d1bf96
+  metadata.gz: 614002454318ec3de6dc470fad81e00e57c2b750
+  data.tar.gz: 39bb78f3cd1d05d32e3c298e0d8b0eacf66b5a6e
 SHA512:
-  metadata.gz: a3d7878cea4c6ccb4ede987cd424cdeddae79c8f79f80ca835af479a0d28fbc944406b8e7d327bf24b42c1ad419f57f81e9eb0f3f55c7706b30cf56c6ff14e5c
-  data.tar.gz: 14eff83bc5121fefe0736e19e28fe6a5c7bd4edc8a0b85c66366ec5781e806c5ea186663267aeb2a7c914713f672aafeef537238849c9330e10a9ffc5d7366c4
+  metadata.gz: 73859a79af4d3b17769eaa18499f684b29ec91a5850bf5149d5bc7f74ca06515921a1b727bfb918c50c75b6502ec6a90aa442db5b859b67dee971139fe2801df
+  data.tar.gz: 8e267c59fc4b76f4276b351b73c2a621d70e3ec586304156692afe007200e8c4ffedc5073b265df82e4caa7e231d209f91d0a451cbe26dbe8191618d54f2def7

data/README.md

@@ -100,6 +100,39 @@ mod 'lab_config',
   :git => 'git@github.com:puppetinabox/lab_config.git'
 =======================================================================
 ```
+#### extending puppet modules & bolt projects 
+
+Due to the nature of the generate-puppetfile gem it makes an excellent tool for developing the Puppetfile for [bolt projects]( https://puppet.com/docs/bolt/latest/bolt_project_directories.html). Seeing the simplest way to create a Bolt project is with the Puppet PDK this approach extends that use case. Add the following to your `.sync.yml` in a pdk managed module and run `pdk update`.zd
+
+```
+Gemfile:
+  optional:
+    ':development':
+      - gem: 'generate-puppetfile'
+        version: '~> 1.0
+```
+
+Add the following to `/rakelib/generate_puppetfile.rake` to create a rake target for the experimental `pdk bundle` feature. You can then use `pdk bundle exec rake generate_puppetfile` to generate the puppetfile based on the modules metadata.
+
+```
+require 'json'
+
+desc 'generate puppetfile'
+task :generate_puppetfile, [:mod] do |t, args| 
+    args.with_defaults(:mod => JSON.parse(File.read('metadata.json'))['name'])
+    sh "generate-puppetfile -c  #{args.mod}"
+end
+```
+Add the following to `/rakelib/generate_fixturesfile.rake` to create a rake target for the experimental `pdk bundle` feature. You can then use `pdk bundle exec rake generate_fixturesfile` to generate the `.fixtures.yaml` based on the module metadata to aid in testing with the `pdk test` feature.
+
+```
+desc 'generate fixtures'
+task :generate_fixturesfile do |t| 
+    mod = JSON.parse(File.read('metadata.json'))['name']
+    sh "generate-puppetfile -f -p ./Puppetfile #{mod} --fixtures-only -m #{mod}"
+end
+```
+
 
 ## Limitations
 

data/lib/generate_puppetfile/bin.rb

@@ -11,11 +11,11 @@ require 'uri'
 module GeneratePuppetfile
   # Internal: The Bin class contains the logic for calling generate_puppetfile at the command line
   class Bin
-    Module_Regex        = %r{^\s*mod ['\"]([a-z0-9_]+\/[a-z0-9_]+)['\"](,\s+['\"](\d+\.\d+\.\d+)['\"])?\s*$}
-    Repository_Regex    = %r{^\s*mod\s+['\"](\w+)['\"]\s*,\s*$}
-    Location_Only_Regex = %r{^\s+:git\s+=>\s+['\"](\S+)['\"]\s*$}
-    Location_Plus_Regex = %r{^\s+:git\s+=>\s+['\"](\S+)['\"]\s*,\s*$}
-    Type_ID_Regex       = %r{^\s+:(\w+)\s+=>\s+['\"](\S+)['\"]\s*$}
+    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*#}
@@ -435,6 +435,7 @@ forge 'https://forge.puppet.com'
         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 << {
@@ -456,14 +457,14 @@ forge 'https://forge.puppet.com'
       fixtures_data = "fixtures:\n"
       if symlinks
         fixtures_data += "  symlinks:\n"
-        symlinks.each do |symlink|
+        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.each do |repodata|
+        @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.)
@@ -476,7 +477,7 @@ forge 'https://forge.puppet.com'
     #{name}:
       repo: "#{location}"
           EOF
-          data += "      #{type}: \"#{id}\"\n" if (type && id)
+          data += "      #{type}: \"#{id}\"\n" unless @options[:latest_versions] || !type || !id
 
           fixtures_data += data
         end
@@ -485,15 +486,14 @@ forge 'https://forge.puppet.com'
 
       unless @module_data.empty?
         fixtures_data += "  forge_modules:\n"
-        @module_data.keys.each do |modulename|
-          shortname = modulename.split('/')[1]
+        @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}"
-      ref: "#{version}"
           EOF
-          data.gsub!(/^ *ref.*$\n/, '') unless version != nil
+          data += "      ref: \"#{version}\"\n" unless @options[:latest_versions] || version.nil?
 
           fixtures_data += data
         end

data/lib/generate_puppetfile/optparser.rb

@@ -36,6 +36,10 @@ module GeneratePuppetfile
           options[:modulename] = name
         end
 
+        opts.on('-l', '--latest-versions', "Use latest version of forge modules and default branch of repository modules in .fixtures.yml") do |name|
+          options[:latest_versions] = true
+        end
+
         opts.on('-s', '--silent', 'Run in silent mode. Supresses all non-debug output. Adds the -c flag automatically.') do
           options[:silent] = true
           options[:create_puppetfile] = true

data/lib/generate_puppetfile/version.rb

@@ -1,3 +1,3 @@
 module GeneratePuppetfile
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: generate-puppetfile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Nelson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Generate a Puppetfile