beaker-rspec 5.3.0 → 5.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjdkNWQ1OWQ5N2NiMjY5ZDExNzE0YTUxODMyZWFkYjBmYWEwMmRlMw==
+    NDYxN2NmZWJkNTMyMGNlNGNkMWI5NTcwMzQ2YzU0YzYxZjI5OTZlYw==
   data.tar.gz: !binary |-
-    MzQ3Zjc0ZmUxNDVlYzk3Y2Q0YmYzNTAyMDI1ZmNlMmRmYjU1Y2UyNQ==
+    YzkxZjg3YTA1NWExYjU1OWQ5Zjg3OWU4MWRiNWY1NDNlMGY4YTE5NA==
 SHA512:
   metadata.gz: !binary |-
-    ODUxMmU0NzYwZjQ1MWU5OGUyMjU1NWJiMDdlY2ZiNDk4YWRlYTI2NmIzZWIx
-    OTMwZGI3ZThmOTY3MzljMjI5NDIzYTI0NWU4ZmUxYjkxNWU0MmU4MzcxZTJl
-    ZmMwMjc5ZTcyYjNmNjI1ODhlMWE0MzIxMDEwNjJhYzMzNGIwZGQ=
+    NDNhYWUyNjMzZGFjOWYyODViNTJlOGQ3ZWRiN2JiZmVkM2I2YjFhYzRlNWNj
+    YjNhNTg3ZjM3YTdkNzM2YzdkNDQ5YzI1ZWY5OTNmYzU0Y2Q3ZWVjNTE0MjY3
+    OWY1YjJmOTc2N2ExODZiNjNmMzFhYTA5ZTM3Zjc1MjQzMjcwMjU=
   data.tar.gz: !binary |-
-    NzMyM2MwYjAyZGY2ZmU3MDYyMzRjYzViZDdmOTkyMjhjNTNiMzBlOWMwNmY2
-    NGQyMjVjM2U4ZjUwZjA0ZGMzNWJmMzJiY2NlMDc1OWQ5MDEwY2I3ZTI5Mjcw
-    OGZiMTIxNDQ5NjM3ZmJkYmNhMzFlMmI1MTViNjQyZTUxYWZkZDU=
+    Nzk0MWU5NDdhY2VkODlmOTEyZjAwOWI4NzcyMDRiYzgxZjJkMGM5ZTVmYjZi
+    ZGI3YjU1NjQwZjU4YTU0YzEzZTY4MTc3Y2IyMTBjN2M3MTA0ODhkZWQzMzQ2
+    MTQxOGVkYjQ0ZjFlM2VkZTExYzViZTUyMjVhMmFmZjIxNWQ4NGI=

data/HISTORY.md

@@ -1,6 +1,7 @@
 # default - History
 ## Tags
-* [LATEST - 13 Oct, 2015 (2ea88c14)](#LATEST)
+* [LATEST - 9 Jun, 2016 (a25f1e77)](#LATEST)
+* [5.3.0 - 13 Oct, 2015 (2efeb932)](#5.3.0)
 * [5.2.2 - 3 Sep, 2015 (69980e14)](#5.2.2)
 * [5.2.1 - 27 Aug, 2015 (49c45f61)](#5.2.1)
 * [5.2.0 - 15 Jul, 2015 (261dacdb)](#5.2.0)
@@ -23,7 +24,67 @@
 * [beaker-rspec1.0.0 - 3 Dec, 2013 (65e89ec9)](#beaker-rspec1.0.0)
 
 ## Details
-### <a name = "LATEST">LATEST - 13 Oct, 2015 (2ea88c14)
+### <a name = "LATEST">LATEST - 9 Jun, 2016 (a25f1e77)
+
+* (GEM) update beaker-rspec version to 5.4.0 (a25f1e77)
+
+* Merge pull request #79 from richburroughs/master (4db37886)
+
+
+```
+Merge pull request #79 from richburroughs/master
+
+fixed an incomplete sentence in README.md
+```
+* fixed an incomplete sentence in README.md (cfd9cbd6)
+
+* Merge pull request #77 from oskar-flores/fix-serverspec-on-non-cygwin-node (a617f7bb)
+
+
+```
+Merge pull request #77 from oskar-flores/fix-serverspec-on-non-cygwin-node
+
+Add a check on windows part, to exec commands on a non cygwin environment
+```
+* Merge pull request #78 from DavidS/bkr-577-update-readme (563ba7e7)
+
+
+```
+Merge pull request #78 from DavidS/bkr-577-update-readme
+
+(BKR-577) Update README to describe usage in detail
+```
+* (BKR-577) Update README to describe usage in detail (18b307a7)
+
+* Cleaning code as per @DavidS sugestion (c0142b57)
+
+* Add a check on windows part, to exec commads on a non cywing environment (f483b063)
+
+* fixed up recent README changes (2771b4b1)
+
+* Merge pull request #71 from electrical/cleanup_ctrl_c (756de678)
+
+
+```
+Merge pull request #71 from electrical/cleanup_ctrl_c
+
+(BKR-345) Cleanup and quit on ctrl-c
+```
+* Merge pull request #76 from DavidS/document-env (b3d4f839)
+
+
+```
+Merge pull request #76 from DavidS/document-env
+
+Document environment variables
+```
+* Document environment variables (5ab74188)
+
+* (BKR-345) Cleanup and quit on ctrl-c (90a74317)
+
+### <a name = "5.3.0">5.3.0 - 13 Oct, 2015 (2efeb932)
+
+* (HISTORY) update beaker-rspec history for gem release 5.3.0 (2efeb932)
 
 * (GEM) update beaker-rspec version to 5.3.0 (2ea88c14)
 

data/README.md

@@ -1,4 +1,154 @@
-beaker-rspec
-=======================
+#beaker-rspec
 
-Bridge between puppet test harness (beaker) and rspec
+beaker-rspec is a bridge between the puppet acceptance test harness ([beaker](https://github.com/puppetlabs/beaker)) and [rspec](https://github.com/rspec/rspec). It also integrates [serverspec](http://serverspec.org/).
+
+#Typical Workflow
+
+Beaker does setup and provision all nodes from your nodeset on each test run, and cleans up the VMs after use. During development on a module it can be very handy to keep the VMs available for inspection or reuse. Set `BEAKER_destroy=no` do skip the cleanup and `BEAKER_provision=no` once the VMs are created.
+
+1. Run tests with `BEAKER_destroy=no`, no setting for `BEAKER_provision`
+  * beaker-rspec will use spec/acceptance/nodesets/default.yml node file
+  * boxes will be newly provisioned
+  * boxes will be preserved post-testing
+* Run tests with `BEAKER_destroy=no` and `BEAKER_provision=no`
+  * beaker-rspec will use spec/acceptance/nodesets/default.yml node file
+  * boxes will be re-used from previous run
+  * boxes will be preserved post-testing
+* Nodes become corrupted with too many test runs/bad data and need to be refreshed then set `BEAKER_provision=yes`
+* Testing is complete and you want to clean up, run once more with `BEAKER_destroy` unset
+  * you can also:
+
+        cd .vagrant/beaker_vagrant_files/default.yml ; vagrant destroy --force
+
+##Supported ENV variables
+
+* `BEAKER_color`: set to `no` to disable color output
+* `BEAKER_debug`: set to any value to enable beaker debug logging
+* `BEAKER_destroy`: set to `no` to keep the VMs after the test run. Set to `onpass` to keep the VMs around only after a test failure.
+* `BEAKER_keyfile`: specify alternate SSH key to access the test VMs
+* `BEAKER_provision`: set to `no` to skip provisioning boxes before testing, beaker will then assume that boxes are already provisioned and reachable
+* `BEAKER_set`: set to the name of the node file to be used during testing (exclude .yml file extension, it will be added by beaker-rspec). The file is assumed to be in module's spec/acceptance/nodesets directory.
+* `BEAKER_setfile` - set to the full path to a node file be used during testing (be sure to include full path and file extensions, beaker-rspec will use this path without editing/altering it in any way)
+
+For details on the specific mappings, the [setup code](https://github.com/puppetlabs/beaker-rspec/blob/2771b4b1864692690254a969680a57ff22ac0516/lib/beaker-rspec/spec_helper.rb#L26-L32) and the [beaker docs](https://github.com/puppetlabs/beaker/wiki/The-Command-Line).
+
+#Building your Module Testing Environment
+
+Using puppetlabs-mysql as an example module.
+
+##Clone the module repository of the module where you want to add tests
+
+    git clone https://github.com/puppetlabs/puppetlabs-mysql
+    cd puppetlabs-mysql
+
+##Install beaker-rspec
+
+In module's top level directory edit the Gemfile. If there is a `:system_tests` or `:acceptance` group, add it there.
+
+```ruby
+group :acceptance do
+  gem 'beaker-rspec'
+end
+```
+
+Then run
+
+    bundle install
+
+##Create node files
+
+These files indicate the nodes (or hosts) that the tests will be run on.  By default, any node file called `default.yml` will be used.  You can override this using the `BEAKER_set` environment variable to indicate an alternate file.  Do not provide full path or the '.yml' file extension to `BEAKER_set`, it is assumed to be located in 'spec/acceptance/nodesets/${NAME}.yml' by beaker-rspec.  If you wish to use a completely different file location use `BEAKER_setfile` and set it to the full path (including file extension) of your hosts file.
+
+Nodes are pulled from [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppetlabs).
+
+Example node files can be found here:
+
+* [Puppet Labs example Vagrant node files](https://github.com/puppetlabs/beaker/blob/master/docs/Example-Vagrant-Hosts-Files.md)
+
+Create the nodesets directory.  From module's top level directory:
+
+    mkdir -p spec/acceptance/nodesets
+
+Copy any nodesets that you wish to use into the nodesets directory.
+
+##Create the spec_helper_acceptance.rb
+
+Create example file `spec_helper_acceptance.rb`:
+
+```ruby
+require 'beaker-rspec'
+require 'pry'
+
+# Install Puppet on all hosts
+hosts.each do |host|
+  on host, install_puppet
+end
+
+RSpec.configure do |c|
+  module_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+  c.formatter = :documentation
+
+  c.before :suite do
+    # Install module to all hosts
+    hosts.each do |host|
+      install_dev_puppet_module_on(host, :source => module_root, :module_name => 'mysql',
+          :target_module_path => '/etc/puppet/modules')
+      # Install dependencies
+      on(host, puppet('module', 'install', 'puppetlabs-stdlib'))
+
+      # Add more setup code as needed
+    end
+  end
+end
+```
+
+Update spec_helper_acceptance.rb to reflect the module under test.  You will need to set the correct module name and add any module dependencies.  Place the file in the `spec` directory (in this case `puppetlabs-mysql/spec`)
+
+##Create spec tests for your module
+
+Spec tests are written in [RSpec](http://rspec.info). You can also use [serverspec](http://serverspec.org/) matchers to test [resources](http://serverspec.org/resource_types.html).
+
+Example spec file `spec/acceptance/mysql_account_delete_spec.rb`:
+
+```ruby
+require 'spec_helper_acceptance'
+
+describe 'mysql::server::account_security class' do
+  let(:manifest) {
+    <<-EOS
+      class { 'mysql::server': remove_default_accounts => true }
+    EOS
+  }
+
+  it 'should run without errors' do
+    result = apply_manifest(manifest)
+    expect(@result.exit_code).to eq 2
+  end
+
+  it 'should delete accounts' do
+    grants_results = shell("mysql -e 'show grants for root@127.0.0.1;'")
+    expect(grants_results.exit_code).to eq 1
+  end
+
+  it 'should delete databases' do
+    show_result = shell("mysql -e 'show databases;'")
+    expect(show_result.stdout).not_to match /test/
+  end
+
+  it 'should run a second time without changes' do
+    result = apply_manifest(manifest)
+    expect(@result.exit_code).to eq 0
+  end
+
+  describe package('mysql-server') do
+    it { is_expected.to be_installed }
+  end
+end
+```
+
+##Run your spec tests
+
+From module's top level directory
+
+    bundle exec rspec spec/acceptance

data/lib/beaker-rspec/helpers/serverspec.rb

@@ -235,10 +235,20 @@ module Specinfra::Backend
     def run_command(cmd, opt = {})
       node = get_working_node
       script = create_script(cmd)
-      on node, "rm -f script.ps1"
+      #when node is not cygwin rm -rf will fail so lets use native del instead
+      #There should be a better way to do this, but for now , this works
+      if node.is_cygwin?
+        delete_command = "rm -rf"
+        redirection = "< /dev/null"
+      else
+        delete_command = "del"
+        redirection = "< NUL"
+      end
+      on node, "#{delete_command} script.ps1"
       create_remote_file(node, 'script.ps1', script)
-      # cygwin support /dev/null, if running from winrm would use < NULL
-      ret = ssh_exec!(node, "powershell.exe -File script.ps1 < /dev/null")
+      #When using cmd on a pswindows node redirection should be set to < NUl
+      #when using a cygwing one, /dev/null should be fine
+      ret = ssh_exec!(node, "powershell.exe -File script.ps1 #{redirection}")
 
       if @example
         @example.metadata[:command] = script

data/lib/beaker-rspec/spec_helper.rb

@@ -47,6 +47,11 @@ RSpec.configure do |c|
   c.validate
   c.configure
 
+  trap "SIGINT" do
+    c.cleanup
+    exit!(1)
+  end
+
   # Destroy nodes if no preserve hosts
   c.after :suite do
     case options[:destroy]

data/lib/beaker-rspec/version.rb

@@ -1,5 +1,5 @@
 module BeakerRSpec
   module Version
-    STRING = '5.3.0'
+    STRING = '5.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-rspec
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2016-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest