octopus-serverspec-extensions 0.17.1 → 0.19.0

data/docs/octopus_deploy_project_group.md

@@ -1,31 +1,31 @@
-# octopus_deploy_project_group
-
-Describes an Octopus [Project Group](https://octopus.com/docs/deployment-process/projects#project-group) resource.
-
-## Example
-
-```ruby
-describe octopus_project_group('Important Projects') do
-  it { should have_description('These are my Very Important projects') }
-end
-```
-
-#### Type
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-Note: `*_projectgroup` (v.1.5.x) is deprecated in favour of `*_project_group`, but included for backwards compatibility
-
-```ruby
-octopus_deploy project_group(server_url, api_key, 'Example Group')   # url and apikey provided
-octopus_deploy_project_group('Example Group')                        # using env vars
-octopus_project_group(server_url, api_key, 'Example Group')          # shorthand
-octopus_project_group('Example Group')
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should exist | Tests for existence of a project group with the given name |
+# octopus_deploy_project_group
+
+Describes an Octopus [Project Group](https://octopus.com/docs/deployment-process/projects#project-group) resource.
+
+## Example
+
+```ruby
+describe octopus_project_group('Important Projects') do
+  it { should have_description('These are my Very Important projects') }
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+Note: `*_projectgroup` (v.1.5.x) is deprecated in favour of `*_project_group`, but included for backwards compatibility
+
+```ruby
+octopus_deploy project_group(server_url, api_key, 'Example Group')   # url and apikey provided
+octopus_deploy_project_group('Example Group')                        # using env vars
+octopus_project_group(server_url, api_key, 'Example Group')          # shorthand
+octopus_project_group('Example Group')
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests for existence of a project group with the given name |
 | should have_description(description) | Tests if the Project group has a given description | 

data/docs/octopus_deploy_smtp_config.md

@@ -1,39 +1,39 @@
-# octopus_deploy_smtp_config
-
-Tests the server-wide SMTP configuration. This can be found in the Octopus Portal under Configuration -> SMTP
-
-## Example
-
-```ruby
-describe octopus_deploy_smtp_config do
-  it { should be_configured }
-  it { should have_from_address('hello@example.com') }
-  it { should be_using_credentials('myusername') }
-  it { should_not be_using_credentials('myspecialusername') }
-  it { should be_on_port(25) }
-  it { should be_on_host('smtp.example.com')}
-  it { should be_using_ssl }
-end
-```
-
-#### Type
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-```ruby
-octopus_deploy_smtp_config(server_url, api_key)  # url and apikey provided
-octopus_deploy_smtp_config                       # using environment vars
-octopus_smtp_config(server_url, api_key)         # shorthand
-octopus_smtp_config
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should be_configured | Tests if the SMTP configuration has been set
-| should be_on_host(host) | Tests the "SMTP Host" field |
-| should be_on_port(port) | Tests the "SMTP Port" field |
-| should be_using_ssl | Tests the "Use SSL/TLS" field |
-| should have_from_address(address) | Tests the "From Address" field |
-| should be_using_credentials(username) | Tests the "Credentials" field (username only) |
+# octopus_deploy_smtp_config
+
+Tests the server-wide SMTP configuration. This can be found in the Octopus Portal under Configuration -> SMTP
+
+## Example
+
+```ruby
+describe octopus_deploy_smtp_config do
+  it { should be_configured }
+  it { should have_from_address('hello@example.com') }
+  it { should be_using_credentials('myusername') }
+  it { should_not be_using_credentials('myspecialusername') }
+  it { should be_on_port(25) }
+  it { should be_on_host('smtp.example.com')}
+  it { should be_using_ssl }
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+```ruby
+octopus_deploy_smtp_config(server_url, api_key)  # url and apikey provided
+octopus_deploy_smtp_config                       # using environment vars
+octopus_smtp_config(server_url, api_key)         # shorthand
+octopus_smtp_config
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should be_configured | Tests if the SMTP configuration has been set
+| should be_on_host(host) | Tests the "SMTP Host" field |
+| should be_on_port(port) | Tests the "SMTP Port" field |
+| should be_using_ssl | Tests the "Use SSL/TLS" field |
+| should have_from_address(address) | Tests the "From Address" field |
+| should be_using_credentials(username) | Tests the "Credentials" field (username only) |

data/docs/octopus_deploy_space.md

@@ -1,32 +1,32 @@
-# octopus_deploy_space
-
-Describes an Octopus Deploy [Space](https://octopus.com/docs/administration/spaces) resource.
-
-## Example
-
-```ruby
-describe octopus_deploy_space('Team Phoenix') do
-  it { should exist }
-  it { should have_running_task_queue }
-end
-```
-
-#### Type
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-```ruby
-octopus_deploy_space(server_url, api_key, space_name)  # url and apikey provided
-octopus_deploy_space(space_name)                       # using environment variables
-octopus_space(server_url, api_key, space_name)
-octopus_space(space_name)                              # shorthand
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| exist | test for existence of a given space |
-| be_default | Tests if this space is the default space |
-| have_running_task_queue | tests if the queue for this space is disabled |
-| have_description(description) | tests if the space has the specified description |
+# octopus_deploy_space
+
+Describes an Octopus Deploy [Space](https://octopus.com/docs/administration/spaces) resource.
+
+## Example
+
+```ruby
+describe octopus_deploy_space('Team Phoenix') do
+  it { should exist }
+  it { should have_running_task_queue }
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+```ruby
+octopus_deploy_space(server_url, api_key, space_name)  # url and apikey provided
+octopus_deploy_space(space_name)                       # using environment variables
+octopus_space(server_url, api_key, space_name)
+octopus_space(space_name)                              # shorthand
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| exist | test for existence of a given space |
+| be_default | Tests if this space is the default space |
+| have_running_task_queue | tests if the queue for this space is disabled |
+| have_description(description) | tests if the space has the specified description |

data/docs/octopus_deploy_team.md

@@ -1,26 +1,26 @@
-# octopus_deploy_team
-
-Describes an Octopus Deploy [Team](https://octopus.com/docs/administration/managing-users-and-teams) resource. 
-
-## Example
-
-```ruby
-describe octopus_team('Super Ninja Developer Squad') do
-  it { should exist }
-end
-
-```
-#### Type
-
-```ruby
-octopus_deploy_team([url, api_key], team_name)
-octopus_team([url, api_key], team_name)
-octopus_team([url, api_key], team_name).in_space(space_name)
-
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
+# octopus_deploy_team
+
+Describes an Octopus Deploy [Team](https://octopus.com/docs/administration/managing-users-and-teams) resource. 
+
+## Example
+
+```ruby
+describe octopus_team('Super Ninja Developer Squad') do
+  it { should exist }
+end
+
+```
+#### Type
+
+```ruby
+octopus_deploy_team([url, api_key], team_name)
+octopus_team([url, api_key], team_name)
+octopus_team([url, api_key], team_name).in_space(space_name)
+
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
 | should exist | Checks for existence of a team with the given name |

data/docs/octopus_deploy_tentacle.md

@@ -1,41 +1,41 @@
-# octopus_deploy_tentacle
-
-Describes an Octopus Deploy [Tentacle agent](https://octopus.com/docs/infrastructure/deployment-targets/windows-targets) resource.
-
-Must be run on the same machine as `tentacle.exe` at present. Cannot remotely test tentacles at the present time.
-
-## Example
-
-```ruby
-describe octopus_tentacle('MyTentacle') do
-  it { should be_polling_tentacle }
-  it { should have_policy('My tentacle policy')}
-end
-```
-
-#### Type
-
-```ruby
-octopus_deploy_tentacle([url, api_key], instance_name)
-octopus_tentacle([url, api_key], instance_name)
-octopus_tentacle([url, api_key], instance_name).in_space('Octopus')
-
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should exist | Tests if tentacle.exe is present locally |
-| should be_registered_with_the_server | Checks if this tentacle instance is present in the target server |
-| should be_online | Tests if the tentacle has a status of online. If the machine is in a healthcheck, waits until healthcheck completes |
-| should be_in_environment(env_name) | Tests if the tentacle is registered to a given [Environment](octopus_deploy_environment.md) |
-| should be_in_space(space_name) | Tests if a tentacle appears in a given space. _deprecated_. | 
-| should have_tenant(tenant_name) | Tests if a tentacle is registered to a given tenant |
-| should have_tenant_tag(tag_name) | Tests if a tentacle is registered to a given tenant tag |
-| should have_policy(policy_name) | Tests if a tentacle has a give policy applied |
-| should have_role(role_name) | Tests if a tentacle has a given role applied |
-| should have_display_name |  Tests if a tentacle has a given display name |
-| should have_tenanted_deployment_participation(mode) | Tests if a tentacle can take part in tenanted deployments |
-| should be_polling_tentacle | Tests if a tentacle is in the 'polling' or 'Active' mode |
+# octopus_deploy_tentacle
+
+Describes an Octopus Deploy [Tentacle agent](https://octopus.com/docs/infrastructure/deployment-targets/windows-targets) resource.
+
+Must be run on the same machine as `tentacle.exe` at present. Cannot remotely test tentacles at the present time.
+
+## Example
+
+```ruby
+describe octopus_tentacle('MyTentacle') do
+  it { should be_polling_tentacle }
+  it { should have_policy('My tentacle policy')}
+end
+```
+
+#### Type
+
+```ruby
+octopus_deploy_tentacle([url, api_key], instance_name)
+octopus_tentacle([url, api_key], instance_name)
+octopus_tentacle([url, api_key], instance_name).in_space('Octopus')
+
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests if tentacle.exe is present locally |
+| should be_registered_with_the_server | Checks if this tentacle instance is present in the target server |
+| should be_online | Tests if the tentacle has a status of online. If the machine is in a healthcheck, waits until healthcheck completes |
+| should be_in_environment(env_name) | Tests if the tentacle is registered to a given [Environment](octopus_deploy_environment.md) |
+| should be_in_space(space_name) | Tests if a tentacle appears in a given space. _deprecated_. | 
+| should have_tenant(tenant_name) | Tests if a tentacle is registered to a given tenant |
+| should have_tenant_tag(tag_name) | Tests if a tentacle is registered to a given tenant tag |
+| should have_policy(policy_name) | Tests if a tentacle has a give policy applied |
+| should have_role(role_name) | Tests if a tentacle has a given role applied |
+| should have_display_name |  Tests if a tentacle has a given display name |
+| should have_tenanted_deployment_participation(mode) | Tests if a tentacle can take part in tenanted deployments |
+| should be_polling_tentacle | Tests if a tentacle is in the 'polling' or 'Active' mode |
 | should be_listening_tentacle |  Tests if a tentacle is in the 'listening' or 'Passive' mode |

data/docs/octopus_deploy_upgrade_config.md

@@ -1,34 +1,34 @@
-# octopus_deploy_upgrade_config
-
-Tests the server-wide upgrade configuration. This can be found in the UI at Configuration->Settings->Updates & Usage Telemetry.
-
-## Example
-
-```ruby
-describe octopus_deploy_upgrade_config do
-  it { should include_statistics }
-  it { should never_show_notifications }  
-end
-```
-
-#### Type
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-```ruby
-octopus_deploy_upgrade_config(server_url, api_key)  # url and apikey provided
-octopus_deploy_upgrade_config                       # using environment vars
-octopus_upgrade_config(server_url, api_key)         # shorthand
-octopus_upgrade_config                              # shorthand, using env vars
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should have_notification_mode(mode) | Tests if the Notification mode is set to the given value. Possible values: ['AlwaysShow', 'ShowOnlyMajorMinor', 'NeverShow'] |
-| should never_show_notifications | equivalent to `should_have_notification_mode('NeverShow')` | 
-| should always_show_notifications | equivalent to `should_have_notification_mode('AlwaysShow')` | 
-| should show_major_minor_notifications | equivalent to `should_have_notification_mode('ShowOnlyMajorMinor')` |
-| should include_statistics | Tests if the IncludeStatistics setting is set to `true` |
+# octopus_deploy_upgrade_config
+
+Tests the server-wide upgrade configuration. This can be found in the UI at Configuration->Settings->Updates & Usage Telemetry.
+
+## Example
+
+```ruby
+describe octopus_deploy_upgrade_config do
+  it { should include_statistics }
+  it { should never_show_notifications }  
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+```ruby
+octopus_deploy_upgrade_config(server_url, api_key)  # url and apikey provided
+octopus_deploy_upgrade_config                       # using environment vars
+octopus_upgrade_config(server_url, api_key)         # shorthand
+octopus_upgrade_config                              # shorthand, using env vars
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should have_notification_mode(mode) | Tests if the Notification mode is set to the given value. Possible values: ['AlwaysShow', 'ShowOnlyMajorMinor', 'NeverShow'] |
+| should never_show_notifications | equivalent to `should_have_notification_mode('NeverShow')` | 
+| should always_show_notifications | equivalent to `should_have_notification_mode('AlwaysShow')` | 
+| should show_major_minor_notifications | equivalent to `should_have_notification_mode('ShowOnlyMajorMinor')` |
+| should include_statistics | Tests if the IncludeStatistics setting is set to `true` |
 | should allow_checking | Tests if the AllowChecking setting is set to `true` |  

data/docs/octopus_deploy_user.md

@@ -1,34 +1,34 @@
-# octopus_deploy_user
-
-Describes an Octopus Deploy [User](https://octopus.com/docs/administration/managing-users-and-teams#Managingusersandteams-UserandServiceaccounts) resource.
-
-## Example
-
-```ruby
-describe octopus_deploy_user('bobthedeveloper') do
-  it { should exist }
-  it { should be_active }
-end
-```
-
-#### Type
-
-This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
-
-```ruby
-octopus_deploy_user(url, api_key, user_name)  # url and apikey provided
-octopus_deploy_user(user_name)                # using environment vars
-octopus_user(url, api_key, user_name)         # shorthand
-octopus_user(user_name)
-```
-
-#### Matchers
-
-| Matcher | Description |
-|:--------|:------------|
-| should exist | Tests for existence of a User account with the given name |
-| should be_active | Tests if the User is enabled/has the 'Is Active' checkbox checked | 
-| should have_email(email) | Tests the email address associated with the User account |
-| should have_api_key(purpose) | Tests if the User has an API Key with the stated purpose field |
-| should have_display_name(name) | Tests the Display Name set for the User |
+# octopus_deploy_user
+
+Describes an Octopus Deploy [User](https://octopus.com/docs/administration/managing-users-and-teams#Managingusersandteams-UserandServiceaccounts) resource.
+
+## Example
+
+```ruby
+describe octopus_deploy_user('bobthedeveloper') do
+  it { should exist }
+  it { should be_active }
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
+
+```ruby
+octopus_deploy_user(url, api_key, user_name)  # url and apikey provided
+octopus_deploy_user(user_name)                # using environment vars
+octopus_user(url, api_key, user_name)         # shorthand
+octopus_user(user_name)
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests for existence of a User account with the given name |
+| should be_active | Tests if the User is enabled/has the 'Is Active' checkbox checked | 
+| should have_email(email) | Tests the email address associated with the User account |
+| should have_api_key(purpose) | Tests if the User has an API Key with the stated purpose field |
+| should have_display_name(name) | Tests the Display Name set for the User |
 | should be_service_account | Tests if the User is a service account |