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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
|
Feature: Run commands in ruby process
Running a lot of scenarios where each scenario uses Aruba
to spawn a new ruby process can be time consuming.
Aruba lets you plug in your own process class that can
run a command in the same ruby process as Cucumber/Aruba.
We expect that the command supports the following API. It needs to accept:
argv, stdin, stdout, stderr and kernel on `#initialize` and it needs to have
an `execute!`-method.
```ruby
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
\@argv = argv
\@stdin = stdin
\@stdout = stdout
\@stderr = stderr
\@kernel = kernel
end
def execute!
end
end
end
end
```
The switch to the working directory takes place around the `execute!`-method.
If needed make sure, that you determine the current working directory within
code called by the `execute!`-method or just use `Dir.getwd` during "runtime"
and not during "loadtime", when the `ruby`-interpreter reads in you class
files.
*Pros*:
* Very fast compared to spawning processes
* You can use libraries like
[simplecov](https://github.com/colszowka/simplecov) more easily, because
there is only one "process" which adds data to `simplecov`'s database
*Cons*:
* You might oversee some bugs: You might forget to require libraries in your
"production" code, because you have required them in your testing code
* Using `:in_process` interactively is not supported
**WARNING**: Using `:in_process` interactively is not supported
Background:
Given I use a fixture named "cli-app"
And a file named "features/support/cli_app.rb" with:
"""
require 'cli/app/runner'
"""
And a file named "features/support/in_proccess.rb" with:
"""
require 'aruba/cucumber'
Before('@in-process') do
aruba.config.command_launcher = :in_process
aruba.config.main_class = Cli::App::Runner
end
After('@in-process') do
aruba.config.command_launcher = :spawn
end
"""
Scenario: Run custom code
Given a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts(@argv.map(&:reverse).join(' '))
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `reverse.rb Hello World`
Then the output should contain:
\"\"\"
olleH dlroW
\"\"\"
"""
When I run `cucumber`
Then the features should all pass
Scenario: Mixing custom code and normal cli
Given an executable named "bin/cli" with:
"""
#!/bin/bash
echo $*
"""
And a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts(@argv.map(&:reverse).join(' '))
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command in process
When I run `reverse.rb Hello World`
Then the output should contain:
\"\"\"
olleH dlroW
\"\"\"
Scenario: Run command
When I run `cli Hello World`
Then the output should contain:
\"\"\"
Hello World
\"\"\"
"""
When I run `cucumber`
Then the features should all pass
Scenario: The current working directory is changed as well
Given a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts("PWD-ENV is " + Dir.getwd)
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `pwd.rb`
Then the output should match %r<PWD-ENV.*tmp/aruba>
"""
When I run `cucumber`
Then the features should all pass
Scenario: The PWD environment is changed to current working directory
Given a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts("PWD-ENV is " + ENV['PWD'])
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `pwd.rb`
Then the output should match %r<PWD-ENV.*tmp/aruba>
"""
When I run `cucumber`
Then the features should all pass
Scenario: Set runner via "Aruba.process ="-method (deprecated)
Given a file named "features/support/in_proccess.rb" with:
"""
require 'aruba/cucumber'
require 'aruba/processes/in_process'
Before('@in-process') do
Aruba.process = Aruba::Processes::InProcess
Aruba.process.main_class = Cli::App::Runner
end
After('@in-process') do
Aruba.process = Aruba::Processes::SpawnProcess
end
"""
Given a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts(@argv.map(&:reverse).join(' '))
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `reverse.rb Hello World`
Then the output should contain:
\"\"\"
olleH dlroW
\"\"\"
"""
When I run `cucumber`
Then the features should all pass
Scenario: Set runner via "Aruba.process ="-method and use old class name Aruba::InProcess (deprecated)
Given a file named "features/support/in_proccess.rb" with:
"""
require 'aruba/cucumber'
require 'aruba/in_process'
require 'aruba/spawn_process'
Before('@in-process') do
Aruba.process = Aruba::InProcess
Aruba.process.main_class = Cli::App::Runner
end
After('@in-process') do
Aruba.process = Aruba::SpawnProcess
end
"""
Given a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
@stdin = stdin
@stdout = stdout
@stderr = stderr
@kernel = kernel
end
def execute!
@stdout.puts(@argv.map(&:reverse).join(' '))
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `reverse.rb Hello World`
Then the output should contain:
\"\"\"
olleH dlroW
\"\"\"
"""
When I run `cucumber`
Then the features should all pass
Scenario: Use $stderr, $stdout and $stdin to access IO
May may need/want to use the default `STDERR`, `STDOUT`, `STDIN`-constants
to access IO from within your script. Unfortunately this does not work with
the `:in_process`-command launcher. You need to use `$stderr`, `$stdout`
and `$stdin` instead.
For this example I chose `thor` to parse ARGV. Its `.start`-method accepts
an "Array" as ARGV and a "Hash" for some other options – `.start <ARGV>, <OPTIONS>`
Given a file named "lib/cli/app/runner.rb" with:
"""
require 'cli/app/cli_parser'
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
$kernel = kernel
$stdin = stdin
$stdout = stdout
$stderr = stderr
end
def execute!
Cli::App::CliParser.start @argv
end
end
end
end
"""
And a file named "lib/cli/app/cli_parser.rb" with:
"""
require 'thor'
module Cli
module App
class CliParser < Thor
def self.exit_on_failure?
true
end
desc 'do_it', 'Reverse input'
def do_it(*args)
$stderr.puts 'Hey ya, Hey ya, check, check, check'
$stdout.puts(args.flatten.map(&:reverse).join(' '))
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `reverse.rb do_it Hello World`
Then the stdout should contain:
\"\"\"
olleH dlroW
\"\"\"
And the stderr should contain:
\"\"\"
Hey ya, Hey ya, check, check, check
\"\"\"
"""
When I run `cucumber`
Then the features should all pass
Scenario: Use $kernel to use Kernel to capture exit code
Ruby's `Kernel`-module provides some helper methods like `exit`.
Unfortunately running `#exit` with `:in_process` would make the whole ruby
interpreter exit. So you might want to use our `FakeKernel`-module module
instead which overwrites `#exit`. This will also make our tests for
checking the exit code work. This example also uses the `thor`-library.
Given a file named "lib/cli/app/runner.rb" with:
"""
require 'cli/app/cli_parser'
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@argv = argv
$kernel = kernel
$stdin = stdin
$stdout = stdout
$stderr = stderr
end
def execute!
Cli::App::CliParser.start @argv
end
end
end
end
"""
And a file named "lib/cli/app/cli_parser.rb" with:
"""
require 'thor'
module Cli
module App
class CliParser < Thor
def self.exit_on_failure?
true
end
desc 'do_it', 'Reverse input'
def do_it(*args)
$kernel.exit 5
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
When I run `reverse.rb do_it`
Then the exit status should be 5
"""
When I run `cucumber`
Then the features should all pass
Scenario: Using `:in_process` interactively is not supported
Reading from STDIN blocks ruby from going on. But writing to STDIN - e.g.
type some letters on keyboard - can only appear later, but this point is
never reached, because ruby is blocked.
Given the default aruba exit timeout is 5 seconds
And a file named "lib/cli/app/runner.rb" with:
"""
module Cli
module App
class Runner
def initialize(argv, stdin, stdout, stderr, kernel)
@stdin = stdin
end
def execute!
while res = @stdin.gets.to_s.chomp
break if res == 'quit'
puts res.reverse
end
end
end
end
end
"""
And a file named "features/in_process.feature" with:
"""
Feature: Run a command in process
@in-process
Scenario: Run command
Given the default aruba exit timeout is 2 seconds
When I run `reverse.rb do_it` interactively
When I type "hello"
Then the output should contain:
\"\"\"
hello
\"\"\"
"""
When I run `cucumber`
Then the exit status should not be 0
|