Skip to content

Commit a4841ed

Browse files
committed
fix markdown
1 parent 08ca62d commit a4841ed

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#beaker-rspec
1+
# beaker-rspec
22

33
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/).
44

5-
#Upgrading from beaker-rspec 5 to 6
5+
# Upgrading from beaker-rspec 5 to 6
66

77
In beaker-rspec 6, we've picked up the newest beaker, 3.y. In this release, we've
88
given up support for Ruby 1.9 and moved to 2.2.5 as our lowest tested version,
@@ -13,7 +13,7 @@ To learn more about those changes, please checkout our
1313
doc. Note that besides the Ruby version & beaker dependency change, nothing else
1414
was changed in beaker-rspec itself.
1515

16-
#Typical Workflow
16+
# Typical Workflow
1717

1818
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.
1919

@@ -31,7 +31,7 @@ Beaker does setup and provision all nodes from your nodeset on each test run, an
3131

3232
cd .vagrant/beaker_vagrant_files/default.yml ; vagrant destroy --force
3333

34-
##Supported ENV variables
34+
## Supported ENV variables
3535

3636
* `BEAKER_color`: set to `no` to disable color output
3737
* `BEAKER_debug`: set to any value to enable beaker debug logging
@@ -43,16 +43,16 @@ Beaker does setup and provision all nodes from your nodeset on each test run, an
4343

4444
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/blob/master/docs/tutorials/the_command_line.md).
4545

46-
#Building your Module Testing Environment
46+
# Building your Module Testing Environment
4747

4848
Using puppetlabs-mysql as an example module.
4949

50-
##Clone the module repository of the module where you want to add tests
50+
## Clone the module repository of the module where you want to add tests
5151

5252
git clone https://github.com/puppetlabs/puppetlabs-mysql
5353
cd puppetlabs-mysql
5454

55-
##Install beaker-rspec
55+
## Install beaker-rspec
5656

5757
In module's top level directory edit the Gemfile. You should see a `:system_tests`
5858
or `:acceptance` group there, but if not, add beaker-rspec there:
@@ -67,7 +67,7 @@ Then run
6767

6868
bundle install
6969

70-
##Create node files
70+
## Create node files
7171

7272
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.
7373

@@ -83,7 +83,7 @@ Create the nodesets directory. From module's top level directory:
8383

8484
Copy any nodesets that you wish to use into the nodesets directory.
8585

86-
##Create the spec_helper_acceptance.rb
86+
## Create the spec_helper_acceptance.rb
8787

8888
In the `spec` folder, you should see the project's `spec_helper_acceptance.rb`.
8989
This file contains all of the setup logic needed to get your Systems Under Test
@@ -133,7 +133,7 @@ This method will install the latest puppet-agent from the specified
133133

134134
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`)
135135

136-
##Create spec tests for your module
136+
## Create spec tests for your module
137137

138138
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).
139139

@@ -178,7 +178,7 @@ describe 'mysql::server::account_security class' do
178178
end
179179
```
180180

181-
##Run your spec tests
181+
## Run your spec tests
182182

183183
From module's top level directory
184184

0 commit comments

Comments
 (0)