module Aruba::Api::Filesystem

Filesystem methods

Public Instance Methods

absolute?(path) click to toggle source

Check if path is absolute

@return [TrueClass, FalseClass]

Result of check
# File lib/aruba/api/filesystem.rb, line 55
def absolute?(path)
  ArubaPath.new(path).absolute?
end
all_directories() click to toggle source

Return all existing directories in current directory

@return [Array]

List of files
# File lib/aruba/api/filesystem.rb, line 87
def all_directories
  list('.').select { |p| directory? p }.map { |p| expand_path(p) }
end
all_files() click to toggle source

Return all existing files in current directory

@return [Array]

List of files
# File lib/aruba/api/filesystem.rb, line 79
def all_files
  list('.').select { |p| file? p }.map { |p| expand_path(p) }
end
all_paths() click to toggle source

Return all existing paths (directories, files) in current dir

@return [Array]

List of files and directories
# File lib/aruba/api/filesystem.rb, line 71
def all_paths
  list('.').map { |p| expand_path(p) }
end
append_to_file(file_name, file_content) click to toggle source

Append data to file

@param [String] file_name

The name of the file to be used

@param [String] file_content

The content which should be appended to file
# File lib/aruba/api/filesystem.rb, line 315
def append_to_file(file_name, file_content)
  file_name = expand_path(file_name)

  Aruba.platform.mkdir(File.dirname(file_name))
  File.open(file_name, 'a') { |f| f << file_content }
end
chmod(*args) click to toggle source

Change file system permissions of file

@param [Octal] mode

File system mode, eg. 0755

@param [String] file_name

Name of file to be modified. This file needs to be present to succeed
# File lib/aruba/api/filesystem.rb, line 284
def chmod(*args)
  args = args.flatten

  options = if args.last.kind_of? Hash
              args.pop
            else
              {}
            end

  mode = args.shift
  mode = if mode.kind_of? String
           mode.to_i(8)
         else
           mode
         end

  args.each { |p| raise "Expected #{p} to be present" unless exist?(p) }
  paths = args.map { |p| expand_path(p) }

  Aruba.platform.chmod(mode, paths, options)

  self
end
copy(*args) click to toggle source

Copy a file and/or directory

@param [String, Array] source

A single file or directory, multiple files or directories or multiple
files and directories. If multiple sources are given the destination
needs to be a directory

@param [String] destination

A file or directory name. If multiple sources are given the destination
needs to be a directory

rubocop:disable Metrics/CyclomaticComplexity def copy(*source, destination)

# File lib/aruba/api/filesystem.rb, line 175
def copy(*args)
  args = args.flatten
  destination = args.pop
  source = args

  source.each do |s|
    raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
  end

  raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix
  raise ArgumentError, "Multiples sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)

  source_paths     = source.map { |f| expand_path(f) }
  destination_path = expand_path(destination)

  if source_paths.count > 1
    Aruba.platform.mkdir(destination_path)
  else
    Aruba.platform.mkdir(File.dirname(destination_path))
    source_paths = source_paths.first
  end

  Aruba.platform.cp source_paths, destination_path

  self
end
create_directory(directory_name) click to toggle source

Create a directory in current directory

@param [String] directory_name

The name of the directory which should be created
# File lib/aruba/api/filesystem.rb, line 326
def create_directory(directory_name)
  Aruba.platform.mkdir expand_path(directory_name)

  self
end
directory(path) click to toggle source

Create directory object

@return [Dir]

The directory object
# File lib/aruba/api/filesystem.rb, line 95
def directory(path)
  fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name

  Dir.new(expand_path(path))
end
directory?(file) click to toggle source

Check if directory exist and is directory

@param [String] file

The file/directory which should exist
# File lib/aruba/api/filesystem.rb, line 37
def directory?(file)
  Aruba.platform.directory? expand_path(file)
end
disk_usage(*paths) click to toggle source

Calculate disk usage for file(s) and/or directories

It shows the disk usage for a single file/directory. If multiple paths are given, it sum their size up.

@param [Array, Path] paths

The paths

@result [FileSize]

Bytes on disk
# File lib/aruba/api/filesystem.rb, line 375
def disk_usage(*paths)
  expect(paths.flatten).to Aruba::Matchers.all be_an_existing_path

  Aruba.platform.determine_disk_usage paths.flatten.map { |p| ArubaPath.new(expand_path(p)) }, aruba.config.physical_block_size
end
executable?(path) click to toggle source

Check if file exist and is executable

@param [String] file

The file which should exist
# File lib/aruba/api/filesystem.rb, line 45
def executable?(path)
  path = expand_path(path)

  Aruba.platform.file?(path) && Aruba.platform.executable?(path)
end
exist?(file_or_directory) click to toggle source

Check if file or directory exist

@param [String] file_or_directory

The file/directory which should exist
# File lib/aruba/api/filesystem.rb, line 21
def exist?(file_or_directory)
  Aruba.platform.exist? expand_path(file_or_directory)
end
file?(file) click to toggle source

Check if file exist and is file

@param [String] file

The file/directory which should exist
# File lib/aruba/api/filesystem.rb, line 29
def file?(file)
  Aruba.platform.file? expand_path(file)
end
file_size(name) click to toggle source

Get size of file

@return [Numeric]

The size of the file
# File lib/aruba/api/filesystem.rb, line 385
def file_size(name)
  raise ArgumentError, "#{name} does not exist" unless exist? name

  Aruba.platform.determine_file_size expand_path(name)
end
list(name) click to toggle source

Return content of directory

@return [Array]

The content of directory
# File lib/aruba/api/filesystem.rb, line 105
def list(name)
  fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
  fail ArgumentError, %(Only directories are supported. Path "#{name}" is not a directory.) unless directory? name

  existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
  current_working_directory = ArubaPath.new(expand_path('.'))

  existing_files.map { |d| ArubaPath.new(d).relative_path_from(current_working_directory).to_s }
end
move(*args) click to toggle source

Move a file and/or directory

@param [String, Array] source

A single file or directory, multiple files or directories or multiple
files and directories. If multiple sources are given the destination
needs to be a directory

@param [String] destination

A file or directory name. If multiple sources are given the destination
needs to be a directory

rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/MethodLength

# File lib/aruba/api/filesystem.rb, line 216
def move(*args)
  args = args.flatten
  destination = args.pop
  source = args

  source.each do |s|
    raise ArgumentError, "Using a fixture as source (#{source}) is not supported" if s.start_with? aruba.config.fixtures_path_prefix
  end

  raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix

  source.each do |s|
    raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
  end

  raise ArgumentError, "Multiple sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)

  source_paths     = source.map { |f| expand_path(f) }
  destination_path = expand_path(destination)

  if source_paths.count > 1
    Aruba.platform.mkdir(destination_path)
  else
    Aruba.platform.mkdir(File.dirname(destination_path))
    source_paths = source_paths.first
  end

  Aruba.platform.mv source_paths, destination_path

  self
end
overwrite_file(name, content) click to toggle source

Create a file with given content

The method does check if file already exists and fails if the file is missing. If the file name is a path the method will create all neccessary directories.

# File lib/aruba/api/filesystem.rb, line 271
def overwrite_file(name, content)
  Aruba.platform.create_file(expand_path(name), content, true)

  self
end
read(name) click to toggle source

Return content of file

@return [Array]

The content of file, without "\n" or "\r\n" at the end. To rebuild the file use `content.join("\n")`
# File lib/aruba/api/filesystem.rb, line 119
def read(name)
  fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
  fail ArgumentError, %(Only files are supported. Path "#{name}" is not a file.) unless file? name

  File.readlines(expand_path(name)).map(&:chomp)
end
relative?(path) click to toggle source

Check if path is relative

@return [TrueClass, FalseClass]

Result of check
# File lib/aruba/api/filesystem.rb, line 63
def relative?(path)
  ArubaPath.new(path).relative?
end
remove(*args) click to toggle source

Remove file or directory

@param [Array, String] name

The name of the file / directory which should be removed
# File lib/aruba/api/filesystem.rb, line 336
def remove(*args)
  args = args.flatten

  options = if args.last.kind_of? Hash
              args.pop
            else
              {}
            end

  args = args.map { |p| expand_path(p) }

  Aruba.platform.rm(args, options)
end
touch(*args) click to toggle source

Create an empty file

@param [String] file_name

The name of the file
# File lib/aruba/api/filesystem.rb, line 146
def touch(*args)
  args = args.flatten

  options = if args.last.kind_of? Hash
              args.pop
            else
              {}
            end

  args.each { |p| create_directory(File.dirname(p)) }

  Aruba.platform.touch(args.map { |p| expand_path(p) }, options)

  self
end
with_file_content(file) { |content| ... } click to toggle source

Read content of file and yield the content to block

@param [String) file

The name of file which should be read from

@yield

Pass the content of the given file to this block
# File lib/aruba/api/filesystem.rb, line 357
def with_file_content(file, &block)
  expect(file).to be_an_existing_path

  content = read(file).join("\n")

  yield(content)
end
write_file(name, content) click to toggle source

Create a file with given content

The method does not check if file already exists. If the file name is a path the method will create all neccessary directories.

@param [String] file_name

The name of the file

@param [String] file_content

The content which should be written to the file
# File lib/aruba/api/filesystem.rb, line 136
def write_file(name, content)
  Aruba.platform.create_file(expand_path(name), content, false)

  self
end
write_fixed_size_file(name, size) click to toggle source

Create a file with the given size

The method does not check if file already exists. If the file name is a path the method will create all neccessary directories.

@param [String] file_name

The name of the file

@param [Integer] file_size

The size of the file
# File lib/aruba/api/filesystem.rb, line 260
def write_fixed_size_file(name, size)
  Aruba.platform.create_fixed_size_file(expand_path(name), size, false)

  self
end