octopus-serverspec-extensions 0.15.5 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260a7c2b8e6581eacd93f295117fa984b5e496dc51cb23c798d34c02c8411690
-  data.tar.gz: 348f4dfda4e0cf997e881e85c79fe10146982692d7af54aa5af8b354701fe755
+  metadata.gz: 282b996f710e8c9a9feef460d983835143603931ad3a8864955082f967487086
+  data.tar.gz: 992f37a34e67a35376d65800ba12887e90923ce3cc71f8723daed742b711c67d
 SHA512:
-  metadata.gz: 68c3951d2313d435d1f106028862489bdf3eef2dd65b1731ba01aa61e24387c750480fbca74713c5be5a25d66d10e2b176442890a7006b29340e68ad8e556314
-  data.tar.gz: 8997eca9173dce7dfc46e0ec63af78fe043b0d7d652279128c9233ca110b937ea4d2921b37fa5d0bae9e9cd35ec41e42c3a85c05b2b3963b7da4fff4888c2b1e
+  metadata.gz: ea1e0139abeabbc3bb370316647cd92a057679842027f00630e678e7ca9fd4d1417b0596249ddfab79be8ec58b84272a08591d9e5283a1338772a65c1f5e2f22
+  data.tar.gz: 7bb2a95785aa6c6a8f1498dabe731794196b1a334fe30dd6ca92dec1203017ae6242719ca72eb5f4ca5cde509135de982750ac37a99fc0e926e1c638cf373d88

data/docs/authentication.md

@@ -0,0 +1,45 @@
+# Authenticating to your Octopus Server
+
+There are two main ways of authenticating to your Octopus Server from your ServerSpec tests.
+
+#### 1. Using Automatic Environment Variables
+
+If you do not provide a URL and API key in your type call, the type will try to fall back to environment variables.
+
+This option is much cleaner to read, and helps to protect you from leaked credentials, but can be less explicit if you're testing against multiple Octopus Instances.
+
+| Variable              | Description                                                                             |
+|:----------------------|:----------------------------------------------------------------------------------------|
+| OCTOPUS_CLI_SERVER    | The http or https URL of your Octopus Deploy server: e.g. https://octopus.example.com/  |
+| OCTOPUS_CLI_API_KEY   | A valid API key, with rights to view the resources you're testing                       |
+
+The following example will attempt to use the Environment variables. If they are not present, it will raise an exception:
+
+```ruby
+describe octopus_deploy_account('myawsaccount').in_space('Octopus') do
+    it { should exist }
+end
+``` 
+
+#### 2. Provide creds with each type
+
+This method makes sense if you're testing multiple Octopus Servers in the same ruby script, and need a visual cue to which servers you're testing in a specific block.
+ 
+Simply provide the URL and API key of your Octopus server as the first two parameters in your type
+
+The following example will connect to a specific server using a specific API key:
+
+```ruby
+describe octopus_deploy_account('https://octopus.example.com/', 'API-1234ABCDE5678FGHI', 'myawsaccount').in_space('Octopus') do
+    it { should exist }
+end
+``` 
+
+#### 3. Using your own Environment Variables
+You can provide the types with a different environment variable by using Ruby's `ENV[]` hash. 
+
+```ruby
+describe octopus_deploy_smtp_config(ENV['MY_OCTOPUS_URL'], ENV['MY_OCTOPUS_API_KEY']) do
+  it { should be_configured }
+end
+```

data/docs/octopus_deploy_account.md

@@ -0,0 +1,37 @@
+# octopus_deploy_account
+
+Describes an [Octopus Infrastructure Account](https://octopus.com/docs/infrastructure/accounts).
+
+A number of properties of Accounts (such as passwords & secret keys) are [sensitive]() values, therefore we can't directly test them. 
+
+## Example
+
+```ruby
+
+describe octopus_deploy_account("myawsaccount").in_space("Octopus") do
+    it { should exist }
+    it { should be_aws_account }
+    it { should_not be_azure_account }
+    it { should have_description('My main AWS account') }
+end
+
+```
+
+#### Type
+
+```ruby
+octopus_deploy_account([server_url, api_key], account_name)
+octopus_account([server_url, api_key], account_name)
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests if an account of the name exists |
+| should be_aws_account | Amazon Web Services account |
+| should be_azure_account | Microsoft Azure account   |
+| should be_ssh_key_pair | SSH keypair |
+| should be_token | A token for use with services such as Kubernetes| 
+| should be_username_password | A username and password for use with services supporting user/pass |
+

data/docs/octopus_deploy_doc_template.md

@@ -0,0 +1,17 @@
+# octopus_deploy_user
+
+
+
+## Example
+
+
+#### Type
+
+```ruby
+
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|

data/docs/octopus_deploy_environment.md

@@ -0,0 +1,33 @@
+# octopus_deploy_environment
+
+Tests an Octopus Deploy [Environment](https://octopus.com/docs/infrastructure/environments) resource.
+
+## Example
+
+```ruby
+describe octopus_deploy_environment('Production').in_space('Team Octopus') do
+  it { should exist }
+end
+```
+
+#### Type
+
+This type can be instantiated in several ways, depending on [how you authenticate](authentication.md), and whether your target environment is in a [Space](https://octopus.com/blog/spaces-introduction).
+
+```ruby
+octopus_deploy_environment(url, api_key, environment_name)                 # url and apikey provided
+octopus_deploy_environment(environment_name)                               # using environment vars
+octopus_environment(environment_name).in_space(space_name)                 # using environment vars, in a [space](https://octopus.com/blog/spaces-introduction)
+octopus_environment(url, api_key, environment_name)
+octopus_environment(environment_name)
+octopus_environment(url, api_key, environment_name).in_space(space_name)
+```
+
+#### Matchers
+
+| Matcher | Description |
+|:--------|:------------|
+| should exist | Tests for the existence of a given Environment |
+| should use_guided_failure | Tests if the Environment has the Use Guided Failure default applied |
+| should allow_dynamic_infrastructure | Tests if the checkbox for [Allow Dynamic Infrastructure](https://octopus.com/docs/infrastructure/environments#enabling-dynamic-infrastructure) is checked |
+ 

data/docs/octopus_deploy_project_group.md

@@ -0,0 +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 |
+| should have_description(description) | Tests if the Project group has a given description | 

data/docs/octopus_deploy_smtp_config.md

@@ -0,0 +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) |

data/docs/octopus_deploy_space.md

@@ -0,0 +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 |

data/docs/octopus_deploy_team.md

@@ -0,0 +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 |
+|:--------|:------------|
+| should exist | Checks for existence of a team with the given name |

data/docs/octopus_deploy_tentacle.md

@@ -0,0 +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 |
+| should be_listening_tentacle |  Tests if a tentacle is in the 'listening' or 'Passive' mode |

data/docs/octopus_deploy_upgrade_config.md

@@ -0,0 +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` |
+| should allow_checking | Tests if the AllowChecking setting is set to `true` |  

data/docs/octopus_deploy_user.md

@@ -0,0 +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 |
+| should be_service_account | Tests if the User is a service account |

data/docs/octopus_deploy_worker.md

@@ -0,0 +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 |
+| should be_listening_worker |  Tests if a worker is in the 'listening' or 'Passive' mode |

data/docs/octopus_deploy_worker_pool.md

@@ -0,0 +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 |
+|:--------|:------------|
+| should exist | Tests for existence of a pool with this name |