octopus-serverspec-extensions 0.15.4 → 0.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09404e7c6f33ee6dfde8d34818fb89754b9bd29c823a8b6d32a30f36042a8ca2'
-  data.tar.gz: 7db537c1863d7717b83c0b71aa03a8fa9005f728a8d4294d09f29ac750488bbe
+  metadata.gz: 260a7c2b8e6581eacd93f295117fa984b5e496dc51cb23c798d34c02c8411690
+  data.tar.gz: 348f4dfda4e0cf997e881e85c79fe10146982692d7af54aa5af8b354701fe755
 SHA512:
-  metadata.gz: 51779dd45bc5df85051afe6675e70d2e74347e639d3f136dd0e13e001fab5d0c7f957c8cb4cbd790971601ff9f97ca9e07f6566b8dab44f5c252d8b90bc661ac
-  data.tar.gz: 5892ca16b7895a43414d99d5fe685f3a645584d370f95bfb5a5922031ee0d63fc1fef6d55d8e61eee1187eaad440ee4e7469e210a795c04cdd6dfa8ee0e878da
+  metadata.gz: 68c3951d2313d435d1f106028862489bdf3eef2dd65b1731ba01aa61e24387c750480fbca74713c5be5a25d66d10e2b176442890a7006b29340e68ad8e556314
+  data.tar.gz: 8997eca9173dce7dfc46e0ec63af78fe043b0d7d652279128c9233ca110b937ea4d2921b37fa5d0bae9e9cd35ec41e42c3a85c05b2b3963b7da4fff4888c2b1e

data/lib/octopus_serverspec_extensions.rb

@@ -5,6 +5,7 @@ require 'octopus_serverspec_extensions/type/octopus_deploy_tentacle.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/windows_dsc.rb'
 require 'octopus_serverspec_extensions/type/windows_firewall.rb'
 require 'octopus_serverspec_extensions/type/windows_scheduled_task.rb'

data/lib/octopus_serverspec_extensions/type/octopus_deploy_account.rb

@@ -0,0 +1,165 @@
+require 'serverspec'
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployAccount < Base
+    @account = nil
+    @serverUrl = nil
+    @apiKey = nil
+    @serverSupportsSpaces = nil
+    @spaceId = nil
+    @spaceFragment = ""
+
+    # constants for account types
+    AZURE = 'AzureSubscription'.freeze
+    AWS = 'AmazonWebServicesAccount'.freeze
+    SSH = 'SshKeypair'.freeze
+    TOKEN = 'Token'.freeze
+    USERNAME = 'UsernamePassword'.freeze
+    ACCOUNTTYPES = [AZURE, AWS, SSH, TOKEN, USERNAME]
+
+    def initialize(serverUrl, apiKey, account_name, space_name = nil)
+      @name = "Octopus Deploy Account #{account_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 account_name.nil?
+        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?
+      (!@account.nil?) && (@account != [])
+    end
+
+    def has_description?(account_description)
+      return false if @account.nil?
+      @account["Description"] == account_description
+    end
+
+    def is_account_type?(account_type_name)
+      if !ACCOUNTTYPES.include? account_type_name
+        raise("'#{account_type_name}' is not a valid account type")
+      end
+      return false if @account.nil?
+
+      @account["AccountType"] == account_type_name
+    end
+
+    def is_azure_account?
+      return false if @account.nil?
+      @account["AccountType"] == AZURE
+      # should also have a subscription number, but Octopus manages validation on this
+    end
+
+    def is_aws_account?
+      return false if @account.nil?
+      @account["AccountType"] == AWS
+    end
+
+    def is_ssh_key_pair?
+      return false if @account.nil?
+      @account["AccountType"] == SSH
+    end
+
+    def is_username_password?
+      return false if @account.nil?
+      @account["AccountType"] == USERNAME
+    end
+
+    def is_token?
+      return false if @account.nil?
+      @account["AccountType"] == TOKEN
+    end
+
+    def in_environment?(environment_name)
+      return false if @account.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"]
+      !@account["EnvironmentIds"].select {|e| e == environment_id}.empty?
+    end
+
+    def has_tenanted_deployment_participation?(mode)
+      return false if @machine.nil?
+      @machine["TenantedDeploymentParticipation"] == mode # copied directly from tentacle
+    end
+
+    def has_property?(property_name, expected_value)
+      return false if @account.nil?
+      @account[property_name] == expected_value
+    end
+  end
+
+  def octopus_deploy_account(serverUrl, apiKey, account_name)
+    OctopusDeployAccount.new(serverUrl, apiKey, account_name)
+  end
+
+  private
+
+  def get_account_via_api(serverUrl, apiKey, account_name)
+    account = nil
+    url = "#{serverUrl}/api/#{@spaceFragment}accounts/all?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      account = body.select {|i| i['Name'] == account_name }.first unless body.nil?
+    rescue => e
+      raise "get_account_via_api: Unable to connect to #{url}: #{e}"
+    end
+
+    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
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/version.rb

@@ -1,3 +1,3 @@
 module OctopusServerSpecExtensions
-  VERSION = "0.15.4"
+  VERSION = "0.15.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopus-serverspec-extensions
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.15.5
 platform: ruby
 authors:
 - Matt Richardson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec
@@ -160,6 +160,7 @@ files:
 - lib/octopus_serverspec_extensions/type/chocolatey_package.rb
 - lib/octopus_serverspec_extensions/type/java_property_file.rb
 - lib/octopus_serverspec_extensions/type/npm_package.rb
+- lib/octopus_serverspec_extensions/type/octopus_deploy_account.rb
 - lib/octopus_serverspec_extensions/type/octopus_deploy_environment.rb
 - lib/octopus_serverspec_extensions/type/octopus_deploy_project_group.rb
 - lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb