beaker-puppet 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzZhZjg0NGIxMjBhNDkyMjQ5NGEyYmNjYzljMTYyZDVmZWFhMmM4YQ==
+  data.tar.gz: !binary |-
+    OTQ0YjQ4MTkzOTAzMWU5ZGYwZjZlNTE1ZTg5MGMxNzk0Y2VmNjBlYw==
+SHA512:
+  metadata.gz: !binary |-
+    NmY3YTljNDMxOGViNTFlYWM3MDJlNmQ3MmU4OTk0MjdkMjE2Y2RmOGU3OWU0
+    Yjc0ZjRjN2I2YWYyZTU0NjJhNjYwZGMwMTBmNDJiYzg3OTBiMjA5ZGI5NDE0
+    YmQ3NzNkY2NmNDhiNGJjNGY0NjRjMTg4Njg1MDU4YTI0Y2YxZGE=
+  data.tar.gz: !binary |-
+    ZjA3NmY0YTcyMDI3NmMxNjc2MWY2YzllODFjMjc0YTZiODE1MzUzZjc5YzFi
+    YjcyZTcyMTljNmM1YTYyN2IwODI5Y2NkZGU5M2M3ZjgxMDc5OWJjYWY4YTRk
+    ZWUwOTc2M2MwZTAwNjA0MmFmMWMxYjNiNDZkYzk4OTZlOTYyOWY=

data/.gitignore

@@ -0,0 +1,25 @@
+*.swp
+log/*
+!.gitignore
+junit
+acceptance-tests
+Gemfile.lock
+options.rb
+test.cfg
+.yardoc
+yard_docs
+coverage
+.bundle
+.vendor
+_vendor
+tmp/
+doc
+# JetBrains IDEA
+*.iml
+.idea/
+# rbenv file
+.ruby-version
+.ruby-gemset
+# Vagrant folder
+.vagrant/
+.vagrant_files/

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.configure do
+  add_filter 'spec/'
+  add_filter 'vendor/'
+  add_filter do |file|
+    file.lines_of_code < 10
+  end
+end
+
+SimpleCov.start if ENV['BEAKER_PUPPET_COVERAGE']

data/Gemfile

@@ -0,0 +1,25 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+gemspec
+
+
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git:[^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+
+group :test do
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.0')
+end
+
+
+if File.exists? "#{__FILE__}.local"
+  eval(File.read("#{__FILE__}.local"), binding)
+end

data/HISTORY.md

@@ -0,0 +1,8 @@
+# worker - History
+## Tags
+* [LATEST - 16 Jun, 2017 (310921d4)](#LATEST)
+
+## Details
+### <a name = "LATEST">LATEST - 16 Jun, 2017 (310921d4)
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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/README.md

@@ -0,0 +1,55 @@
+# beaker-puppet: The Puppet-Specific Beaker Library
+
+The purpose of this library is to hold all puppet-specific info & DSL methods.
+This includes all helper & installer methods.
+
+It might not be up to that state yet, but that's the goal for this library. If
+you see anything puppet-specific that you'd like to pull into this library out
+of beaker, please do, we would love any help that you'd like to provide. 
+
+# How Do I Use This?
+
+### Right Now? (beaker 3.x)
+
+At this point, beaker-puppet is included in beaker, so you don't have to _do_
+anything to get the methods in this library.
+
+You can use these methods in a test by referencing them by name without
+qualifications, as they're included in the beaker DSL by default.
+
+### In beaker's Next Major Version? (beaker 4.x)
+
+In beaker's next major version, the requirement for beaker-puppet will be pulled
+from that repo. When that happens, then the usage pattern will change. In order
+to use this then, you'll need to include beaker-puppet as a dependency right
+next to beaker itself.
+
+Once you've done that & installed the gems, in your test, you'll have to
+```ruby
+require 'beaker-puppet'
+```
+
+Doing this will include (automatically) the beaker-puppet DSL methods in the
+beaker DSL. Then you can call beaker-puppet methods, exactly as you did before.
+
+# How Do I Test This?
+
+### Unit / Spec Testing
+
+You can run the spec testing using our rake task `test:spec:run`. You can also run
+`rspec` directly. If you'd like to see a coverage report, then you can run the
+`test:spec:coverage` rake task.
+
+### Acceptance Testing
+
+Acceptance testing can be run using the `acceptance` rake test namespace. For
+instance, to test using our package installation, you can run the
+`acceptance:pkg` task.
+
+Note in the above rake tasks that there are some environment variables that you
+can use to customize your run. For specifying your System Under Test (SUT)
+environment, you can use `BEAKER_HOSTS`, passing a file path to a beaker hosts
+file, or you can provide a beaker-hostgenerator value to the `TEST_TARGET`
+environment variable. You can also specify the tests that get executed with the
+`TESTS` environment variable.
+

data/Rakefile

@@ -0,0 +1,299 @@
+require 'rspec/core/rake_task'
+require 'securerandom'
+require 'beaker-hostgenerator'
+
+
+namespace :test do
+
+  namespace :spec do
+
+    desc "Run spec tests"
+    RSpec::Core::RakeTask.new(:run) do |t|
+      t.rspec_opts = ['--color']
+      t.pattern = 'spec/'
+    end
+
+    desc "Run spec tests with coverage"
+    RSpec::Core::RakeTask.new(:coverage) do |t|
+      ENV['BEAKER_PUPPET_COVERAGE'] = 'y'
+      t.rspec_opts = ['--color']
+      t.pattern = 'spec/'
+    end
+
+  end
+
+  namespace :acceptance do
+    USAGE = <<-EOS
+You may set BEAKER_HOSTS=config/nodes/foo.yaml or include it in an acceptance-options.rb for Beaker,
+or specify TEST_TARGET in a form beaker-hostgenerator accepts, e.g. ubuntu1504-64a.
+You may override the default master test target by specifying MASTER_TEST_TARGET.
+You may set TESTS=path/to/test,and/more/tests.
+You may set additional Beaker OPTIONS='--more --options'
+If there is a Beaker options hash in a ./acceptance/local_options.rb, it will be included.
+Commandline options set through the above environment variables will override settings in this file.
+    EOS
+
+    desc <<-EOS
+Run the puppet beaker acceptance tests on a puppet gem install.
+#{USAGE}
+    EOS
+    task :gem  => 'gen_hosts' do
+      beaker_test(:gem)
+    end
+
+    desc <<-EOS
+Run the puppet beaker acceptance tests on a puppet git install.
+#{USAGE}
+    EOS
+    task :git  => 'gen_hosts' do
+      beaker_test(:git)
+    end
+
+    desc <<-EOS
+Run the puppet beaker acceptance tests on a puppet package install.
+#{USAGE}
+    EOS
+    task :pkg => 'gen_hosts' do
+      beaker_test(:pkg)
+    end
+
+    desc <<-EOS
+Run the puppet beaker acceptance tests on a base system (no install).
+#{USAGE}
+    EOS
+    task :base => 'gen_hosts' do
+      beaker_test()
+    end
+
+    desc 'Generate Beaker Host Config File'
+    task :gen_hosts do
+      if hosts_file_env
+        next
+      end
+      cli = BeakerHostGenerator::CLI.new([test_targets])
+      FileUtils.mkdir_p('tmp') # -p ignores when dir already exists
+      File.open("tmp/#{HOSTS_FILE}", 'w') do |fh|
+        fh.print(cli.execute)
+      end
+    end
+
+    def hosts_opt(use_preserved_hosts=false)
+      if use_preserved_hosts
+        "--hosts=#{HOSTS_PRESERVED}"
+      else
+        if hosts_file_env
+          "--hosts=#{hosts_file_env}"
+        else
+          "--hosts=tmp/#{HOSTS_FILE}"
+        end
+      end
+    end
+
+    def hosts_file_env
+      ENV['BEAKER_HOSTS']
+    end
+
+    def agent_target
+      ENV['TEST_TARGET'] || 'redhat7-64af'
+    end
+
+    def master_target
+      ENV['MASTER_TEST_TARGET'] || 'redhat7-64default.mdcal'
+    end
+
+    def test_targets
+      ENV['LAYOUT'] || "#{master_target}-#{agent_target}"
+    end
+
+    HOSTS_FILE = "#{test_targets}-#{SecureRandom.uuid}.yaml"
+    HOSTS_PRESERVED  = 'log/latest/hosts_preserved.yml'
+
+    def beaker_test(mode = :base, options = {})
+
+      preserved_hosts_mode = options[:hosts] == HOSTS_PRESERVED
+      final_options = HarnessOptions.final_options(mode, options)
+
+      options_opt  = ""
+      # preserved hosts can not be used with an options file (BKR-670)
+      #   one can still use OPTIONS
+
+      if !preserved_hosts_mode
+        options_file = 'merged_options.rb'
+        options_opt  = "--options-file=#{options_file}"
+        File.open(options_file, 'w') do |merged|
+          merged.puts <<-EOS
+# Copy this file to local_options.rb and adjust as needed if you wish to run
+# with some local overrides.
+          EOS
+          merged.puts(final_options)
+        end
+      end
+
+      tests = ENV['TESTS'] || ENV['TEST']
+      tests_opt = ""
+      tests_opt = "--tests=#{tests}" if tests
+
+      overriding_options = ENV['OPTIONS'].to_s
+
+      args = [options_opt, hosts_opt(preserved_hosts_mode), tests_opt,
+              *overriding_options.split(' ')].compact
+
+      sh("beaker", *args)
+    end
+
+    module HarnessOptions
+      defaults = {
+        :tests  => ['tests'],
+        :log_level => 'debug',
+        :preserve_hosts => 'onfail',
+      }
+
+      DEFAULTS = defaults
+
+      def self.get_options(file_path)
+        puts "Attempting to merge config file: #{file_path}"
+        if File.exists? file_path
+          options = eval(File.read(file_path), binding)
+        else
+          puts "No options file found at #{File.expand_path(file_path)}... skipping"
+        end
+        options || {}
+      end
+
+      def self.get_mode_options(mode)
+        get_options("./acceptance/config/#{mode}/acceptance-options.rb")
+      end
+
+      def self.get_local_options
+        get_options('./acceptance/local_options.rb')
+      end
+
+      def self.final_options(mode, intermediary_options = {})
+        mode_options = get_mode_options(mode)
+        local_overrides = get_local_options
+        final_options = DEFAULTS.merge(mode_options)
+        final_options.merge!(intermediary_options)
+        final_options.merge!(local_overrides)
+      end
+
+    end
+
+  end
+
+end
+
+# namespace-named default tasks.
+# these are the default tasks invoked when only the namespace is referenced.
+# they're needed because `task :default` in those blocks doesn't work as expected.
+task 'test:spec' => 'test:spec:run'
+task 'test:acceptance' => 'test:acceptance:quick'
+
+# global defaults
+task :test => 'test:spec'
+task :default => :test
+
+###########################################################
+#
+#   Documentation Tasks
+#
+###########################################################
+DOCS_DAEMON = "yard server --reload --daemon --server thin"
+FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker'
+
+def running?( cmdline )
+  ps = `ps -ef`
+  found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ )
+  if found.length > 1
+    raise StandardError, "Found multiple YARD Servers. Don't know what to do."
+  end
+
+  yes = found.empty? ? false : true
+  return yes, found.first
+end
+
+def pid_from( output )
+  output.squeeze(' ').strip.split(' ')[1]
+end
+
+desc 'Start the documentation server in the foreground'
+task :docs => 'docs:clear' do
+  original_dir = Dir.pwd
+  Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+  sh FOREGROUND_SERVER
+  Dir.chdir( original_dir )
+end
+
+namespace :docs do
+
+  desc 'Clear the generated documentation cache'
+  task :clear do
+    original_dir = Dir.pwd
+    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+    sh 'rm -rf docs'
+    Dir.chdir( original_dir )
+  end
+
+  desc 'Generate static documentation'
+  task :gen => 'docs:clear' do
+    original_dir = Dir.pwd
+    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+    output = `bundle exec yard doc`
+    puts output
+    if output =~ /\[warn\]|\[error\]/
+      fail "Errors/Warnings during yard documentation generation"
+    end
+    Dir.chdir( original_dir )
+  end
+
+  desc 'Run the documentation server in the background, alias `bg`'
+  task :background => 'docs:clear' do
+    yes, output = running?( DOCS_DAEMON )
+    if yes
+      puts "Not starting a new YARD Server..."
+      puts "Found one running with pid #{pid_from( output )}."
+    else
+      original_dir = Dir.pwd
+      Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
+      sh "bundle exec #{DOCS_DAEMON}"
+      Dir.chdir( original_dir )
+    end
+  end
+
+  task(:bg) { Rake::Task['docs:background'].invoke }
+
+  desc 'Check the status of the documentation server'
+  task :status do
+    yes, output = running?( DOCS_DAEMON )
+    if yes
+      pid = pid_from( output )
+      puts "Found a YARD Server running with pid #{pid}"
+    else
+      puts "Could not find a running YARD Server."
+    end
+  end
+
+  desc "Stop a running YARD Server"
+  task :stop do
+    yes, output = running?( DOCS_DAEMON )
+    if yes
+      pid = pid_from( output )
+      puts "Found a YARD Server running with pid #{pid}"
+      `kill #{pid}`
+      puts "Stopping..."
+      yes, output = running?( DOCS_DAEMON )
+      if yes
+        `kill -9 #{pid}`
+        yes, output = running?( DOCS_DAEMON )
+        if yes
+          puts "Could not Stop Server!"
+        else
+          puts "Server stopped."
+        end
+      else
+        puts "Server stopped."
+      end
+    else
+      puts "Could not find a running YARD Server"
+    end
+  end
+end