BREAKING CHANGE: xScheduledTask: Add support for disabling built-in tasks - Fixes #74

[PlagueHO]

Pull Request (PR) description

• xScheduledTask:
  • Add support to disable built-in scheduled tasks - See Issue #74.
  • Fix unit test mocked schedule task object structure.
• BREAKING CHANGE: xScheduledTask:
  • Breaking change because Get-TargetResource no longer outputs
    ActionExecutable and ScheduleType properties when the scheduled
    task does not exist. It will also include TaskPath in output when
    scheduled task does not exist.

This Pull Request (PR) fixes the following issues:

• Fixes xScheduleTask: Cannot disable already present tasks #74

Task list:

• Change details added to Unreleased section of CHANGELOG.md?
• Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate?
• Examples appropriately updated?
• New/changed code adheres to Style Guidelines?
• Unit and (optional) Integration tests created/updated where possible?

@johlju - as always would you be able to review for me? I cleaned up the unit tests hashtable layouts because I figured you'd pick up on the incorrect style 😁 - so sorry about the large number of style corrections in the unit tests file.

---

This change is 

[codecov-io]

Codecov Report

Merging #132 into dev will increase coverage by <1%.
The diff coverage is 100%.

@@         Coverage Diff         @@
##           dev   #132    +/-   ##
===================================
+ Coverage   88%    89%   +<1%     
===================================
  Files        5      5            
  Lines      630    638     +8     
===================================
+ Hits       560    568     +8     
  Misses      70     70

[johlju]

Reviewed 8 of 9 files at r1, 1 of 1 files at r2.
Review status: all files reviewed at latest revision, 6 unresolved discussions.

---

DSCResources/MSFT_xScheduledTask/MSFT_xScheduledTask.psm1, line 1627 at r2 (raw file):

    Write-Verbose -Message ($script:localizedData.TestingDscParameterStateMessage)

    return Test-DscParameterState -CurrentValues $currentValues -DesiredValues $desiredValues -Verbose

Should this always output verbose messages even when user has not asked for it?

---

Examples/xScheduledTask/11-DisableABuiltInTask.ps1, line 17 at r2 (raw file):

        [ValidateNotNullorEmpty()]
        [System.Management.Automation.PSCredential]
        $Credential

This parameter is not used.

---

Examples/xScheduledTask/12-DeleteABuiltInTask.ps1, line 17 at r2 (raw file):

        [ValidateNotNullorEmpty()]
        [System.Management.Automation.PSCredential]
        $Credential

This parameter is not used.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 40 at r2 (raw file):

        function Register-ScheduledTask
        {
            param (

Parenthesis on the next row.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 41 at r2 (raw file):

        {
            param (
                [switch]

Should have [Parameter()] on this too.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 154 at r2 (raw file):

                }

                Mock -CommandName Get-ScheduledTask { return @{

Should have -MockWith. Throughout.

---

Comments from Reviewable

[PlagueHO]

All done @johlju - plus I found a couple of other style issues in the Unit tests - so fixed those.

---

Review status: 5 of 9 files reviewed at latest revision, 6 unresolved discussions.

---

DSCResources/MSFT_xScheduledTask/MSFT_xScheduledTask.psm1, line 1627 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Should this always output verbose messages even when user has not asked for it?

Doh! Good catch - I enabled this while doing some debugging.

---

Examples/xScheduledTask/11-DisableABuiltInTask.ps1, line 17 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

This parameter is not used.

Done.

---

Examples/xScheduledTask/12-DeleteABuiltInTask.ps1, line 17 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

This parameter is not used.

Done.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 40 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Parenthesis on the next row.

Done.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 41 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Should have [Parameter()] on this too.

Done.

---

Tests/Unit/MSFT_xScheduledTask.Tests.ps1, line 154 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Should have -MockWith. Throughout.

Done.

---

Comments from Reviewable

[johlju]

---

Reviewed 4 of 4 files at r3.
Review status: all files reviewed at latest revision, all discussions resolved.

---

Comments from Reviewable