Contents

# 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 |
 

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
octopus-serverspec-extensions-0.19.1	docs/octopus_deploy_environment.md
octopus-serverspec-extensions-0.19.0	docs/octopus_deploy_environment.md