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
|
# frozen_string_literal: true
require 'pathname'
require 'aruba/platform'
Aruba.platform.require_matching_files('../matchers/file/*.rb', __FILE__)
Aruba.platform.require_matching_files('../matchers/directory/*.rb', __FILE__)
Aruba.platform.require_matching_files('../matchers/path/*.rb', __FILE__)
# Aruba
module Aruba
# Api
module Api
# Filesystem methods
module Filesystem
# Check if file or directory exist
#
# @param [String] file_or_directory
# The file/directory which should exist
def exist?(file_or_directory)
Aruba.platform.exist? expand_path(file_or_directory)
end
# Check if file exist and is file
#
# @param [String] file
# The file/directory which should exist
def file?(file)
Aruba.platform.file? expand_path(file)
end
# Check if directory exist and is directory
#
# @param [String] file
# The file/directory which should exist
def directory?(file)
Aruba.platform.directory? expand_path(file)
end
# Check if file exist and is executable
#
# @param [String] path
# The path which should exist and be executable
#
# @return [Boolean]
def executable?(path)
path = expand_path(path)
Aruba.platform.file?(path) && Aruba.platform.executable?(path)
end
# Check if path is absolute
#
# @return [Boolean]
def absolute?(path)
Aruba.platform.absolute_path?(path)
end
# Check if path is relative
#
# @return [Boolean]
def relative?(path)
Aruba.platform.relative_path?(path)
end
# Return all existing paths (directories, files) in current dir
#
# @return [Array]
# List of files and directories
def all_paths
list('.').map { |path| expand_path(path) }
end
# Return all existing files in current directory
#
# @return [Array]
# List of files
def all_files
list('.').select { |p| file? p }.map { |p| expand_path(p) }
end
# Return all existing directories in current directory
#
# @return [Array]
# List of files
def all_directories
list('.').select { |p| directory? p }.map { |p| expand_path(p) }
end
# Create directory object
#
# @return [Dir]
# The directory object
def directory(path)
raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
Dir.new(expand_path(path))
end
# Return content of directory
#
# @return [Array]
# The content of directory
def list(name)
raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
unless directory? name
raise ArgumentError,
%(Only directories are supported. Path "#{name}" is not a directory.)
end
existing_files = Dir.glob(expand_path(File.join(name, '**', '*')))
current_working_directory = Pathname.new(expand_path('.'))
existing_files.map do |d|
Pathname.new(d).relative_path_from(current_working_directory).to_s
end
end
# 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")`
def read(name)
raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
unless file? name
raise ArgumentError, %(Only files are supported. Path "#{name}" is not a file.)
end
File.readlines(expand_path(name)).map(&:chomp)
end
# 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] name
# The name of the file
#
# @param [String] content
# The content which should be written to the file
def write_file(name, content)
Aruba.platform.create_file(expand_path(name), content, false)
self
end
# Create an empty file
#
# @param [String] file_name
# The name of the file
def touch(*args)
args = args.flatten
options = if args.last.is_a? 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
# 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
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
if destination.start_with? aruba.config.fixtures_path_prefix
raise ArgumentError,
"Using a fixture as destination (#{destination}) is not supported"
end
if source.count > 1 && exist?(destination) && !directory?(destination)
raise ArgumentError, 'Multiples sources can only be copied to a directory'
end
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
# 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
def move(*args)
args = args.flatten
destination = args.pop
source = args
source.each do |s|
if s.start_with? aruba.config.fixtures_path_prefix
raise ArgumentError, "Using a fixture as source (#{source}) is not supported"
end
end
if destination.start_with? aruba.config.fixtures_path_prefix
raise ArgumentError,
"Using a fixture as destination (#{destination}) is not supported"
end
source.each do |s|
raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
end
if source.count > 1 && exist?(destination) && !directory?(destination)
raise ArgumentError, 'Multiple sources can only be copied to a directory'
end
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
# 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] name
# The name of the file
#
# @param [Integer] size
# The size of the file
def write_fixed_size_file(name, size)
Aruba.platform.create_fixed_size_file(expand_path(name), size, false)
self
end
# 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.
def overwrite_file(name, content)
Aruba.platform.create_file(expand_path(name), content, true)
self
end
# Change file system permissions of file
#
# @param [Octal] mode
# File system mode, eg. 0o755
#
# @param [String] file_name
# Name of file to be modified. This file needs to be present to succeed
def chmod(*args)
args = args.flatten
options = if args.last.is_a? Hash
args.pop
else
{}
end
mode = args.shift
mode = mode.to_i(8) if mode.is_a? String
args.each { |path| raise "Expected #{path} to be present" unless exist?(path) }
paths = args.map { |path| expand_path(path) }
Aruba.platform.chmod(mode, paths, options)
self
end
# 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
def append_to_file(file_name, file_content)
file_name = expand_path(file_name)
File.open(file_name, 'a') { |f| f << file_content }
end
# Append lines to a (text) file. This will make sure a newline is present
# between the old content and the new.
#
# @param [String] file_name
# The name of the file to be used
#
# @param [String] file_content
# The lines which should be appended to file
def append_lines_to_file(file_name, file_content)
file_name = expand_path(file_name)
last = File.open(file_name) do |f|
f.seek(-3, IO::SEEK_END)
f.read
end
File.open(file_name, 'a') do |f|
f << "\n" unless last.end_with? "\n"
f << file_content
end
end
# Create a directory in current directory
#
# @param [String] directory_name
# The name of the directory which should be created
def create_directory(directory_name)
Aruba.platform.mkdir expand_path(directory_name)
self
end
# Remove file or directory
#
# @param [Array, String] name
# The name of the file / directory which should be removed
def remove(*args)
args = args.flatten
options = if args.last.is_a? Hash
args.pop
else
{}
end
args = args.map { |path| expand_path(path) }
Aruba.platform.rm(args, options)
end
# 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
def with_file_content(file)
expect(file).to be_an_existing_path
content = read(file).join("\n")
yield(content)
end
# 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
#
# @return [FileSize]
# Bytes on disk
def disk_usage(*paths)
paths = paths.flatten
expect(paths).to all be_an_existing_path
expanded = paths.map { |path| expand_path(path) }
Aruba.platform.determine_disk_usage(expanded)
end
# Get size of file
#
# @param [String] name
# File name
#
# @return [Numeric]
# The size of the file
def file_size(name)
expect(name).to be_an_existing_file
Aruba.platform.determine_file_size expand_path(name)
end
end
end
end
|