octopus-serverspec-extensions 0.18.1 → 0.19.0

data/lib/octopus_serverspec_extensions/type/octopus_deploy_environment.rb

@@ -1,117 +1,117 @@
-require 'serverspec'
-require 'serverspec/type/base'
-require 'net/http'
-require 'json'
-
-module Serverspec::Type
-  class OctopusDeployEnvironment < Base
-    @environment = nil
-    @environment_name = nil
-    @serverUrl = nil
-    @apiKey = nil
-    @spaceId = nil
-    @spaceFragment = ""
-
-    def initialize(*url_and_api_key, environment_name)
-      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
-
-      @environment_name = environment_name
-      @name = "Octopus Deploy Environment #{environment_name}"
-      @runner = Specinfra::Runner
-      @serverUrl = serverUrl
-      @apiKey = apiKey
-
-      if environment_name.nil?
-        raise "'environment_name' was not provided. Unable to connect to Octopus server to validate configuration."
-      end
-
-      @serverSupportsSpaces = check_supports_spaces(serverUrl)
-    end
-
-    def exists?
-      load_resource_if_nil
-      (!@environment.nil?) && (@environment != [])
-    end
-
-    def use_guided_failure?
-      load_resource_if_nil
-      false if @environment.nil?
-      @environment['UseGuidedFailure'] == true
-    end
-
-    def allow_dynamic_infrastructure?
-      load_resource_if_nil
-      false if @environment.nil?
-      @environment['AllowDynamicInfrastructure'] == true
-    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 @environment_name.nil?
-        raise "'environment_name' was not provided. Unable to connect to Octopus server to validate configuration."
-      end
-      if(@spaceId.nil?)
-        raise "unable to resolve space '#{@spaceId}'"
-      end
-      self
-    end
-
-    private
-
-    def load_resource_if_nil
-      if @environment.nil?
-        @environment = get_environment_via_api(@serverUrl, @apiKey, @environment_name)
-      end
-    end
-
-    def get_space_id(space_name)
-      return false if @serverSupportsSpaces.nil?
-      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"]
-      space_id
-    end
-  end
-
-  # module-level constructors/entrypoints
-
-  def octopus_deploy_environment(*url_and_api_key, environment_name)
-    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
-
-    OctopusDeployEnvironment.new(serverUrl, apiKey, environment_name)
-  end
-
-  def octopus_environment(*url_and_api_key, environment_name)
-    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
-
-    OctopusDeployEnvironment.new(serverUrl, apiKey, environment_name)
-  end
-
-  private
-
-  def get_environment_via_api(serverUrl, apiKey, environment_name)
-    environment = nil
-
-    unless @spaceId.nil?
-      # set the spaceId correctly
-      @spaceFragment = "#{@spaceId}/"
-    end
-
-    url = "#{serverUrl}/api/#{@spaceFragment}environments?name=#{environment_name}&api-key=#{apiKey}"
-
-    begin
-      resp = Net::HTTP.get_response(URI.parse(url))
-      body = JSON.parse(resp.body)
-      environment = body['Items'].first unless body.nil?
-    rescue => e
-      raise "Unable to connect to #{url}: #{e}"
-    end
-
-    environment
-  end
-end
-
-include Serverspec::Type
+require 'serverspec'
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployEnvironment < Base
+    @environment = nil
+    @environment_name = nil
+    @serverUrl = nil
+    @apiKey = nil
+    @spaceId = nil
+    @spaceFragment = ""
+
+    def initialize(*url_and_api_key, environment_name)
+      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+      @environment_name = environment_name
+      @name = "Octopus Deploy Environment #{environment_name}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      if environment_name.nil?
+        raise "'environment_name' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+
+      @serverSupportsSpaces = check_supports_spaces(serverUrl)
+    end
+
+    def exists?
+      load_resource_if_nil
+      (!@environment.nil?) && (@environment != [])
+    end
+
+    def use_guided_failure?
+      load_resource_if_nil
+      false if @environment.nil?
+      @environment['UseGuidedFailure'] == true
+    end
+
+    def allow_dynamic_infrastructure?
+      load_resource_if_nil
+      false if @environment.nil?
+      @environment['AllowDynamicInfrastructure'] == true
+    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 @environment_name.nil?
+        raise "'environment_name' was not provided. Unable to connect to Octopus server to validate configuration."
+      end
+      if(@spaceId.nil?)
+        raise "unable to resolve space '#{@spaceId}'"
+      end
+      self
+    end
+
+    private
+
+    def load_resource_if_nil
+      if @environment.nil?
+        @environment = get_environment_via_api(@serverUrl, @apiKey, @environment_name)
+      end
+    end
+
+    def get_space_id(space_name)
+      return false if @serverSupportsSpaces.nil?
+      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"]
+      space_id
+    end
+  end
+
+  # module-level constructors/entrypoints
+
+  def octopus_deploy_environment(*url_and_api_key, environment_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+    OctopusDeployEnvironment.new(serverUrl, apiKey, environment_name)
+  end
+
+  def octopus_environment(*url_and_api_key, environment_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+    OctopusDeployEnvironment.new(serverUrl, apiKey, environment_name)
+  end
+
+  private
+
+  def get_environment_via_api(serverUrl, apiKey, environment_name)
+    environment = nil
+
+    unless @spaceId.nil?
+      # set the spaceId correctly
+      @spaceFragment = "#{@spaceId}/"
+    end
+
+    url = "#{serverUrl}/api/#{@spaceFragment}environments?name=#{environment_name}&api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      environment = body['Items'].first unless body.nil?
+    rescue => e
+      raise "Unable to connect to #{url}: #{e}"
+    end
+
+    environment
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/octopus_deploy_project_group.rb

@@ -1,128 +1,128 @@
-require 'serverspec/type/base'
-require 'net/http'
-require 'json'
-
-module Serverspec::Type
-  class OctopusDeployProjectGroup < Base
-    @project_group = nil
-    @project_group_name = nil
-    @serverUrl = nil
-    @apiKey = nil
-    @serverSupportsSpaces = nil
-    @spaceId = nil
-    @spaceFragment = ""
-
-    def initialize(*url_and_api_key, project_group_name)
-      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
-
-      raise "'project_group_name' was not provided. Unable to connect to Octopus server to validate configuration."  if project_group_name.nil?
-
-      @project_group_name = project_group_name
-
-      @name = "Octopus Deploy Project Group #{project_group_name}"
-      @runner = Specinfra::Runner
-      @serverUrl = serverUrl
-      @apiKey = apiKey
-
-      @serverSupportsSpaces = check_supports_spaces(serverUrl)
-    end
-
-    def exists?
-      load_resource_if_nil
-      (!@project_group.nil?) && (@project_group != [])
-    end
-
-    def has_description?(project_group_description)
-      load_resource_if_nil
-      return false if @project_group.nil?
-      @project_group["Description"] == project_group_description
-    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 @project_group_name.nil?
-        raise "'project_group_name' was not provided. Please provide a project group name and try again."
-      end
-      self
-    end
-
-    private
-
-    def get_space_id(space_name)
-      return false if @serverSupportsSpaces.nil?
-      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"]
-      space_id
-    end
-
-    def load_resource_if_nil
-      if @project_group.nil?
-        @project_group = get_project_group_via_api(@serverUrl, @apiKey, @project_group_name)
-      end
-    end
-  end
-
-  # module-level constructors/entrypoints
-
-  def octopus_deploy_projectgroup(*url_and_api_key, project_group_name) # deprecated - no underscore in name
-    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
-    OctopusDeployProjectGroup.new(serverUrl, apiKey, project_group_name)
-  end
-
-  def octopus_deploy_project_group(*url_and_api_key, project_group_name)
-    url, apikey = get_octopus_creds(url_and_api_key)
-    octopus_deploy_projectgroup(url, apikey, project_group_name)
-  end
-
-  def octopus_project_group(*url_and_api_key, project_group_name)
-    url, apikey = get_octopus_creds(url_and_api_key)
-    octopus_deploy_projectgroup(url, apikey, project_group_name)
-  end
-
-  def octopus_projectgroup(*url_and_api_key, project_group_name) # deprecated - no underscore in name
-    url, apikey = get_octopus_creds(url_and_api_key)
-    octopus_deploy_projectgroup(url, apikey, project_group_name)
-  end
-
-  private
-
-  def get_project_group_via_api(serverUrl, apiKey, project_group_name)
-    pg = nil
-
-   raise "'project_group_name' not supplied" if(project_group_name.nil? || project_group_name == '')
-
-    unless @spaceId.nil?
-      @spaceFragment = "#{@spaceId}/"
-    end
-
-    url = "#{serverUrl}/api/#{@spaceFragment}projectgroups/all?api-key=#{apiKey}"
-
-    begin
-      resp = Net::HTTP.get_response(URI.parse(url))
-      body = JSON.parse(resp.body)
-      pg = body.select {|i| i['Name'] == project_group_name }.first unless body.nil?
-    rescue => e
-      raise "get_project_group_via_api: Unable to connect to #{url}: #{e}"
-    end
-
-    pg
-  end
-
-  def get_space_id?(space_name)
-    url = "#{@serverUrl}/api/Spaces/all?api-key=#{@apiKey}"
-    begin
-      resp = Net::HTTP.get_response(URI.parse(url))
-      spaces = JSON.parse(resp.body)
-      space_id = spaces.select {|e| e["Name"] == space_name}.first["Id"]
-    rescue
-      raise "get_space_id: unable to connect to #{url}: #{e}"
-    end
-    space_id
-  end
-end
-
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployProjectGroup < Base
+    @project_group = nil
+    @project_group_name = nil
+    @serverUrl = nil
+    @apiKey = nil
+    @serverSupportsSpaces = nil
+    @spaceId = nil
+    @spaceFragment = ""
+
+    def initialize(*url_and_api_key, project_group_name)
+      serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+      raise "'project_group_name' was not provided. Unable to connect to Octopus server to validate configuration."  if project_group_name.nil?
+
+      @project_group_name = project_group_name
+
+      @name = "Octopus Deploy Project Group #{project_group_name}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      @serverSupportsSpaces = check_supports_spaces(serverUrl)
+    end
+
+    def exists?
+      load_resource_if_nil
+      (!@project_group.nil?) && (@project_group != [])
+    end
+
+    def has_description?(project_group_description)
+      load_resource_if_nil
+      return false if @project_group.nil?
+      @project_group["Description"] == project_group_description
+    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 @project_group_name.nil?
+        raise "'project_group_name' was not provided. Please provide a project group name and try again."
+      end
+      self
+    end
+
+    private
+
+    def get_space_id(space_name)
+      return false if @serverSupportsSpaces.nil?
+      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"]
+      space_id
+    end
+
+    def load_resource_if_nil
+      if @project_group.nil?
+        @project_group = get_project_group_via_api(@serverUrl, @apiKey, @project_group_name)
+      end
+    end
+  end
+
+  # module-level constructors/entrypoints
+
+  def octopus_deploy_projectgroup(*url_and_api_key, project_group_name) # deprecated - no underscore in name
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+    OctopusDeployProjectGroup.new(serverUrl, apiKey, project_group_name)
+  end
+
+  def octopus_deploy_project_group(*url_and_api_key, project_group_name)
+    url, apikey = get_octopus_creds(url_and_api_key)
+    octopus_deploy_projectgroup(url, apikey, project_group_name)
+  end
+
+  def octopus_project_group(*url_and_api_key, project_group_name)
+    url, apikey = get_octopus_creds(url_and_api_key)
+    octopus_deploy_projectgroup(url, apikey, project_group_name)
+  end
+
+  def octopus_projectgroup(*url_and_api_key, project_group_name) # deprecated - no underscore in name
+    url, apikey = get_octopus_creds(url_and_api_key)
+    octopus_deploy_projectgroup(url, apikey, project_group_name)
+  end
+
+  private
+
+  def get_project_group_via_api(serverUrl, apiKey, project_group_name)
+    pg = nil
+
+   raise "'project_group_name' not supplied" if(project_group_name.nil? || project_group_name == '')
+
+    unless @spaceId.nil?
+      @spaceFragment = "#{@spaceId}/"
+    end
+
+    url = "#{serverUrl}/api/#{@spaceFragment}projectgroups/all?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      pg = body.select {|i| i['Name'] == project_group_name }.first unless body.nil?
+    rescue => e
+      raise "get_project_group_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    pg
+  end
+
+  def get_space_id?(space_name)
+    url = "#{@serverUrl}/api/Spaces/all?api-key=#{@apiKey}"
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      spaces = JSON.parse(resp.body)
+      space_id = spaces.select {|e| e["Name"] == space_name}.first["Id"]
+    rescue
+      raise "get_space_id: unable to connect to #{url}: #{e}"
+    end
+    space_id
+  end
+end
+
 include Serverspec::Type