beaker-facter 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OThlZDI4MmUxYTY5MTEyZDhlYzA2NmI4MGU2MTI2N2Y0Zjk1OTljNw==
+  data.tar.gz: !binary |-
+    ZGVmYTRiNjEzZjNhYWJlYTIxMzI2MmFkNmRkNmNlYTE3MjA0MDlmMQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTYwM2I1ODI3MjI2ODIyZGFiMWYxZTViZTQ0M2YwZjM0MWM4Yjc2ZWIwNDM0
+    M2RhZmVmMmYyYTk4MmM0NGJmNTNmNmZjYWRkOGE5OWMyZjVlN2EyODZhYjhl
+    N2ZmMzIzZmM5OGIxNDRmNzVjMTQ5NTRiYTI2MmRjN2Q3ZTFlNzQ=
+  data.tar.gz: !binary |-
+    MzM5YzVmYmU4MzM2ZmI2MjczZWJjNGViNmQ5ZDJlOWJjNTVjYjE0NGJkZDhk
+    MjYyMzA5NjM0OGE2M2QxZWE3MWZjMmM0ODcwMWEzMjViYzRkYTg5OWQwM2Mz
+    NGQwMWM2Zjg5OGU4NjA4OWU1NzVlZjJmM2EyN2ZiOWZkOTY0NjU=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--tty

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_FACTER_COVERAGE']

data/Gemfile

@@ -0,0 +1,27 @@
+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
+
+
+# We don't put beaker in as a test dependency because we
+# don't want to create a transitive dependency
+group :acceptance_testing do
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 2.0')
+end
+
+
+if File.exists? "#{__FILE__}.local"
+  eval(File.read("#{__FILE__}.local"), binding)
+end

data/HISTORY.md

@@ -0,0 +1,8 @@
+# default - History
+## Tags
+* [LATEST - 5 Nov, 2015 (ece69e29)](#LATEST)
+
+## Details
+### <a name = "LATEST">LATEST - 5 Nov, 2015 (ece69e29)
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,2 @@
+# beaker-facter
+Beaker DSL Extension Facter Helpers

data/Rakefile

@@ -0,0 +1,185 @@
+require 'rspec/core/rake_task'
+
+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['COVERAGE'] = 'y'
+      t.rspec_opts = ['--color']
+      t.pattern = 'spec/'
+    end
+
+  end
+
+  namespace :acceptance do
+
+    def hosts
+      ENV['HOSTS'] || ENV['CONFIG'] || 'acceptance/config/nodes/redhat-7-x86_64.yaml'
+    end
+
+    def tests
+      ENV['TESTS'] || ENV['TEST'] || 'acceptance/tests'
+    end
+
+    def generate_beaker_cli_flags
+      # the options file (including the default options might also have tests
+      #   they'll get merged with the below by beaker
+      tests_opt = "--tests=#{tests}" if tests
+
+      hosts_opt = "--hosts=#{hosts}" if hosts
+
+      overriding_options = ENV['OPTIONS'].to_s
+
+      # compact to remove the nil elements
+      [hosts_opt, tests_opt, *overriding_options.split(' ')].compact
+    end
+
+    desc 'Component functional tests for beaker-facter.'
+    task :quick do
+      sh('beaker',
+         '--type', 'foss',
+         '--load-path', 'acceptance/lib',
+         '--pre-suite', 'acceptance/pre-suite',
+         '--keyfile', ENV['KEY'] || "#{ENV['HOME']}/.ssh/id_rsa",
+         *generate_beaker_cli_flags,
+        )
+    end
+
+    desc 'Component functional tests with coverage for beaker-facter.'
+    task :coverage do
+      ENV['COVERAGE'] = 'y'
+      sh('beaker',
+         '--type', 'foss',
+         '--load-path', 'acceptance/lib',
+         '--pre-suite', 'acceptance/pre-suite',
+         '--keyfile', ENV['KEY'] || "#{ENV['HOME']}/.ssh/id_rsa",
+         *generate_beaker_cli_flags,
+        )
+    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

data/acceptance/config/nodes/vagrant-ubuntu-1404.yml

@@ -0,0 +1,8 @@
+HOSTS:
+  ubuntu-server-1404-x64:
+    roles:
+      - master
+    platform: ubuntu-14.04-amd64
+    box: puppetlabs/ubuntu-14.04-64-nocm
+    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+    hypervisor: vagrant

data/acceptance/lib/acceptance/install.rb

@@ -0,0 +1,108 @@
+module Acceptance
+  module Install
+    PLATFORM_PATTERNS = {
+      :redhat        => /fedora|el|centos/,
+      :debian        => /debian|ubuntu/,
+      :debian_ruby18 => /debian|ubuntu-lucid|ubuntu-precise/,
+      :solaris       => /solaris/,
+      :windows       => /windows/,
+    }.freeze
+
+    # Installs packages on the hosts.
+    #
+    # @param hosts [Array<Host>] Array of hosts to install packages to.
+    # @param package_hash [Hash{Symbol=>Array<String,Array<String,String>>}]
+    #   Keys should be a symbol for a platform in PLATFORM_PATTERNS.  Values
+    #   should be an array of package names to install, or of two element
+    #   arrays where a[0] is the command we expect to find on the platform
+    #   and a[1] is the package name (when they are different).
+    # @param options [Hash{Symbol=>Boolean}]
+    # @option options [Boolean] :check_if_exists First check to see if
+    #   command is present before installing package.  (Default false)
+    # @return true
+    def install_packages_on(hosts, package_hash, options = {})
+      check_if_exists = options[:check_if_exists]
+      hosts = [hosts] unless hosts.kind_of?(Array)
+      hosts.each do |host|
+        package_hash.each do |platform_key,package_list|
+          if pattern = PLATFORM_PATTERNS[platform_key]
+            if pattern.match(host['platform'])
+              package_list.each do |cmd_pkg|
+                if cmd_pkg.kind_of?(Array)
+                  command, package = cmd_pkg
+                else
+                  command = package = cmd_pkg
+                end
+                if !check_if_exists || !host.check_for_package(command)
+                  host.logger.notify("Installing #{package}")
+                  additional_switches = '--allow-unauthenticated' if platform_key == :debian
+                  host.install_package(package, additional_switches)
+                end
+              end
+            end
+          else
+            raise("Unknown platform '#{platform_key}' in package_hash")
+          end
+        end
+      end
+      return true
+    end
+    module_function :install_packages_on
+
+    def install_repos_on(host, project, sha, repo_configs_dir)
+      platform = host['platform'].with_version_codename
+      platform_configs_dir = File.join(repo_configs_dir,platform)
+      tld     = sha == 'nightly' ? 'nightlies.puppetlabs.com' : 'builds.puppetlabs.lan'
+      project = sha == 'nightly' ? project + '-latest'        : project
+      sha     = sha == 'nightly' ? nil                        : sha
+
+      case platform
+      when /^(fedora|el|centos)-(\d+)-(.+)$/
+        variant = (($1 == 'centos') ? 'el' : $1)
+        fedora_prefix = ((variant == 'fedora') ? 'f' : '')
+        version = $2
+        arch = $3
+
+        repo_filename = "pl-%s%s-%s-%s%s-%s.repo" % [
+          project,
+          sha ? '-' + sha : '',
+          variant,
+          fedora_prefix,
+          version,
+          arch
+        ]
+        repo_url = "http://%s/%s/%s/repo_configs/rpm/%s" % [tld, project, sha, repo_filename]
+
+        on host, "curl --silent --show-error --output /etc/yum.repos.d/#{repo_filename} #{repo_url}"
+      when /^(debian|ubuntu)-([^-]+)-(.+)$/
+        variant = $1
+        version = $2
+        arch = $3
+
+        list_filename = "pl-%s%s-%s.list" % [
+          project,
+          sha ? '-' + sha : '',
+          version
+        ]
+        list_url = "http://%s/%s/%s/repo_configs/deb/%s" % [tld, project, sha, list_filename]
+
+        on host, "curl --silent --show-error --output /etc/apt/sources.list.d/#{list_filename} #{list_url}"
+        on host, "apt-get update"
+      else
+        if project == 'puppet-agent'
+          opts = {
+            :puppet_collection => 'PC1',
+            :puppet_agent_sha => ENV['SHA'],
+            :puppet_agent_version => ENV['SUITE_VERSION'] || ENV['SHA']
+          }
+          # this installs puppet-agent on windows (msi) and osx (dmg)
+          install_puppet_agent_dev_repo_on(agent, opts)
+        else
+          fail_test("No repository installation step for #{platform} yet...")
+        end
+      end
+    end
+    module_function :install_repos_on
+
+  end
+end

data/acceptance/pre-suite/010_install.rb

@@ -0,0 +1,21 @@
+require 'acceptance/install'
+extend Acceptance::Install
+
+step 'Install facter' do
+  sha = ENV['SHA'] || ENV['GIT_SHA'] || 'nightly'
+  hosts.each do |host|
+    install_repos_on(host, 'puppet-agent', sha, 'repo-configs')
+    host.add_env_var('PATH', '/opt/puppetlabs/bin:${PATH}')
+  end
+
+  PACKAGES = {
+    :redhat => [
+      'puppet-agent',
+    ],
+    :debian => [
+      'puppet-agent',
+    ],
+  }
+
+  install_packages_on(hosts, PACKAGES)
+end

data/acceptance/tests/facter.rb

@@ -0,0 +1,39 @@
+test_name 'fact_on, fact, facter, oh my' do
+  facts_expected = [/timezone => \w\w\w/, /facterversion => \d+\.\d+\.\d+/]
+  agents.each do |agent|
+    on(agent, 'ln -s /opt/puppetlabs/bin/facter /opt/puppetlabs/bin/cfacter')
+    step "facter should return all facts on #{agent}" do
+      facts = on(agent,facter).stdout
+      facts_expected.each do |expected|
+        assert_match(expected, facts, 'expected fact not found using facter helper')
+      end
+    end
+
+    step "cfacter should return all facts on #{agent}" do
+      facts = on(agent,facter).stdout
+      facts_expected.each do |expected|
+        assert_match(expected, facts, 'expected fact not found using facter helper')
+      end
+    end
+
+    step "fact_on should work on a single host" do
+      fact = fact_on(agent,'osfamily')
+      assert_match(/\w+/, fact, 'osfamily fact not found using fact_on helper')
+    end
+  end
+
+
+  step "fact_on should work on a multiple hosts and return an array" do
+    facts = fact_on(hosts,'hostname')
+    assert(facts.kind_of?(Array), 'fact_on did not return an array when given an array')
+    facts.each.with_index do |fact,index|
+      assert_equal(hosts[index].hostname.split('.').first, fact, 'hostname fact not found using fact helper on multiple hosts')
+    end
+  end
+
+  step "fact should work on default host" do
+    fact = fact('ipaddress')
+    assert_equal(default.ip, fact, 'ipaddress fact not found using fact helper on default host')
+  end
+
+end

data/beaker-facter.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'beaker-facter/version'
+
+Gem::Specification.new do |s|
+  s.name        = "beaker-facter"
+  s.version     = Beaker::DSL::Helpers::Facter::Version::STRING
+  s.authors     = ["Puppetlabs"]
+  s.email       = ["qe-team@puppetlabs.com"]
+  s.homepage    = "https://github.com/puppetlabs/beaker-facter"
+  s.summary     = %q{Beaker DSL Extension Facter Helpers}
+  s.description = %q{For use with the Beaker acceptance testing tool}
+  s.license     = 'Apache2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Testing dependencies
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'fakefs', '~> 0.6'
+  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'pry', '~> 0.10'
+
+  # Documentation dependencies
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'markdown'
+  s.add_development_dependency 'thin'
+
+  # Run time dependencies
+  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
+end

data/bin/beaker-facter

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(Gem)
+require 'beaker-facter'
+
+VERSION_STRING =
+"
+          ,'````',
+    .`',.'        `..'``',      ____
+  ,'                     `', .-'    '-.
+ ;                        ..' /)       '.         ,'``',  ,..,   ,..,
+  ',            ,.,    .'`/  (/          \     ,.'      '`    '.'    ;
+    '.,.`'.,,,.`   `''`  ;                ;  ,`                       ',
+                         |                | ;                           ;
+     beaker-facter    ___|                | `.,     ;    ,...         ,'
+                   .-'   ;                ;    `.,.' `,.'    `,.     ;
+                 .' /)    \              /                      `.,,'
+                /  (/      '.          .' '.
+               ;             '-._  _.-'     \
+               |                |)(          ;
+               |                (__)         |
+               ;                ;/           |
+                \              //            ;
+                 '.          .'/            /
+                   '-._  _.-' /.          .'
+                       )(    /  '-._  _.-'
+                      (__)  /       )(
+                       |   /       (__)
+                       |  /       _,'
+                       | /    _,'
+                       |/._,'
+"
+
+puts VERSION_STRING % [Beaker::DSL::Helpers::Hiera::Version::STRING]
+
+exit 0

data/lib/beaker-facter/helpers.rb

@@ -0,0 +1,88 @@
+module Beaker
+  module DSL
+    # These are wrappers to equivalent {Beaker::Command} objects
+    # so that command line actions are executed within an appropriate and
+    # configurable environment.
+    #
+    # I find most of these adapters of suspicious value and have deprecated
+    # many of them.
+    module Wrappers
+
+      # This is hairy and because of legacy code it will take a bit more
+      # work to disentangle all of the things that are being passed into
+      # this catchall param.
+      #
+      def facter(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options['ENV'] ||= {}
+        options[:cmdexe] = true
+        Command.new('facter', args, options )
+      end
+
+      # This is hairy and because of legacy code it will take a bit more
+      # work to disentangle all of the things that are being passed into
+      # this catchall param.
+      #
+      def cfacter(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options['ENV'] ||= {}
+        options[:cmdexe] = true
+        Command.new('cfacter', args, options )
+      end
+
+    end
+
+
+    module Helpers
+      # Methods that help you interact with your facter installation, facter must be installed
+      # for these methods to execute correctly
+      module Facter
+
+        # @!macro [new] common_opts
+        #   @param [Hash{Symbol=>String}] opts Options to alter execution.
+        #   @option opts [Boolean] :silent (false) Do not produce log output
+        #   @option opts [Array<Fixnum>] :acceptable_exit_codes ([0]) An array
+        #     (or range) of integer exit codes that should be considered
+        #     acceptable.  An error will be thrown if the exit code does not
+        #     match one of the values in this list.
+        #   @option opts [Boolean] :accept_all_exit_codes (false) Consider all
+        #     exit codes as passing.
+        #   @option opts [Boolean] :dry_run (false) Do not actually execute any
+        #     commands on the SUT
+        #   @option opts [String] :stdin (nil) Input to be provided during command
+        #     execution on the SUT.
+        #   @option opts [Boolean] :pty (false) Execute this command in a pseudoterminal.
+        #   @option opts [Boolean] :expect_connection_failure (false) Expect this command
+        #     to result in a connection failure, reconnect and continue execution.
+        #   @option opts [Hash{String=>String}] :environment ({}) These will be
+        #     treated as extra environment variables that should be set before
+        #     running the command.
+        #
+
+        # Get a facter fact from a provided host
+        #
+        # @param [Host, Array<Host>, String, Symbol] host    One or more hosts to act upon,
+        #                            or a role (String or Symbol) that identifies one or more hosts.
+        # @param [String] name The name of the fact to query for
+        # @!macro common_opts
+        #
+        # @return String The value of the fact 'name' on the provided host
+        # @raise  [FailTest] Raises an exception if call to facter fails
+        def fact_on(host, name, opts = {})
+          result = on host, facter(name, opts)
+          if result.kind_of?(Array)
+            result.map { |res| res.stdout.chomp }
+          else
+            result.stdout.chomp
+          end
+        end
+
+        # Get a facter fact from the default host
+        # @see #fact_on
+        def fact(name, opts = {})
+          fact_on(default, name, opts)
+        end
+      end
+    end
+  end
+end

data/lib/beaker-facter/version.rb

@@ -0,0 +1,11 @@
+module Beaker
+  module DSL
+    module Helpers
+      module Facter
+        module Version
+          STRING = '0.1.0'
+        end
+      end
+    end
+  end
+end

data/lib/beaker-facter.rb

@@ -0,0 +1,11 @@
+module Beaker
+  module DSL
+    module Helpers
+      module Facter
+        require 'stringify-hash'
+        require 'beaker-facter/helpers'
+        require 'beaker-facter/version'
+      end
+    end
+  end
+end

data/spec/beaker-facter/helpers_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+class ClassMixedWithDSLHelpers
+  include BeakerTestHelpers
+  include Beaker::DSL::Helpers::Facter
+  include Beaker::DSL::Wrappers
+
+  def logger
+    RSpec::Mocks::Double.new('logger').as_null_object
+  end
+end
+
+describe ClassMixedWithDSLHelpers do
+
+  let( :command ){ 'ls' }
+  let( :beaker_command ) { class_double("Beaker::DSL::Wrappers::Command").as_stubbed_const(:transfer_nested_constants => true) }
+  let( :host )   { double.as_null_object }
+  let( :result ) { BeakerTestHelpers::Result.new( host, command ) }
+
+  let( :master ) { make_host( 'master',   :roles => %w( master agent default)    ) }
+  let( :agent )  { make_host( 'agent',    :roles => %w( agent )           ) }
+  let( :dash )   { make_host( 'console',  :roles => %w( dashboard agent ) ) }
+  let( :db )     { make_host( 'db',       :roles => %w( database agent )  ) }
+  let( :custom ) { make_host( 'custom',   :roles => %w( custom agent )    ) }
+  let( :hosts )  { [ master, agent, dash, db, custom ] }
+  let(:empty_opts) { {'ENV' => {}, :cmdexe => true } }
+
+  describe '#facter' do
+    it 'should split out the options and pass "facter" as first arg to Command' do
+      expect( beaker_command ).to receive( :new ).
+        with('facter', [ '-p' ], empty_opts)
+      subject.facter( '-p' )
+    end
+  end
+
+  describe '#cfacter' do
+    it 'should split out the options and pass "cfacter" as first arg to Command' do
+      expect( beaker_command ).to receive( :new ).
+        with('cfacter', [ '-p' ], empty_opts)
+      subject.cfacter( '-p' )
+    end
+  end
+
+  describe '#fact_on' do
+    it 'retrieves a fact on a single host' do
+      result.stdout = "family\n"
+      expect( subject ).to receive(:facter).with('osfamily',{}).once
+      expect( subject ).to receive(:on).and_return(result)
+
+      expect( subject.fact_on('host','osfamily') ).to be === result.stdout.chomp
+    end
+
+   it 'retrieves an array of facts from multiple hosts' do
+      allow( subject ).to receive( :hosts ).and_return( hosts )
+      times = hosts.length
+      results = []
+      hosts.each.with_index do |host, index|
+        results[index] = BeakerTestHelpers::Result.new( host, command )
+        results[index].stdout = "family\n"
+      end
+      expected = ["family"] * hosts.length
+      expect( subject ).to receive(:facter).with('osfamily',{}).once
+      expect( subject ).to receive(:on).and_return(results)
+
+      expect( subject.fact_on(hosts,'osfamily') ).to be === expected
+    end
+  end
+
+  describe '#fact' do
+    it 'delegates to #fact_on with the default host' do
+      allow( subject ).to receive(:hosts).and_return(hosts)
+      allow( subject ).to receive( :default ).and_return( hosts[0] )
+      expect( subject ).to receive(:fact_on).with(master,"osfamily",{}).once
+
+      subject.fact('osfamily')
+    end
+  end
+
+end

data/spec/beaker_test_helpers.rb

@@ -0,0 +1,29 @@
+# These are specifically to mock Beaker methods necessary for testing
+# that will be available during runtime because this is never run separate
+# from Beaker itself.
+#
+# Including Beaker as a dependency would not work as a solution to this issue,
+# since that would make a cycle in the dependency graph, at least until
+# Beaker 3.0 happens and this is no longer a dependency of Beaker's.
+module BeakerTestHelpers
+
+  class Result
+    attr_accessor :host, :cmd, :exit_code, :stdout, :stderr, :output,
+                  :raw_stdout, :raw_stderr, :raw_output
+    def initialize(host, cmd)
+      @host       = host
+      @cmd        = cmd
+      @stdout     = ''
+      @stderr     = ''
+      @output     = ''
+      @exit_code  = nil
+    end
+  end
+
+  def block_on hosts
+    if block_given?
+      yield hosts
+    end
+  end
+
+end

data/spec/helpers.rb

@@ -0,0 +1,111 @@
+module TestFileHelpers
+  def create_files file_array
+    file_array.each do |f|
+      FileUtils.mkdir_p File.dirname(f)
+      FileUtils.touch f
+    end
+  end
+
+  def fog_file_contents
+    { :default => { :aws_access_key_id => "IMANACCESSKEY",
+                    :aws_secret_access_key => "supersekritkey",
+                    :aix_hypervisor_server => "aix_hypervisor.labs.net",
+                    :aix_hypervisor_username => "aixer",
+                    :aix_hypervisor_keyfile => "/Users/user/.ssh/id_rsa-acceptance",
+                    :solaris_hypervisor_server => "solaris_hypervisor.labs.net",
+                    :solaris_hypervisor_username => "harness",
+                    :solaris_hypervisor_keyfile => "/Users/user/.ssh/id_rsa-old.private",
+                    :solaris_hypervisor_vmpath => "rpoooool/zs",
+                    :solaris_hypervisor_snappaths => ["rpoooool/USER/z0"],
+                    :vsphere_server => "vsphere.labs.net",
+                    :vsphere_username => "vsphere@labs.com",
+                    :vsphere_password => "supersekritpassword",
+    } }
+  end
+
+end
+
+module HostHelpers
+  HOST_DEFAULTS = { :platform => 'unix',
+                    :snapshot => 'pe',
+                    :box => 'box_name',
+                    :roles => ['agent'],
+                    :snapshot => 'snap',
+                    :ip => 'default.ip.address',
+                    :box => 'default_box_name',
+                    :box_url => 'http://default.box.url',
+  }
+
+  HOST_NAME     = "vm%d"
+  HOST_SNAPSHOT = "snapshot%d"
+  HOST_IP       = "ip.address.for.%s"
+  HOST_BOX      = "%s_of_my_box"
+  HOST_BOX_URL  = "http://address.for.my.box.%s"
+  HOST_TEMPLATE = "%s_has_a_template"
+
+  def logger
+    double( 'logger' ).as_null_object
+  end
+
+  def make_opts
+    opts = StringifyHash.new
+    opts.merge( { :logger => logger,
+                  :host_config => 'sample.config',
+                  :type => nil,
+                  :pooling_api => 'http://vcloud.delivery.puppetlabs.net/',
+                  :datastore => 'instance0',
+                  :folder => 'Delivery/Quality Assurance/Staging/Dynamic',
+                  :resourcepool => 'delivery/Quality Assurance/Staging/Dynamic',
+                  :gce_project => 'beaker-compute',
+                  :gce_keyfile => '/path/to/keyfile.p12',
+                  :gce_password => 'notasecret',
+                  :gce_email => '12345678910@developer.gserviceaccount.com',
+    } )
+  end
+
+  def generate_result (name, opts )
+    result = double( 'result' )
+    stdout = opts.has_key?(:stdout) ? opts[:stdout] : name
+    stderr = opts.has_key?(:stderr) ? opts[:stderr] : name
+    exit_code = opts.has_key?(:exit_code) ? opts[:exit_code] :  0
+    exit_code = [exit_code].flatten
+    allow( result ).to receive( :stdout ).and_return( stdout )
+    allow( result ).to receive( :stderr ).and_return( stderr )
+    allow( result ).to receive( :exit_code ).and_return( *exit_code )
+    result
+  end
+
+  def make_host_opts name, opts
+    make_opts.merge( { 'HOSTS' => { name => opts } } ).merge( opts )
+  end
+
+  def make_host name, host_hash
+    host_hash = StringifyHash.new.merge(HOST_DEFAULTS.merge(host_hash))
+
+    host = make_opts.merge(host_hash)
+
+    allow(host).to receive( :name ).and_return( name )
+    allow(host).to receive( :to_s ).and_return( name )
+    allow(host).to receive( :exec ).and_return( generate_result( name, host_hash ) )
+    host
+  end
+
+  def make_hosts preset_opts = {}, amt = 3
+    hosts = []
+    (1..amt).each do |num|
+      name = HOST_NAME % num
+      opts = { :snapshot => HOST_SNAPSHOT % num,
+               :ip => HOST_IP % name,
+               :template => HOST_TEMPLATE % name,
+               :box => HOST_BOX % name,
+               :box_url => HOST_BOX_URL % name }.merge( preset_opts )
+      hosts << make_host(name, opts)
+    end
+    hosts
+  end
+
+  def make_instance instance_data = {}
+    OpenStruct.new instance_data
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '.bundle/gems'
+  end
+end
+require 'beaker-facter'
+require 'beaker_test_helpers'
+require 'helpers'
+
+require 'rspec/its'
+
+RSpec.configure do |config|
+  config.include TestFileHelpers
+  config.include HostHelpers
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: beaker-facter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppetlabs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stringify-hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+description: For use with the Beaker acceptance testing tool
+email:
+- qe-team@puppetlabs.com
+executables:
+- beaker-facter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .simplecov
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- acceptance/config/nodes/vagrant-ubuntu-1404.yml
+- acceptance/lib/acceptance/install.rb
+- acceptance/pre-suite/010_install.rb
+- acceptance/tests/facter.rb
+- beaker-facter.gemspec
+- bin/beaker-facter
+- lib/beaker-facter.rb
+- lib/beaker-facter/helpers.rb
+- lib/beaker-facter/version.rb
+- spec/beaker-facter/helpers_spec.rb
+- spec/beaker_test_helpers.rb
+- spec/helpers.rb
+- spec/spec_helper.rb
+homepage: https://github.com/puppetlabs/beaker-facter
+licenses:
+- Apache2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Beaker DSL Extension Facter Helpers
+test_files: []
+has_rdoc: