Class: Serverspec::Type::OctopusDeployTentacle

Inherits:
Base
  • Object
show all
Defined in:
lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb

Instance Method Summary collapse

Constructor Details

#initialize(serverUrl, apiKey, instance, spaceId = 'Spaces-1') ⇒ OctopusDeployTentacle

Returns a new instance of OctopusDeployTentacle.



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
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 15

def initialize(serverUrl, apiKey, instance, spaceId = 'Spaces-1')
  @name = "Octopus Deploy Tentacle #{instance}"
  @runner = Specinfra::Runner
  @serverUrl = serverUrl
  @apiKey = apiKey
  @spaceId = spaceId

  if (serverUrl.nil?)
    puts "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
    return
  end
  if (apiKey.nil?)
    puts "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
    return
  end

  if (exists?)
    thumbprint = `"c:\\program files\\Octopus Deploy\\Tentacle\\Tentacle.exe" show-thumbprint --console --nologo --instance #{instance}`
    thumbprint = thumbprint.gsub('==== ShowThumbprintCommand starting ====', '').strip
    thumbprint = thumbprint.gsub('The thumbprint of this Tentacle is: ', '').strip
    thumbprint = thumbprint.gsub('==== ShowThumbprintCommand completed ====', '').strip
    thumbprint = thumbprint.gsub('==== ShowThumbprintCommand ====', '').strip

    @serverSupportsSpaces = check_supports_spaces(serverUrl)

    if (@serverSupportsSpaces)
      @spaceFragment = "#{@spaceId}/"
    end

    @machine = get_machine_via_api(serverUrl, apiKey, thumbprint)
  else
    puts "tentacle.exe does not exist"
  end
end

Instance Method Details

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 140

def exists?
  ::File.exists?("c:\\program files\\Octopus Deploy\\Tentacle\\Tentacle.exe")
end

#has_display_name?(name) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
120
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 117

def has_display_name?(name)
  return false if @machine.nil?
  @machine["Name"] == name
end

#has_endpoint?(uri) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
125
126
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 122

def has_endpoint?(uri)
  return false if @machine.nil?
  puts "Expected uri '#{uri}' for Tentacle #{@name}, but got '#{@machine["Uri"]}'" unless (@machine["Uri"].casecmp(uri) == 0)
  @machine["Uri"].casecmp(uri) == 0
end

#has_policy?(policy_name) ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
105
106
107
108
109
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 102

def has_policy?(policy_name)
  return false if @machine.nil?
  url = "#{@serverUrl}/api/#{spaceFragment}machinepolicies/all?api-key=#{@apiKey}"
  resp = Net::HTTP.get_response(URI.parse(url))
  policies = JSON.parse(resp.body)
  policy_id = policies.select {|e| e["Name"] == policy_name}.first["Id"]
  @machine["MachinePolicyId"] == policy_id
end

#has_role?(role_name) ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
114
115
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 111

def has_role?(role_name)
  return false if @machine.nil?
  roles = @machine["Roles"]
  !roles.select {|e| e == role_name}.empty?
end

#has_tenant?(tenant_name) ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 87

def has_tenant?(tenant_name)
  return false if @machine.nil?
  url = "#{@serverUrl}/api/#{spaceFragment}tenants/all?api-key=#{@apiKey}"
  resp = Net::HTTP.get_response(URI.parse(url))
  tenants = JSON.parse(resp.body)
  tenant_id = tenants.select {|e| e["Name"] == tenant_name}.first["Id"]
  !@machine["TenantIds"].select {|e| e == tenant_id}.empty?
end

#has_tenant_tag?(tag_set, tag) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
99
100
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 96

def has_tenant_tag?(tag_set, tag)
  return false if @machine.nil?
  tenant_tags = @machine["TenantTags"]
  !tenant_tags.select {|e| e == "#{tag_set}/#{tag}"}.empty?
end

#in_environment?(environment_name) ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
71
72
73
74
75
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 68

def in_environment?(environment_name)
  return false if @machine.nil?
  url = "#{@serverUrl}/api/#{spaceFragment}environments/all?api-key=#{@apiKey}"
  resp = Net::HTTP.get_response(URI.parse(url))
  environments = JSON.parse(resp.body)
  environment_id = environments.select {|e| e["Name"] == environment_name}.first["Id"]
  !@machine["EnvironmentIds"].select {|e| e == environment_id}.empty?
end

#in_space?(space_name) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
84
85
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 77

def in_space?(space_name)
  return false if @machine.nil?
  return false if @serverSupportsSpaces
  url = "#{@serverUrl}/api/#{spaceFragment}spaces/all?api-key=#{@apiKey}"
  resp = Net::HTTP.get_response(URI.parse(url))
  spaces = JSON.parse(resp.body)
  space_id = spaces.select {|e| e["Name"] == space_name}.first["Id"]
  @machine["SpaceId"] == space_id
end

#listening_tentacle? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
131
132
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 128

def listening_tentacle?
  return false if @machine.nil?
  puts "Expected CommunicationStyle 'TentaclePassive' for Tentacle #{@name}, but got '#{@machine["Endpoint"]["CommunicationStyle"]}'" if (@machine["Endpoint"]["CommunicationStyle"] != "TentaclePassive")
  @machine["Endpoint"]["CommunicationStyle"] == "TentaclePassive"
end

#online? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 54

def online?
  return nil if @machine.nil?
  @machine = poll_until_machine_has_completed_healthcheck(@serverUrl, @apiKey, @machine["Thumbprint"])
  status = @machine['Status']
  if ("#{status}" == "")
    status = @machine['HealthStatus'] if "#{status}" == ""
    puts "Expected status 'Healthy|HasWarnings' for Tentacle #{@name}, but got '#{status}'" if (status != "Healthy" && status != "HasWarnings")
    status == "Healthy" || status == "HasWarnings"
  else
    puts "Expected status 'Online|CalamariNeedsUpgrade|NeedsUpgrade' for Tentacle #{@name}, but got '#{status}'" if (status != "Online" && status != "CalamariNeedsUpgrade" && status != "NeedsUpgrade")
    status == "Online" || status == "CalamariNeedsUpgrade" || status == "NeedsUpgrade"
  end
end

#polling_tentacle? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
137
138
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 134

def polling_tentacle?
  return false if @machine.nil?
  puts "Expected CommunicationStyle 'TentacleActive' for Tentacle #{@name}, but got '#{@machine["Endpoint"]["CommunicationStyle"]}'" if (@machine["Endpoint"]["CommunicationStyle"] != "TentacleActive")
  @machine["Endpoint"]["CommunicationStyle"] == "TentacleActive"
end

#registered_with_the_server? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb', line 50

def registered_with_the_server?
  !@machine.nil?
end