Class: CircleCI::Parallel::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/circleci/parallel/configuration.rb,
lib/circleci/parallel/configuration/slave_node_configuration.rb,
lib/circleci/parallel/configuration/master_node_configuration.rb,
lib/circleci/parallel/configuration/configuration_collection_proxy.rb

Defined Under Namespace

Classes: ConfigurationCollectionProxy, MasterNodeConfiguration, SlaveNodeConfiguration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



15
16
17
18
 
# File 'lib/circleci/parallel/configuration.rb', line 15

def initialize
  @silent = false
  @mock_mode = false
end

Instance Attribute Details

#mock_mode ⇒ Boolean

Returns whether mock mode is enabled (default: false).

Returns:

  • (Boolean) —

    whether mock mode is enabled (default: false)



13
14
15
 
# File 'lib/circleci/parallel/configuration.rb', line 13

def mock_mode
  @mock_mode
end

#silent ⇒ Boolean

Returns whether progress messages should be outputted to STDOUT (default: false).

Returns:

  • (Boolean) —

    whether progress messages should be outputted to STDOUT (default: false)



10
11
12
 
# File 'lib/circleci/parallel/configuration.rb', line 10

def silent
  @silent
end

Instance Method Details

#after_download(chdir: true, &block) ⇒ Object

Deprecated.

Use on_master_node.after_download instead.



42
43
44
 
# File 'lib/circleci/parallel/configuration.rb', line 42

def after_download(chdir: true, &block)
  on_master_node.after_download(chdir: chdir, &block)
end

#after_join(chdir: true, &block) ⇒ Object

Deprecated.

Use on_every_node.after_sync instead.



47
48
49
 
# File 'lib/circleci/parallel/configuration.rb', line 47

def after_join(chdir: true, &block)
  on_every_node.after_sync(chdir: chdir, &block)
end

#before_join(chdir: true, &block) ⇒ Object

Deprecated.

Use on_every_node.before_sync instead.



37
38
39
 
# File 'lib/circleci/parallel/configuration.rb', line 37

def before_join(chdir: true, &block)
  on_every_node.before_sync(chdir: chdir, &block)
end

#master_node_configuration ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



52
53
54
 
# File 'lib/circleci/parallel/configuration.rb', line 52

def master_node_configuration
  @master_node_configuration ||= MasterNodeConfiguration.new
end

#on_each_slave_node ⇒ SlaveNodeConfiguration

Returns:



32
33
34
 
# File 'lib/circleci/parallel/configuration.rb', line 32

def on_each_slave_node
  slave_node_configuration
end

#on_every_node ⇒ ConfigurationCollectionProxy

Returns:



21
22
23
24
 
# File 'lib/circleci/parallel/configuration.rb', line 21

def on_every_node
  @every_node_configuration ||=
    ConfigurationCollectionProxy.new(master_node_configuration, slave_node_configuration)
end

#on_master_node ⇒ MasterNodeConfiguration

Returns:



27
28
29
 
# File 'lib/circleci/parallel/configuration.rb', line 27

def on_master_node
  master_node_configuration
end

#slave_node_configuration ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



57
58
59
 
# File 'lib/circleci/parallel/configuration.rb', line 57

def slave_node_configuration
  @slave_node_configuration ||= SlaveNodeConfiguration.new
end