aruba-turnip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c68318e3bab555e2bcc2cec056fc44575b040dd4
+  data.tar.gz: 8503e02f1933c0fb1bba89d15b7db47e5bd3d667
+SHA512:
+  metadata.gz: d0cd2b254ac61b6d33ace3c1be0589d44e41e7a3f04de6a0cd0e76d2a8c1eb18e8e9d3002de098f6ca4f158bfc75b42913ce3e78d82d6c036fb2cfd7c78b07aa
+  data.tar.gz: ff567de60934ba6bb536cedc6f7020f351affac16ed5263b0ec0fd8a9992fc7ff4bccd737bc24814a74658437124a36d402b9942da5c72154de0ccbac3669ff7

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--require turnip/rspec
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joe.g.yates@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :debug do
+  if !RUBY_PLATFORM.include?("java")
+    gem "byebug", "~> 4.0.5"
+    gem "pry-byebug", "~> 3.1.0"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Aruba::Turnip
+
+This gem provides step definitions suitable for use
+in projects tested with [RSpec](https://github.com/rspec/rspec) and
+[Turnip](https://github.com/jnicklas/turnip).
+
+The steps are direct adaptations of the step definitions and support code
+provided by [Aruba](https://github.com/cucumber/aruba) for
+[Cucumber](https://github.com/cucumber/cucumber-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aruba-turnip'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aruba-turnip
+
+## Usage
+
+See the step definitions in `lib/aruba/turnip`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you
+to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/joeyates/aruba-turnip.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aruba-turnip.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aruba/turnip/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aruba-turnip"
+  spec.version       = Aruba::Turnip::VERSION
+  spec.authors       = ["Joe Yates"]
+  spec.email         = ["joe.g.yates@gmail.com"]
+
+  spec.summary       = %q{Turnip step definitions for Aruba.}
+  spec.description   = <<-EOT
+This gem contains adaptations of Aruba's step definitions suitable for use
+in projects tested with RSpec and Turnip.
+  EOT
+  spec.homepage      = "https://github.com/joeyates/aruba-turnip"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "aruba", "~> 0.14"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "turnip"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aruba/turnip"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aruba/turnip/command.rb

@@ -0,0 +1,379 @@
+require 'aruba/generators/script_file'
+
+step 'I run :command' do |cmd|
+  cmd = sanitize_text(cmd)
+  run_simple(cmd, fail_on_error: false)
+end
+
+## I successfully run `echo -n "Hello"`
+## I successfully run `sleep 29` for up to 30 seconds
+step 'I successfully run :command:with_optional_timeout' do |cmd, secs|
+  cmd = sanitize_text(cmd)
+  run_simple(cmd, fail_on_error: true, exit_timeout: secs)
+end
+
+=begin
+
+step 'I run the following (?:commands|script)(?: (?:with|in) `([^`]+)`)?:' do |shell, commands|
+  prepend_environment_variable('PATH', expand_path('bin') + ':')
+
+  Aruba.platform.mkdir(expand_path('bin'))
+  shell ||= Aruba.platform.default_shell
+
+  Aruba::ScriptFile.new(:interpreter => shell, :content => commands,
+                        :path => expand_path('bin/myscript')).call
+  step 'I run `myscript`'
+end
+
+=end
+
+step 'I run :command interactively' do |cmd|
+  cmd = sanitize_text(cmd)
+  @interactive = run(cmd)
+end
+
+=begin
+
+# Merge interactive and background after refactoring with event queue
+step 'I run `([^`]*)` in background'do |cmd|
+  run(sanitize_text(cmd))
+end
+
+step 'I type "([^"]*)"' do |input|
+  type(unescape_text(input))
+end
+
+step 'I close the stdin stream' do
+  close_input
+end
+
+step 'I pipe in (?:a|the) file(?: named)? "([^"]*)"' do |file|
+  pipe_in_file(file)
+
+  close_input
+end
+
+step 'I (terminate|stop) the command (?:"([^"]*)"|(?:started last))' do |signal, command|
+  if command
+    cmd = all_commands.find { |c| c.commandline == command }
+    fail ArgumentError, %(No command "#{command}" found) if cmd.nil?
+
+    if signal == 'terminate'
+      # last_command_started.terminate
+      process_monitor.terminate_process!(process_monitor.get_process(command))
+    else
+      # last_command_started.stop
+      process_monitor.stop_process(process_monitor.get_process(command))
+    end
+  else
+    if signal == 'terminate'
+      # last_command_started.terminate
+      process_monitor.terminate_process!(last_command_started)
+    else
+      # last_command_started.stop
+      process_monitor.stop_process(last_command_started)
+    end
+  end
+end
+
+=end
+    
+step 'I stop the command (started last) if :channel contains:' do |channel, expected|
+  begin
+    Timeout.timeout(aruba.config.exit_timeout) do
+      loop do
+        output = last_command_started.public_send channel.to_sym, :wait_for_io => 0
+
+        output   = sanitize_text(output)
+        expected = sanitize_text(expected)
+
+        if output.include? expected
+          last_command_started.terminate
+
+          break
+        end
+
+        sleep 0.1
+      end
+    end
+  rescue ChildProcess::TimeoutError, TimeoutError
+    last_command_started.terminate
+  end
+end
+
+=begin
+
+step 'I wait for (?:output|stdout) to contain:' do |expected|
+  Timeout.timeout(aruba.config.exit_timeout) do
+    loop do
+      begin
+        expect(last_command_started).to have_output an_output_string_including(expected)
+      rescue ExpectationError
+        sleep 0.1
+        retry
+      end
+
+      break
+    end
+  end
+end
+
+step 'I wait for (?:output|stdout) to contain "([^"]*)"' do |expected|
+  Timeout.timeout(aruba.config.exit_timeout) do
+    loop do
+      begin
+        expect(last_command_started).to have_output an_output_string_including(expected)
+      rescue ExpectationError
+        sleep 0.1
+        retry
+      end
+
+      break
+    end
+  end
+end
+
+step 'the output should be (\d+) bytes long' do |size|
+  expect(all_output).to have_output_size size.to_i
+end
+
+=end
+
+step '(the) :channel :outcome contain ":expected"' do |channel, outcome, expected|
+  exactly = false # TODO
+  cmd = false # TODO
+  matcher = case channel.to_sym
+            when :output
+              :have_output
+            when :stderr
+              :have_output_on_stderr
+            when :stdout
+              :have_output_on_stdout
+            end
+
+  commands = if cmd
+               [aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd))]
+             else
+               all_commands
+             end
+
+  output_string_matcher = if exactly
+                            :an_output_string_being_eq
+                          else
+                            :an_output_string_including
+                          end
+
+  if !outcome
+    expect(commands).not_to include_an_object send(matcher, send(output_string_matcher, expected))
+  else
+    expect(commands).to include_an_object send(matcher, send(output_string_matcher, expected))
+  end
+end
+
+## the stderr should contain "hello"
+## the stderr from "echo -n 'Hello'" should contain "hello"
+## the stderr should contain exactly:
+## the stderr from "echo -n 'Hello'" should contain exactly:
+step '(the) :channel :outcome contain:' do |channel, outcome, expected|
+  exactly = false # TODO
+  cmd = false # TODO
+  matcher = case channel.to_sym
+            when :output
+              :have_output
+            when :stderr
+              :have_output_on_stderr
+            when :stdout
+              :have_output_on_stdout
+            else
+              fail ArgumentError, %(Invalid channel "#{channel}" chosen. Only "output", "stderr" or "stdout" are allowed.)
+            end
+
+  commands = if cmd
+               [aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd))]
+             else
+               all_commands
+             end
+
+  output_string_matcher = if exactly
+                            :an_output_string_being_eq
+                          else
+                            :an_output_string_including
+                          end
+
+  if !outcome
+    expect(commands).not_to include_an_object send(matcher, send(output_string_matcher, expected))
+  else
+    expect(commands).to include_an_object send(matcher, send(output_string_matcher, expected))
+  end
+end
+
+=begin
+
+# "the output should match" allows regex in the partial_output, if
+# you don't need regex, use "the output should contain" instead since
+# that way, you don't have to escape regex characters that
+# appear naturally in the output
+step 'the output should( not)? match \/([^\/]*)\/' do |negated, expected|
+  if negated
+    expect(all_commands).not_to include_an_object have_output an_output_string_matching(expected)
+  else
+    expect(all_commands).to include_an_object have_output an_output_string_matching(expected)
+  end
+end
+
+step 'the output should( not)? match %r<([^>]*)>' do |negated, expected|
+  if negated
+    expect(all_commands).not_to include_an_object have_output an_output_string_matching(expected)
+  else
+    expect(all_commands).to include_an_object have_output an_output_string_matching(expected)
+  end
+end
+
+=end
+
+step 'the output :outcome match:' do |expect_success, expected|
+  if expect_success
+    expect(all_commands).to include_an_object have_output an_output_string_matching(expected)
+  else
+    expect(all_commands).not_to include_an_object have_output an_output_string_matching(expected)
+  end
+end
+
+step 'the exit status :outcome be :exit_status' do |expect_success, exit_status|
+  if expect_success
+    expect(last_command_stopped).to have_exit_status exit_status.to_i
+  else
+    expect(last_command_stopped).not_to have_exit_status exit_status.to_i
+  end
+end
+
+=begin
+
+step 'it should( not)? (pass|fail) with "(.*?)"' do |negated, pass_fail, expected|
+  if pass_fail == 'pass'
+    expect(last_command_stopped).to be_successfully_executed
+  else
+    expect(last_command_stopped).not_to be_successfully_executed
+  end
+
+  if negated
+    expect(last_command_stopped).not_to have_output an_output_string_including(expected)
+  else
+    expect(last_command_stopped).to have_output an_output_string_including(expected)
+  end
+end
+
+step 'it should( not)? (pass|fail) with:' do |negated, pass_fail, expected|
+  if pass_fail == 'pass'
+    expect(last_command_stopped).to be_successfully_executed
+  else
+    expect(last_command_stopped).not_to be_successfully_executed
+  end
+
+  if negated
+    expect(last_command_stopped).not_to have_output an_output_string_including(expected)
+  else
+    expect(last_command_stopped).to have_output an_output_string_including(expected)
+  end
+end
+
+step 'it should( not)? (pass|fail) with exactly:' do |negated, pass_fail, expected|
+  if pass_fail == 'pass'
+    expect(last_command_stopped).to be_successfully_executed
+  else
+    expect(last_command_stopped).not_to be_successfully_executed
+  end
+
+  if negated
+    expect(last_command_stopped).not_to have_output an_output_string_eq(expected)
+  else
+    expect(last_command_stopped).to have_output an_output_string_being_eq(expected)
+  end
+end
+
+step 'it should( not)? (pass|fail) (?:with regexp?|matching):' do |negated, pass_fail, expected|
+  if pass_fail == 'pass'
+    expect(last_command_stopped).to be_successfully_executed
+  else
+    expect(last_command_stopped).not_to be_successfully_executed
+  end
+
+  if negated
+    expect(last_command_stopped).not_to have_output an_output_string_matching(expected)
+  else
+    expect(last_command_stopped).to have_output an_output_string_matching(expected)
+  end
+end
+
+step '(?:the )?(output|stderr|stdout) should not contain anything' do |channel|
+  matcher = case channel.to_sym
+            when :output
+              :have_output
+            when :stderr
+              :have_output_on_stderr
+            when :stdout
+              :have_output_on_stdout
+            else
+              fail ArgumentError, %(Invalid channel "#{channel}" chosen. Only "output", "stdout" and "stderr" are supported.)
+            end
+
+  expect(all_commands).to include_an_object send(matcher, be_nil.or(be_empty))
+end
+
+step '(?:the )?(output|stdout|stderr) should( not)? contain all of these lines:' do |channel, negated, table|
+  table.raw.flatten.each do |expected|
+    matcher = case channel.to_sym
+              when :output
+                :have_output
+              when :stderr
+                :have_output_on_stderr
+              when :stdout
+                :have_output_on_stdout
+              else
+                fail ArgumentError, %(Invalid channel "#{channel}" chosen. Only "output", "stdout" and "stderr" are supported.)
+              end
+
+    if negated
+      expect(all_commands).not_to include_an_object have_output an_output_string_including(expected)
+    else
+      expect(all_commands).to include_an_object have_output an_output_string_including(expected)
+    end
+  end
+end
+
+step '^the (?:default )?aruba io wait timeout is (\d+) seconds?' do |seconds|
+  aruba.config.io_wait_timeout = seconds.to_i
+end
+
+=end
+
+step 'the (default) aruba exit timeout is :seconds seconds' do |seconds|
+  aruba.config.exit_timeout = seconds.to_i
+end
+
+=begin
+
+step '^the (?:default )?aruba stop signal is "([^"]*)"' do |signal|
+  aruba.config.stop_signal = signal
+end
+
+step '^I wait (\d+) seconds? for (?:a|the) command to start up' do |seconds|
+  aruba.config.startup_wait_time = seconds.to_i
+end
+
+step 'I send the signal "([^"]*)" to the command (?:"([^"]*)"|(?:started last))' do |signal, command|
+  if command
+    cmd = all_commands.find { |c| c.commandline == command }
+    fail ArgumentError, %(No command "#{command}" found) if cmd.nil?
+
+    cmd.send_signal signal
+  else
+    last_command_started.send_signal signal
+  end
+end
+
+=end
+
+step 'I look for executables in ":directory" within the current directory' do |directory|
+  prepend_environment_variable 'PATH', expand_path(directory) + ':'
+end