module Aruba::Api::Deprecated

Deprecated

Public Instance Methods

_create_file(name, content, check_presence) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 632
def _create_file(name, content, check_presence)
  Aruba.platform.deprecated(
    'The use of "#_create_file" is deprecated.'
  )

  ArubaFileCreator.new.write(expand_path(name), content, check_presence)

  self
end
_create_fixed_size_file(file_name, file_size, check_presence) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 643
def _create_fixed_size_file(file_name, file_size, check_presence)
  Aruba.platform.deprecated(
    'The use of "#_create_fixed_size_file" is deprecated.'
  )

  ArubaFixedSizeFileCreator.new.write(expand_path(name), size, check_presence)

  self
end
_ensure_newline(str) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 69
def _ensure_newline(str)
  Aruba.platform.deprecated('The use of "#_ensure_newline" is deprecated')

  Aruba.platform.ensure_newline cmd
end
_mkdir(dir_name) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 470
def _mkdir(dir_name)
  Aruba.platform.deprecated(
    'The use of "#_mkdir" is deprecated'
  )

  Aruba.platform.mkdir(dir_name)
end
_read_interactive() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 87
def _read_interactive
  Aruba.platform.deprecated(
    'The use of "#_read_interactive" is deprecated.' \
    ' Use "last_command_started.stdout" instead'
  )

  last_command_started.stdout
end
_rm(dir_name) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 479
def _rm(dir_name)
  Aruba.platform.deprecated(
    'The use of "#_rm_rf" is deprecated'
  )

  Aruba.platform.rm(dir_name)
end
_write_interactive(input) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 111
def _write_interactive(input)
  Aruba.platform.deprecated(
    'The use of "#_write_interactive" is deprecated.' \
    ' Use "#last_command_started.write()" instead'
  )

  last_command_started.write(input)
end
absolute_path(*args) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 76
def absolute_path(*args)
  Aruba.platform.deprecated(
    'The use of "absolute_path" is deprecated.' \
    ' Use "expand_path" instead.' \
    ' But be aware that "expand_path" uses a different implementation'
  )

  File.expand_path File.join(*args), aruba.current_directory
end
announce_or_puts(msg) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 97
def announce_or_puts(msg)
  Aruba.platform.deprecated(
    'The use of "#announce_or_puts" is deprecated.' \
    ' Use "#announcer.mode = :kernel" or "#announcer.mode = :puts" instead'
  )

  if(@puts)
    Kernel.puts(msg)
  else
    puts(msg)
  end
end
announcer() click to toggle source

@deprecated

Access to announcer

# File lib/aruba/api/deprecated.rb, line 1091
def announcer
  Aruba.platform.deprecated(
    'The use of "#announcer" is deprecated.' \
    ' Use "aruba.announcer" instead'
  )

  @announcer ||= Platforms::Announcer.new(
    self,
    :stdout => defined?(@announce_stdout),
    :stderr => defined?(@announce_stderr),
    :dir    => defined?(@announce_dir),
    :cmd    => defined?(@announce_cmd),
    :env    => defined?(@announce_env)
  )

  @announcer
end
append_output_to(message) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 940
def append_output_to(message)
  Aruba.platform.deprecated(
    'The use of "#append_output_to" is deprecated'
  )

  "#{message} Output:\n\n#{all_output}\n"
end
assert_exact_output(expected, actual) click to toggle source

@deprecated

Full compare arg1 and arg2

@return [TrueClass, FalseClass]

If arg1 is exactly the same as arg2 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 756
def assert_exact_output(expected, actual)
  Aruba.platform.deprecated(
    'The use of "#assert_exact_output" is deprecated.' \
    ' Use "expect(command).to have_output \'exact\'" instead.' \
    ' There are also special matchers for "stdout" and "stderr"'
  )

  actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
  expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
    to eq Aruba.platform.unescape(expected, aruba.config.keep_ansi)
end
assert_exit_status(status) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 919
def assert_exit_status(status)
  Aruba.platform.deprecated(
    'The use of "#assert_exit_status" is deprecated.' \
    ' Use "expect(last_command_started).to have_exit_status(status)"'
  )

  expect(last_command_started).to have_exit_status(status)
end
assert_exit_status_and_output(expect_to_pass, expected_output, expect_exact_output) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 428
def assert_exit_status_and_output(expect_to_pass, expected_output,
                                  expect_exact_output)
  assert_success(expect_to_pass)
  if expect_exact_output
    assert_exact_output(expected_output, all_output)
  else
    assert_partial_output(expected_output, all_output)
  end
end
assert_exit_status_and_partial_output(expect_to_pass, expected) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 416
def assert_exit_status_and_partial_output(expect_to_pass, expected)
  Aruba.platform.deprecated(
    'The use of "assert_exit_status_and_partial_output" is deprecated.' \
    ' Use "expect(last_command_started).to be_successfully_executed"' \
    ' and "expect(command).to have_output /partial/" instead.'
  )

  assert_success(expect_to_pass)
  assert_partial_output(expected, all_output)
end
assert_failing_with(expected) click to toggle source

@deprecated

Check if command failed and if arg1 is included in output

@return [TrueClass, FalseClass]

If exit status is not equal 0 and arg1 is included in output return
true, otherwise false
# File lib/aruba/api/deprecated.rb, line 883
def assert_failing_with(expected)
  Aruba.platform.deprecated(
    'The use of "#assert_passing_with" is deprecated.' \
    ' Use "expect(last_command_started).not_to be_successfully_executed"' \
    ' and "expect(last_command_started).to have_output(/partial/)"' \
    ' or something similar instead.' \
    ' There are also special matchers for "stdout" and "stderr"'
  )

  assert_success(false)
  assert_partial_output(expected, all_output)
end
assert_matching_output(expected, actual) click to toggle source

@deprecated

Regex Compare arg1 and arg2

@return [TrueClass, FalseClass]

If arg2 matches arg1 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 791
def assert_matching_output(expected, actual)
  Aruba.platform.deprecated(
    'The use of "#assert_matching_output" is deprecated.' \
    ' Use "expect(actual).to match_output partial" instead.'
  )

  actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
  expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
    to match(/#{Aruba.platform.unescape(expected, aruba.config.keep_ansi)}/m)
end
assert_no_partial_output(unexpected, actual) click to toggle source

@deprecated

Negative partial compare arg1 and arg2

@return [TrueClass, FalseClass]

If arg2 does not match/include arg1 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 825
def assert_no_partial_output(unexpected, actual)
  Aruba.platform.deprecated(
    'The use of "#assert_no_partial_output" is deprecated.' \
    ' Use "expect(actual).not_to include_output_string partial" instead.'
  )

  actual.force_encoding(unexpected.encoding) if RUBY_VERSION >= "1.9"
  if Regexp === unexpected
    expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
      not_to match unexpected
  else
    expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
      not_to include(unexpected)
  end
end
assert_not_exit_status(status) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 929
def assert_not_exit_status(status)
  Aruba.platform.deprecated(
    'The use of "#assert_not_exit_status" is deprecated.' \
    ' Use "expect(last_command_started).not_to have_exit_status(status)"'
  )

  expect(last_exit_status).not_to eq(status),
    append_output_to("Exit status was #{last_exit_status} which was not expected.")
end
assert_not_matching_output(expected, actual) click to toggle source

@deprecated

Negative regex compare arg1 and arg2

@return [TrueClass, FalseClass]

If arg2 does not match arg1 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 808
def assert_not_matching_output(expected, actual)
  Aruba.platform.deprecated(
    'The use of "#assert_not_matching_output" is deprecated.' \
    ' Use "expect(actual).not_to match_output partial" instead.'
  )

  actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
  expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
    not_to match(/#{Aruba.platform.unescape(expected, aruba.config.keep_ansi)}/m)
end
assert_partial_output(expected, actual) click to toggle source

@deprecated

Partial compare arg1 and arg2

@return [TrueClass, FalseClass]

If arg2 contains arg1 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 774
def assert_partial_output(expected, actual)
  Aruba.platform.deprecated(
    'The use of "#assert_partial_output" is deprecated.' \
    ' Use "expect(actual).to include_output_string partial" instead.'
  )

  actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
  expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).
    to include(Aruba.platform.unescape(expected, aruba.config.keep_ansi))
end
assert_partial_output_interactive(expected) click to toggle source

@deprecated

Partial compare output of interactive command and arg1

@return [TrueClass, FalseClass]

If output of interactive command includes arg1 return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 847
def assert_partial_output_interactive(expected)
  Aruba.platform.deprecated(
    'The use of "#assert_partial_output_interactive" is deprecated.' \
    ' Use "expect(last_command_started).to have_output an_output_string_including partial" instead.'
  )

  Aruba.platform.unescape(last_command_started.stdout, aruba.config.keep_ansi).
    include?(Aruba.platform.unescape(expected, aruba.config.keep_ansi))
end
assert_passing_with(expected) click to toggle source

@deprecated

Check if command succeeded and if arg1 is included in output

@return [TrueClass, FalseClass]

If exit status is 0 and arg1 is included in output return true, otherwise false
# File lib/aruba/api/deprecated.rb, line 863
def assert_passing_with(expected)
  Aruba.platform.deprecated(
    'The use of "#assert_passing_with" is deprecated.' \
    ' Use "expect(last_command_started).to be_successfully_executed"' \
    ' and expect(last_command_started).to have_output(/partial/)"' \
    ' or something similar instead.' \
    ' There are also special matchers for "stdout" and "stderr"'
  )

  assert_success(true)
  assert_partial_output(expected, all_output)
end
assert_success(success) click to toggle source

@deprecated

Check exit status of process

@return [TrueClass, FalseClass]

If arg1 is true, return true if command was successful
If arg1 is false, return true if command failed
# File lib/aruba/api/deprecated.rb, line 903
def assert_success(success)
  Aruba.platform.deprecated(
    'The use of "#assert_success" is deprecated.' \
    ' Use "expect(last_command_started).to be_successfully_executed" or' \
    ' with "not_to" or the negative form "have_failed_running"' \
    ' (requires rspec >= 3.1)'
  )

  if success
    expect(last_command_started).to be_successfully_executed
  else
    expect(last_command_started).not_to be_successfully_executed
  end
end
check_binary_file_content(file, reference_file, expect_match = true) click to toggle source

@deprecated Check if the content of file against the content of a reference file

@param [String] file

The file to be checked

@param [String] reference_file

The reference file

@param [true, false] expect_match

Must the content be in the file or not
# File lib/aruba/api/deprecated.rb, line 361
def check_binary_file_content(file, reference_file, expect_match = true)
  Aruba.platform.deprecated(
    'The use of "#check_binary_file_content" is deprecated.' \
    ' Use "expect(file).to have_same_file_content_as(file)"'
  )

  stop_all_commands

  if expect_match
    expect(file).to have_same_file_content_as reference_file
  else
    expect(file).not_to have_same_file_content_as reference_file
  end
end
check_directory_presence(paths, expect_presence) click to toggle source

@deprecated Check presence of a directory

@param [Array] paths

The paths to be checked

@param [true, false] expect_presence

Should the directory be there or should the directory not be there
# File lib/aruba/api/deprecated.rb, line 384
def check_directory_presence(paths, expect_presence)
  Aruba.platform.deprecated(
    'The use of "#check_directory_presence" is deprecated.' \
    ' Use "expect(directory).to be_an_existing_directory"'
  )

  stop_all_commands

  paths.each do |path|
    path = expand_path(path)

    if expect_presence
      expect(path).to be_an_existing_directory
    else
      expect(path).not_to be_an_existing_directory
    end
  end
end
check_exact_file_content(file, exact_content, expect_match = true) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 341
def check_exact_file_content(file, exact_content, expect_match = true)
  Aruba.platform.deprecated(
    'The use of "#check_exact_file_content" is deprecated.' \
    ' Use "expect(file).to have_file_content(content)" with a string'
  )

  check_file_content(file, exact_content, expect_match)
end
check_file_content(file, content, expect_match = true) click to toggle source

Check the content of file

It supports partial content as well. And it is up to you to decided if the content must be there or not.

@param [String] file

The file to be checked

@param [String, Regexp] content

The content which must/must not be in the file. If content is
a String exact match is done, if content is a Regexp then file
is matched using regular expression

@param [true, false] expect_match

Must the content be in the file or not
# File lib/aruba/api/deprecated.rb, line 453
def check_file_content(file, content, expect_match = true)
  Aruba.platform.deprecated(
    'The use of "#check_file_content" is deprecated.' \
    ' Use "expect(file).to have_file_content(content)" instead.' \
    ' For eq match use string, for partial match use /regex/'
  )

  stop_all_commands

  if expect_match
    expect(file).to have_file_content content
  else
    expect(file).not_to have_file_content content
  end
end
check_file_presence(paths, expect_presence = true) click to toggle source

@deprecated

Check if paths are present

@param [#each] paths

The paths which should be checked

@param [true,false] expect_presence

Should the given paths be present (true) or absent (false)
# File lib/aruba/api/deprecated.rb, line 287
def check_file_presence(paths, expect_presence = true)
  Aruba.platform.deprecated(
    'The use of "check_file_presence" is deprecated.' \
    ' Use "expect(path).to be_an_existing_file" or' \
    ' "expect(all_paths).to all match /pattern/" instead'
  )

  stop_all_commands

  Array(paths).each do |path|
    if path.kind_of? Regexp
      if expect_presence
        expect(all_paths).to match_path_pattern(path)
      else
        expect(all_paths).not_to match_path_pattern(path)
      end
    else
      if expect_presence
        expect(path).to be_an_existing_file
      else
        expect(path).not_to be_an_existing_file
      end
    end
  end
end
check_file_size(paths_and_sizes) click to toggle source

@deprecated Check the file size of paths

@params [Hash] paths_and_sizes

A hash containing the path (key) and the expected size (value)

@example

paths_and_sizes = {
  'file' => 10
}

check_file_size(paths_and_sizes)
# File lib/aruba/api/deprecated.rb, line 327
def check_file_size(paths_and_sizes)
  Aruba.platform.deprecated(
    'The use of "#check_file_size" is deprecated.' \
    ' Use "expect(file).to have_file_size(size)" instead'
  )

  stop_all_commands

  paths_and_sizes.each do |path, size|
    expect(path).to have_file_size size
  end
end
check_filesystem_permissions(*args) click to toggle source

Check file system permissions of file

@param [Octal] expected_permissions

Expected file system permissions, e.g. 0755

@param [String] file_names

The file name(s)

@param [Boolean] expected_result

Are the permissions expected to be mode or are they expected not to be mode?
# File lib/aruba/api/deprecated.rb, line 609
def check_filesystem_permissions(*args)
  Aruba.platform.deprecated(
    'The use of "#check_filesystem_permissions" is deprecated.' \
    ' Use "expect(path).to have_permissions perms" instead'
  )

  args = args.flatten

  expected_permissions = args.shift
  expected_result      = args.pop

  args.each do |p|
    raise "Expected #{p} to be present" unless exist? p

    if expected_result
      expect(p).to have_permissions expected_permissions
    else
      expect(p).not_to have_permissions expected_permissions
    end
  end
end
check_for_deprecated_variables() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 703
def check_for_deprecated_variables
  if defined? @aruba_exit_timeout
    Aruba.platform.deprecated(
      'The use of "@aruba_exit_timeout" is deprecated.' \
      ' Use "#aruba.config.exit_timeout = <numeric>" instead'
    )
    aruba.config.exit_timeout = @aruba_exit_timeout
  end

  if defined? @aruba_io_wait_seconds
    Aruba.platform.deprecated(
      'The use of "@aruba_io_wait_seconds" is deprecated.' \
      ' Use "#aruba.config.io_wait_timeout = <numeric>" instead'
    )
    aruba.config.io_wait_timeout = @aruba_io_wait_seconds
  end

  if defined? @keep_ansi
    Aruba.platform.deprecated(
      'The use of "@aruba_keep_ansi" is deprecated.' \
      ' Use "#aruba.config.remove_ansi_escape_sequences = <true|false>" instead.' \
      ' Be aware that it uses an inverted logic'
    )

    aruba.config.remove_ansi_escape_sequences = false
  end

  if defined? @aruba_root_directory
    Aruba.platform.deprecated(
      'The use of "@aruba_root_directory" is deprecated.' \
      ' Use "#aruba.config.root_directory = <string>" instead'
    )

    aruba.config.root_directory = @aruba_root_directory.to_s
  end
end
clean_current_dir(*args, &block) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 498
def clean_current_dir(*args, &block)
  Aruba.platform.deprecated(
    'The use of "clean_current_dir" is deprecated.' \
    ' Use "#setup_aruba" or `#remove(\'.\') to clean up Aruba\'s working' \
    ' directory before your tests are run'
  )

  setup_aruba
end
clean_current_directory() click to toggle source

@deprecated Clean the current directory

# File lib/aruba/api/deprecated.rb, line 44
def clean_current_directory
  Aruba.platform.deprecated(
    'The use of "clean_current_directory" is deprecated.' \
    ' Either use "#setup_aruba" or "#remove(\'.\')" to clean up Aruba\'s' \
    ' working directory before your tests are run'
  )

  setup_aruba
end
create_dir(*args) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 248
def create_dir(*args)
  Aruba.platform.deprecated(
    'The use of "#create_dir" is deprecated.' \
    ' Use "#create_directory" instead'
  )
  create_directory(*args)
end
current_dir(*args, &block) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 488
def current_dir(*args, &block)
  Aruba.platform.deprecated(
    'The use of "#current_dir" is deprecated.' \
    ' Use "#current_directory" instead'
  )

  current_directory(*args, &block)
end
current_directory() click to toggle source

@deprecated Get access to current dir

@return

Current directory
# File lib/aruba/api/deprecated.rb, line 32
def current_directory
  Aruba.platform.deprecated(
    'The use of "current_directory" is deprecated.' \
    ' Use "expand_path(".")" to get the current directory or "#cd" to run' \
    ' code in the current directory.'
  )

  aruba.current_directory.to_s
end
current_ruby() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 62
def current_ruby
  Aruba.platform.deprecated('The use of "#current_ruby" is deprecated')

  Aruba.platform.current_ruby cmd
end
detect_ruby(cmd) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 55
def detect_ruby(cmd)
  Aruba.platform.deprecated('The use of "#detect_ruby" is deprecated')

  Aruba.platform.detect_ruby cmd
end
dirs() click to toggle source

@deprecated The path to the directory which should contain all your test data You might want to overwrite this method to place your data else where.

@return [Array]

The directory path: Each subdirectory is a member of an array
# File lib/aruba/api/deprecated.rb, line 15
def dirs
  Aruba.platform.deprecated(
    'The use of "dirs" is deprecated.' \
    ' Use "Aruba.configure { |c| c.current_directory = \'path/to/dir\' }"' \
    ' instead to set the current directory and "expand_path(".")" to get' \
    ' the current directory or use "#cd(\'.\') { # your code }" to run' \
    ' code in the current directory'
  )

  @dirs ||= aruba.current_directory
end
eot() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 121
def eot
  Aruba.platform.deprecated(
    'The use of "#eot" is deprecated.' \
    ' Use "#close_input" instead.'
  )

  close_input
end
exit_timeout() click to toggle source

@deprecated

Default exit timeout for running commands with aruba

# File lib/aruba/api/deprecated.rb, line 1001
def exit_timeout
  Aruba.platform.deprecated(
    'The use of "#exit_timeout" is deprecated.' \
    ' Use "aruba.config.exit_timeout" instead.'
  )

  aruba.config.exit_timeout
end
filesystem_permissions(*args) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 592
def filesystem_permissions(*args)
  Aruba.platform.deprecated(
    'The use of "#filesystem_permissions" is deprecated.' \
    ' Use "#chmod" instead'
  )

  chmod(*args)
end
fixtures_directory() click to toggle source

The path to the directory which contains fixtures You might want to overwrite this method to place your data else where.

@return [String]

The directory to where your fixtures are stored
# File lib/aruba/api/deprecated.rb, line 693
def fixtures_directory
  Aruba.platform.deprecated(
    'The use of "#fixtures_directory" is deprecated.' \
    ' Use "aruba.fixtures_directory" instead'
  )

  aruba.fixtures_directory
end
get_process(wanted) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 956
def get_process(wanted)
  Aruba.platform.deprecated('The use of "#get_process" is deprecated')

  process_monitor.get_process(wanted)
end
in_current_dir(&block) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 509
def in_current_dir(&block)
  Aruba.platform.deprecated(
    'The use of "in_current_dir" is deprecated.' \
    ' Use "#in_current_directory { }" instead'
  )

  in_current_directory(&block)
end
io_wait() click to toggle source

@deprecated

Default io wait timeout

Overwrite this method if you want a different timeout or set `@aruba_io_wait_seconds

# File lib/aruba/api/deprecated.rb, line 1016
def io_wait
  Aruba.platform.deprecated(
    'The use of "#io_wait" is deprecated.' \
    ' Use "aruba.config.io_wait_timeout" instead'
  )

  aruba.config.io_wait_timeout
end
last_command() click to toggle source

Last command started

# File lib/aruba/api/deprecated.rb, line 741
def last_command
  Aruba.platform.deprecated(
    'The use of "#last_command" is deprecated.' \
    ' Use "#last_command_started"'
  )

  process_monitor.last_command_started
end
last_exit_status() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 1037
def last_exit_status
  Aruba.platform.deprecated(
    'The use of "#last_exit_status" is deprecated.' \
    ' Use "#last_command_(started|stopped).exit_status" instead'
  )

  process_monitor.last_exit_status
end
mod?(file, perms, &block) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 224
def mod?(file, perms, &block)
  Aruba.platform.deprecated(
    'The use of "#mod?" is deprecated.' \
    ' Use "expect(file).to have_permissions(perms)" instead'
  )

  expect(Array(file)).to Aruba::Matchers.all have_permissions(perms)
end
only_processes() click to toggle source

@deprecated Only processes

# File lib/aruba/api/deprecated.rb, line 1027
def only_processes
  Aruba.platform.deprecated(
    'The use of "#only_processes" is deprecated.' \
    ' Use "#all_commands" instead'
  )

  process_monitor.only_processes
end
original_env() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 583
def original_env
  Aruba.platform.deprecated(
    'The use of "#original_env" is deprecated'
  )

  @original_env ||= {}
end
output_from(cmd) click to toggle source

@deprecated

Fetch output (stdout, stderr) from command

@param [String] cmd

The command
# File lib/aruba/api/deprecated.rb, line 968
def output_from(cmd)
  Aruba.platform.deprecated('The use of "#output_from" is deprecated')

  process_monitor.output_from(cmd)
end
prep_for_fs_check() { || ... } click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 404
def prep_for_fs_check(&block)
  Aruba.platform.deprecated(
    'The use of "prep_for_fs_check" is deprecated.' \
    ' Use apropriate methods and the new rspec matchers instead'
  )

  stop_all_commands

  cd('') { yield }
end
process_monitor() click to toggle source

@private @deprecated

# File lib/aruba/api/deprecated.rb, line 1137
def process_monitor
  Aruba.platform.deprecated('The use of "#process_monitor" is deprecated.')

  aruba.command_monitor
end
processes() click to toggle source

@private @deprecated

# File lib/aruba/api/deprecated.rb, line 1145
def processes
  Aruba.platform.deprecated(
    'The use of "#process_monitor" is deprecated.' \
    ' Use "#all_commands" instead.'
  )

  aruba.command_monitor.send(:processes)
end
register_process(*args) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 949
def register_process(*args)
  Aruba.platform.deprecated('The use of "#register_process" is deprecated')

  process_monitor.register_process(*args)
end
remove_dir(*args) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 270
def remove_dir(*args)
  Aruba.platform.deprecated(
    'The use of "remove_dir" is deprecated.' \
    ' Use "remove" instead'
  )
  remove(*args)
end
remove_directory(*args) click to toggle source

@deprecated Remove directory

@param [String] directory_name

The name of the directory which should be removed
# File lib/aruba/api/deprecated.rb, line 261
def remove_directory(*args)
  Aruba.platform.deprecated(
    'The use of "remove_directory" is deprecated.' \
    ' Use "remove" instead'
  )
  remove(*args)
end
remove_file(*args) click to toggle source

@deprecated Remove file

@param [String] file_name

The file which should be deleted in current directory
# File lib/aruba/api/deprecated.rb, line 238
def remove_file(*args)
  Aruba.platform.deprecated(
    'The use of "#remove_file" is deprecated.' \
    ' Use "#remove" instead'
  )

  remove(*args)
end
restore_env() click to toggle source

@deprecated Restore original process environment

# File lib/aruba/api/deprecated.rb, line 542
def restore_env
  Aruba.platform.deprecated(
    'The use of "#restore_env" is deprecated.' \
    ' If you use "set_environment_variable" there\'s no need to restore' \
    ' the environment'
  )

  original_env.each do |key, value|
    if value
      ENV[key] = value
      aruba.environment[key] = value
    else
      aruba.environment.delete key
      ENV.delete key
    end
  end
end
root_directory() click to toggle source

@deprecated The root directory of aruba

# File lib/aruba/api/deprecated.rb, line 679
def root_directory
  Aruba.platform.deprecated(
    'The use of "#root_directory" is deprecated.' \
    ' Use "aruba.root_directory" instead'
  )

  aruba.root_directory
end
run(*args) click to toggle source

Run given command and stop it if timeout is reached

@param [String] cmd

The command which should be executed

@param [Hash] opts

Options

@option [Integer] exit_timeout

If the timeout is reached the command will be killed

@option [Integer] io_wait_timeout

Wait for IO to finish

@option [Integer] startup_wait_time

Wait for a command to start

@option [String] stop_signal

Use signal to stop command

@yield [SpawnProcess]

Run block with process

@see run_command @deprecated

# File lib/aruba/api/deprecated.rb, line 171
def run(*args)
  Aruba.platform.deprecated(
    'The use of "#run" is deprecated.' \
    ' Use "run_command" instead'
  )

  run_command(*args)
end
run_interactive(cmd) click to toggle source

Run a command interactively

@param [String] cmd

The command to by run

@see cmd @deprecated

# File lib/aruba/api/deprecated.rb, line 137
def run_interactive(cmd)
  Aruba.platform.deprecated(
    'The use of "#run_interactive" is deprecated.' \
    ' Use "run_command" instead'
  )

  run_command(cmd)
end
run_simple(*args) click to toggle source

Run a command with aruba

Checks for error during command execution and checks the output to detect an timeout error.

@param [String] cmd

The command to be executed

@param [Hash] options

Options for aruba

@option [TrueClass,FalseClass] fail_on_error

Should aruba fail on error?

@option [Integer] exit_timeout

Timeout for execution

@option [Integer] io_wait_timeout

Timeout for IO - STDERR, STDOUT
# File lib/aruba/api/deprecated.rb, line 200
def run_simple(*args)
  Aruba.platform.deprecated(
    'The use of "#run_simple" is deprecated.' \
    ' Use "run_command_and_stop" instead'
  )

  run_command_and_stop(*args)
end
set_env(key, value) click to toggle source

@deprecated Set environment variable

@param [String] key

The name of the environment variable as string, e.g. 'HOME'

@param [String] value

The value of the environment variable. Needs to be a string.
# File lib/aruba/api/deprecated.rb, line 568
def set_env(key, value)
  Aruba.platform.deprecated(
    'The use of "#set_env" is deprecated.' \
    ' Use "set_environment_variable" instead. ' \
    ' But be careful, this method uses a different kind of implementation'
  )

  aruba.announcer.announce(:environment, key, value)
  set_environment_variable key, value

  original_env[key] = ENV.delete(key) unless original_env.key? key
  ENV[key] = value
end
stderr_from(cmd) click to toggle source

@deprecated

Fetch stderr from command

@param [String] cmd

The command
# File lib/aruba/api/deprecated.rb, line 992
def stderr_from(cmd)
  Aruba.platform.deprecated('The use of "#stderr_from" is deprecated')

  process_monitor.stderr_from(cmd)
end
stdout_from(cmd) click to toggle source

@deprecated

Fetch stdout from command

@param [String] cmd

The command
# File lib/aruba/api/deprecated.rb, line 980
def stdout_from(cmd)
  Aruba.platform.deprecated('The use of "#stdout_from" is deprecated')

  process_monitor.stdout_from(cmd)
end
stop_process(process) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 1047
def stop_process(process)
  Aruba.platform.deprecated(
    'The use of "#stop_process" is deprecated.' \
    ' Use "#last_command_(started|stopped).stop" instead'
  )

  @last_exit_status = process_monitor.stop_process(process)
end
stop_processes!() click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 1067
def stop_processes!
  Aruba.platform.deprecated(
    'The use of "#stop_processes!" is deprecated.' \
    ' Use "#stop_all_commands" instead'
  )

  stop_all_commands
end
terminate_process(process) click to toggle source

@deprecated

# File lib/aruba/api/deprecated.rb, line 1057
def terminate_process(process)
  Aruba.platform.deprecated(
    'The use of "#terminate_process" is deprecated.' \
    ' Use "#last_command_(started|stopped).terminate" instead'
  )

  process_monitor.terminate_process(process)
end
terminate_processes!() click to toggle source

@deprecated

Terminate all running processes

# File lib/aruba/api/deprecated.rb, line 1079
def terminate_processes!
  Aruba.platform.deprecated(
    'The use of "#stop_processes!" is deprecated.' \
    ' Use "all_commands.each(&:terminate)" instead'
  )

  all_commands.each(&:terminate)
end
touch_file(*args) click to toggle source

@deprecated Create an empty file

@param [String] file_name

The name of the file
# File lib/aruba/api/deprecated.rb, line 214
def touch_file(*args)
  Aruba.platform.deprecated(
    'The use of "#touch_file" is deprecated.' \
    ' Use "#touch" instead'
  )

  touch(*args)
end
unescape(string, keep_ansi = false) click to toggle source

@deprecated Unescape string

@param [String] string

The string which should be unescaped, e.g. the output of a command

@return

The string stripped from escape sequences
# File lib/aruba/api/deprecated.rb, line 661
def unescape(string, keep_ansi = false)
  Aruba.platform.deprecated(
    'The use of "#unescape" is deprecated.' \
    ' Use "#sanitize_text" intead'
  )

  string = unescape_text(string)
  if !keep_ansi ||
     !aruba.config.keep_ansi ||
     aruba.config.remove_ansi_escape_sequences
    string = extract_text(string)
  end

  string
end
use_clean_gemset(gemset) click to toggle source

@deprecated Use a clean rvm gemset

Please make sure that you've got [rvm](rvm.io/) installed.

@param [String] gemset

The name of the gemset to be used
# File lib/aruba/api/deprecated.rb, line 1116
def use_clean_gemset(gemset)
  Aruba.platform.deprecated('The use of "#use_clean_gemset" is deprecated.')
  run_simple(%{rvm gemset create "#{gemset}"}, true)
  if all_stdout =~ /'#{gemset}' gemset created \((.*)\)\./
    gem_home = Regexp.last_match[1]
    set_environment_variable('GEM_HOME', gem_home)
    set_environment_variable('GEM_PATH', gem_home)
    set_environment_variable('BUNDLE_PATH', gem_home)

    paths = (ENV['PATH'] || "").split(File::PATH_SEPARATOR)
    paths.unshift(File.join(gem_home, 'bin'))
    set_environment_variable('PATH', paths.uniq.join(File::PATH_SEPARATOR))

    run_simple("gem install bundler", true)
  else
    raise "I didn't understand rvm's output: #{all_stdout}"
  end
end
with_env(env = {}) { || ... } click to toggle source

@deprecated Run block with environment

@param [Hash] env

The variables to be used for block.

@yield

The block of code which should be run with the changed environment variables
# File lib/aruba/api/deprecated.rb, line 526
def with_env(env = {}, &block)
  Aruba.platform.deprecated(
    'The use of "#with_env" is deprecated.' \
    ' Use "#with_environment {}" instead. But be careful this uses a' \
    ' different implementation'
  )

  env.each do |k,v|
    set_env k, v
  end
  yield
  restore_env
end