mschuchard.general.goss_validate (1.0.1) — module

Install collection

Install with ansible-galaxy collection install mschuchard.general:==1.0.1

Add to requirements.yml

  collections:
    - name: mschuchard.general
      version: 1.0.1

Description

Validate a system with a gossfile or gossfiles.

Requirements

• goss >= 0.3.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# validate a system with a gossfile at /path/to/my_gossfile.yaml
- name: Validate a system with a gossfile at /path/to/my_gossfile.yaml
  mschuchard.general.goss_validate:
    gossfile: /path/to/my_gossfile.yaml

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# validate a system with a default location gossfile, a var file at /path/to/vars.yaml, and a json format output
- name: Validate a system with a default location gossfile, a var file at /path/to/vars.yaml, and a pretty json format output
  mschuchard.general.goss_validate:
    format: json
    format_opts: pretty
    vars: /path/to/vars.yaml

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# validate a system with retry timeout at fifteen seconds, and a delay between retries at thirty seconds
- name: Validate a system with retry timeout at thirty seconds, and a delay between retries at fifteen seconds
  mschuchard.general.goss_validate:
    retry_timeout: 30s
    sleep: 15s

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# validate a system with a default location gossfile and its corresponding golang template with inline variables and dpkg package
- name: Validate a system with a default location gossfile and its corresponding golang template with inline variables and dpkg package
  mschuchard.general.goss_validate:
    package: rpm
    vars_inline:
      my_service: httpd
      my_package: apache

Inputs

    
vars:
    description: Path to YAMl or JSON format file containing variables for template.
    required: false
    type: bool

sleep:
    default: 1s
    description: Time to sleep between retries, only active when -r is set.
    required: false
    type: str

format:
    default: rspecish
    description: Output format for validation report.
    required: false
    type: str

package:
    description: The package type to use.
    required: false
    type: str

gossfile:
    default: goss.yaml
    description: The specific gossfile used for validating the output.
    required: false
    type: str

max_concur:
    default: 50
    description: Max number of tests to run concurrently
    required: false
    type: int

format_opts:
    description: Extra options passed to the formatter. Valid options are perfdata, pretty,
      or verbose.
    required: false
    type: str

vars_inline:
    description: Variables for the template.
    required: false
    type: dict

retry_timeout:
    default: 0s
    description: Retry on failure so long as elapsed plus sleep time is less than this.
    required: false
    type: str

Outputs

command:
  description: The raw GoSS command executed by Ansible.
  returned: always
  type: str