octopus-serverspec-extensions 0.15.5 → 0.17.0

data/lib/octopus_serverspec_extensions.rb

@@ -2,10 +2,16 @@ require 'octopus_serverspec_extensions/type/chocolatey_package.rb'
 require 'octopus_serverspec_extensions/type/npm_package.rb'
 require 'octopus_serverspec_extensions/type/java_property_file.rb'
 require 'octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_worker.rb'
 require 'octopus_serverspec_extensions/type/octopus_deploy_environment.rb'
 require 'octopus_serverspec_extensions/type/octopus_deploy_project_group.rb'
 require 'octopus_serverspec_extensions/type/octopus_deploy_worker_pool.rb'
 require 'octopus_serverspec_extensions/type/octopus_deploy_account.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_smtp_config.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_team.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_upgrade_config.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_user.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_space.rb'
 require 'octopus_serverspec_extensions/type/windows_dsc.rb'
 require 'octopus_serverspec_extensions/type/windows_firewall.rb'
 require 'octopus_serverspec_extensions/type/windows_scheduled_task.rb'
@@ -14,3 +20,67 @@ require 'octopus_serverspec_extensions/matcher/run_under_account.rb'
 require 'octopus_serverspec_extensions/matcher/have_windows_line_endings.rb'
 require 'octopus_serverspec_extensions/matcher/have_linux_line_endings.rb'
 require 'octopus_serverspec_extensions/version.rb'
+
+private
+
+def get_env_var(name)
+  raise 'unexpected env var' if name != 'OCTOPUS_CLI_API_KEY' && name != 'OCTOPUS_CLI_SERVER'
+  raise "env var #{name} not found" if ENV[name].nil?
+  ENV[name]
+end
+
+def get_octopus_url(server_url)
+  # returns the url or nil
+  if server_url.nil?
+    server_url = get_env_var('OCTOPUS_CLI_SERVER')
+  end
+
+  server_url
+end
+
+def get_octopus_api_key(api_key)
+  # returns the api key or nil
+  if api_key.nil?
+    api_key = get_env_var('OCTOPUS_CLI_API_KEY')
+  end
+
+  api_key
+end
+
+def get_octopus_creds(args)
+  server = args[0]
+  api_key = args[1]
+
+  if args.length != 0 && args.length != 2
+    raise "Supplied credentials invalid. Expected: [url, api_key] Received: #{args}"
+  end
+
+  if server.nil?
+    server = get_env_var('OCTOPUS_CLI_SERVER')
+  end
+
+  if api_key.nil?
+    api_key = get_env_var('OCTOPUS_CLI_API_KEY')
+  end
+
+  # are they still nil? raise an error
+  if api_key.nil? or server.nil?
+    raise "Supplied credentials invalid. One or more of [server, api_key] was null. " +
+      "If you intended to use Environment Variables, please check the value of OCTOPUS_CLI_SERVER and OCTOPUS_CLI_API_KEY"
+  end
+
+  server = server.chomp("/") # remove the trailing slash if it exists
+
+  [server, api_key]
+end
+
+def check_supports_spaces(server_url)
+  begin
+    resp = Net::HTTP.get_response(URI.parse("#{server_url}/api/"))
+    body = JSON.parse(resp.body)
+    version = body['Version']
+    return Gem::Version.new(version) > Gem::Version.new('2019.0.0')
+  rescue => e
+    raise "check_supports_spaces: Unable to connect to #{server_url}: #{e}"
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/allow_dynamic_infrastructure.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :allow_dynamic_infrastructure do
+  match do |env|
+    env.allow_dynamic_infrastructure? == true
+  end
+
+  failure_message do |env|
+    "Expected Environment '#{env.environment_name}' to allow dynamic infrastructure, but it didn't"
+  end
+
+  failure_message_when_negated do |env|
+    "Expected Environment '#{env.environment_name}' not to allow dynamic infrastructure, but it did"
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/use_guided_failure.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :use_guided_failure do
+  match do |env|
+    env.use_guided_failure? == true
+  end
+
+  failure_message do |env|
+    "Expected Environment '#{env.environment_name}' to use guided failure mode, but it didn't"
+  end
+
+  failure_message_when_negated do |env|
+    "Expected Environment '#{env.environment_name}' not to use guided failure mode, but it did"
+  end
+end

data/lib/octopus_serverspec_extensions/type/octopus_deploy_account.rb

@@ -6,6 +6,7 @@ require 'json'
 module Serverspec::Type
   class OctopusDeployAccount < Base
     @account = nil
+    @accountName = nil
     @serverUrl = nil
     @apiKey = nil
     @serverSupportsSpaces = nil
@@ -18,52 +19,38 @@ module Serverspec::Type
     SSH = 'SshKeypair'.freeze
     TOKEN = 'Token'.freeze
     USERNAME = 'UsernamePassword'.freeze
-    ACCOUNTTYPES = [AZURE, AWS, SSH, TOKEN, USERNAME]
+    ACCOUNT_TYPES = [AZURE, AWS, SSH, TOKEN, USERNAME]
+
+    def initialize(*url_and_api_key, account_name)
+      server_url, api_key = get_octopus_creds(url_and_api_key)
+
+      @serverSupportsSpaces = check_supports_spaces(server_url)
 
-    def initialize(serverUrl, apiKey, account_name, space_name = nil)
       @name = "Octopus Deploy Account #{account_name}"
       @runner = Specinfra::Runner
-      @serverUrl = serverUrl
-      @apiKey = apiKey
+      @accountName = account_name
+      @serverUrl = server_url
+      @apiKey = api_key
 
-      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
-      if account_name.nil?
+      if account_name.nil? or account_name == ""
         raise "'account_name' was not provided. Unable to connect to Octopus server to validate configuration."
       end
-
-      @serverSupportsSpaces = check_supports_spaces(serverUrl)
-
-      if @serverSupportsSpaces
-        # set the spaceId correctly
-
-        if space_name.nil?
-          @spaceId = 'Spaces-1' # default to Spaces-1
-        else
-          @spaceId = get_space_id?(space_name)
-        end
-
-        @spaceFragment = "#{@spaceId}/"
-      end
-
-      @account = get_account_via_api(serverUrl, apiKey, account_name)
     end
 
     def exists?
+      load_resource_if_nil()
       (!@account.nil?) && (@account != [])
     end
 
     def has_description?(account_description)
+      load_resource_if_nil()
       return false if @account.nil?
       @account["Description"] == account_description
     end
 
-    def is_account_type?(account_type_name)
-      if !ACCOUNTTYPES.include? account_type_name
+    def account_type?(account_type_name)
+      load_resource_if_nil()
+      if !ACCOUNT_TYPES.include? account_type_name
         raise("'#{account_type_name}' is not a valid account type")
       end
       return false if @account.nil?
@@ -71,33 +58,34 @@ module Serverspec::Type
       @account["AccountType"] == account_type_name
     end
 
-    def is_azure_account?
+    def azure_account?
       return false if @account.nil?
-      @account["AccountType"] == AZURE
+      account_type?(AZURE)
       # should also have a subscription number, but Octopus manages validation on this
     end
 
-    def is_aws_account?
+    def aws_account?
       return false if @account.nil?
-      @account["AccountType"] == AWS
+      account_type?(AWS)
     end
 
-    def is_ssh_key_pair?
+    def ssh_key_pair?
       return false if @account.nil?
-      @account["AccountType"] == SSH
+      account_type?(SSH)
     end
 
-    def is_username_password?
+    def username_password?
       return false if @account.nil?
-      @account["AccountType"] == USERNAME
+      account_type?(USERNAME)
     end
 
-    def is_token?
+    def token?
       return false if @account.nil?
-      @account["AccountType"] == TOKEN
+      account_type?(TOKEN)
     end
 
     def in_environment?(environment_name)
+      load_resource_if_nil()
       return false if @account.nil?
       url = "#{@serverUrl}/api/#{@spaceFragment}environments/all?api-key=#{@apiKey}"
       resp = Net::HTTP.get_response(URI.parse(url))
@@ -107,17 +95,55 @@ module Serverspec::Type
     end
 
     def has_tenanted_deployment_participation?(mode)
+      load_resource_if_nil()
       return false if @machine.nil?
       @machine["TenantedDeploymentParticipation"] == mode # copied directly from tentacle
     end
 
     def has_property?(property_name, expected_value)
+      load_resource_if_nil()
       return false if @account.nil?
       @account[property_name] == expected_value
     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 @accountName.nil?
+        raise "'account_name' was not provided. Please provide an account name and try again."
+      end
+      self
+    end
+
+    private
+
+    def load_resource_if_nil
+      if @account.nil?
+        @account = get_account_via_api(@serverUrl, @apiKey, @accountName)
+      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
 
-  def octopus_deploy_account(serverUrl, apiKey, account_name)
+  def octopus_deploy_account(*url_and_api_key, account_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
+    OctopusDeployAccount.new(serverUrl, apiKey, account_name)
+  end
+
+  def octopus_account(*url_and_api_key, account_name)
+    serverUrl, apiKey = get_octopus_creds(url_and_api_key)
+
     OctopusDeployAccount.new(serverUrl, apiKey, account_name)
   end
 
@@ -125,6 +151,12 @@ module Serverspec::Type
 
   def get_account_via_api(serverUrl, apiKey, account_name)
     account = nil
+
+    unless @spaceId.nil?
+      # set the spaceId correctly
+      @spaceFragment = "#{@spaceId}/"
+    end
+
     url = "#{serverUrl}/api/#{@spaceFragment}accounts/all?api-key=#{apiKey}"
 
     begin
@@ -138,27 +170,6 @@ module Serverspec::Type
     account
   end
 
-  def check_supports_spaces(serverUrl)
-    begin
-      resp = Net::HTTP.get_response(URI.parse("#{serverUrl}/api/"))
-      body = JSON.parse(resp.body)
-      version = body['Version']
-      return Gem::Version.new(version) > Gem::Version.new('2019.0.0')
-    rescue => e
-      puts "check_supports_spaces: Unable to connect to #{serverUrl}: #{e}"
-    end
-
-    false
-  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
 

data/lib/octopus_serverspec_extensions/type/octopus_deploy_environment.rb

@@ -6,34 +6,87 @@ require 'json'
 module Serverspec::Type
   class OctopusDeployEnvironment < Base
     @environment = nil
+    @environment_name = nil
     @serverUrl = nil
     @apiKey = nil
+    @spaceId = nil
+    @spaceFragment = ""
 
-    def initialize(serverUrl, apiKey, environment_name)
+    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 (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
-      if (environment_name.nil?)
+      if environment_name.nil?
         raise "'environment_name' was not provided. Unable to connect to Octopus server to validate configuration."
       end
 
-      @environment = get_environment_via_api(serverUrl, apiKey, environment_name)
+      @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_deploy_environment(serverUrl, apiKey, environment_name)
+  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
 
@@ -41,7 +94,13 @@ module Serverspec::Type
 
   def get_environment_via_api(serverUrl, apiKey, environment_name)
     environment = nil
-    url = "#{serverUrl}/api/environments?name=#{environment_name}&api-key=#{apiKey}"
+
+    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))

data/lib/octopus_serverspec_extensions/type/octopus_deploy_project_group.rb

@@ -4,100 +4,125 @@ require 'json'
 
 module Serverspec::Type
   class OctopusDeployProjectGroup < Base
-    @projectgroup = nil
+    @project_group = nil
+    @project_group_name = nil
     @serverUrl = nil
     @apiKey = nil
     @serverSupportsSpaces = nil
     @spaceId = nil
     @spaceFragment = ""
 
-    def initialize(serverUrl, apiKey, projectgroup_name, space_name = nil)
-      @name = "Octopus Deploy Project Group #{projectgroup_name}"
+    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
 
-
-      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
-      if projectgroup_name.nil?
-        raise "'projectgroup_name' was not provided. Unable to connect to Octopus server to validate configuration."
-      end
-
       @serverSupportsSpaces = check_supports_spaces(serverUrl)
+    end
 
-      if @serverSupportsSpaces
-        # set the spaceId correctly
+    def exists?
+      load_resource_if_nil
+      (!@project_group.nil?) && (@project_group != [])
+    end
 
-        if space_name.nil?
-          @spaceId = 'Spaces-1' # default to Spaces-1
-        else
-          @spaceId = get_space_id?(space_name)
-        end
+    def has_description?(project_group_description)
+      load_resource_if_nil
+      return false if @project_group.nil?
+      @project_group["Description"] == project_group_description
+    end
 
-        @spaceFragment = "#{@spaceId}/"
+    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
-
-      @projectgroup = get_projectgroup_via_api(serverUrl, apiKey, projectgroup_name)
+      self
     end
 
-    def exists?
-      (!@projectgroup.nil?) && (@projectgroup != [])
+    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 has_description?(projectgroup_description)
-      return false if @projectgroup.nil?
-      @projectgroup["Description"] == projectgroup_description
+    def load_resource_if_nil
+      if @project_group.nil?
+        @project_group = get_project_group_via_api(@serverUrl, @apiKey, @project_group_name)
+      end
     end
   end
 
-  def octopus_deploy_projectgroup(serverUrl, apiKey, projectgroup_name, spaceName = nil)
-    OctopusDeployProjectGroup.new(serverUrl, apiKey, projectgroup_name, spaceName)
+  # 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_projectgroup_via_api(serverUrl, apiKey, projectgroup_name)
+  def get_project_group_via_api(serverUrl, apiKey, project_group_name)
     pg = nil
-    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'] == projectgroup_name }.first unless body.nil?
-    rescue => e
-      raise "get_projectgroup_via_api: Unable to connect to #{url}: #{e}"
+   raise "'project_group_name' not supplied" if(project_group_name.nil? || project_group_name == '')
+
+    unless @spaceId.nil?
+      @spaceFragment = "#{@spaceId}/"
     end
 
-    pg
-  end
+    url = "#{serverUrl}/api/#{@spaceFragment}projectgroups/all?api-key=#{apiKey}"
 
-  def check_supports_spaces(serverUrl)
     begin
-      resp = Net::HTTP.get_response(URI.parse("#{serverUrl}/api/"))
+      resp = Net::HTTP.get_response(URI.parse(url))
       body = JSON.parse(resp.body)
-      version = body['Version']
-      return Gem::Version.new(version) > Gem::Version.new('2019.0.0')
+      pg = body.select {|i| i['Name'] == project_group_name }.first unless body.nil?
     rescue => e
-      puts "check_supports_spaces: Unable to connect to #{serverUrl}: #{e}"
+      raise "get_project_group_via_api: Unable to connect to #{url}: #{e}"
     end
 
-    false
+    pg
   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"]
+    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