SmbShare: Bugfix to enable change of the path when the share already exists.

[danielboth]

Pull Request (PR) description

This changes enables the SmbShare resource to change the path on an existing share. To ensure a user does this consciously, a parameter Force is added to the resource. Force needs to be true for the resource to drop and recreate the share on the new path.

If the user did not set Force to true, a warning will be displayed stating the resource cannot get into desired state without setting Force to true.

This Pull Request (PR) fixes the following issues

• Fixes SmbShare: If the Share exists but with the wrong Path, the resource does not update the path #215

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 the 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 

[codecov-io]

Codecov Report

Merging #286 into dev will increase coverage by <1%.
The diff coverage is 90%.

@@         Coverage Diff          @@
##            dev   #286    +/-   ##
====================================
+ Coverage    88%    88%   +<1%     
====================================
  Files        14     14            
  Lines      1469   1478     +9     
====================================
+ Hits       1294   1302     +8     
- Misses      175    176     +1

[danielboth]

Hi @PlagueHO, on another branch I have a fix for #284 (https://github.com/danielboth/ComputerManagementDsc/tree/SmbShare-ScopeName-support). That one builds on the features I've added in this branch, would you like to review those in one go, or that we first merge this one?

[PlagueHO]

Hi @danielboth - can you resolve the conflicts on this one?

My feeling is to complete this PR first (as it is a bug fix) and then we'll get the feature one through.

[danielboth]

Good, I got the same feeling (the reason I splitted them to start with), so let's get this one through first. Just resolved the merge conflict.

[PlagueHO]

Closing/Reopening to kick CI again.

[PlagueHO]

Reviewed 6 of 8 files at r1, 1 of 2 files at r2, 1 of 1 files at r3.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @danielboth)

---

DSCResources/MSFT_SmbShare/MSFT_SmbShare.schema.mof, line 18 at r3 (raw file):

    [Write, Description("Specifies which accounts is granted read permission to access the SMB share.")] String ReadAccess[];
    [Write, Description("Specifies if the SMB share should be added or removed."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
    [Write, Description("Specifies if the SMB share is allowed to be dropped and recreated.")] Boolean Force;

This text should match the value in the PSM1. Can you add the part in the parenthesis from the parenthesis?

---

Examples/Resources/SmbShare/4-SmbShare_RecreateShare_Config.ps1, line 3 at r3 (raw file):

<#PSScriptInfo
.VERSION 1.0.0
.GUID d0847694-6a83-4f5b-bf6f-30cb078033bc

Can you generate a new GUID? This one looks like it's already used by one of the other examples.

[danielboth]

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

---

DSCResources/MSFT_SmbShare/MSFT_SmbShare.schema.mof, line 18 at r3 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

This text should match the value in the PSM1. Can you add the part in the parenthesis from the parenthesis?

Done.

---

Examples/Resources/SmbShare/4-SmbShare_RecreateShare_Config.ps1, line 3 at r3 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Can you generate a new GUID? This one looks like it's already used by one of the other examples.

Is this GUID used? Can you explain why it's important for this one to be unique?

Anyway, updated now, just like to know the why.

[PlagueHO]

Reviewed 2 of 2 files at r4.
Reviewable status: complete! all files reviewed, all discussions resolved

---

Examples/Resources/SmbShare/4-SmbShare_RecreateShare_Config.ps1, line 3 at r3 (raw file):

Previously, danielboth (Daniël) wrote…

Is this GUID used? Can you explain why it's important for this one to be unique?

Anyway, updated now, just like to know the why.

The Guid represents the unique id of the script (not the filename as you might expect). The intent was that this was how PS Gallery would uniquely identify a script. Whether it does or not remains to be seen (it may just use the filename) - but it is still best to follow the intent of the field.

[PlagueHO]

Reviewable status: complete! all files reviewed, all discussions resolved