puppet-magnum 3.0.0

data/generator_files/licenses/apachev2.erb

@@ -0,0 +1,13 @@
+Copyright (c) <%= copyright_year %> <%= copyright_holder %>  
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/generator_files/licenses/mit.erb

@@ -0,0 +1,20 @@
+Copyright (c) <%= copyright_year %> <%= copyright_holder %>  
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/generator_files/licenses/reserved.erb

@@ -0,0 +1,2 @@
+Copyright (c) <%= copyright_year %> <%= copyright_holder %>  
+All Rights Reserved - Do Not Redistribute

data/generator_files/puppet-magnum.init.erb

@@ -0,0 +1 @@
+<%= puppet_magnum_init_timestamp %>

data/generator_files/puppet/init.pp.erb

@@ -0,0 +1,47 @@
+# Class: <%= module_name %>
+# ===========================
+#
+# Full description of class <%= module_name %> here.
+#
+# Parameters
+# ----------
+#
+# Document parameters here.
+#
+# * `sample parameter`
+#  Explanation of what this parameter affects and what it defaults to.
+#  e.g. "Specify one or more upstream ntp servers as an array."
+#
+# Variables
+# ---------
+#
+# Here you should define a list of variables that this module would require.
+#
+# * `sample variable`
+#  Explanation of how this variable affects the function of this class and if
+#  it has a default. e.g. "The parameter enc_ntp_servers must be set by the
+#  External Node Classifier as a comma separated list of hostnames." (Note,
+#  global variables should be avoided in favor of class parameters as
+#  of Puppet 2.6.)
+#
+# Examples
+# --------
+#
+# @example
+#    class { '<%= module_name %>':
+#      servers => [ 'pool.ntp.org', 'ntp.local.company.com' ],
+#    }
+#
+# Authors
+# -------
+#
+# Author Name: <%= maintainer_email %>
+#
+# Copyright
+# ---------
+#
+# Copyright (C) <%= copyright_year %> <%= copyright_holder %>
+#
+class <%= module_name %> {
+
+}

data/generator_files/puppet/metadata.json.erb

@@ -0,0 +1,26 @@
+{
+  "name": "<%= module_name %>",
+  "summary": "<%= module_name %>",
+  "tags": ["<%= module_name %>"],
+  "author": "<%= maintainer_email %>",
+  "license": "<%= license_name %>",
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": ">= 3.2.0"
+    }
+  ],
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+          "14.04"
+      ]
+    }
+  ],
+  "source": "https://example.com",
+  "project_page": "https://example.com",
+  "issues_url": "https://example.com",
+  "data_provider": null,
+  "version": "1.0.0"
+}

data/generator_files/puppet/params.pp.erb

@@ -0,0 +1,16 @@
+# Class: <%= module_name %>::params
+# ===========================
+#
+# Authors
+# -------
+#
+# Author Name: <%= maintainer_email %>
+#
+# Copyright
+# ---------
+#
+# Copyright (C) <%= copyright_year %> <%= copyright_holder %>
+#
+class <%= module_name %>::params {
+
+}

data/generator_files/spec/fixtures.yml.erb

@@ -0,0 +1,9 @@
+# For puppetlabs_spec_helper documentation - see https://github.com/puppetlabs/puppetlabs_spec_helper
+
+fixtures:
+  repositories:
+    stdlib: 'git://github.com/puppetlabs/puppetlabs-stdlib'
+  symlinks:
+    <%= module_name %>/files: '../../../../files'
+    <%= module_name %>/manifests: '../../../../manifests'
+    <%= module_name %>/templates: '../../../../templates'

data/generator_files/spec/rspec.erb

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/generator_files/spec/rspec/init_spec.rb.erb

@@ -0,0 +1,6 @@
+# for rspec-puppet documentation - see http://rspec-puppet.com/tutorial/
+require_relative '../spec_helper'
+
+describe '<%= module_name %>' do
+  it 'should do something'
+end

data/generator_files/spec/rspec/spec_helper.rb.erb

@@ -0,0 +1,10 @@
+require 'rspec-puppet'
+require 'puppetlabs_spec_helper/module_spec_helper'
+require 'puppetlabs_spec_helper/puppetlabs_spec_helper'
+
+fixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))
+
+RSpec.configure do |c|
+  c.module_path = File.join(fixture_path, 'modules')
+  c.manifest_dir = File.join(fixture_path, 'manifests')
+end

data/generator_files/spec/serverspec/init_spec.rb.erb

@@ -0,0 +1,5 @@
+# For serverspec documentation - see http://serverspec.org/tutorial.html
+
+describe '<%= module_name %>' do
+  it 'should do something'
+end

data/generator_files/util/Gemfile.erb

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'colorize'
+
+gem 'puppet', '~> 4.4.1'
+gem 'rspec', '~> 3.1.0'
+gem 'puppet-lint', '~> 1.1.0'
+gem 'rspec-puppet', '~> 2.4.0'
+gem 'puppetlabs_spec_helper', '~> 1.1.1'

data/generator_files/util/Rakefile.erb

@@ -0,0 +1,35 @@
+require 'rake'
+require 'colorize'
+require 'rspec/core/rake_task'
+require 'puppet-lint/tasks/puppet-lint'
+require 'puppetlabs_spec_helper/rake_tasks'
+
+desc 'Run unit tests'
+task :unit do
+  Rake::Task[:spec_prep].invoke
+  Rake::Task[:spec_standalone].invoke
+end
+task :spec => []; Rake::Task[:spec].clear
+task :spec => :unit
+
+desc 'Run syntax, lint and unit tests'
+task :test do
+  Rake::Task[:syntax].invoke
+  Rake::Task[:lint].invoke
+  Rake::Task[:unit].invoke
+end
+
+# puppet-lint options
+Rake::Task[:lint].clear
+PuppetLint::RakeTask.new :lint do |config|
+  config.ignore_paths = ['spec/**/*.pp']
+  config.log_format = '%{path}:%{linenumber}:%{check}:%{KIND}:%{message}'
+  config.disable_checks = [ "class_inherits_from_params_class", "disable_autoloader_layout", "80chars" ]
+  config.fail_on_warnings = false
+end
+
+# remove undesired rake tasks
+task :build => []; Rake::Task[:build].clear
+task :clean => []; Rake::Task[:clean].clear
+task :default => []; Rake::Task[:default].clear
+task :default => :test

data/generator_files/vagrant/Vagrantfile.erb

@@ -0,0 +1,33 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+VAGRANTFILE_API_VERSION = '2'
+
+Vagrant.require_version '>= 1.8.0'
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+
+  # Using Puppet Labs official Vagrant boxes, from: https://atlas.hashicorp.com/puppetlabs
+  config.vm.box = 'puppetlabs/ubuntu-14.04-64-puppet'
+
+  config.vm.provider 'virtualbox' do |vbox|
+    vbox.memory = 1024
+#   vbox.cpus = 2
+  end
+
+  config.vm.provision :shell, :path => '.vagrant_puppet/init.sh'
+
+  config.vm.provision :puppet do |puppet|
+    puppet.environment_path = '.vagrant_puppet/environments'
+    puppet.environment = 'vagrant'
+    puppet.options = '--verbose'
+  end
+
+  config.vm.provision :serverspec do |spec|
+    spec.pattern = 'serverspec/*_spec.rb'
+  end
+
+end
+
+unless Vagrant.has_plugin?('vagrant-serverspec')
+  raise 'vagrant-serverspec is not installed!'
+end

data/generator_files/vagrant/environment/environment.conf.erb

@@ -0,0 +1,18 @@
+# Each environment can have an environment.conf file. Its settings will only
+# affect its own environment. See docs for more info:
+# https://docs.puppetlabs.com/puppet/latest/reference/config_file_environment.html
+
+# Any unspecified settings use default values; some of those defaults are based
+# on puppet.conf settings.
+
+# If these settings include relative file paths, they'll be resolved relative to
+# this environment's directory.
+
+# Allowed settings and default values:
+
+# modulepath = ./modules:$basemodulepath
+# manifest = (default_manifest from puppet.conf, which defaults to ./manifests)
+# config_version = (no script; Puppet will use the time the catalog was compiled)
+# environment_timeout = (environment_timeout from puppet.conf, which defaults to 0)
+    # Note: unless you have a specific reason, we recommend only setting
+    # environment_timeout in puppet.conf.

data/generator_files/vagrant/environment/manifests/init.pp.erb

@@ -0,0 +1 @@
+include <%= module_name %>

data/generator_files/vagrant/init.sh.erb

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+STAGE='/tmp/magnum-vagrant-stage'
+
+FIXTURES_DIR='/vagrant/spec/fixtures/modules'
+VAGRANT_PUPPET_ENV_DIR='/tmp/vagrant-puppet/environments/vagrant'
+
+if [ ! -e $STAGE ]; then
+
+  echo "Initial provision, running the magnum-vagrant shell provisioner script..."
+
+  apt-get update
+
+  mkdir -p $VAGRANT_PUPPET_ENV_DIR
+  ln -sfn $FIXTURES_DIR $VAGRANT_PUPPET_ENV_DIR/modules
+
+  touch $STAGE
+
+else
+  echo "Not initial provision, skipping the magnum-vagrant shell provisioner script..."
+fi
+
+exit 0

data/lib/puppet-magnum.rb

@@ -0,0 +1,13 @@
+require 'thor'
+require 'pathname'
+
+module PuppetMagnum
+  autoload :BaseGenerator,      'puppet-magnum/generators/base_generator'
+  autoload :CreateGenerator,    'puppet-magnum/generators/create_generator'
+  autoload :Cli,                'puppet-magnum/cli'
+  autoload :Module,             'puppet-magnum/cli/module'
+
+  def self.root
+    @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+  end
+end

data/lib/puppet-magnum/cli.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require_relative './version'
+
+module PuppetMagnum
+  class Cli < Thor
+
+    desc 'module', 'Module related tasks. Type \'puppet-magnum module\' for more help.'
+    subcommand 'module', Module
+
+    desc 'version', 'Display version information.'
+    def version
+      puts "puppet-magnum (#{PuppetMagnum::VERSION.chomp})"
+    end
+
+  end
+end

data/lib/puppet-magnum/cli/module.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require 'yaml'
+
+module PuppetMagnum
+  class Module < Thor
+
+    desc 'create [MODULE_NAME]', 'Creates a new Puppet module.'
+    def create(module_name)
+      PuppetMagnum::CreateGenerator.new([File.join(Dir.pwd, module_name), module_name], options).invoke_all
+    end
+
+    desc 'init [MODULE_NAME]', 'Initializes an existing Puppet module.'
+    def init(module_name)
+      PuppetMagnum::CreateGenerator.new([File.join(Dir.pwd, module_name), module_name], options).invoke_all
+    end
+
+    def self.banner(task, namespace = false, subcommand = true)
+      "#{basename} #{task.formatted_usage(self, namespace, subcommand).split(':').join(' ')}"
+    end
+
+    private
+      def options
+        original_options = super
+
+        rcfile = File.expand_path('~/.magnumrc')
+        return original_options unless File.exists?(rcfile)
+
+        defaults = ::YAML::load_file(rcfile) || {}
+        Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
+      end
+  end
+end

data/lib/puppet-magnum/generators/base_generator.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+
+module PuppetMagnum
+  class BaseGenerator < Thor::Group
+    include Thor::Actions
+    include Thor::Shell
+
+    argument :path,
+      type: :string,
+      required: true
+
+    def self.source_root
+      PuppetMagnum.root.join('generator_files')
+    end
+
+    private 
+
+    def target
+      @target ||= Pathname.new(File.expand_path(path))
+    end
+
+  end
+end

data/lib/puppet-magnum/generators/create_generator.rb

@@ -0,0 +1,188 @@
+module PuppetMagnum
+  class CreateGenerator < BaseGenerator
+
+    argument :module_name,
+      type: :string,
+      required: true
+
+    class_option :license,
+      type: :string,
+      default: 'reserved'
+
+    class_option :maintainer,
+      type: :string,
+      default: 'Example, Inc.'
+
+    class_option :maintainer_email,
+      type: :string,
+      default: 'puppet@example.com'
+
+    class_option :copyright_holder,
+      type: :string
+
+    def write_emptydirs
+      empty_directory target.join('manifests')
+      empty_directory target.join('templates')
+      empty_directory target.join('files')
+      empty_directory target.join('spec')
+      empty_directory target.join('serverspec')
+      empty_directory target.join('.vagrant_puppet')
+    end
+
+    def write_readme
+      template 'README.md.erb', target.join('README.md')
+    end
+
+    def write_changelog
+      template 'CHANGELOG.md.erb', target.join('CHANGELOG.md')
+    end
+
+    def write_license
+      template license_file, target.join('LICENSE')
+    end
+
+    def write_metadata_json
+      template 'puppet/metadata.json.erb', target.join('metadata.json')
+    end
+
+    def write_manifests_templates_files
+      template 'puppet/init.pp.erb', target.join('manifests/init.pp')
+      template 'puppet/params.pp.erb', target.join('manifests/params.pp')
+    end
+
+    def write_spec_setup
+      spec_dirs = [ 'classes', 'defines', 'functions', 'hosts', 'unit' ]
+      spec_dirs.each do |dir|
+        empty_directory target.join("spec/#{dir}")
+      end
+
+      empty_directory target.join('spec/fixtures/manifests')
+      create_file target.join('spec/fixtures/manifests/site.pp')
+
+      empty_directory target.join("spec/fixtures/modules/#{module_name}")
+      spec_dirs = ['manifests', 'templates', 'files']
+      spec_dirs.each { |spec_dir|
+        remove_file target.join("spec/fixtures/modules/#{module_name}/#{spec_dir}")
+        create_link target.join("spec/fixtures/modules/#{module_name}/#{spec_dir}"), "../../../../#{spec_dir}"
+      }
+
+      template 'spec/rspec/spec_helper.rb.erb', target.join('spec/spec_helper.rb')
+      template 'spec/rspec/init_spec.rb.erb', target.join("spec/classes/#{module_name}_spec.rb")
+
+      template 'spec/rspec.erb', target.join('.rspec')
+    end
+
+    def write_serverspec_setup
+      template 'spec/serverspec/init_spec.rb.erb', target.join("serverspec/#{module_name}_spec.rb")
+    end
+
+    def write_fixtures
+       template 'spec/fixtures.yml.erb', target.join('.fixtures.yml')
+    end
+
+    def write_gemfile
+      remove_file target.join('Gemfile')
+      template 'util/Gemfile.erb', target.join('Gemfile')
+    end
+
+    def write_rakefile
+      remove_file target.join('Rakefile')
+      template 'util/Rakefile.erb', target.join('Rakefile')
+    end
+
+    def write_vagrantfile
+      template 'vagrant/Vagrantfile.erb', target.join('Vagrantfile')
+      template 'vagrant/init.sh.erb', target.join('.vagrant_puppet/init.sh')
+
+      # create default puppet environment
+      template 'vagrant/environment/environment.conf.erb',
+                target.join('.vagrant_puppet/environments/vagrant/environment.conf')
+      template 'vagrant/environment/manifests/init.pp.erb',
+                target.join('.vagrant_puppet/environments/vagrant/manifests/init.pp')
+    end
+
+    def write_puppet_magnum_init
+      remove_file target.join('.puppet-magnum.init')
+      template 'puppet-magnum.init.erb', target.join('.puppet-magnum.init')
+    end
+
+    # due to the 'git add' operation, this function should be called last
+    def write_git_setup
+      remove_file target.join('.gitignore')
+      template 'git/gitignore.erb', target.join('.gitignore')
+
+      unless File.exists?(target.join('.git'))
+        inside target do
+          run 'git init', capture: true
+          run 'git add -A', capture: true
+        end
+      end
+    end
+
+    private
+
+    def commented(content)
+      content.split("\n").collect { |s| "# #{s}" }.join("\n")
+    end
+
+    def license_name
+      case options[:license]
+      when 'apachev2'; 'Apache 2.0'
+      when 'mit'; 'MIT'
+      when 'reserved'; 'All Rights Reserved'
+      else
+        raise "Unknown license: '#{options[:license]}'"
+      end
+    end
+
+    def license
+      ERB.new(File.read(File.join(self.class.source_root, license_file))).result(binding)
+    end
+
+    def license_file
+      case options[:license]
+      when 'apachev2'; 'licenses/apachev2.erb'
+      when 'mit'; 'licenses/mit.erb'
+      when 'reserved'; 'licenses/reserved.erb'
+      else
+        raise "Unknown license: '#{options[:license]}'"
+      end
+    end
+
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable? exe
+        }
+      end
+      return nil
+    end
+
+    def maintainer
+      options[:maintainer]
+    end
+
+    def maintainer_email
+      options[:maintainer_email]
+    end
+
+    def copyright_year
+      Time.now.year
+    end
+
+    def copyright_holder
+      options[:copyright_holder] || maintainer
+    end
+
+    def puppet_magnum_init_timestamp
+      "puppet-magnum (#{PuppetMagnum::VERSION.chomp}) last initialized this Puppet module directory on #{Time.now.ctime}."
+    end
+
+    def default_options
+      { module_name: module_name }
+    end
+
+  end
+end