Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nwops/puppet-retrospec

The only tool you need to generate puppet code, tests, modules, facts, types, providers, data and everything else.
https://github.com/nwops/puppet-retrospec

devops generator magic puppet ruby

Last synced: 25 days ago
JSON representation

The only tool you need to generate puppet code, tests, modules, facts, types, providers, data and everything else.

Awesome Lists containing this project

README 

        
Puppet-Retrospec

================

A retrospec plugin for puppet that generates puppet rspec test code based on the current code inside your module.



Proper testing is hard especially when you are new to ruby, rspec or even puppet.



Retrospec makes it dead simple to get started with advanced puppet module development.  Retrospec will scan you puppet module files and actually write some very basic rspec-puppet test code.  Thus this gem will retrofit your existing puppet module with everything needed to get going with puppet unit testing.  Additionally, retrospec will outfit your module with any file you can think of.  Say goodbye to repetitive module setup.



Not only will retrospec generate tests for you, it will also assist in creating many of the advanced puppet module files like custom facts, functions, types, providers and schemas, as well as their associated test files. It will even create the module from scratch if so desired.



The project was named retrospec because there are many times when you need to retrofit your module with various things.



If you like this project, star it and tell people!



See the [Website](https://www.puppet-retrospec.com)



Table of Contents

=================



  * [Build Status](#build-status)

  * [News](#news)

  * [Install](#install)

  * [How to use](#usage)

    * [Module Path](#module-path)

    * [Command Line Help](#command-line-help)

  * [Design Goals](#design-goals)

  * [Using the Generators](#using-the-generators)

    * [Auto spec file creation](#auto-spec-file-creation)

    * [Creating a new puppet module](#creating-a-new-puppet-module)

    * [Creating a new fact](#creating-a-new-fact)

    * [Creating a new provider](#creating-a-new-provider)

    * [Creating a new function](#creating-a-new-function)

    * [Creating a new type](#creating-a-new-type)

    * [Creating a schema file](#creating-a-new-module-schema-file)

  * [Enable Future Parser](#enabling-the-future-parser)

  * [Configuration](#configuration)

  * [Example](#example)

  * [About the test suite](#about-the-test-suite)

  * [How Does it do this](#how-does-it-do-this)

  * [Beaker Testing](#beaker-testing)

  * [Troubleshooting](#troubleshooting)

  * [Running Tests](#running-tests)

  * [Understanding Variable Resolution](#understanding-variable-resolution)

  * [Todo](#todo)

  * [Future Parser Support](#future-parser-support)

  * [Paid Support](#paid-support)



TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)



## Build Status

![Build Status](https://gitlab.com/nwops/puppet-retrospec/badges/master/build.svg)

[![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`



### 4/20/17

With all the changes in hiera recently and the ability to provide data in puppet modules.  I thought it would be a good

time to create a generator for retrospec to create hiera backends and data in module scaffolding. With the 1.6.0 release

you are now a simple step away to retrofitting data into your module.



Just run `retrospec puppet module_data` to auto create the scaffolding.



Note: You must be using puppet 4.7+ (PE 2016.4.x) to actually use data in a module, but there is nothing stopping

you from creating the scaffolding.



Note: If you are using puppet 4.7-4.8 you will need to add `data_provider: "hiera"` in your module's metadata.json file.



### 3/7/17

You can now sync files.  Any template file that contains a `.sync` in the file name will automatically

be syncronized.  This is especially helpful for Gemfiles, Rakefiles and other static files that need to be updated.

### 2/1/17

You can now choose to overwrite files!  This is very useful when updating old module code with newer content.

See Usage below for how to enable.



## Install

`gem install puppet-retrospec`  



This will also install the retrospec framework that is required to use the plugin.



## Usage

The easiest way to get started using retrospec-puppet is to run `retrospec puppet`

from within your module directory. Retrospec uses the current directory if no options

are specified.  Expect to run `retrospec puppet` multiple times throughout the day.

Retrospec will never overwrite a file, so if something already exists retrospec will

skip the file. Many times you will find yourself deleting existing files and allowing retrospec to recreate them based on updated templates.



### Overwriting files

As stated above retrospec will not overwrite your files.  However, sometimes recreating files is desired as you change

your code.  Before '1.3' it was not possible to overwrite files, but now we can safely specify which files should be

overwritten.  This feature is off by default so you will need to enable it.



To enable please use the global options `--enable-overwrite` or if you want everything `--enable-overwrite-all`



Note: Enabling this feature will prompt you before running destructive operations like:  `y/n/a` where `a` means all.



```

retrospec -h

A framework to automate your development workflow by generating common files and test patterns.



Usage: retrospec [global options] plugin [plugin options]

Available subcommands:

puppet

  -e, --enable-overwrite        Enable overwriting of files, will prompt for each file

  -n, --enable-overwrite-all    Always overwrites files without prompting

  -m, --module-path=         The path (relative or absolute) to the module directory (default: /Users/cosman/github/puppet-retrospec)

  -c, --config-map=          The global retrospec config file (default: /Users/cosman/.retrospec/config.yaml)

  -a, --available-plugins       Show an online list of available plugins

  -v, --version                 Print version and exit

  -h, --help                    Show this message



```

### Module Path

By default the module path is dynamically set based on the current directory.

If you need to point to a directory outside the current directory you can use the `--module_path` option.  This option is built into the retrospec framework

so be sure to use `retrospec -m path_to_module`.



### Command Line Help

There is a `-h` at every level of commands and subcommands.



 - `retrospec -h`

 - `retrospec puppet -h`

 - `retrospec puppet  -h`



```

[puppet@puppetdev ~]$ retrospec -m /tmp/test3323 puppet -h

Generates puppet rspec test code based on the classes and defines inside the manifests directory.



Subcommands:

new_module

new_fact

new_type

new_provider

new_function



  -t, --template-dir=        Path to templates directory (only for overriding Retrospec templates)

                                (default: /Users/cosman/.retrospec/repos/retrospec-puppet-templates)

  -s, --scm-url=             SCM url for retrospec templates (default:

                                https://github.com/nwops/retrospec-templates)

  -n, --name=                The name of the module you wish to create (default: test3323)

  -b, --branch=              Branch you want to use for the retrospec template repo (default: master)

  -a, --namespace=           The namespace to use only when creating a new module (default: namespace)

  -e, --enable-beaker-tests     Enable the creation of beaker tests

  -v, --version                 Print version and exit

  -h, --help                    Show this message  -h, --help                    Show this message

```



## Design Goals

One of the design goals of this plugin is to try to introspect as much information as possible so we don't need input from the user. If you are not sure what default values are used, use the `-h` option and the defaults will be revealed. Most of the defaults are dynamic.  



Another design goal is to allow the user to configure every option so that passing

additional options is not required when configured correctly.  Please see the [Configuration Section](#configuration) for setting a config file.



## Using the Generators

At this time the generators are limited to just creating facts, providers, types, functions and schemas. As time goes on I envision more complicated puppet customizations like faces, indirectors, reports, or whatever else the community deems important.



*Note:* the unit tests files created are only meant to get you started. Be aware that these unit test templates are not perfect and will need further refinement. Testing in this area is not well documented so its based of my own experience and imperfect.  Please submit a PR if you find ways to improve these [templates](https://github.com/nwops/retrospec-templates).  



### Auto spec file creation

Each generator will also create associated test files by default without having to use the generator command.  So if there is a existing module without tests for one of these things, retrospec will create the test files automatically. There is no need to run the generator subcommands to generate spec files for existing puppet module ruby files.  



### Creating a new puppet module

You can create a puppet module from scratch using retrospec.

This can be compared to using `puppet module generate` with a skeleton. Retrospec

differs slightly in that you can specify which skeleton/templates to use at creation time.  This is helpful when working with different clients or puppet versions.

Unlike `puppet module generate` retrospec does not force you to create a

directory with a namespace.  This means you do not need to rename anything after creating it. By default retrospec will consult the retrospec config file for default settings which can be overridden on the command line.  Having the config in place can save you a few key strokes.



```

# use -m to specify the module path

retrospec -m /tmp/test_module_123 puppet new_module -n lmc-test123

# or without specifying module_path

cd /tmp/modules

export RETROSPEC_PUPPET_AUTO_GENERATE=true

retrospec puppet new_module -n lmc-test124

 + /private/tmp/modules/lmc-test124/manifests/

 + /private/tmp/modules/lmc-test124/manifests/init.pp  

 + /private/tmp/modules/lmc-test124/metadata.json

```



### Creating a new fact

Creating a new fact is easy with retrospec. Just use the following to

create a fact and unit test.

```

retrospec -m /tmp/test_module_123 puppet new_fact -n datacenter

Successfully ran hook: /Users/cosman/github/retrospec-templates/clone-hook

 + /private/tmp/modules/test123/lib/facter/

 + /private/tmp/modules/test123/lib/facter/datacenter.rb

 + /private/tmp/modules/test123/spec/unit/facter/

 + /private/tmp/modules/test123/spec/unit/facter/datacenter_spec.rb

```



### Creating a new provider

Create a new provider is easy.  Just specify the puppet type you want the generator

to use and the stub code for a provider and provider test file will be created.



```

cd testabc124

retrospec puppet new_provider -t package -n ibm_pkg

Successfully ran hook: /Users/user1/retrospec-templates/clone-hook



 + /tmp/testabc124/lib/puppet/provider/package/

 + /tmp/testabc124/lib/puppet/provider/package/ibm_pkg.rb

Successfully ran hook: /Users/user1/retrospec-templates/pre-hook

```

### Creating a new function

Creating a new function is just as easy as other generators. Use the new_function

sub command and specify the name.  Specify `--type v4` if you wish to create

a new 'v4' function, otherwise v3 is the default. Since testing functions

can be done in both rspec-ruby and rspec-puppet you can specify the test type as

well and retrospec will default to `rspec-puppet`.



```

cd testabc124

retrospec puppet new_function -n is_url

Successfully ran hook: /Users/user1/retrospec-templates/clone-hook

+ /private/tmp/testabc124/lib/puppet/parser/functions/

+ /private/tmp/testabc124/lib/puppet/parser/functions/is_url.rb

```



### Creating a new type

Creating a type is similar to any other generator. You can specify which parameters,

properties, and providers to generate. Retrospec will generate a default provider

if none are specified.



```

retrospec puppet new_type -n test_type --parameters param1 param2 --properties prop1 prop2 --providers default

Successfully ran hook: /Users/user1/retrospec-templates/clone-hook



 + /private/tmp/testabc124/lib/puppet/type/

 + /private/tmp/testabc124/lib/puppet/type/test_type.rb

 + /private/tmp/testabc124/lib/puppet/provider/test_type/

 + /private/tmp/testabc124/lib/puppet/provider/test_type/default.rb

Successfully ran hook: /Users/user1/retrospec-templates/pre-hook

```

### Creating a new module schema file

Schema files are something I came up with recently and something I have found useful for various things. These schema files map all the puppet parameters in the classes and defines you have inside your module. You can use these schema files for validating hiera, generating documentation, or to serve as parameter documentation.  At this time the generator map only known datatypes so its up to you to define some of the complex data structures you have for puppet parameters.

Maintaining a schema file is optional, but is incredible useful for people using your module and validating hiera data. Schema files are generated by default with every `retrospec puppet` run.



```

cd testabc124

retrospec puppet

+ /private/tmp/testabc124/testabc124_schema.yaml

```



## Configuration

 Below is a list of options that you can set in the config file.  Setting these options will help cut down on passing parameters. (/Users/username/.retrospec/config.yaml)  `retrospec -h`



 *Note:* if might be useful to have several config files for different clients or

 situations where you want to easily swap out templates or options.

 `retrospec --config-map /Users/user1/.retrospec/client1.yaml`



```yaml

# used by the main puppet plugin and every subcommand

plugins::puppet::templates::url: https://github.com/nwops/retrospec-templates

plugins::puppet::templates::ref: master

plugins::puppet::enable_beaker_tests: true

plugins::puppet::enable_future_parser: true

plugins::puppet::template_dir: /Users/username/.retrospec/repos/retrospec-puppet-templates

# used when creating new modules

plugins::puppet::namespace: organization

plugins::puppet::default_license: 'Apache-2.0'

plugins::puppet::author: your_name

# used when creating new functions

plugins::puppet::default_function_version: v3

plugins::puppet::default_function_test_type: rspec



```



*Note:* your not required to set any of these as they can be specified on the cli and also default to reasonable values.



## Example

Below you can see that it creates files for every resource in the apache module in addition to other files that you need for unit testing puppet code. Rspec-puppet best practices says to put definitions in a defines folder and classes in a classes folder since it infers what kind of resource it is based on this convention.  Retrospec sets up this scaffolding for you.  Don't like the files that came with your module?  Simply delete the files and regenerate them with `puppet retrospec`.



```shell

$ pwd

/Users/cosman/github/puppetlabs-apache

$ retrospec puppet

 + /Users/cosman/github/puppetlabs-apache/Gemfile

  + /Users/cosman/github/puppetlabs-apache/Rakefile

  + /Users/cosman/github/puppetlabs-apache/spec/

  + /Users/cosman/github/puppetlabs-apache/spec/shared_contexts.rb

  + /Users/cosman/github/puppetlabs-apache/spec/spec_helper.rb

  + /Users/cosman/github/puppetlabs-apache/.fixtures.yml

  + /Users/cosman/github/puppetlabs-apache/.gitignore

  + /Users/cosman/github/puppetlabs-apache/.travis.yml

  + /Users/cosman/github/puppetlabs-apache/spec/classes/

  + /Users/cosman/github/puppetlabs-apache/spec/classes/default_mods_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/classes/dev_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/disk_cache_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/classes/service_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/classes/ssl_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/defines/

  + /Users/cosman/github/puppetlabs-apache/spec/defines/balancer_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/defines/balancermember_spec.rb

  + /Users/cosman/github/puppetlabs-apache/spec/defines/vhost_spec.rb



```



Looking at the file we can see that it did a lot of work for us.  Retrospec generated many tests automatically. However the variable resolution isn't perfect so you will need to manually resolve some variables.  This doesn't produce 100% coverage but all you did was press enter to produce all this anyways. Below is the classes/apache_spec.rb file.  Notice that while Retrospec created all these files, you still need to do more work.

Retrospec is only here to setup your module for testing, which might save you several hours each time you create a module. Below I'll go through the different parts of automation that you can use in your testing.



```ruby

require 'spec_helper'

require 'shared_contexts'



describe 'apache' do

  # by default the hiera integration uses hiera data from the shared_contexts.rb file

  # but basically to mock hiera you first need to add a key/value pair

  # to the specific context in the spec/shared_contexts.rb file

  # Note: you can only use a single hiera context per describe/context block

  # rspec-puppet does not allow you to swap out hiera data on a per test block

  #include_context :hiera



  # below is the facts hash that gives you the ability to mock

  # facts on a per describe/context block.  If you use a fact in your

  # manifest you should mock the facts below.

  let(:facts) do

    {}

  end

  # below is a list of the resource parameters that you can override.

  # By default all non-required parameters are commented out,

  # while all required parameters will require you to add a value

  let(:params) do

    {

      #:default_mods => true,

      #:default_vhost => true,

      #:default_ssl_vhost => false,

      #:default_ssl_cert => $apache::params::default_ssl_cert,

      #:default_ssl_key => $apache::params::default_ssl_key,

      #:default_ssl_chain => undef,

      #:default_ssl_ca => undef,

      #:default_ssl_crl_path => undef,

      #:default_ssl_crl => undef,

      #:service_enable => true,

      #:logroot => $apache::params::logroot,

      #:ports_file => $apache::params::ports_file,

      #:server_tokens => "OS",

      #:server_signature => "On",

    }

  end

  # add these two lines in a single test block to enable puppet and hiera debug mode

  # Puppet::Util::Log.level = :debug

  # Puppet::Util::Log.newdestination(:console)

  it do

    is_expected.to contain_package('httpd').

             with({"ensure"=>"installed",

                   "name"=>"$apache::params::apache_name",

                   "notify"=>"Class[Apache::Service]"})

  end

  it do

    is_expected.to contain_group('$apache::params::group').

             with({"ensure"=>"present",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_user('$apache::params::user').

             with({"ensure"=>"present",

                   "gid"=>"$apache::params::group",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_class('apache::service').

             with({"service_enable"=>"true"})

  end

  it do

    is_expected.to contain_exec('mkdir $apache::params::confd_dir').

             with({"creates"=>"$apache::params::confd_dir",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_file('$apache::params::confd_dir').

             with({"ensure"=>"directory",

                   "recurse"=>"true",

                   "purge"=>"$purge_confd",

                   "notify"=>"Class[Apache::Service]",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_concat('$apache::params::ports_file').

             with({"owner"=>"root",

                   "group"=>"root",

                   "mode"=>"0644",

                   "notify"=>"Class[Apache::Service]",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_concat__fragment('Apache ports header').

             with({"target"=>"$apache::params::ports_file",

                   "content"=>"template(apache/ports_header.erb)"})

  end

  it do

    is_expected.to contain_exec('mkdir $apache::params::mod_dir').

             with({"creates"=>"$apache::params::mod_dir",

                   "require"=>"Package[httpd]"})

  end

  it do

    is_expected.to contain_file('$apache::params::conf_dir/$apache::params::conf_file').

             with({"ensure"=>"file",

                   "content"=>"template($conf_template)",

                   "notify"=>"Class[Apache::Service]",

                   "require"=>"Package[httpd]"})

  end

end



```



## About the test suite

At this time the test suite that is automatically generated is very basic.  Essentially it just creates a test for every resource not in a code block with the exception of conditional code blocks.  While this might be all you need, the more complex your code is the less retrospec will generate until further improvements to the generator are made.



However, one of the major stumbling blocks is just constructing everything in the spec

directory which retrospec does for you automatically.  Its now up to you to further enhance your test suite with more tests and conditional logic using describe blocks and such.  You will notice that some variables are not resolved. Currently this is a limitation that I hope to overcome, but until now its up to you to manually resolve those variables prefixed with a '$'.



Example:



```ruby

should contain_file('$::tomcat::params::catalina_home').

             with({"ensure"=>"directory",

                   "owner"=>"$::tomcat::params::user",

                   "group"=>"$::tomcat::params::group"})



```



For now you will probably want to read up on the following documentation:



* [Puppet Rspec](http://rspec-puppet.com)

* [Puppet spec helper](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/master/README.markdown)



## How Does it do this

Basically Retrospec uses the puppet lexer and parser to scan your code in order to fill out some basic templates that will retrofit your puppet module with unit tests.



## Overriding the Templates

There may be a time when you want to override the default templates used to generate the rspec related files. By default retrospec will clone these [templates](https://github.com/nwops/retrospec-templates) and place inside the default or specified template directory.  



```shell

-t, --template-dir=        Path to templates directory (only for overriding Retrospec templates) (default: /Users/cosman/github/retrospec-templates)

-s, --scm-url=             SCM url for retrospec templates (default: [email protected]:nwops/retrospec-templates.git)

-b, --branch=              Branch you want to use for the retrospec template repo (default: master)



```



### Environment variables to set template defaults

RETROSPEC_PUPPET_SCM_URL  # set this to auto set your scm url to the templates

RETROSPEC_PUPPET_SCM_REF (from version 1.6.0)  # set this to auto checkout a particular branch (only works upon initial checkout)

RETROSPEC_PUPPET_SCM_BRANCH :same as RETROSPEC_PUPPET_SCM_REF. Use this in version before 1.6.0. As of this version, RETROSPEC_PUPPET_SCM_REF takes precedence.



After running retrospec, retrospec will clone the templates from the default template url or from whatever you set to the templates path.  If you have already created the erb file in the templates location, then retrospec will not overwrite the file as there will be a SCM conflict. You can use multiple template paths if you use them for different projects so just be sure the set the correct template option when running retrospec.  `retrospec -t`



The default user location for the templates when not using `retrospec -t` variable is ~/.retrospec/repos/retrospec-puppet-templates



Example:

`--template-dir=~/my_templates`



## Beaker Testing

Beaker is Puppetlabs acceptance testing framework that you use to test puppet code on real machines.  Beaker is fairly new and is subject to frequent changes.  Testing patterns have not been established yet so consider beaker support in puppet-retrospec

to be experimental.



If you wish to enable the creation of beaker tests you can use the following cli option.  By default these acceptance tests are not created.  However at a later time they will be enabled by default.



`--enable-beaker-tests`



I am no expert in Beaker so if you see an issue with the templates, acceptance_spec_helper or other workflow, please issue a PR.



## Troubleshooting

If you see the following, this error means that you need to add a fixture to the fixtures file. At this time I have no idea what your module requires.  So just add the module that this class belongs to in the .fixtures file.



See [fixtures doc](https://github.com/puppetlabs/puppetlabs_spec_helper#using-fixtures) for more information



```shell

8) tomcat::instance::source

     Failure/Error: it { should compile }

     Puppet::Error:

       Could not find class staging for coreys-macbook-pro-2.local on node coreys-macbook-pro-2.local

     # ./spec/defines/instance/source_spec.rb:34:in `block (2 levels) in '

```



If you see something like the following, this means your current module is using a much older version of Rspec.  Retrospec uses Rspec 3 syntax so you need to update your rspec version.  If you have tests that using older rspec syntax, take a look

at [transpec](https://github.com/yujinakayama/transpec)



```shell

   103) apache::vhost

        Failure/Error: is_expected.to contain_file('').

        NameError:

          undefined local variable or method `is_expected' for #

        # ./spec/defines/vhost_spec.rb:103:in `block (2 levels) in '



```



If your tests will not run after running retrospec. Your spec_helper, Rakefile and Gemfile may not be compatible with the pre-defined templates.  Just delete these files and re-run retrospec to recreate them.  Add back any modifications you might have had.



## Running Retrospec Tests

Puppet-retrospec tests its code against real modules downloaded directly from puppet forge.



To run a clean test suite and re-download you must run with environment variable set

```

RETROSPEC_CLEAN_UP_TEST_MODULES=true bundle exec rake spec

```



Otherwise to save time we skip the removal of test puppet modules therefore we don't re-download

```

bundle exec rake spec

```



## Understanding Variable Resolution

Because the code does not rely on catalog compilation we have to build our own scope through non trival methods.  Some variables will get resolved while others will not.  As this project progresses we might find a better way at resolving variables.  For now, some variable will require manual interpolation.



### Variable Resolution workflow.



1. load code in parser and find all parameters. Store these parameter values.

2. Find all vardef objects, resolve them if possible and store the values

3. Anything contained in a block of code is currently ignored, until later refinement.



## Puppet 4.x Support

As of 1.0.0 Retrospec Puppet provides full support for code written against the 4.x/future parser.

If you have 3.x code the 4.x parser may throw errors instead of deprecation warnings.

If you do not wish to convert your 3.x to 4.x code yet, you will need to use the puppet-retrospec

version < 1.0.0



## Ruby Support

Currently this library only supports ruby >= 1.9.3.  Since we vendor Puppet 4.5.x you need to have

a supported ruby version that puppet 4.5 supports which.  



## Paid Support

Want to see new features developed faster?  Contact me about a support contract so I can develop this tool during

the day instead of after work.  contact: [email protected]