Added module win_pester and relatives integration tests #37343

equelin · 2018-03-13T11:10:10Z

SUMMARY

Run Pester tests with Ansible on Windows hosts.

You may integrate this module in your Ansible workflow to check if the configuration of your Windows host is correct after running your playbook.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

win_pester

ANSIBLE VERSION

2.5

ADDITIONAL INFORMATION

Options

parameter	required	default	choices	comments
src	true			(string) Specifies the source path of the test files on the remote host. Could be files or folder. If a folder, the module will try to run Pester tests with all ps1 files available in it.
version	false			(string) Specifies the minimum version of the Pester module that has to be available on the remote host.

Examples

- name: Run Pester test(s) in the file C:\Pester\test01.test.ps1
  win_pester:
    src: C:\Pester\test01.test.ps1

- name: Run Pester test(s) located in the 'C:\Pester' folder and defining the minimum version of the pester module
  win_pester:
    src: C:\Pester
    version: '3.4.0'

Return Values

name	description	returned	type	sample
pester_result	Data returned by the Pester module	success
pester_version	Version of the Pester module find on the remote host		string	'4.1.0'

Playbook

This playbook will copy the Pester tests files on the remote hosts, run the tests and verified if a test failed. The tests files are deleted at the end.

- name: Test out win_pester module
  hosts: windows
  vars:
    local_test_files:
      - "files/test01.test.ps1"
      - "files/test02.test.ps1"
    remote_test_folder: C:\Pester\

  tasks:
    - name : Copy test file(s)
      win_copy:
        src: "{{ item }}"
        dest: "{{ remote_test_folder }}"
      with_items: "{{local_test_files}}"

    - name: Run Pester test(s) located in a folder and defining the minimum version of the pester module
      win_pester:
        src: "{{ remote_test_folder }}"
        version: '3.4.0'
      register: result

    - name: Check if one of the Pester tests failed
      assert:
        that: result.pester_result.FailedCount == 0

    - name: Delete test folder
      win_file:
        path: "{{ remote_test_folder }}"
        state: absent

ansibot · 2018-03-13T11:38:33Z

cc @dagwieers @jborean93 @jhawkesworth @nitzmahone
click here for bot help

jhawkesworth · 2018-03-14T08:05:28Z

lib/ansible/modules/windows/win_pester.ps1

+    If (Get-Module -Name $Module -ListAvailable -ErrorAction SilentlyContinue) {
+        Import-Module $Module
+    } else {
+        Fail-Json -obj $result -message "Cannot find module: $Module"


Just a little thing, but it would be nice to prompt the user to check if pester is installed and suggest they install it via win_psmodule or win_chocolatey as appropriate.

What's the best way to prompt informations to users ?

Sorry I could have been clearer. I just mean it would be nice to add more information to the -message string to suggest to the user how they could fix the problem where the pester module cannot be loaded by Get-Module. Something like
Fail-Json -obj $result -message "Cannot find module: $Module. Check if pester is installed, and if it is not, install using win_psmodule or win_chocolatey."

Thanks @jhawkesworth I've modified the code with your recommendations .

jhawkesworth · 2018-03-14T08:07:32Z

test/integration/targets/win_pester/tasks/main.yml

+- name: Get facts
+  setup:
+
+- name: Add Pester module


I would consider adding these steps to the examples so users can know how to ensure they have pre-requisites for running the module.

Sure thing !

jhawkesworth · 2018-03-14T08:14:06Z

I think this would be a nice module to have.

I see that the module documentation isn't passing the sanity checks currently.

A quick way to check that the module documentation at least parses is to run 'ansible-doc win_pester'. You can of course run the same sanity tests like this from root of ansible source code.

test/runner/ansible-test sanity --test validate-modules win_pester

Hope this helps and that we can eventually get this module included into Ansible

By the way, do you have any links you would recommend for getting started with pester - its not something I have made any use of?

equelin · 2018-03-15T21:28:17Z

Hello @jhawkesworth,

Thanks for the feedback ! I'll try to implement your comments as soon as possible.

You'll find a lot of documentations about Pester directly on the Pester GitHub wiki. I'm quiet sure you'll find something useful ;-)

dagwieers · 2018-03-16T15:23:20Z

I think we can remove the [WIP] in the title ;-)

dagwieers · 2018-03-16T15:24:22Z

lib/ansible/modules/windows/win_pester.ps1

+}
+
+# Run Pester tests
+If (Test-Path -Path $path -PathType Leaf) {


So I would be expecting -LiteralPath everywhere unless this is not needed.

@jborean93 You have a good perspective on this.

equelin · 2018-03-16T16:13:39Z

Thanks for your help @dagwieers. I'm learning a lot ;-)

dagwieers · 2018-03-16T18:33:51Z

lib/ansible/modules/windows/win_pester.py

+  - Run Pester tests on Windows hosts.
+  - Test files have to be available on the remote host.
+requirements:
+  - The Pester module should be present on the remote host.


You only need to list the component name (and optionally minimum version). The documentation will generate the supporting text.

ansibot · 2018-03-17T00:26:31Z

@LiranNis @SamLiu79 @timothyvandenbrande @andrewsaraceni @ar7z1 @blakfeld @brianlloyd @chrishoffman @daBONDi @elventear @henrikwallstrom @if-meaton @joshludwig @marqelme @nwchandler @nwsparks @petemounce @ptemplier @rndmh3ro @schwartzmx @smadam813 @themiwi @tksarah

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

jhawkesworth · 2018-04-06T07:18:24Z

Looks good to me

shipit

jhawkesworth · 2018-04-06T07:20:48Z

bot_status

ansibot · 2018-04-06T07:23:21Z

Components

lib/ansible/modules/windows/win_pester.ps1
support: community
maintainers: dagwieers jborean93 jhawkesworth nitzmahone

lib/ansible/modules/windows/win_pester.py
support: community
maintainers: dagwieers jborean93 jhawkesworth nitzmahone

test/integration/targets/win_pester/aliases
support: community
maintainers:

test/integration/targets/win_pester/defaults/main.yml
support: community
maintainers:

test/integration/targets/win_pester/files/test01.test.ps1
support: community
maintainers:

test/integration/targets/win_pester/files/test02.test.ps1
support: community
maintainers:

test/integration/targets/win_pester/tasks/main.yml
support: community
maintainers:

Metadata

waiting_on: maintainer
changes_requested_by: null
needs_info: False
needs_revision: False
needs_rebase: False
merge_commits: []
mergeable_state: clean
shippable_status: success
maintainer_shipits (module maintainers): 0
community_shipits (namespace maintainers): 0
ansible_shipits (core team members): 1
shipit_actors (maintainers or core team members): jhawkesworth
shipit_actors_other: []
automerge: automerge shipit test failed

click here for bot help

jhawkesworth · 2018-04-06T10:45:32Z

bot doesn't automerge new modules apparently.
since this has been discussed at Windows Working Group and there were no objections, and the code looks good to me, I'm merging this.

* Added module win_pester and relatives integration tests * Corrected issues as stated by ansible-test * Added defaults variable in integration tests * Added task to install Pester if needed in the integration test * Corrected error in win_psmodule task * Added Pester installation with Chocolatey when Powershell version < 5 * Get facts... * Disabled invoke-pester output * Added pester_result type * Added jhawkesworth changes proposal * Corrected documentation linting * Corrected linting * Added dagwieers recommendations * Added dagwieers recommendations * Corrected linting errors and task error in integration test * Corrected error in integration test * Added dagwieers recommendations * Corrected requirements in the DOCUMENTATION block

Added module win_pester and relatives integration tests

6a8b1bc

equelin added 3 commits March 13, 2018 13:11

Corrected issues as stated by ansible-test

1450eb4

Added defaults variable in integration tests

cf4531c

Added task to install Pester if needed in the integration test

5f338d8

ryansb removed the needs_triage Needs a first human triage before being processed. label Mar 13, 2018

equelin added 3 commits March 13, 2018 21:25

Corrected error in win_psmodule task

ee174fb

Added Pester installation with Chocolatey when Powershell version < 5

ff8e240

Get facts...

8dd0af7

jhawkesworth reviewed Mar 14, 2018

View reviewed changes

equelin changed the title ~~Added module win_pester and relatives integration tests~~ [WIP] Added module win_pester and relatives integration tests Mar 15, 2018

ansibot added the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Mar 15, 2018

Disabled invoke-pester output

105635c

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Mar 15, 2018

Added pester_result type

f563452

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Mar 15, 2018

Added dagwieers recommendations

24c5181

dagwieers approved these changes Mar 16, 2018

View reviewed changes

equelin added 2 commits March 16, 2018 15:31

Corrected linting errors and task error in integration test

bd75438

Corrected error in integration test

4cf0ff3

dagwieers suggested changes Mar 16, 2018

View reviewed changes

Added dagwieers recommendations

dac24ed

equelin changed the title ~~[WIP] Added module win_pester and relatives integration tests~~ Added module win_pester and relatives integration tests Mar 16, 2018

ansibot removed the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Mar 16, 2018

dagwieers suggested changes Mar 16, 2018

View reviewed changes

Corrected requirements in the DOCUMENTATION block

aa677ba

dagwieers approved these changes Mar 17, 2018

View reviewed changes

ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 17, 2018

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Mar 25, 2018

ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Apr 6, 2018

jhawkesworth merged commit 49aac5f into ansible:devel Apr 6, 2018

ansible locked and limited conversation to collaborators Apr 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added module win_pester and relatives integration tests #37343

Added module win_pester and relatives integration tests #37343

equelin commented Mar 13, 2018

ansibot commented Mar 13, 2018

jhawkesworth Mar 14, 2018

equelin Mar 15, 2018

jhawkesworth Mar 16, 2018

equelin Mar 16, 2018

jhawkesworth Mar 14, 2018

equelin Mar 15, 2018

equelin Mar 16, 2018

jhawkesworth commented Mar 14, 2018

equelin commented Mar 15, 2018

dagwieers commented Mar 16, 2018

dagwieers Mar 16, 2018

equelin commented Mar 16, 2018

dagwieers Mar 16, 2018

ansibot commented Mar 17, 2018

jhawkesworth commented Apr 6, 2018

jhawkesworth commented Apr 6, 2018

ansibot commented Apr 6, 2018

jhawkesworth commented Apr 6, 2018

Added module win_pester and relatives integration tests #37343

Added module win_pester and relatives integration tests #37343

Conversation

equelin commented Mar 13, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

Options

Examples

Return Values

Playbook

ansibot commented Mar 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhawkesworth commented Mar 14, 2018

equelin commented Mar 15, 2018

dagwieers commented Mar 16, 2018

Choose a reason for hiding this comment

equelin commented Mar 16, 2018

Choose a reason for hiding this comment

ansibot commented Mar 17, 2018

jhawkesworth commented Apr 6, 2018

jhawkesworth commented Apr 6, 2018

ansibot commented Apr 6, 2018

Components

Metadata

jhawkesworth commented Apr 6, 2018