Support installing modules from 'puppet://' urls.

Toby McLaughlin · Toby McLaughlin · commit ab02789858ca · 2016-04-29T14:30:43.000+10:00
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ spec/fixtures/artifacts/*
 !spec/fixtures/artifacts/.gitignore
 spec/fixtures/modules/*
 !spec/fixtures/modules/logstash
+files/*.gem
 .bundle
 .vendor
 .vagrant
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,9 @@
 sudo: required
+
+# Use Travis' Ubuntu Trusty machines. They have more RAM.
+# It does not affect which OSs we are testing, since they all provided
+# by Docker containers. This simply defines which OS Docker itself will
+# be running on.
 dist: trusty
 
 services:
@@ -9,10 +14,16 @@ language: ruby
 rvm:
   - 1.9.3
 
-
 script:
- # - make test-unit
-  - travis_wait 30 bundle exec rake beaker
+  # Some of our test can take long time, and not output anything while they
+  # are running. If this goes on for too long (ten minutes), then Travis
+  # will assume the build has stalled, and kill it.
+  #
+  # It' a bit cheeky, but lets make sure that _something_ goes to STDOUT
+  # every five minutes, so that our build won't be killed unjustly.
+  - (while true; do date --iso-8601=seconds; sleep 300; done) &
+  - bundle exec rake beaker 2>&1 | grep -Fv 'localhost $ scp /tmp/beaker'
+  #                         ^ filter out annoying debug lines from Beaker.
 
 env:
   global:
diff --git a/Gemfile b/Gemfile
@@ -22,12 +22,14 @@ gem 'rspec', '~> 3.0'
 gem 'rake'
 gem 'puppet-doc-lint'
 gem 'puppet-lint'
+gem 'puppet-strings'
 gem 'puppetlabs_spec_helper'
 gem 'puppet-syntax'
 gem 'rspec-puppet-facts'
 gem 'rubocop'
 gem 'serverspec'
 gem 'webmock'
+gem 'redcarpet'
 
 # Extra Puppet-lint gems
 gem 'puppet-lint-appends-check', :require => false
diff --git a/Makefile b/Makefile
@@ -1,6 +1,8 @@
 #	opensuse-121 \
 #       sles-11sp3 \
 
+default: deps lint test-unit docs
+
 distros = \
 	centos-6 \
 	centos-7 \
@@ -21,6 +23,9 @@ puppet-module-deps:
 	done
 	touch spec/fixtures/manifests/site.pp
 
+docs:
+	bundle exec puppet strings
+
 lint:
 	bundle exec rake lint
 	bundle exec rake validate
diff --git a/Vagrantfile b/Vagrantfile
@@ -6,9 +6,6 @@
 
 shell_script = <<-END
   if [[ ! -L /usr/local/bin/puppet ]]; then
-    apt-get update
-    apt-get --assume-yes upgrade
-
     for mod in puppetlabs-apt puppetlabs-stdlib electrical-file_concat; do
       puppet module install --target-dir=/opt/puppetlabs/puppet/modules $mod
     done
@@ -26,7 +23,7 @@ module_root = '/etc/puppetlabs/code/environments/production/modules/logstash'
 Vagrant.configure(2) do |config|
   config.vm.box = 'puppetlabs/debian-8.2-64-puppet'
   config.vm.provision('shell', inline: shell_script)
-  %w(manifests templates).each do |dir|
+  %w(manifests templates files).each do |dir|
     config.vm.synced_folder(dir, "#{module_root}/#{dir}")
   end
 end
diff --git a/files/.gitignore b/files/.gitignore
diff --git a/manifests/plugin.pp b/manifests/plugin.pp
@@ -1,24 +1,24 @@
 # Manage the installation of a Logstash plugin.
 #
 # By default, plugins are downloaded from RubyGems, but it is also possible
-# to install from a local Gem.
+# to install from a local Gem, or one stored in Puppet.
 #
 # @example install a plugin
 #   logstash::plugin { 'logstash-input-stdin': }
 #
 # @example remove a plugin
 #   logstash::plugin { 'logstash-input-stout':
-#     ensure => absent
+#     ensure => absent,
 #   }
 #
 # @example install a plugin from a local file
 #   logstash::plugin { 'logstash-input-custom':
-#     source => 'file:///tmp/logstash-input-custom.gem'
+#     source => 'file:///tmp/logstash-input-custom.gem',
 #   }
 #
-# @example install a plugin from a file on the puppetmaster
+# @example install a plugin from a Puppet module.
 #   logstash::plugin { 'logstash-input-custom':
-#     source => 'puppet:///plugin-module/logstash-input-custom.gem'
+#     source => 'puppet:///modules/logstash-site-plugins/logstash-input-custom.gem',
 #   }
 #
 # @param source [String] install from this file, not from RubyGems.
@@ -31,11 +31,34 @@
   require logstash
   $exe = '/opt/logstash/bin/plugin'
 
-  if($source) {
-    $plugin = $source
-  }
-  else {
-    $plugin = $name
+  case $source { # Where should we get the plugin from?
+    undef: {
+      # No explict source, so search Rubygems for the plugin, by name.
+      # ie. "/opt/logstash/bin/plugin install logstash-output-elasticsearch"
+      $plugin = $name
+    }
+
+    /^\//: {
+      # A gem file that is already available on the local filesystem.
+      # Install from the local path.
+      # ie. "/opt/logstash/bin/plugin install /tmp/logtash-filter-custom.gem"
+      $plugin = $source
+    }
+
+    /^puppet:/: {
+      # A 'puppet:///' URL. Download the gem from Puppet, then install
+      # the plugin from the downloaded file.
+      $downloaded_file = sprintf('/tmp/%s', basename($source))
+      file { $downloaded_file:
+        source => $source,
+        before => Exec["install-${name}"],
+      }
+      $plugin = $downloaded_file
+    }
+
+    default: {
+      fail('"source" should be a local path, a "puppet:///" url, or undef.')
+    }
   }
 
   case $ensure {
diff --git a/spec/acceptance/003_plugin_spec.rb b/spec/acceptance/003_plugin_spec.rb
@@ -23,10 +23,17 @@ def installed_plugins
   end
 
   def remove(plugin)
-    stop_logstash
     shell("/opt/logstash/bin/plugin uninstall #{plugin} || true")
   end
 
+  before(:all) do
+    install_logstash
+  end
+
+  before(:each) do
+    stop_logstash
+  end
+
   context 'when output-csv is not installed' do
     before(:each) do
       remove('logstash-output-csv')
@@ -61,7 +68,15 @@ def remove(plugin)
 
   it 'can install a plugin from a local gem' do
     plugin = 'logstash-output-cowsay'
-    ensure_plugin('present', plugin, "source => '/tmp/#{plugin}-0.1.0.gem'")
+    source = "/tmp/#{plugin}-0.1.0.gem"
+    ensure_plugin('present', plugin, "source => '#{source}'")
+    expect(installed_plugins).to contain(plugin)
+  end
+
+  it 'can install a plugin from a "puppet://" url' do
+    plugin = 'logstash-output-cowthink'
+    source = "puppet:///modules/logstash/#{plugin}-0.1.0.gem"
+    ensure_plugin('present', plugin, "source => '#{source}'")
     expect(installed_plugins).to contain(plugin)
   end
 end
diff --git a/spec/fixtures/plugins/logstash-output-cowthink-0.1.0.gem b/spec/fixtures/plugins/logstash-output-cowthink-0.1.0.gem
diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb
@@ -118,6 +118,9 @@ def puppet_enterprise?
   # Provide a Logstash plugin as a local Gem.
   scp_to(host, './spec/fixtures/plugins/logstash-output-cowsay-0.1.0.gem', '/tmp/')
 
+  # ...and another plugin that can be fetched from Puppet with "puppet:///"
+  FileUtils.cp('./spec/fixtures/plugins/logstash-output-cowthink-0.1.0.gem', './files/')
+
   project_root = File.dirname(File.dirname(__FILE__))
   install_dev_puppet_module_on(host, source: project_root, module_name: 'logstash')
   install_puppet_module_via_pmt_on(host, module_name: 'puppetlabs-stdlib')
