Class: RSpecSystem::NodeSet::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec-system/node_set/base.rb

Overview

This class is abstract.

Subclass and override methods to create a new NodeSet variant.

Base class for a NodeSet driver. If you want to create a new driver, you should sub-class this and override all the methods below.

Direct Known Subclasses

Vagrant, Vsphere

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(setname, config, custom_prefabs_path, options) ⇒ Base

Create new NodeSet, populating necessary data structures.



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/rspec-system/node_set/base.rb', line 14

def initialize(setname, config, custom_prefabs_path, options)
  @setname = setname
  @config = config
  @custom_prefabs_path = custom_prefabs_path
  @destroy = options[:destroy]

  @nodes = {}
  config['nodes'].each do |k,v|
    @nodes[k] = RSpecSystem::Node.node_from_yaml(self, k, v, custom_prefabs_path)
  end
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



7
8
9
 
# File 'lib/rspec-system/node_set/base.rb', line 7

def config
  @config
end

#custom_prefabs_path ⇒ Object (readonly)

Returns the value of attribute custom_prefabs_path.



9
10
11
 
# File 'lib/rspec-system/node_set/base.rb', line 9

def custom_prefabs_path
  @custom_prefabs_path
end

#destroy ⇒ Object (readonly)

Returns the value of attribute destroy.



11
12
13
 
# File 'lib/rspec-system/node_set/base.rb', line 11

def destroy
  @destroy
end

#nodes ⇒ Object (readonly)

Returns the value of attribute nodes.



10
11
12
 
# File 'lib/rspec-system/node_set/base.rb', line 10

def nodes
  @nodes
end

#setname ⇒ Object (readonly)

Returns the value of attribute setname.



8
9
10
 
# File 'lib/rspec-system/node_set/base.rb', line 8

def setname
  @setname
end

Instance Method Details

#default_node ⇒ RSpecSystem::Node

Return default node

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rspec-system/node_set/base.rb', line 54

def default_node
  dn = config['default_node']
  if dn.nil?
    if nodes.length == 1
      dn = nodes.first[1]
      return dn
    else
      raise "No default node"
    end
  else
    return nodes[dn]
  end
end

#env_type ⇒ Object

Return environment type



47
48
49
 
# File 'lib/rspec-system/node_set/base.rb', line 47

def env_type
  self.class::ENV_TYPE
end

#randmac ⇒ String

Return a random mac address

Returns:

  • (String) —

    a random mac address



138
139
140
 
# File 'lib/rspec-system/node_set/base.rb', line 138

def randmac
  "080027" + (1..3).map{"%0.2X"%rand(256)}.join
end

#random_string(length = 50) ⇒ String

Return a random string of chars, used for temp dir creation

Returns:

  • (String) —

    string of 50 random characters A-Z and a-z



71
72
73
74
 
# File 'lib/rspec-system/node_set/base.rb', line 71

def random_string(length = 50)
  o =  [('a'..'z'),('A'..'Z')].map{|i| i.to_a}.flatten
  (0...length).map{ o[rand(o.length)] }.join
end

#rcp(options) ⇒ Object

Copy a file to the host in the NodeSet.



42
43
44
 
# File 'lib/rspec-system/node_set/base.rb', line 42

def rcp(options)
  raise "Unimplemented method #rcp"
end

#run(options) ⇒ Object

Run a command on a host in the NodeSet.



37
38
39
 
# File 'lib/rspec-system/node_set/base.rb', line 37

def run(options)
  raise "Unimplemented method #run"
end

#setup ⇒ Object

Setup the NodeSet by starting all nodes.



27
28
29
 
# File 'lib/rspec-system/node_set/base.rb', line 27

def setup
  raise "Unimplemented method #setup"
end

#ssh_exec!(ssh, command) ⇒ Hash

Execute command via SSH.

A special version of exec! from Net::SSH that returns exit code and exit signal as well. This method is blocking.

Parameters:

  • ssh (Net::SSH::Connection::Session) —

    an active ssh session

  • command (String) —

    command to execute

Returns:

  • (Hash) —

    a hash of results



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
 
# File 'lib/rspec-system/node_set/base.rb', line 93

def ssh_exec!(ssh, command)
  r = {
    :stdout => '',
    :stderr => '',
    :exit_code => nil,
    :exit_signal => nil,
  }
  ssh.open_channel do |channel|
    channel.exec(command) do |ch, success|
      unless success
        abort "FAILED: couldn't execute command (ssh.channel.exec)"
      end
      channel.on_data do |ch,data|
        d = data
        print d
        r[:stdout]+=d
      end

      channel.on_extended_data do |ch,type,data|
        d = data
        print d
        r[:stderr]+=d
      end

      channel.on_request("exit-status") do |ch,data|
        c = data.read_long
        puts "Exit code: #{c}"
        r[:exit_code] = c
      end

      channel.on_request("exit-signal") do |ch, data|
        s = data.read_string
        puts "Exit signal: #{s}"
        r[:exit_signal] = s
      end
    end
  end
  ssh.loop

  r
end

#teardown ⇒ Object

Shutdown the NodeSet by shutting down or pausing all nodes.



32
33
34
 
# File 'lib/rspec-system/node_set/base.rb', line 32

def teardown
  raise "Unimplemented method #teardown"
end

#tmppath ⇒ String

TODO:

Very Linux dependant, probably need to consider OS X and Windows at least.

Generates a random string for use in remote transfers.

Returns:

  • (String) —

    a random path



81
82
83
 
# File 'lib/rspec-system/node_set/base.rb', line 81

def tmppath
  '/tmp/' + random_string
end