Use common module DscResource.Common #453

johlju · 2020-05-02T17:18:30Z

Pull Request (PR) description

NetworkingDsc
- Updated to use the common module DscResource.Common.

This Pull Request (PR) fixes the following issues

None.

Task list

Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
Entry should say what was changed, and how that affects users (if applicable).
Resource documentation added/updated in README.md in resource folder.
Resource parameter descriptions added/updated in 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

johlju · 2020-05-02T19:18:43Z

@PlagueHO this one is ready for review now.

PlagueHO

Looking great @johlju ! Just some minor tweaks. I'll replicate into other repos when I have a change (have created issues to track).

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

Can you use the $modulePath variable defined above?

Also, is there a need to use a script scoped variable here?

Finally, you could just use the same code pattern as the line above:

Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'DscResource.Common'))

source/DSCResources/DSC_DnsClientGlobalSetting/DSC_DnsClientGlobalSetting.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_DnsConnectionSuffix/DSC_DnsConnectionSuffix.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_DnsServerAddress/DSC_DnsServerAddress.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_Firewall/DSC_Firewall.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_FirewallProfile/DSC_FirewallProfile.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_HostsFile/DSC_HostsFile.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_IPAddress/DSC_IPAddress.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_IPAddressOption/DSC_IPAddressOption.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterName/DSC_NetAdapterName.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterRdma/DSC_NetAdapterRdma.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterRsc/DSC_NetAdapterRsc.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterRss/DSC_NetAdapterRss.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetAdapterState/DSC_NetAdapterState.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetBios/DSC_NetBios.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetConnectionProfile/DSC_NetConnectionProfile.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetIPInterface/DSC_NetIPInterface.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetworkTeam/DSC_NetworkTeam.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_NetworkTeamInterface/DSC_NetworkTeamInterface.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_ProxySettings/DSC_ProxySettings.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_Route/DSC_Route.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_WaitForNetworkTeam/DSC_WaitForNetworkTeam.psm1, line 13 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_WinsServerAddress/DSC_WinsServerAddress.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

source/DSCResources/DSC_WinsSetting/DSC_WinsSetting.psm1, line 8 at r1 (raw file):

            -ChildPath 'NetworkingDsc.Common.psm1'))

$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

See previous comments.

johlju

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_DnsClientGlobalSetting/DSC_DnsClientGlobalSetting.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_DnsConnectionSuffix/DSC_DnsConnectionSuffix.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_DnsServerAddress/DSC_DnsServerAddress.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_Firewall/DSC_Firewall.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_FirewallProfile/DSC_FirewallProfile.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_HostsFile/DSC_HostsFile.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_IPAddress/DSC_IPAddress.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_IPAddressOption/DSC_IPAddressOption.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterName/DSC_NetAdapterName.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterRdma/DSC_NetAdapterRdma.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterRsc/DSC_NetAdapterRsc.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterRss/DSC_NetAdapterRss.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetAdapterState/DSC_NetAdapterState.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetBios/DSC_NetBios.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetConnectionProfile/DSC_NetConnectionProfile.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetIPInterface/DSC_NetIPInterface.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetworkTeam/DSC_NetworkTeam.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_NetworkTeamInterface/DSC_NetworkTeamInterface.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_ProxySettings/DSC_ProxySettings.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_Route/DSC_Route.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_WaitForNetworkTeam/DSC_WaitForNetworkTeam.psm1, line 13 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_WinsServerAddress/DSC_WinsServerAddress.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

source/DSCResources/DSC_WinsSetting/DSC_WinsSetting.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Done.

PlagueHO

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1, line 8 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Sorry @johlju - I didn't check my example (just freehanded into comment). It should be:

Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')

This is causing the tests to fail. Sorry about that - my bad.

johlju

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1, line 8 at r1 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Not your fault 😄 I was sitting in front of the TV and just did a search and replace, and didn't even read the code, I just assumed it was correct. 😉 Then pushed and forgot to look at the status checks because was working with stuff in SqlServerDsc at the same time. 🙂

Hopefully it passes now. I will keep an eye on it.

PlagueHO

Just need to wait for the tests to pass. It looks like they failed because of a problem creating the loopback adapters on the agent.... a bit strange.

johlju added the needs review The pull request needs a code review. label May 2, 2020

johlju added 6 commits May 2, 2020 19:19

Remove code from NetworkingDsc.Common

943f25e

Fix formatting in RequiredModules.psd1

46f612f

Remove functions

580fb72

Update pipeline files

d79d103

Update module files

c78ac71

Update CHANGELOG.ms

a3c522a

johlju force-pushed the fix/use-dscresource-common branch from e10d450 to a3c522a Compare May 2, 2020 17:19

johlju added 2 commits May 2, 2020 19:22

Update common module

05c8ce1

Update localixed strings

8719632

johlju requested a review from PlagueHO May 2, 2020 17:43

johlju added 4 commits May 2, 2020 20:03

Update localized strings in unit tests

3c2d7e9

Update tests, remove Assert-IPAddress

b4e515c

Update exports

e778fe1

Remove exports

619bd9d

PlagueHO requested changes May 2, 2020

View reviewed changes

FIx review comments at r1

b68d8f6

johlju requested a review from PlagueHO May 3, 2020 09:22

johlju commented May 3, 2020

View reviewed changes

PlagueHO requested changes May 3, 2020

View reviewed changes

Update import

0253a65

johlju requested a review from PlagueHO May 4, 2020 05:16

johlju commented May 4, 2020

View reviewed changes

PlagueHO approved these changes May 4, 2020

View reviewed changes

PlagueHO merged commit e260d74 into dsccommunity:master May 4, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use common module DscResource.Common #453

Use common module DscResource.Common #453

johlju commented May 2, 2020 •

edited

johlju commented May 2, 2020

PlagueHO left a comment

johlju left a comment

PlagueHO left a comment

johlju left a comment

PlagueHO left a comment

Use common module DscResource.Common #453

Use common module DscResource.Common #453

Conversation

johlju commented May 2, 2020 • edited

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

Task list

johlju commented May 2, 2020

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 May 2, 2020 •

edited