Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahelal/cf-inspec
inSpec resources for Cloudfoundry, Opsman and Bosh
https://github.com/ahelal/cf-inspec
bosh cloudfoundry inspec opsman opsmanager pcf testing
Last synced: about 1 month ago
JSON representation
inSpec resources for Cloudfoundry, Opsman and Bosh
- Host: GitHub
- URL: https://github.com/ahelal/cf-inspec
- Owner: ahelal
- License: bsd-3-clause
- Created: 2019-04-12T16:59:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T21:24:42.000Z (over 2 years ago)
- Last Synced: 2023-10-18T13:38:51.209Z (about 1 year ago)
- Topics: bosh, cloudfoundry, inspec, opsman, opsmanager, pcf, testing
- Language: Ruby
- Homepage:
- Size: 118 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/ahelal/cf-inspec)
# inSpec Cloudfoundry resources
This InSpec resource pack that provides the required resources to write tests for cloudfoundry.
## Prerequisites
You need [inSpec](https://www.inspec.io/downloads/) :)
## Usage
### Create a new profile
1. `$ inspec init profile my-profile`
```yaml
name: my-profile
title: test
version: 0.1.0
depends:
- name: cf-inspec
url: https://github.com/ahelal/cf-inspec/archive/master.tar.gz
```
2. Edit inspec.yml to reflect the depends
3. Define your tests in `your_profile/control`
### Configuration for Opsman resources
You need to export **required** opsman variables
* `OM_TARGET` with schema eg. `https://opsman.example.com`
* `OM_USERNAME`
* `OM_PASSWORD`
Optional variables
* `OM_SKIP_SSL_VALIDATION` defaults to `false`
### Available resources
List of [available resources](doc/opsman)
#### Examples
Check the [Opsman examples](test/examples/opsman/controls)
An example profile
```ruby
control 'opsman should be reachable and using desired version' do
describe bosh_info do
its('version') { should match(/2.3/) }
end
end
control 'Certificate should not expire in the next two months' do
describe om_certificates(2, 'm') do
its('expires') { should be_empty }
end
end
describe om_director_properties do
its(%w[director_configuration ntp_servers_string]) { should eq 'us.pool.ntp.org, time.google.com' }
its(%w[iaas_configuration tls_enabled]) { should eq true }
its(%w[syslog_configuration enabled]) { should eq true }
end
control 'PCF should be installed, and deigo_cell should be in desired the instance count and type' do
describe om_deployed_products do
its(%w[cf version]) { should match(/2.3.9/) }
end
describe om_resource_jobs do
its(%w[cf diego_cell instances]) { should be > 10 }
its(%w[cf diego_cell instance_type id]) { should eq 'm3.medium' }
end
end
```
### Running in Concourse
Add the following task to your pipeline and map the location of your tests to the `specs` input. if your test is located in a subdir you need to pass that too `SPECS_SUBDIR: PATH/../`
You should read the inspec EULA and if you agree flip the `EULA: true`
```yaml
---
resources:
- name: cf-inspec-tasks
type: git
source:
uri: https://github.com/ahelal/cf-inspec.git
branch: master
- name: source-code
type: git
source:
uri: https://github.com//
branch: master
jobs:
- name: run-inspec
plan:
- get: cf-inspec-tasks
- get: source-code
- task: run-inspec
file: cf-inspec-tasks/task/task.yml
input_mapping:
specs: source-code
params:
OM_TARGET: ((OM_TARGET))
OM_USERNAME: ((OM_USERNAME))
OM_PASSWORD: ((OM_PASSWORD))
SPECS_SUBDIR: test/examples/om
INSPEC_CACHE_TIME: 0
EULA: true
```
### API caching
If you have many tests API calls might be slow. You can enable caching to increase test speed.
* `INSPEC_CACHE_TIME` defaults to `0` seconds
* `INSPEC_CACHE_DIR` defaults to `~/.inspec_cache`