puppet_module_packaging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 355d955a3532b7fd7bec451b8177c3220247f5f1
+  data.tar.gz: 6d8e077720efe12fe7c556dd77af6cf09a3a62ae
+SHA512:
+  metadata.gz: c19b218cdeafa6f4f11362842c3e4e4198905bf62da25cb415decf44094c8bdcaf03abdc2397719dfa2412b768be61a04ede7815a91fd301b158eabaf65c692c
+  data.tar.gz: 9dac89efa58e82ac8e090f9f8fdc3bcafc8a87f5ffbca2e3875f1045206ee5e4095e9d65d5dd128243b584c9cb6c0073601da3d8270bb50562b71faf2f04db7c

data/.gitignore

@@ -0,0 +1,12 @@
+*.swp
+*.swo
+.bundle
+.envrc
+.vagrant
+Gemfile.lock
+vendor
+#! IMPORTANT as we don't want to commit things built by tests (esp. packages)
+**/pkg
+!lib/**/pkg
+test/fixture/**/build
+#! IMPORTANT

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-19mode
+
+bundler_args: --path vendor/bundle
+
+before_install:
+  - sudo apt-get install rpm
+
+script:
+  - bundle exec rake test:all

data/Changelog.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.0.1
+
+* Add `rpm`, `deb`, `install` and `clean` tasks.
+* Recognize all the `Modulefile` fields except dependencies.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefano Zanella
+
+MIT License
+
+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/README.md

@@ -0,0 +1,90 @@
+# Puppet Module Packaging
+
+[![Build Status](https://travis-ci.org/stefanozanella/puppet_module_packaging.png?branch=master)](https://travis-ci.org/stefanozanella/puppet_module_packaging)
+
+Provides Rake tasks to ease shipping of Puppet modules as proper system
+packages.
+
+Currently, it provides tasks to build Debian and RPM packages. To do that, it
+uses excellent Jordan Sissel's [fpm](https://github.com/jordansissel/fpm).
+
+**NOTE**: at this stage, this library lacks a bunch of useful features
+(particularly, its behavior can't be customized in any way and there's no
+dependency management). Feel free to
+submit issues or PRs if there's something that could help you out and you'd
+like to see integrated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puppet_module_packaging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppet_module_packaging
+
+## Usage
+
+To have the shipped Rake tasks available for your module, just add the
+following line to your `Rakefile`:
+
+    require 'puppet_module_packaging/rake_task'
+
+This will add the following tasks to your set:
+
+* `install`
+* `clean`
+* `deb`
+* `rpm`
+
+To package your module, you only need to call the `deb` or `rpm` one.
+The package will be output into the `pkg` folder; you can see the packaged
+content into the `build` folder. _Package name_ will respect the following
+format:
+
+    puppet-mod-<author>-<module_name>
+
+The information needed to build the package are carved out from the
+`Modulefile`. In particular, there must be a `name` and a `version` field; the
+first one must be in the form `author/module_name`. All other fields are
+optional and are mapped into package fields with equivalent meaning.
+
+**NOTE**: The module will be installed under `/usr/share/puppet/modules`, not
+into `/etc/puppet`!
+
+## Compatibility
+
+OS compatibility resembles the one of FPM; in particular:
+
+* on **OS X**, only Debian packages can be built
+* in order to create RPMs on other platforms, the `rpmbuild` command must be
+  present on the system. This can be obtained with:
+  * `apt-get install rpm` (Debian-based)
+  * `yum install rpm-build` (RedHat-based)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+
+Executed tests vary depending on tools availability. In particular, end-to-end
+tests involving generation of an RPM package are not run if `rpmbuild` is not
+found on the system. To ease development, a `Vagrantfile` is provided, complete
+with a Puppet manifest to configure the testing host. If you wish to run all
+the tests without installing `rpmbuild`, you can just do the following:
+
+    vagrant up
+    vagrant ssh
+    cd /vagrant
+    bundle install --path vendor/bundle
+    bundle exec rake test:all

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+require 'rubygems/tasks'
+
+namespace :test do
+  suites = [:end_to_end, :unit, :integration]
+
+  desc "Run all test suites"
+  task :all => suites
+
+  suites.each do |suite|
+    Rake::TestTask.new suite do |t|
+      t.libs << 'lib'
+      t.libs << 'test'
+      t.pattern = "test/#{suite}/**/*.rb"
+      t.verbose = true
+    end
+  end
+end
+
+Gem::Tasks.new
+
+task :default => "test:all"

data/Vagrantfile

@@ -0,0 +1,11 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "ubuntu-base-oss"
+  config.vm.box_url = "http://vagrantboxes.derecom.it/boxes/ubuntu-base-oss.box"
+  config.vm.provision :puppet do |puppet|
+    puppet.manifests_path = "test"
+    puppet.manifest_file  = "test_vm.pp"
+  end
+end

data/lib/puppet_module/pkg/tasks/build.rb

@@ -0,0 +1,120 @@
+class Class
+  def type(sym)
+    self.class_eval <<-EOS
+      def type
+        "#{sym.to_s}"
+      end
+    EOS
+  end
+
+  def filename(str)
+    self.class_eval <<-EOS
+      def filename
+        "#{str}"
+      end
+    EOS
+  end
+end
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      class Build
+        def initialize(system)
+          @sys = system
+        end
+
+        def invoke(mod, opts)
+          self.modinfo = mod
+          self.build_opts = opts
+
+          @sys.mkdir opts.pkg_dir
+          @sys.sh("fpm #{fpm_opts} #{installed_files}")
+        end
+
+        def type
+          raise NotImplementedError
+        end
+
+        def filename
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_accessor :modinfo
+        attr_accessor :build_opts
+
+        def fpm_opts
+          [ src_fmt,
+            dest_fmt,
+            name,
+            version,
+            arch,
+            maintainer,
+            url,
+            description,
+            license,
+            chdir,
+            output ].join " "
+        end
+
+        def pkg_name
+          "puppet-mod-#{modinfo.author}-#{modinfo.name}"
+        end
+
+        def name
+          "-n #{pkg_name}"
+        end
+
+        def version
+          "-v #{modinfo.version}"
+        end
+
+        def arch
+          "-a all"
+        end
+
+        def maintainer
+          optionally('-m', modinfo.author_full)
+        end
+
+        def url
+          optionally('--url', modinfo.project_page)
+        end
+
+        def description
+          optionally('--description', modinfo.summary)
+        end
+
+        def license
+          optionally('--license', modinfo.license)
+        end
+
+        def src_fmt
+          "-s dir"
+        end
+
+        def chdir
+          "-C #{build_opts.install_dir}"
+        end
+
+        def installed_files
+          "."
+        end
+
+        def output
+          "-p #{build_opts.pkg_dir}/#{filename}"
+        end
+
+        def dest_fmt
+          "-t #{type}"
+        end
+
+        def optionally(switch, field)
+          field ? "#{switch} '#{field}'" : ""
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/clean.rb

@@ -0,0 +1,15 @@
+module PuppetModule
+  module Pkg
+    class Tasks
+      class Clean
+        def initialize(system)
+          @sys = system
+        end
+
+        def invoke(mod, opts)
+          @sys.rm opts.install_dir
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/deb.rb

@@ -0,0 +1,13 @@
+require 'puppet_module/pkg/tasks/build'
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      class Deb < Build
+        type :deb
+
+        filename '#{pkg_name}_VERSION_ARCH.deb'
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/install.rb

@@ -0,0 +1,33 @@
+module PuppetModule
+  module Pkg
+    class Tasks
+      class Install
+        def initialize(system)
+          @sys = system
+        end
+
+        def invoke(mod, opts)
+          @mod_name = mod.name
+          @out_dir = opts.install_dir
+
+          @sys.mkdir install_path
+          @sys.cp assets_to_install, install_path
+        end
+
+        private
+
+        def install_path
+          File.join(@out_dir, dest_path, @mod_name)
+        end
+
+        def dest_path
+          '/usr/share/puppet/modules'
+        end
+
+        def assets_to_install
+          ['manifests','templates','lib','files']
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/modulefile.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      class Modulefile
+        def self.parse(file)
+          self.new(File.read(file)).metadata
+        end
+
+        attr_reader :metadata
+
+        def initialize(str)
+          @metadata = OpenStruct.new
+          binding.eval str
+          validate_required_fields
+        end
+
+        def method_missing(*args)
+          # TODO: Maybe display an info message about the
+          # unrecognized/unsupported field? (it might be a typo, so the user
+          # might be happy to know what have been ignored)
+        end
+
+        private
+
+        def name(s)
+          @metadata.author, @metadata.name = s.split '/'
+        end
+
+        def version(s)
+          @metadata.version = s
+        end
+
+        def source(s)
+          @metadata.source = s
+        end
+
+        def author(s)
+          @metadata.author_full = s
+        end
+
+        def license(s)
+          @metadata.license = s
+        end
+
+        def summary(s)
+          @metadata.summary = s
+        end
+
+        def description(s)
+          @metadata.description = s
+        end
+
+        def project_page(s)
+          @metadata.project_page = s
+        end
+
+        def validate_required_fields
+          raise ArgumentError, 'Modulefile doesn`t contain name or author' unless
+            @metadata.name and @metadata.author
+
+          raise ArgumentError, 'Modulefile doesn`t contain version information' unless
+            @metadata.version
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/rake_tasks.rb

@@ -0,0 +1,42 @@
+require 'rake/tasklib'
+
+require 'puppet_module/pkg/tasks/system'
+require 'puppet_module/pkg/tasks/deb'
+require 'puppet_module/pkg/tasks/rpm'
+require 'puppet_module/pkg/tasks/install'
+require 'puppet_module/pkg/tasks/clean'
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      class RakeTasks < Rake::TaskLib
+        def initialize(mod_info)
+          sys = System.new
+          options = OpenStruct.new(
+            :install_dir => 'build',
+            :pkg_dir     => 'pkg')
+
+          desc "Install the module in a local temp dir"
+          task :install => :clean do
+            Install.new(sys).invoke(mod_info, options)
+          end
+
+          desc "Clean build artifacts"
+          task :clean do
+            Clean.new(sys).invoke(mod_info, options)
+          end
+
+          desc "Wraps the module into a Debian package"
+          task :deb => :install do
+            Deb.new(sys).invoke(mod_info, options)
+          end
+
+          desc "Wraps the module into a RPM package"
+          task :rpm => :install do
+            RPM.new(sys).invoke(mod_info, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/rpm.rb

@@ -0,0 +1,13 @@
+require 'puppet_module/pkg/tasks/build'
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      class RPM < Build
+        type :rpm
+
+        filename '#{pkg_name}-VERSION.ARCH.rpm'
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks/system.rb

@@ -0,0 +1,25 @@
+module PuppetModule
+  module Pkg
+    class Tasks
+      class System
+        def mkdir(path)
+          FileUtils.mkdir_p path
+        end
+
+        def cp(src, dest)
+          sanitized_src = src.is_a?(Range) ? src.to_a : src
+
+          FileUtils.cp_r sanitized_src, dest
+        end
+
+        def rm(path)
+          FileUtils.rm_rf path
+        end
+
+        def sh(cmd)
+          `#{cmd}`
+        end
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/tasks.rb

@@ -0,0 +1,13 @@
+require 'puppet_module/pkg/tasks/rake_tasks'
+
+require 'puppet_module/pkg/tasks/modulefile'
+
+module PuppetModule
+  module Pkg
+    class Tasks
+      def initialize
+        RakeTasks.new(Modulefile.parse("Modulefile"))
+      end
+    end
+  end
+end

data/lib/puppet_module/pkg/version.rb

@@ -0,0 +1,5 @@
+module PuppetModule
+  module Pkg
+    VERSION = "0.0.1"
+  end
+end

data/puppet_module_packaging.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'pathname'
+require 'puppet_module/pkg/version'
+
+signing_key_file = ENV['RUBYGEMS_SIGNING_KEY_FILE']
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet_module_packaging"
+  spec.version       = PuppetModule::Pkg::VERSION
+  spec.authors       = ["Stefano Zanella"]
+  spec.email         = ["zanella.stefano@gmail.com"]
+  spec.summary       = %q{Rake tasks for packaging Puppet modules}
+  spec.homepage      = "https://github.com/stefanozanella/puppet_module_packaging"
+  spec.license       = "MIT"
+  spec.description   = <<-EOS
+    puppet_module_packaging provides some Rake tasks to ease wrapping Puppet
+    modules into proper system packages like deb and rpm.
+  EOS
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fpm", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubygems-tasks"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-filesystem"
+  spec.add_development_dependency "minitest-around"
+  spec.add_development_dependency "mocha"
+
+  spec.signing_key = Pathname.new(signing_key_file).expand_path if signing_key_file
+  spec.cert_chain = ["rubygems-stefanozanella.crt"]
+end

data/rubygems-stefanozanella.crt

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA96YW5l
+bGxhLnN0ZWZhbm8xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+ARkWA2NvbTAeFw0xMzA4MDcxOTA2MDZaFw0xNDA4MDcxOTA2MDZaMEYxGDAWBgNV
+BAMMD3phbmVsbGEuc3RlZmFubzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+2JCnJCnjjs62MR/Tw/4WgSG42ruiCEqXV1ECMsXymHPE8xyHkYAwLXvBRzOkZ/IA
+puJ1XhScduMRcUuE0ZPA5N2HBZI0WsmyyNTYBjOob8m0SNInoRZfIMloj3D8QzB7
+/6G5HLMWNx60JEpIDgfXvIuSRKNKQ0/0+/G/H4COgj72pd3F4dYltvx+mSwPRq7Q
+MdZsK3T5Q3d4eLBY1VSlJpq0wkwdEWTXAhR0Mfmbn1D8m9IhJfubgXuXVBY4OPO8
+KAF/wWqTkzA6guVQlSKdZR4vwms7OpeFkotnivBKa6JwUQSXO8AZEyy53V8cSYDu
+dbaFi53YbEwOWSMQnW8/kQIDAQABozkwNzAdBgNVHQ4EFgQUcBKkmJAvSTKfDf7z
+LEu1wE+Rk+swCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQAD
+ggEBAMeqfk1l4Y0iZ8jNiu0afcQ60DVqBkRtrT/rsZEqGsdOw11bntOE4yWpo4Kd
+Y0C/kYrVQ/mIN7IGKbCSjES3aYdQftV9SRW77FA25m2KXRbnEYtJDUX35gAqSdRY
+9IiYivsMq2dr70eKPNFrFOwWvmwhcGyEG8EDvYoXWllke7RGz1Dn/AZx6jPnShO+
+0ru4OXsM9++md3sGXIugEFNygvo2/1yQoTe6+XiBocS+pWsJd6JZBfkxPRT4Dz4H
+RigBD0E3/t/ABjCXkmqwp5gnAZmP8JiVUkn8rp5E0FXvC8T7nsPs2TW/TAmUV6rN
+hK25FX8YWgT9fD9y3PpWjiYcrCo=
+-----END CERTIFICATE-----

data/test/end_to_end/clean_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+describe 'clean task' do
+  around do |t|
+    do_into_tmp_module('testmod', t)
+  end
+
+  it 'removes the directories produced by the install task' do
+    `rake install`
+    `rake clean`
+
+    refute directory?('build'), 'expected build dir to have been wiped, but it was still there'
+  end
+end

data/test/end_to_end/install_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+describe 'install task' do
+  around do |t|
+    do_into_tmp_module('testmod', t)
+  end
+
+  describe 'by default' do
+    let(:output_dir) { 'build/usr/share/puppet/modules/testmod' }
+
+    it 'installs all module dirs into the `build` subfolder' do
+      `rake install`
+
+      assert directory?(output_dir), "expected #{output_dir} to exist, but it didn't"
+      filesystem {
+        dir 'manifests' do
+          file 'init.pp'
+        end
+
+        dir 'files' do
+          file 'example.dat'
+        end
+
+        dir 'templates' do
+          file 'config.erb'
+        end
+
+        dir 'lib' do
+          file 'utils.rb'
+        end
+      }.must_exist_within output_dir
+    end
+  end
+end