Class: Hydra::Task

Inherits:
Object
  • Object
show all
Defined in:
lib/hydra/tasks.rb

Overview

Hydra Task Common attributes and methods

Direct Known Subclasses

GlobalTask, ProfileTask, RemoteTask, SyncTask, TestTask

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#autosort ⇒ Object

Automatically sort files using their historical runtimes. Defaults to true To disable:

t.autosort = false



26
27
28
 
# File 'lib/hydra/tasks.rb', line 26

def autosort
  @autosort
end

#config ⇒ Object

Path to the hydra config file. If not set, it will check ‘hydra.yml’ and ‘config/hydra.yml’



20
21
22
 
# File 'lib/hydra/tasks.rb', line 20

def config
  @config
end

#environment ⇒ Object

Returns the value of attribute environment.



39
40
41
 
# File 'lib/hydra/tasks.rb', line 39

def environment
  @environment
end

#files ⇒ Object

Files to test. You can add files manually via:

t.files << [file1, file2, etc]

Or you can use the add_files method



13
14
15
 
# File 'lib/hydra/tasks.rb', line 13

def files
  @files
end

#listeners ⇒ Object

Event listeners. Defaults to the MinimalOutput listener. You can add additional listeners if you’d like. For example, on linux (with notify-send) you can add the notifier listener:

t.listeners << Hydra::Listener::Notifier.new



32
33
34
 
# File 'lib/hydra/tasks.rb', line 32

def listeners
  @listeners
end

#name ⇒ Object

Name of the task. Default ‘hydra’



6
7
8
 
# File 'lib/hydra/tasks.rb', line 6

def name
  @name
end

#runner_log_file ⇒ Object

Set to a valid file path if you want to save the output of the runners in a log file



46
47
48
 
# File 'lib/hydra/tasks.rb', line 46

def runner_log_file
  @runner_log_file
end

#serial ⇒ Object

Set to true if you want to run this task only on the local machine with one runner. A “Safe Mode” for some test files that may not play nice with others.



37
38
39
 
# File 'lib/hydra/tasks.rb', line 37

def serial
  @serial
end

#show_time ⇒ Object

Set to false if you don’t want to show the total running time



42
43
44
 
# File 'lib/hydra/tasks.rb', line 42

def show_time
  @show_time
end

#verbose ⇒ Object

True if you want to see Hydra’s message traces



16
17
18
 
# File 'lib/hydra/tasks.rb', line 16

def verbose
  @verbose
end

Instance Method Details

#add_files(pattern) ⇒ Object

Add files to test by passing in a string to be run through Dir.glob. For example:

t.add_files 'test/units/*.rb'



62
63
64
 
# File 'lib/hydra/tasks.rb', line 62

def add_files(pattern)
  @files += Dir.glob(pattern)
end

#find_config_file ⇒ Object

Search for the hydra config file



50
51
52
53
54
55
56
 
# File 'lib/hydra/tasks.rb', line 50

def find_config_file
  @config ||= 'hydra.yml'
  return @config if File.exists?(@config)
  @config = File.join('config', 'hydra.yml')
  return @config if File.exists?(@config)
  @config = nil
end