1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
Feature: Getting started with RSpec and aruba
Background:
Given I use the fixture "empty-app"
Scenario: Simple Integration
To use the simple integration just require `aruba/rspec` in your
`spec_helper.rb`. After that you only need to flag your tests with `type:
:aruba` and some things are set up for.
The simple integration adds some `before(:each)`-hooks for you:
\* Setup Aruba Test directory
\* Clear environment (ENV)
\* Make HOME-variable configarable via `arub.config.home_directory`
\* Configure `aruba` via `RSpec`-metadata
\* Activate announcers based on `RSpec`-metadata
Be careful, if you are going to use a `before(:all)`-hook to set up
files/directories. Those will be deleted by the `setup_aruba`-call within
the `before(:each)`-hook. Look for some custom integration further down the
documentation for a solution.
Given a file named "spec/spec_helper.rb" with:
"""
require 'aruba/rspec'
"""
And a file named "spec/getting_started_spec.rb" with:
"""
require 'spec_helper'
RSpec.describe 'Integrate Aruba into RSpec', :type => :aruba do
context 'when to be or not be...' do
it { expect(aruba).to be }
end
context 'when write file' do
let(:file) { 'file.txt' }
before(:each) { write_file file, 'Hello World' }
it { expect(file).to be_an_existing_file }
it { expect([file]).to include an_existing_file }
end
end
"""
When I run `rspec`
Then the specs should all pass
Scenario: Simple Custom Integration
There might be some use cases where you want to build an aruba integration
of your own. You need to include the API and make sure, that you run
\* `restore_env` (only for aruba < 1.0.0)
\* `setup_aruba`
before any method of aruba is used.
Given a file named "spec/spec_helper.rb" with:
"""
require 'aruba/api'
RSpec.configure do |config|
config.include Aruba::Api
end
"""
And a file named "spec/getting_started_spec.rb" with:
"""
require 'spec_helper'
RSpec.describe 'Custom Integration of aruba' do
let(:file) { 'file.txt' }
before(:each) { setup_aruba }
before(:each) { write_file file, 'Hello World' }
it { expect(file).to be_an_existing_file }
end
"""
When I run `rspec`
Then the specs should all pass
Scenario: Custom Integration using before(:all)-hook
You can even use `aruba` within a `before(:all)`-hook. But again, make sure
that `setup_aruba` is run before you use any method of `aruba`. Using
`setup_aruba` both in `before(:all)`- and `before(:each)`-hook is not
possible and therefor not supported:
Running `setup_aruba` removes `tmp/aruba`, creates a new one `tmp/aruba`
and make it the working directory. Running it within a `before(:all)`-hook,
run some `aruba`-method and then run `setup_arub` again within a
`before(:each)`-hook, will remove the files/directories created within the
`before(:all)`-hook.
Given a file named "spec/spec_helper.rb" with:
"""
require 'aruba/api'
RSpec.configure do |config|
config.include Aruba::Api
end
"""
And a file named "spec/getting_started_spec.rb" with:
"""
require 'spec_helper'
RSpec.describe 'Custom Integration of aruba' do
before(:all) { setup_aruba }
before(:all) { write_file 'file.txt', 'Hello World' }
it { expect('file.txt').to be_an_existing_file }
end
"""
When I run `rspec`
Then the specs should all pass
Scenario: Setup aruba before use any of it's methods
From 1.0.0 it will be required, that you setup aruba before you use it.
Given a file named "spec/spec_helper.rb" with:
"""
require 'aruba/api'
RSpec.configure do |config|
config.include Aruba::Api
end
"""
And a file named "spec/getting_started_spec.rb" with:
"""
require 'spec_helper'
RSpec.describe 'Custom Integration of aruba' do
let(:file) { 'file.txt' }
before(:each) { setup_aruba }
it { expect(true).to be true }
end
"""
And an empty file named "tmp/aruba/garbage.txt"
When I run `rspec`
Then the specs should all pass
And the file "tmp/aruba/garbage.txt" should not exist anymore
Scenario: Fail-safe use if "setup_aruba" is not used
If you forgot to run `setup_aruba` before the first method of aruba is
used, you might see an error. Although we did our best to prevent this.
Make sure that you run `setup_aruba` before any method of aruba is used. At
best before each and every test.
This will be not supported anymore from 1.0.0 on.
Given a file named "spec/spec_helper.rb" with:
"""
require 'aruba/api'
RSpec.configure do |config|
config.include Aruba::Api
end
"""
And a file named "spec/getting_started_spec.rb" with:
"""
require 'spec_helper'
RSpec.describe 'Custom Integration of aruba' do
let(:file) { 'file.txt' }
it { expect { write_file file, 'Hello World' }.not_to raise_error }
it { expect(aruba.current_directory.directory?).to be true }
end
"""
When I run `rspec`
Then the specs should all pass
|
