ansible.builtin.win_pester (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Run Pester tests on Windows hosts.

Test files have to be available on the remote host.

Requirements

• Pester

Usage examples

Scanned by Steampunk Spotter

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

- name: Get facts
  setup:

Scanned by Steampunk Spotter

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

- name: Add Pester module
  action:
    module_name: "{{ 'win_psmodule' if ansible_powershell_version >= 5 else 'win_chocolatey' }}"
    name: Pester
    state: present

Scanned by Steampunk Spotter

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

- name: Run the pester test provided in the path parameter.
  win_pester:
    path: C:\Pester

Scanned by Steampunk Spotter

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

- name: Run the pester tests only for the tags specified.
  win_pester:
    path: C:\Pester\TestScript.tests
    tags: CI,UnitTests

Scanned by Steampunk Spotter

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

# Run pesters tests files that are present in the specified folder
# ensure that the pester module version available is greater or equal to the version parameter.
- name: Run the pester test present in a folder and check the Pester module version.
  win_pester:
    path: C:\Pester\test01.test.ps1
    version: 4.1.0

Scanned by Steampunk Spotter

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

- name: Run the pester test present in a folder with given script parameters.
  win_pester:
    path: C:\Pester\test04.test.ps1
    test_parameters:
      Process: lsass
      Service: bits

Inputs

    
path:
    description:
    - Path to a pester test file or a folder where tests can be found.
    - If the path is a folder, the module will consider all ps1 files as Pester tests.
    required: true
    type: str

tags:
    description:
    - Runs only tests in Describe blocks with specified Tags values.
    - Accepts multiple comma separated tags.
    type: list
    version_added: '2.9'
    version_added_collection: ansible.builtin

version:
    description:
    - Minimum version of the pester module that has to be available on the remote host.

test_parameters:
    description:
    - Allows to specify parameters to the test script.
    type: dict
    version_added: '2.9'
    version_added_collection: ansible.builtin

Outputs

output:
  description: Results of the Pester tests.
  returned: success
  sample: false
  type: list
pester_version:
  description: Version of the pester module found on the remote host.
  returned: always
  sample: 4.3.1
  type: str