puppet-retrospec 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca1e5137298e9ae66d799a66eaf71a221e696379
-  data.tar.gz: 707f87e0cb1f5fb001d16459a037f8055806f9ba
+  metadata.gz: 56ddee7e316cf7e2074a1f6ca6cdc34561baaa31
+  data.tar.gz: 7bc02f19562beb2981babe6bd17949b51901f942
 SHA512:
-  metadata.gz: c72d4b82b2eec85b0c29194f33822b3fe135246206c135f99f6cfd8f86a8c155a071f5e7cd9057ce8aa100b3d6d99df05fe53a275a6bb45d39bfe3871baa095b
-  data.tar.gz: 223c391870cedfb12b50dfc6246e91fbad7cbc667d4102dafa42d4e09c38b44b8a6f6be0e86b802cc78b8d9e91ac5cd068fe4807cb0d1067d6829a5505051639
+  metadata.gz: 79f92a3078d2456d98fa5be550700b9d4001862340ded0cf610ec1192c9e7613153f3099e229bb232d66390cc353d1d6de3f983d5df784c39fd5f507c686ad2b
+  data.tar.gz: c9acb7246d9bbecaa52e851333678f0e25a76fdb3ece6d2751e8bd2b418775ddcddcebc28c3a06b8830cb23c2e13226072ae03481f3499d1be3d909547c40564

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 1.5.0
+ * Adds ability to generate bolt tasks for puppet modules
 ## 1.4.1
  * Adds real module data to common.yaml
 ## 1.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puppet-retrospec (1.4.1)
+    puppet-retrospec (1.5.0)
       awesome_print
       facets
       retrospec (>= 0.6.2)
@@ -98,4 +98,4 @@ DEPENDENCIES
   yard (~> 0.7)
 
 BUNDLED WITH
-   1.14.6
+   1.15.4

data/README.md

@@ -50,6 +50,14 @@ TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 [![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
 
 ## News
+### 10/11/17
+Adds the ability to generate puppet bolt tasks, parameters with some predefined language types
+
+`retrospec puppet new_task -n reboot -t bash -p "name, count, amount"`
+
+Generates the parameters file and task file.
+
+
 ### 5/10/17
 Adds ability to create module data.  With the release of puppet 4.9 we can now use module data.  
 Use the module_data generater to auto setup module data in your puppet module.  `retrospec puppet module_data`

data/lib/retrospec/plugins/v1/plugin/generators/task_generator.rb

@@ -0,0 +1,116 @@
+require 'json'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class TaskGenerator < Retrospec::Puppet::Generators::BaseGenerator
+        EXT_TYPES = {
+            'ruby' => 'rb',
+            'generic' => 'generic',
+            'python' => 'py',
+            'powershell' => 'ps1',
+            'bash' => 'sh',
+            'node' => 'js'
+        }
+
+        # retrospec will initilalize this class so its up to you
+        # to set any additional variables you need to get the job done.
+        def initialize(module_path, spec_object = {})
+          super
+          @plural_name = 'tasks'
+          @singular_name = 'task'
+        end
+
+        def shebang
+          "#!/usr/bin/env #{task_type}"
+        end
+
+        def task_params
+          config_data[:task_params].gsub(/\s/, '').split(",")
+        end
+
+        def task_params_output
+          params = {}
+          task_params.each_with_object({}) do |item, obj|
+            obj["description"] = "The description of the #{item} parameter"
+            obj["type"] = "String"
+            params[item] = obj
+          end
+          params
+        end
+
+        def task_type
+          config_data[:task_type]
+        end
+
+        def run
+          files = []
+          files << generate_task_files
+          files
+        end
+
+        def task_filepath
+          ext = EXT_TYPES.fetch(task_type, task_type)
+          File.join(module_path, 'tasks', "#{item_name}.#{ext}")
+        end
+
+        def task_params_filepath
+          File.join(module_path, 'tasks', "#{item_name}.json")
+        end
+
+        def item_spec_path
+          File.join(spec_path, plural_name, "#{item_name}_spec.rb")
+        end
+
+        def enable_beaker_tasks?
+          false
+        end
+
+        def generate_task_files
+          context.task_type = task_type
+          context.shebang = shebang
+          context.task_params_output = task_params_output
+          context.task_params = task_params
+          parameter_template = File.join(template_dir, 'task_parameters.json.retrospec.erb')
+          task_template = Dir.glob(File.join(template_dir, 'types', task_type, '*')).first
+          unless task_template
+            task_template = Dir.glob(File.join(template_dir, 'types', 'task.retrospec.erb')).first
+          end
+          files = []
+          files << safe_create_template_file(task_filepath, task_template, context)
+          files << safe_create_template_file(task_params_filepath, parameter_template, context)
+          files
+        end
+
+        # used to display subcommand options to the cli
+        # the global options are passed in for your usage
+        # http://trollop.rubyforge.org
+        # all options here are available in the config passed into config object
+        # returns the parameters
+        def self.run_cli(global_opts, args=ARGV)
+          task_types = %w(bash generic ruby python node powershell)
+          task_type  = global_opts['plugins::puppet::default_task_type'] || 'bash'
+          sub_command_opts = Trollop.options(args) do
+            banner <<-EOS
+Creates a new puppet bolt task for your module
+
+Example: retrospec puppet new_task -n reboot -p "name, ttl, message"
+
+            EOS
+            opt :name, "The name of the task you wish to create", :type => :string, :required => true, :short => '-n'
+            opt :task_params, "The task parameter names separated by commas", :short => '-p', :type => :string, :required => false, default: "name"
+            opt :task_type, "The task type of the task (#{task_types.join(', ')})", :type => :string, :required => false, :short => '-t',
+                :default => task_type
+
+          end
+          unless sub_command_opts[:name]
+            Trollop.educate
+            exit 1
+          end
+          plugin_data = global_opts.merge(sub_command_opts)
+          plugin_data
+        end
+      end
+    end
+  end
+end

data/lib/retrospec/plugins/v1/plugin/puppet.rb

@@ -92,7 +92,7 @@ module Retrospec
           scm_branch = ENV['RETROSPEC_PUPPET_SCM_BRANCH'] || plugin_config['plugins::puppet::templates::ref'] || 'master'
           beaker_tests  = plugin_config['plugins::puppet::enable_beaker_tests'] || false
           # a list of subcommands for this plugin
-          sub_commands  = %w(new_module new_fact new_type new_provider new_function new_report module_data)
+          sub_commands  = %w(new_module new_task new_fact new_type new_provider new_function new_report module_data)
           if sub_commands.count > 0
             sub_command_help = "Subcommands:\n  #{sub_commands.join("\n  ")}\n"
           else
@@ -106,7 +106,6 @@ Generates puppet rspec test code and puppet module components.
 #{sub_command_help}
 
             EOS
-
             opt :template_dir, 'Path to templates directory (only for overriding Retrospec templates)', :type => :string,
             :required => false, :default => template_dir
             opt :scm_url, 'SCM url for retrospec templates', :type => :string, :required => false,
@@ -135,6 +134,8 @@ Generates puppet rspec test code and puppet module components.
                 plugin.new_type(plugin_data, args)
               when :new_function
                 plugin.new_function(plugin_data, args)
+              when :new_task
+                plugin.new_task(plugin_data, args)
               when :new_fact
                 plugin.new_fact(plugin_data, args)
               when :new_provider
@@ -165,6 +166,14 @@ Generates puppet rspec test code and puppet module components.
           plugin_data
         end
 
+        def new_task(config, args)
+          plugin_data = Retrospec::Puppet::Generators::TaskGenerator.run_cli(config, args)
+          plugin_data[:puppet_context] = context
+          t = Retrospec::Puppet::Generators::TaskGenerator.new(plugin_data[:module_path], plugin_data)
+          t.run
+          post_init
+        end
+
         def module_data(module_path, config, args=[])
           plugin_data = Retrospec::Puppet::Generators::ModuleDataGenerator.run_cli(config, args)
           plugin_data[:puppet_context] = context

data/lib/retrospec/plugins/v1/plugin/version.rb

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '1.4.1'
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Corey Osman
@@ -14,84 +14,84 @@ dependencies:
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: retrospec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: facets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Retrofits and generates valid puppet rspec test code to existing modules
@@ -103,15 +103,15 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .dockerignore
-- .document
-- .gitignore
-- .gitlab-ci.yml
-- .overcommit.yml
-- .release_me.yaml
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
+- ".dockerignore"
+- ".document"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".overcommit.yml"
+- ".release_me.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Dockerfile
@@ -143,6 +143,7 @@ files:
 - lib/retrospec/plugins/v1/plugin/generators/serializers/rspec_dumper.rb
 - lib/retrospec/plugins/v1/plugin/generators/serializers/rspec_dumper_full.rb
 - lib/retrospec/plugins/v1/plugin/generators/serializers/schema_dumper.rb
+- lib/retrospec/plugins/v1/plugin/generators/task_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/type_generator.rb
 - lib/retrospec/plugins/v1/plugin/helpers.rb
 - lib/retrospec/plugins/v1/plugin/puppet.rb
@@ -1760,17 +1761,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Generates puppet rspec test code based on the classes and defines inside