octopus-serverspec-extensions 0.15.5 → 0.17.0

data/lib/octopus_serverspec_extensions/type/octopus_deploy_smtp_config.rb

@@ -0,0 +1,109 @@
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeploySmtpConfig < Base
+    @serverUrl = nil
+    @apiKey = nil
+    @smtpConfig = nil
+
+    def initialize(*url_and_api_key)
+      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+      @name = "Octopus Deploy SMTP Config #{serverUrl}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      if serverUrl.nil?
+        serverUrl = get_env_var('OCTOPUS_CLI_SERVER').chomp('/') # removes trailing slash if present
+      end
+
+      if apiKey.nil?
+        apiKey = get_env_var('OCTOPUS_CLI_API_KEY')
+      end
+
+      # is it still nil?
+      if serverUrl.nil?
+        raise "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+      if apiKey.nil?
+        raise "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+
+      @smtpConfig = get_smtp_config_via_api(serverUrl, apiKey)
+    end
+
+    def configured?
+      url = "#{@serverUrl}/api/smtpconfiguration/isconfigured?api-key=#{@apiKey}"
+      begin
+        resp = Net::HTTP.get_response(URI.parse(url))
+        body = JSON.parse(resp.body)
+        smtp = body unless body.nil?
+      rescue => e
+        raise "get_smtp_config_via_api: Unable to connect to #{url}: #{e}"
+      end
+
+      smtp["IsConfigured"]
+    end
+
+    def using_ssl?
+      false if @smtpConfig.nil?
+      @smtpConfig["EnableSsl"]
+    end
+
+    def on_port?(port_number)
+      false if @smtpConfig.nil?
+      @smtpConfig["SmtpPort"] == port_number
+    end
+
+    def on_host?(hostname)
+      false if @smtpConfig.nil?
+      @smtpConfig["SmtpHost"] == hostname
+    end
+
+    def using_credentials?(username)
+      # we can't test the password, but we can check the username
+      false if @smtpConfig.nil?
+      @smtpConfig["SmtpLogin"] == username && @smtpConfig["SmtpPassword"]["HasValue"]
+    end
+
+    def has_from_address?(from_address)
+      false if @smtpConfig.nil?
+      @smtpConfig["SendEmailFrom"] == from_address
+    end
+  end
+
+  # module-level constructors/entrypoints
+
+  def octopus_deploy_smtp_config(*url_and_api_key)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeploySmtpConfig.new(serverUrl, apiKey)
+  end
+
+  def octopus_smtp_config(*url_and_api_key)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    octopus_deploy_smtp_config(serverUrl, apiKey)
+  end
+
+  private
+
+  def get_smtp_config_via_api(serverUrl, apiKey)
+    smtp = nil
+
+    url = "#{serverUrl}/api/smtpconfiguration?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      smtp = body unless body.nil?
+    rescue => e
+      raise "get_smtp_config_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    smtp
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/octopus_deploy_space.rb

@@ -0,0 +1,92 @@
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeploySpace < Base
+    @serverUrl = nil
+    @apiKey = nil
+    @spaceName = nil
+    @space = nil
+
+    def initialize(*url_and_api_key, space_name)
+      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+      @name = "Octopus Deploy Space #{space_name}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      if space_name.nil?
+        raise "'space_name' was not included. Cannot contact server to validate space."
+      end
+
+      @spaceName = space_name
+    end
+
+    def exists?
+      load_resource_if_nil
+      @space.nil? == false
+    end
+
+    def default?
+      load_resource_if_nil
+      false if @space.nil?
+      @space['IsDefault'] == true
+    end
+
+    def has_running_task_queue?
+      load_resource_if_nil
+      false if @space.nil?
+      @space['TaskQueueStopped'] == false
+    end
+
+    def has_description?(description)
+      load_resource_if_nil
+      false if @space.nil?
+      @space['Description'] == description
+    end
+
+    def load_resource_if_nil
+      if @space.nil?
+        @space = get_space_via_api
+      end
+    end
+  end
+
+  # module-level constructors/entrypoints
+
+  def octopus_deploy_space(*url_and_api_key, space_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeploySpace.new(serverUrl, apiKey, space_name)
+  end
+
+  def octopus_space(*url_and_api_key, space_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeploySpace.new(serverUrl, apiKey, space_name)
+  end
+
+  private
+
+  def get_space_via_api
+    space = nil
+
+    @serverSupportsSpaces = check_supports_spaces(@serverUrl)
+
+    unless @serverSupportsSpaces
+      raise "Server does not support Spaces"
+    end
+
+    url = "#{@serverUrl}/api/Spaces/all?api-key=#{@apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      space = body.select {|i| i['Name'] == @spaceName }.first unless body.nil?
+    rescue => e
+      raise "get_account_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    space
+    end
+end

data/lib/octopus_serverspec_extensions/type/octopus_deploy_team.rb

@@ -0,0 +1,82 @@
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployTeam < Base
+    @team_name = nil
+    @serverUrl = nil
+    @apiKey = nil
+    @serverSupportsSpaces = false
+    @team = nil
+    @spaceId = nil
+
+    def initialize(*url_and_api_key, team_name)
+      serverUrl,apiKey = get_octopus_creds(url_and_api_key)
+
+      @team_name = team_name
+
+      @name = "Octopus Deploy User Account #{serverUrl}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      if team_name.nil?
+        raise "'team_name' was not provided"
+      end
+    end
+
+    def exists?
+      load_resource_if_nil
+      @team != nil?
+    end
+
+    def in_space(space_name)
+      # allows us to tag .in_space() onto the end of the resource. as in
+      # describe octopus_account("account name").in_space("MyNewSpace") do
+      @spaceId = get_space_id?(space_name)
+      if @team_name.nil?
+        raise "'team_name' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+      self
+    end
+
+    def load_resource_if_nil
+      if @team.nil?
+        @team = get_team_via_api(@serverUrl, @apiKey, @team_name)
+      end
+    end
+  end
+
+  def octopus_deploy_team(*url_and_api_key, team_name)
+    serverUrl,apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeployTeam.new(serverUrl, apiKey, team_name)
+  end
+
+  def octopus_team(*url_and_api_key, team_name)
+    serverUrl,apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeployTeam.new(serverUrl, apiKey, team_name)
+  end
+
+  private
+
+  def get_team_via_api(serverUrl, apiKey, team_name)
+    team = nil
+
+    url = "#{serverUrl}/api#{@spaceFragment}/teams/all?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      teams = body unless body.nil?
+      team = teams.select {|i| i['Name'] == team_name }.first unless teams.nil?
+    rescue => e
+      raise "get_team_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    team
+  end
+
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb

@@ -20,12 +20,10 @@ module Serverspec::Type
       @spaceId = spaceId
 
       if (serverUrl.nil?)
-        puts "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
-        return
+        raise "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
       end
       if (apiKey.nil?)
-        puts "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
-        return
+        raise "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
       end
 
       if (exists?)
@@ -43,7 +41,7 @@ module Serverspec::Type
 
         @machine = get_machine_via_api(serverUrl, apiKey, thumbprint)
       else
-        puts "tentacle.exe does not exist"
+        raise "tentacle.exe does not exist"
       end
     end
 
@@ -77,7 +75,7 @@ module Serverspec::Type
     def in_space?(space_name)
       return false if @machine.nil?
       return false if @serverSupportsSpaces
-      url = "#{@serverUrl}/api/#{@spaceFragment}spaces/all?api-key=#{@apiKey}"
+      url = "#{@serverUrl}/api/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"]
@@ -121,6 +119,7 @@ module Serverspec::Type
 
     def has_endpoint?(uri)
       return false if @machine.nil?
+      return false if @machine["Uri"].nil? # polling tentacles have null endpoint. catch that.
       puts "Expected uri '#{uri}' for Tentacle #{@name}, but got '#{@machine["Uri"]}'" unless (@machine["Uri"].casecmp(uri) == 0)
       @machine["Uri"].casecmp(uri) == 0
     end
@@ -130,13 +129,13 @@ module Serverspec::Type
       @machine["TenantedDeploymentParticipation"] == mode
     end
 
-    def listening_tentacle?
+    def listening?
       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
 
-    def polling_tentacle?
+    def polling?
       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"

data/lib/octopus_serverspec_extensions/type/octopus_deploy_upgrade_config.rb

@@ -0,0 +1,112 @@
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployUpgradeConfig < Base
+    @serverUrl = nil
+    @apiKey = nil
+    @upgradeConfig = nil
+
+    @NotificationModes = ['AlwaysShow', 'ShowOnlyMajorMinor', 'NeverShow']
+
+    def initialize(*url_and_api_key)
+      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+      @name = "Octopus Deploy Upgrade Config #{serverUrl}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      # is it still nil?
+      if serverUrl.nil?
+        raise "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+      if apiKey.nil?
+        raise "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+
+      @upgradeConfig = get_upgrade_config_via_api(serverUrl, apiKey)
+    end
+
+    def has_notification_mode?(mode)
+      false if @upgradeConfig.nil?
+      @upgradeConfig['NotificationMode'] == mode
+    end
+
+    def never_show_notifications?
+      false if @upgradeConfig.nil?
+      has_notification_mode?('NeverShow')
+    end
+
+    def always_show_notifications?
+      false if @upgradeConfig.nil?
+      has_notification_mode?('AlwaysShow')
+    end
+
+    def show_major_minor_notifications?
+      false if @upgradeConfig.nil?
+      has_notification_mode?('ShowOnlyMajorMinor')
+    end
+
+    def include_statistics?
+      false if @upgradeConfig.nil?
+      @upgradeConfig['IncludeStatistics'] == true
+    end
+
+    def allow_checking?
+      false if @upgradeConfig.nil?
+      @upgradeConfig['AllowChecking'] == true
+    end
+  end
+
+  # module-level constructors/entrypoints
+
+  def octopus_deploy_upgrade_config(*url_and_api_key)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeployUpgradeConfig.new(serverUrl, apiKey)
+  end
+
+  def octopus_upgrade_config(*url_and_api_key)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    octopus_deploy_upgrade_config(serverUrl, apiKey)
+  end
+
+  private
+
+  def get_upgrade_config_endpoint(serverUrl)
+    endpoint = nil
+
+    url = "#{serverUrl}/api/"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      json = body unless body.nil?
+      endpoint = json['Links']['UpgradeConfiguration']
+    rescue => e
+      raise "get_upgrade_config_endpoint: Unable to connect to #{url}: #{e}"
+    end
+
+    endpoint
+  end
+
+  def get_upgrade_config_via_api(serverUrl, apiKey)
+    smtp = nil
+
+    stem = get_upgrade_config_endpoint(serverUrl)
+    url = "#{serverUrl}#{stem}?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      smtp = body unless body.nil?
+    rescue => e
+      raise "get_upgrade_config_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    smtp
+  end
+end
+
+include Serverspec::Type