octopus-serverspec-extensions 0.18.1 → 0.19.0

data/docs/octopus_deploy_worker.md

@@ -1,39 +1,39 @@
-# octopus_deploy_worker
-
-Describes the state of an [Octopus Deploy Worker](https://octopus.com/docs/infrastructure/workers) Agent resource
-
-A worker is essentially a specialised version of the [Tentacle Agent](octopus_deploy_tentacle.md) resource, so this Type has much in common.
-
-## Example
-
-```ruby
-describe octopus_worker('WorkerInstance').in_space('TeamBlue') do
-  it { should exist }
-  it { should be_online }
-  it { should be_listening_worker }
-  it { should have_display_name('Blue Team worker') }
-end
-```
-
-
-#### Type
-
-```ruby
-octopus_deploy_worker([url, api_key], instance_name)
-octopus_worker([url, api_key], instance_name)
-octopus_deploy_worker([url, api_key], instance_name).in_space(space_name)
-
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should exist | Tests if tentacle.exe is present locally |
-| should be_registered_with_the_server | Checks if this worker instance is present in the target server |
-| should be_online | Tests if the worker has a status of 'online'. If the machine is in a healthcheck, waits until healthcheck completes |
-| should be_in_space(space_name) | Tests if a worker appears in a given space. _deprecated_. | 
-| should have_policy(policy_name) | Tests if a worker has a give policy applied |
-| should have_display_name |  Tests if a worker has a given display name |
-| should be_polling_worker | Tests if a worker is in the 'polling' or 'Active' mode |
+# octopus_deploy_worker
+
+Describes the state of an [Octopus Deploy Worker](https://octopus.com/docs/infrastructure/workers) Agent resource
+
+A worker is essentially a specialised version of the [Tentacle Agent](octopus_deploy_tentacle.md) resource, so this Type has much in common.
+
+## Example
+
+```ruby
+describe octopus_worker('WorkerInstance').in_space('TeamBlue') do
+  it { should exist }
+  it { should be_online }
+  it { should be_listening_worker }
+  it { should have_display_name('Blue Team worker') }
+end
+```
+
+
+#### Type
+
+```ruby
+octopus_deploy_worker([url, api_key], instance_name)
+octopus_worker([url, api_key], instance_name)
+octopus_deploy_worker([url, api_key], instance_name).in_space(space_name)
+
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests if tentacle.exe is present locally |
+| should be_registered_with_the_server | Checks if this worker instance is present in the target server |
+| should be_online | Tests if the worker has a status of 'online'. If the machine is in a healthcheck, waits until healthcheck completes |
+| should be_in_space(space_name) | Tests if a worker appears in a given space. _deprecated_. | 
+| should have_policy(policy_name) | Tests if a worker has a give policy applied |
+| should have_display_name |  Tests if a worker has a given display name |
+| should be_polling_worker | Tests if a worker is in the 'polling' or 'Active' mode |
 | should be_listening_worker |  Tests if a worker is in the 'listening' or 'Passive' mode |

data/docs/octopus_deploy_worker_pool.md

@@ -1,26 +1,26 @@
-# octopus_deploy_worker_pool
-
-Describes an Octopus Deploy [Worker Pool](https://octopus.com/docs/infrastructure/workers/worker-pools) resource.
-
-## Example
-
-```ruby
-describe octopus_deploy_worker_pool('My Worker Pool').in_space("My Space") do
-  it { should exist } 
-end
-```
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-#### Type
-
-```ruby
-octopus_deploy_worker_pool('My Worker Pool').in_space("My Space")
-octopus_worker_pool('Pool in Default Space')
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
+# octopus_deploy_worker_pool
+
+Describes an Octopus Deploy [Worker Pool](https://octopus.com/docs/infrastructure/workers/worker-pools) resource.
+
+## Example
+
+```ruby
+describe octopus_deploy_worker_pool('My Worker Pool').in_space("My Space") do
+  it { should exist } 
+end
+```
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+#### Type
+
+```ruby
+octopus_deploy_worker_pool('My Worker Pool').in_space("My Space")
+octopus_worker_pool('Pool in Default Space')
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
 | should exist | Tests for existence of a pool with this name |

data/lib/octopus_serverspec_extensions.rb

@@ -1,86 +1,86 @@
-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'
-require 'octopus_serverspec_extensions/matcher/have_version.rb'
-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
+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'
+require 'octopus_serverspec_extensions/matcher/have_version.rb'
+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

@@ -1,13 +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
+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/have_linux_line_endings.rb

@@ -1,13 +1,13 @@
-RSpec::Matchers.define :have_linux_line_endings do
-  match do |file|
-    !file.content.include?("\r\n")
-  end
-
-  failure_message do |file|
-    "Expected file '#{file.name}' to have linux line endings, but it didn't"
-  end
-
-  failure_message_when_negated do |file|
-    "Expected file '#{file.name}' to not have linux line endings, but it did"
-  end
-end
+RSpec::Matchers.define :have_linux_line_endings do
+  match do |file|
+    !file.content.include?("\r\n")
+  end
+
+  failure_message do |file|
+    "Expected file '#{file.name}' to have linux line endings, but it didn't"
+  end
+
+  failure_message_when_negated do |file|
+    "Expected file '#{file.name}' to not have linux line endings, but it did"
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/have_version.rb

@@ -1,36 +1,36 @@
-RSpec::Matchers.define :have_version do |version|
-  match do |file|
-    get_version(file) == version
-  end
-
-  failure_message do |file|
-    "Expected file '#{file.name}' to have version '#{version}' but it had version '#{get_version}' instead"
-  end
-
-  failure_message_when_negated do |file|
-    "Expected file '#{file.name}' to not have version '#{version}' but it did"
-  end
-
-  private
-  def get_version(file)
-    version_dll = Fiddle.dlopen('version.dll')
-
-    s=''
-    vsize = Fiddle::Function.new(version_dll['GetFileVersionInfoSize'],
-                [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VOIDP],
-                Fiddle::TYPE_LONG).call(file.name, s)
-
-    raise 'Unable to determine the version number' unless vsize > 0
-
-    result = ' '*vsize
-    Fiddle::Function.new(version_dll['GetFileVersionInfo'],
-                         [Fiddle::TYPE_VOIDP, Fiddle::TYPE_LONG,
-                          Fiddle::TYPE_LONG, Fiddle::TYPE_VOIDP],
-            Fiddle::TYPE_VOIDP).call(file.name, 0, vsize, result)
-
-    rstring = result.unpack('v*').map{|s| s.chr if s<256}*''
-    r = /FileVersion..(.*?)\000/.match(rstring)
-
-    r[1]
-  end
-end
+RSpec::Matchers.define :have_version do |version|
+  match do |file|
+    get_version(file) == version
+  end
+
+  failure_message do |file|
+    "Expected file '#{file.name}' to have version '#{version}' but it had version '#{get_version}' instead"
+  end
+
+  failure_message_when_negated do |file|
+    "Expected file '#{file.name}' to not have version '#{version}' but it did"
+  end
+
+  private
+  def get_version(file)
+    version_dll = Fiddle.dlopen('version.dll')
+
+    s=''
+    vsize = Fiddle::Function.new(version_dll['GetFileVersionInfoSize'],
+                [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VOIDP],
+                Fiddle::TYPE_LONG).call(file.name, s)
+
+    raise 'Unable to determine the version number' unless vsize > 0
+
+    result = ' '*vsize
+    Fiddle::Function.new(version_dll['GetFileVersionInfo'],
+                         [Fiddle::TYPE_VOIDP, Fiddle::TYPE_LONG,
+                          Fiddle::TYPE_LONG, Fiddle::TYPE_VOIDP],
+            Fiddle::TYPE_VOIDP).call(file.name, 0, vsize, result)
+
+    rstring = result.unpack('v*').map{|s| s.chr if s<256}*''
+    r = /FileVersion..(.*?)\000/.match(rstring)
+
+    r[1]
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/have_windows_line_endings.rb

@@ -1,13 +1,13 @@
-RSpec::Matchers.define :have_windows_line_endings do
-  match do |file|
-    file.content.include?("\r\n")
-  end
-
-  failure_message do |file|
-    "Expected file '#{file.name}' to have windows line endings, but it didn't"
-  end
-
-  failure_message_when_negated do |file|
-    "Expected file '#{file.name}' to not have windows line endings, but it did"
-  end
-end
+RSpec::Matchers.define :have_windows_line_endings do
+  match do |file|
+    file.content.include?("\r\n")
+  end
+
+  failure_message do |file|
+    "Expected file '#{file.name}' to have windows line endings, but it didn't"
+  end
+
+  failure_message_when_negated do |file|
+    "Expected file '#{file.name}' to not have windows line endings, but it did"
+  end
+end