aruba-turnip 0.1.0

data/lib/aruba/turnip/file.rb

@@ -0,0 +1,223 @@
+step 'I use (a/the) fixture named ":name"' do |name|
+  copy File.join(aruba.config.fixtures_path_prefix, name), name
+  cd name
+end
+
+=begin
+step 'I copy (a/the) (file|directory)(?: (?:named|from))? "([^"]*)" to "([^"]*)"' do |file_or_directory, source, destination|
+  copy source, destination
+end
+
+step 'I move (a/the) (file|directory)(?: (?:named|from))? "([^"]*)" to "([^"]*)"' do |file_or_directory, source, destination|
+  move source, destination
+end
+
+=end
+
+step '(a/the) directory (named) ":dir_name"' do |dir_name|
+  create_directory(dir_name)
+end
+
+step '(a/the) directory (named) ":dir_name" with mode ":mode"' do |dir_name, dir_mode|
+  create_directory(dir_name)
+  chmod(dir_mode, dir_name)
+end
+
+step '(a/the) file (named) ":file_name" with:' do |file_name, file_content|
+  write_file(file_name, file_content)
+end
+
+step '(an/the) executable (named) ":file_name" with:' do |file_name, file_content|
+  step %(a file named "#{file_name}" with mode "0755" and with:), file_content
+end
+
+=begin
+step '(a/the) file (named) "([^"]*)" with "([^"]*)"' do |file_name, file_content|
+  write_file(file_name, unescape_text(file_content))
+end
+=end
+
+step '(a/the) file (named) ":file_name" with mode ":file_mode" and with:' do |file_name, file_mode, file_content|
+  write_file(file_name, unescape_text(file_content))
+  chmod(file_mode, file_name)
+end
+
+=begin
+
+step '(a/the) (\d+) byte file (named) "([^"]*)"' do |file_size, file_name|
+  write_fixed_size_file(file_name, file_size.to_i)
+end
+
+step '(?:an|the) empty file (named) "([^"]*)"' do |file_name|
+  write_file(file_name, "")
+end
+
+step '(?:an|the) empty file (named) "([^"]*)" with mode "([^"]*)"' do |file_name, file_mode|
+  write_file(file_name, "")
+  chmod(file_mode, file_name)
+end
+
+step 'I write to "([^"]*)" with:' do |file_name, file_content|
+  write_file(file_name, file_content)
+end
+
+step 'I overwrite(?: (a/the) file (named))? "([^"]*)" with:' do |file_name, file_content|
+  overwrite_file(file_name, file_content)
+end
+
+=end
+
+step 'I append to ":file_name" with:' do |file_name, file_content|
+  append_to_file(file_name, file_content)
+end
+
+=begin
+
+step 'I append to "([^"]*)" with "([^"]*)"' do |file_name, file_content|
+  append_to_file(file_name, file_content)
+end
+
+step 'I remove (a/the) (?:file|directory) (named) "([^"]*)"( with full force)?' do |name, force_remove|
+  remove(name, :force => force_remove.nil? ? false : true)
+end
+
+step '(a/the) (?:file|directory) (named) "([^"]*)" does not exist' do |name|
+  remove(name, :force => true)
+end
+
+=end
+
+step 'I cd to ":dir"' do |dir|
+  cd(dir)
+end
+
+=begin
+
+step 'the following files should (not )?exist:' do |negated, files|
+  files = files.raw.flatten
+
+  if negated
+    expect(files).not_to include an_existing_file
+  else
+    expect(files).to Aruba::Matchers.all be_an_existing_file
+  end
+end
+
+=end
+
+placeholder :file_or_directory do
+  match /file/ do
+    "file"
+  end
+
+  match /directory/ do
+    "directory"
+  end
+end
+
+step '(a/the) :file_or_directory (named) ":path" :outcome exist (anymore)' do |directory_or_file, path, expect_match|
+  case directory_or_file
+  when "file"
+    if expect_match
+      expect(path).to be_an_existing_file
+    else
+      expect(path).not_to be_an_existing_file
+    end
+  when "directory"
+    if expect_match
+      expect(path).to be_an_existing_directory
+    else
+      expect(path).not_to be_an_existing_directory
+    end
+  end
+end
+
+=begin
+
+step '(a/the) file matching %r<(.*?)> should (not )?exist' do |pattern, expect_match|
+  if expect_match
+    expect(all_paths).not_to include a_file_name_matching(pattern)
+  else
+    expect(all_paths).to include match a_file_name_matching(pattern)
+  end
+end
+
+step '(a/the) (\d+) byte file (named) "([^"]*)" should (not )?exist' do |size, file, negated|
+  if negated
+    expect(file).not_to have_file_size(size)
+  else
+    expect(file).to have_file_size(size)
+  end
+end
+
+step 'the following directories should (not )?exist:' do |negated, directories|
+  directories = directories.rows.flatten
+
+  if negated
+    expect(directories).not_to include an_existing_directory
+  else
+    expect(directories).to Aruba::Matchers.all be_an_existing_directory
+  end
+end
+
+=end
+
+step '(a/the) file (named) ":file" :outcome contain ":content"' do |file, expect_success, content|
+  if expect_success
+    expect(file).to have_file_content file_content_including(content.chomp)
+  else
+    expect(file).not_to have_file_content file_content_including(content.chomp)
+  end
+end
+
+=begin
+
+step '(a/the) file (named) "([^"]*)" should (not )?contain:' do |file, negated, content|
+  if negated
+    expect(file).not_to have_file_content file_content_including(content.chomp)
+  else
+    expect(file).to have_file_content file_content_including(content.chomp)
+  end
+end
+
+step '(a/the) file (named) "([^"]*)" should (not )?contain exactly:' do |file, negated, content|
+  if negated
+    expect(file).not_to have_file_content content
+  else
+    expect(file).to have_file_content content
+  end
+end
+
+step '(a/the) file (named) "([^"]*)" should (not )?match %r<([^\/]*)>' do |file, negated, content|
+  if negated
+    expect(file).not_to have_file_content file_content_matching(content)
+  else
+    expect(file).to have_file_content file_content_matching(content)
+  end
+end
+
+step '(a/the) file (named) "([^"]*)" should (not )?match \/([^\/]*)\/' do |file, negated, content|
+  if negated
+    expect(file).not_to have_file_content file_content_matching(content)
+  else
+    expect(file).to have_file_content file_content_matching(content)
+  end
+end
+
+step '(a/the) file (named) "([^"]*)" should (not )?be equal to file "([^"]*)"/) do |file, negated, reference_file|
+  if negated
+    expect(file).not_to have_same_file_content_like(reference_file)
+  else
+    expect(file).to have_same_file_content_like(reference_file)
+  end
+end
+
+=end
+
+step 'the (file/directory) (named) ":path" :outcome have permissions ":permissions"' do |path, expect_success, permissions|
+  if expect_success
+    expect(path).to have_permissions(permissions)
+  else
+    expect(path).not_to have_permissions(permissions)
+  end
+end

data/lib/aruba/turnip/placeholders.rb

@@ -0,0 +1,37 @@
+placeholder :channel do
+  match /(output|stderr|stdout)/ do |channel|
+    channel
+  end
+end
+
+placeholder :command do
+  match /`([^`]+)`/ do |command|
+    command
+  end
+end
+
+placeholder :with_optional_timeout do
+  match /\sfor up to (\d+) seconds?/ do |seconds|
+    seconds.to_i
+  end
+
+  match // do
+    nil
+  end
+end
+
+placeholder :outcome do
+  match /should not/ do
+    false
+  end
+
+  match /should/ do
+    true
+  end
+end
+
+placeholder :is_regex do
+  match /regex/ do
+    true
+  end
+end

data/lib/aruba/turnip/testing_frameworks.rb

@@ -0,0 +1,33 @@
+# Turnip
+step "the feature/features :outcome (all) pass" do |expect_success|
+  if expect_success
+    step 'the output should not contain "(FAILED"'
+    step 'the output should not contain "No such step:"'
+    step "the exit status should be 0"
+  else
+    step 'the output should contain "(FAILED"'
+    step "the exit status should be 1"
+  end
+end
+
+# Turnip
+step "the feature/features :outcome (all) pass with:" do |expect_success, string|
+  if expect_success
+    step "the features should pass"
+  else
+    step "the features should not pass"
+  end
+
+  step "the output should contain:", string
+end
+
+# Turnip
+step "the feature/features :outcome (all) pass with regex:" do |expect_success, string|
+  if expect_success
+    step "the features should pass"
+  else
+    step "the features should not pass"
+  end
+
+  step "the output should match %r<#{string}>"
+end

data/lib/aruba/turnip/version.rb

@@ -0,0 +1,5 @@
+module Aruba
+  module Turnip
+    VERSION = "0.1.0"
+  end
+end

data/lib/aruba/turnip.rb

@@ -0,0 +1,13 @@
+module Aruba; end
+
+module Aruba::Turnip
+end
+
+require "turnip/rspec"
+require "aruba/rspec"
+require "aruba/api"
+
+require "aruba/turnip/placeholders"
+require "aruba/turnip/command"
+require "aruba/turnip/file"
+require "aruba/turnip/testing_frameworks"

data/spec/acceptance/fixtures/cli-app/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require turnip/rspec
+--pattern "spec/acceptance/**/*.feature,spec/**/*_spec.rb"

data/spec/acceptance/fixtures/cli-app/README.md

@@ -0,0 +1,39 @@
+# Simple Cli App
+
+This is a simple test cli app
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli-app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli-app
+
+## Usage
+
+Place files in `lib/cli/app/`. They are loaded automatically. If you need a
+specific load order, use `require` in your files.
+
+### CLI
+
+```
+cli
+```
+
+### Library
+
+You can use `script/console` to load your library.
+
+### Fixture
+
+This fixture includes files for `cucumber`- and `rspec`-integration.
+

data/spec/acceptance/fixtures/cli-app/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/spec/acceptance/fixtures/cli-app/cli-app.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli/app/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cli-app'
+  spec.version       = Cli::App::VERSION
+  spec.authors       = ['Aruba Developers']
+  spec.email         = 'cukes@googlegroups.com'
+
+  spec.summary       = 'Summary'
+  spec.description   = 'Description'
+  spec.homepage      = 'http://example.com'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/acceptance/fixtures/cli-app/lib/cli/app/suppress_simple_cov_output.rb

@@ -0,0 +1,15 @@
+module SimpleCov
+  module Formatter
+    class HTMLFormatter
+      def format(result)
+        Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path|
+          FileUtils.cp_r(path, asset_output_path)
+        end
+
+        File.open(File.join(output_path, "index.html"), "wb") do |file|
+          file.puts template("layout").result(binding)
+        end
+      end
+    end
+  end
+end

data/spec/acceptance/fixtures/cli-app/lib/cli/app/version.rb

@@ -0,0 +1,5 @@
+module Cli
+  module App
+    VERSION = "0.1.0".freeze
+  end
+end

data/spec/acceptance/fixtures/cli-app/lib/cli/app.rb

@@ -0,0 +1,9 @@
+require 'cli/app/version'
+
+::Dir.glob(File.expand_path('../**/*.rb', __FILE__)).each { |f| require_relative f }
+
+module Cli
+  module App
+    # Your code goes here...
+  end
+end

data/spec/acceptance/fixtures/cli-app/spec/acceptance/non-existence.feature

@@ -0,0 +1,10 @@
+Feature: Working Directory
+  Scenario: Working Directory
+    Given a file named "foo/bar/example.txt" with:
+    """
+    hello world
+    """
+    When I cd to "foo/bar"
+    And I run `cat example.txt`
+    Then the output should contain "hello world"
+    And the file "example.txt" should exist

data/spec/acceptance/fixtures/cli-app/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path("../../../../../lib", __dir__)
+
+require "aruba/turnip"
+require "cli/app"
+
+RSpec.configure do |config|
+  config.include Aruba::Api
+end
+
+::Dir.glob(::File.expand_path("support/**/*.rb", __dir__)).each do |f|
+  require_relative f
+end
+
+::Dir.glob(::File.expand_path("acceptance/support/**/*.rb", __dir__)).each do |f|
+  require_relative f
+end

data/spec/acceptance/fixtures/cli-app/spec/support/aruba.rb

@@ -0,0 +1 @@
+require 'aruba/rspec'

data/spec/acceptance/fixtures/cli-app/tmp/aruba/foo/bar/example.txt

@@ -0,0 +1 @@
+hello world

data/spec/acceptance/steps/aruba_dev_steps.rb

@@ -0,0 +1,56 @@
+When /^I do aruba (.*)$/ do |aruba_step|
+  @aruba_exception = StandardError.new
+
+  begin
+    step(aruba_step)
+  rescue => e
+    @aruba_exception = e
+  end
+end
+
+# Useful for debugging timing problems
+When /^sleep (\d+)$/ do |time|
+  sleep time.to_i
+end
+
+When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
+  ENV[var] = value
+end
+
+Then /^aruba should fail with "([^"]*)"$/ do |error_message|
+  expect(@aruba_exception.message).to include sanitize_text(error_message)
+end
+
+Then /^the following step should fail with Spec::Expectations::ExpectationNotMetError:$/ do |multiline_step|
+  expect{steps multiline_step.to_s}.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+end
+
+Given(/^the default executable$/) do
+  step 'an executable named "bin/aruba-test-cli" with:', <<-EOS
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'cli/app'
+
+exit 0
+  EOS
+end
+
+Given(/^the default feature-test$/) do
+  step(
+    'a file named "features/default.feature" with:',
+    <<-EOS.strip_heredoc
+    Feature: Default Feature
+
+      This is the default feature
+
+      Scenario: Run command
+        Given I successfully run `cli`
+    EOS
+  )
+end
+
+Then(/^aruba should be installed on the local system$/) do
+  run('gem list aruba')
+  expect(last_command_started).to have_output(/aruba/)
+end

data/spec/acceptance/testing_frameworks/turnip/steps/command/exit_statuses.feature

@@ -0,0 +1,136 @@
+Feature: Check exit status of commands
+
+  Use the `the exit status should be \d`-step to check the exit status of the
+  last command which was executed.
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Test for exit status of 0
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    exit 0
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Exit status
+      Scenario: Run command
+        When I run `aruba-test-cli`
+        Then the exit status should be 0
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Test for exit status 1
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        When I run `aruba-test-cli`
+        Then the exit status should be 1
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Test for non-zero exit status
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        When I run `aruba-test-cli`
+        Then the exit status should not be 0
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Successfully run something
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    exit 0
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        When I successfully run `aruba-test-cli`
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Fail to run something successfully
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        When I successfully run `aruba-test-cli`
+    """
+    When I run `rspec`
+    Then the features should not all pass
+
+  Scenario: Overwrite the default exit timeout via step
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    sleep 1
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        Given the default aruba exit timeout is 2 seconds
+        When I successfully run `aruba-test-cli`
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Successfully run something longer then the default time
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    sleep 1
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        Given the default aruba exit timeout is 0 seconds
+        When I successfully run `aruba-test-cli` for up to 2 seconds
+    """
+    When I run `rspec`
+    Then the features should all pass
+
+  Scenario: Unsuccessfully run something that takes too long
+    Given an executable named "bin/aruba-test-cli" with:
+    """
+    #!/bin/bash
+    sleep 2
+    """
+    And a file named "spec/acceptance/exit_status.feature" with:
+    """
+    Feature: Failing program
+      Scenario: Run command
+        Given the default aruba exit timeout is 0 seconds
+        When I successfully run `aruba-test-cli` for up to 1 seconds
+    """
+    When I run `rspec`
+    Then the features should not all pass with:
+    """
+    expected "aruba-test-cli" to have finished in time
+    """