xActiveDirectory: Cleanup code #326

johlju · 2019-06-07T07:53:40Z

Pull Request (PR) description

Changes to xActiveDirectory
- Cleanup of code
  - Removed semicolon throughout where it is not needed.
  - Migrate tests to Pester syntax v4.x (issue #322).
Changes to xADRecycleBin
- Code cleanup.
- It now set back the $ErrorActionPreference that was set prior to
  setting it to 'Stop'.
Changes to xADDomainDefaultPasswordPolicy
- Code cleanup.
Changes to xADDomainTrust
- Code cleanup.
Changes to xADForestProperties
- Minor style cleanup.
Changes to xADOrganizationalUnit
- Code cleanup.
Changes to xADReplicationSiteLink
- Code cleanup.
Changes to xADReplicationSubnet
- Code cleanup.
Changes to xADKDSKey
- Code cleanup.
Changes to xADManagedServiceAccount
- Code cleanup.
Changes to xADServicePrincipalName
- Code cleanup.
Changes to xWaitForADDomain
- Code cleanup.
Changes to xADDomainController
- Code cleanup.
Changes to xADObjectPermissionEntry
- Code cleanup.

This Pull Request (PR) fixes the following issues

Partially ActiveDirectoryDsc: Convert the module to HQRM standards #172

Task list

Added an entry under the Unreleased section in the CHANGELOG.md.
Entry should say what was changed, and how that affects users (if applicable).
Resource documentation added/updated in README.md.
Resource parameter descriptions added/updated in README.md, schema.mof
and comment-based help.
Comment-based help added/updated.
Localization strings added/updated in all localization files as appropriate.
Examples appropriately added/updated.
Unit tests added/updated. See DSC Resource Testing Guidelines.
Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

This change is

codecov-io · 2019-06-07T08:03:16Z

Codecov Report

Merging #326 into dev will increase coverage by <1%.
The diff coverage is 88%.

@@         Coverage Diff          @@
##            dev   #326    +/-   ##
====================================
+ Coverage    91%    92%   +<1%     
====================================
  Files        20     20            
  Lines      2383   2511   +128     
  Branches     10     10            
====================================
+ Hits       2190   2312   +122     
- Misses      183    189     +6     
  Partials     10     10

johlju · 2019-06-07T11:59:42Z

@PlagueHO When you have an hour left over, would you mind reviewing this? 😉 It should not be to much to review I think, Please comment on additional this that need to be done if you see them, either I fix them or I will submit issue for that so other contributors can help. I already submitted a bunch of issues.

PlagueHO · 2019-06-15T10:33:20Z

On this now!

PlagueHO

Wonderful job @johlju - this code is looking so much better. Just some minor bits. I know there is other stuff to be done, but definitely leave for another PR.

Reviewed 33 of 33 files at r1.
Reviewable status: all files reviewed, 17 unresolved discussions (waiting on @johlju)

CHANGELOG.md, line 59 at r1 (raw file):

- Changes to xADObjectPermissionEntry
  - Change the description of the property IdentityReference.
  - Fix failure when applied in the same configuration as xADDomain

Nitpick - end with full stop. And the next line.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 121 at r1 (raw file):

            if ($isDomainMember)
            {
                ## We're already a domain member, so take the credentials out of the equation

Should be a single #

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 132 at r1 (raw file):

            }

            ## No need to check whether the node is actually a domain controller. If we don't throw an exception,

Should be comment block

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 175 at r1 (raw file):

            else
            {
                ## Not sure what's gone on here!

Should be a single #

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 253 at r1 (raw file):

    $isCompliant = $true

    ## The Get-Target resource returns .DomainName as the domain's FQDN. Therefore, we

Should be comment block.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 362 at r1 (raw file):

    # Debug can pause Install-ADDSForest/Install-ADDSDomain, so we remove it.
    [ref] $null = $PSBoundParameters.Remove('Debug')
    ## Not entirely necessary, but run Get-TargetResouece to ensure we raise any pre-flight errors.

Should be a single #

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 376 at r1 (raw file):

        $installADDSParams['CreateDnsDelegation'] = $true
    }
    if ($PSBoundParameters.ContainsKey('DatabasePath'))

Should be blank lines around these if blocks.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 413 at r1 (raw file):

        Write-Verbose -Message ($script:localizedData.CreatingForest -f $DomainName)
        $installADDSParams['DomainName'] = $DomainName
        if ($PSBoundParameters.ContainsKey('DomainNetbiosName'))

Should be blank lines around these if blocks.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 429 at r1 (raw file):

    'Finished' | Out-File -FilePath (Get-TrackingFilename -DomainName $DomainName) -Force

    # Signal to the LCM to reboot the node to compensate for the one we

Should be comment block.

DSCResources/MSFT_xADDomainTrust/MSFT_xADDomainTrust.psm1, line 269 at r1 (raw file):

        # Create the target object
        $trgDirectoryContext = New-Object System.DirectoryServices.ActiveDirectory.DirectoryContext($DomainOrForest, $TargetDomainName, $TargetDomainAdministratorCredential.UserName, $TargetDomainAdministratorCredential.GetNetworkCredential().Password)

This should be using named parameters

DSCResources/MSFT_xADDomainTrust/MSFT_xADDomainTrust.psm1, line 273 at r1 (raw file):

        # Create the source object
        $srcDirectoryContext = New-Object System.DirectoryServices.ActiveDirectory.DirectoryContext($DomainOrForest, $SourceDomainName)

This should be using named parameters

DSCResources/MSFT_xADKDSKey/MSFT_xADKDSKey.psm1, line 510 at r1 (raw file):

    [OutputType([System.String])]
    param
    (

param () is allowed here I think in our Styleguidelines: https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block

DSCResources/MSFT_xADManagedServiceAccount/MSFT_xADManagedServiceAccount.psm1, line 252 at r1 (raw file):

    $compareTargetResourceNonCompliant = Compare-TargetResourceState @PSBoundParameters |
        Where-Object { $_.Pass -eq $false }

Needs -FilterScript - and through out in all Where-Object blocks.

DSCResources/MSFT_xADManagedServiceAccount/MSFT_xADManagedServiceAccount.psm1, line 415 at r1 (raw file):

        if ($Ensure -eq 'Present')
        {
            $isEnsureNonCompliant = $false

Needs blank line after this one.

DSCResources/MSFT_xADObjectPermissionEntry/MSFT_xADObjectPermissionEntry.psm1, line 334 at r1 (raw file):

    {
        # Convert to array to a string for easy compare
        [String] $currentActiveDirectoryRights = ($currentState.ActiveDirectoryRights |

S/b [System.String] or [string]- and next line too.

DSCResources/MSFT_xADUser/MSFT_xADUser.psm1, line 1324 at r1 (raw file):

                    # Find the associated AD property
                    $adProperty = $adPropertyMap |
                        Where-Object { $_.Parameter -eq $parameter }

Should have -FilterScript

Tests/Unit/MSFT_xADGroup.Tests.ps1, line 104 at r1 (raw file):

            It 'Calls "Assert-Module" to check AD module is installed' {
                Mock -CommandName Get-ADGroup { return $fakeADGroup; }

Remove ; at end of lines in this file.

johlju

Ready for review again! 😄

Reviewable status: 13 of 34 files reviewed, 17 unresolved discussions (waiting on @PlagueHO)

CHANGELOG.md, line 59 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Nitpick - end with full stop. And the next line.

Done. Did a bunch.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 121 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be a single #

Done. Throughout the repo.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 132 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be comment block

Done. Throughout the repo.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 175 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be a single #

Done.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 253 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be comment block.

Done.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 362 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be a single #

Done.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 376 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be blank lines around these if blocks.

Done.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 413 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be blank lines around these if blocks.

Done.

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 429 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be comment block.

Done.

DSCResources/MSFT_xADDomainTrust/MSFT_xADDomainTrust.psm1, line 269 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

This should be using named parameters

Done. Throughout the repo.

DSCResources/MSFT_xADDomainTrust/MSFT_xADDomainTrust.psm1, line 273 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

This should be using named parameters

Done.

DSCResources/MSFT_xADKDSKey/MSFT_xADKDSKey.psm1, line 510 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

param () is allowed here I think in our Styleguidelines: https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block

Done. Missed that, thanks!

DSCResources/MSFT_xADManagedServiceAccount/MSFT_xADManagedServiceAccount.psm1, line 252 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Needs -FilterScript - and through out in all Where-Object blocks.

Done. Throughout the repo.

DSCResources/MSFT_xADManagedServiceAccount/MSFT_xADManagedServiceAccount.psm1, line 415 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Needs blank line after this one.

Done.

DSCResources/MSFT_xADObjectPermissionEntry/MSFT_xADObjectPermissionEntry.psm1, line 334 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

S/b [System.String] or [string]- and next line too.

Done. I submitted an issue to track this. I didn't fix this on purpose, I thought the PR was large enough. 😄

DSCResources/MSFT_xADUser/MSFT_xADUser.psm1, line 1324 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should have -FilterScript

Done.

Tests/Unit/MSFT_xADGroup.Tests.ps1, line 104 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Remove ; at end of lines in this file.

Done. Strange that I missed this file. :/

PlagueHO

Doh! Just two minor tweaks left. Great job though @johlju.

Reviewed 21 of 21 files at r2, 1 of 1 files at r3.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @johlju)

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 126 at r2 (raw file):

                $forest = Get-ADForest -Identity $domain.Forest -ErrorAction Stop
            }
            else {

Doh! Missed this one - { needs to be on the next line.

DSCResources/MSFT_xADUser/MSFT_xADUser.psm1, line 152 at r2 (raw file):

    }
    @{

I don't think this blank line should be here.

johlju

Ready for review for a last time ( I hope) 😄

Reviewable status: 32 of 34 files reviewed, 2 unresolved discussions (waiting on @PlagueHO)

DSCResources/MSFT_xADDomain/MSFT_xADDomain.psm1, line 126 at r2 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Doh! Missed this one - { needs to be on the next line.

Done. I missed that too when I went through all code :)

DSCResources/MSFT_xADUser/MSFT_xADUser.psm1, line 152 at r2 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

I don't think this blank line should be here.

Done. Ah, my bad :)

- Cleanup of code - It now set back the `$ErrorActionPreference` that was set prior to setting it to `'Stop'`.

- Cleanup of code.

- Minor style cleanup.

- Code cleanup.

PlagueHO

Reviewable status: 30 of 34 files reviewed, all discussions resolved (waiting on @PlagueHO)

johlju · 2019-06-16T09:09:39Z

Thanks for the review @PlagueHO, much appreciated! I will merge this as soon as the tests pass. Added some entries to the change log that I saw that I missed when changing code during the review. No need to review that.

johlju changed the title ~~xActiveDirectory: Removed semicolon throughout where it is not needed~~ xActiveDirectory: Removed semicolon Jun 7, 2019

johlju changed the title ~~xActiveDirectory: Removed semicolon~~ xActiveDirectory: Cleanup code Jun 7, 2019

johlju added the waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. label Jun 7, 2019

johlju added needs review The pull request needs a code review. and removed waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. labels Jun 7, 2019

johlju force-pushed the cleanup-semicolon branch from 1fa1e4a to ce52ca7 Compare June 8, 2019 19:17

johlju force-pushed the cleanup-semicolon branch from ce52ca7 to 4e505bc Compare June 13, 2019 16:46

PlagueHO reviewed Jun 15, 2019

View reviewed changes

johlju force-pushed the cleanup-semicolon branch 2 times, most recently from af32e42 to f9ccbb0 Compare June 15, 2019 12:28

johlju commented Jun 15, 2019

View reviewed changes

PlagueHO reviewed Jun 15, 2019

View reviewed changes

johlju commented Jun 15, 2019

View reviewed changes

johlju added 13 commits June 15, 2019 15:12

Remove semicolon from rows

c165632

Update CHANGELOG.md

7d2ed6b

Migrate tests to Pester syntax v4.x (issue dsccommunity#322)

8aff5a7

Removed -MockWith {} in unit tests.

d4b25a0

Changes to xADRecycleBin

93fb0d2

- Cleanup of code - It now set back the `$ErrorActionPreference` that was set prior to setting it to `'Stop'`.

Changes to xADRecycleBin

6b76655

- Cleanup of code.

Changes to xADDomainDefaultPasswordPolicy

75d0b93

- Cleanup of code.

Changes to xADDomainTrust

5a0df70

- Cleanup of code.

Changes to xADForestProperties

0530c55

- Minor style cleanup.

Changes to xADGroup

9e9bcac

- Minor style cleanup.

Changes to xADOrganizationalUnit

8560659

- Code cleanup.

Changes to xADUser

a4d033a

- Code cleanup.

Changes to xWaitForADDomain

028f8ac

- Code cleanup.

johlju added 14 commits June 15, 2019 15:15

Add VSCode code formatting

334ce72

Add verbose in xADRecycleBin

f63b18e

Fix typo in xADObjectPermissionEntry.Tests

d6ea286

Typ in xWaitForADDomain.Tests

09e41f1

Fix CHANGELOG.md after rebase

e3646a8

Fix full stop

1c01c35

Fix comment that did not match style guideline

c0f0fe4

Fix if-blocks

b968759

Fix named parameters on New-Object

d06e883

Fix named parameters on Where-Object

22b6b62

Remove semi-colon from missed file

08c7704

Fixed missed comment block

0b984f6

Remove BOM from file

b1b6147

Fix review comments at r3

b638593

johlju force-pushed the cleanup-semicolon branch from aabb55e to b638593 Compare June 15, 2019 13:16

Fix Pester syntax in recent merges

006e836

PlagueHO reviewed Jun 15, 2019

View reviewed changes

Update CHANGELOG.md

acc3c78

johlju added ready for merge The pull request was approved by the community and is ready to be merged by a maintainer. and removed needs review The pull request needs a code review. labels Jun 16, 2019

johlju merged commit 82d6076 into dsccommunity:dev Jun 16, 2019

johlju deleted the cleanup-semicolon branch June 16, 2019 09:36

johlju removed the ready for merge The pull request was approved by the community and is ready to be merged by a maintainer. label Jun 16, 2019

johlju mentioned this pull request Jun 16, 2019

xActiveDirectory: Migrate Pester test syntax from v3 -> v4 #322

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

xActiveDirectory: Cleanup code #326

xActiveDirectory: Cleanup code #326

johlju commented Jun 7, 2019 •

edited

Loading

codecov-io commented Jun 7, 2019 •

edited

Loading

johlju commented Jun 7, 2019

PlagueHO commented Jun 15, 2019

PlagueHO left a comment

johlju left a comment

PlagueHO left a comment

johlju left a comment

PlagueHO left a comment

johlju commented Jun 16, 2019

xActiveDirectory: Cleanup code #326

xActiveDirectory: Cleanup code #326

Conversation

johlju commented Jun 7, 2019 • edited Loading

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

Task list

codecov-io commented Jun 7, 2019 • edited Loading

Codecov Report

johlju commented Jun 7, 2019

PlagueHO commented Jun 15, 2019

PlagueHO left a comment

Choose a reason for hiding this comment

johlju left a comment

Choose a reason for hiding this comment

PlagueHO left a comment

Choose a reason for hiding this comment

johlju left a comment

Choose a reason for hiding this comment

PlagueHO left a comment

Choose a reason for hiding this comment

johlju commented Jun 16, 2019

johlju commented Jun 7, 2019 •

edited

Loading

codecov-io commented Jun 7, 2019 •

edited

Loading