octopus-serverspec-extensions 0.17.1 → 0.19.0

data/lib/octopus_serverspec_extensions/type/octopus_deploy_smtp_config.rb

@@ -1,109 +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
+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

@@ -1,92 +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
+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

@@ -1,82 +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
-
+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