SqlServerConfiguration: Added localization and improved verbose messages

[johlju]

Pull Request (PR) description

• Changes to SqlServerConfiguration
  • Now the verbose message say what option is changing and to what value (issue SqlServerConfiguration: Verbose messages are not descriptive #1014).
  • Changed the RestartTimeout parameter from type SInt32 to type UInt32.
  • Added localization (issue SqlServerConfiguration: Localization should change to align with HQRM modules #605).

This Pull Request (PR) fixes the following issues:
Fixes #1014
Fixes #605

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?

---

This change is 

[codecov-io]

Codecov Report

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

@@          Coverage Diff          @@
##            dev   #1021    +/-   ##
=====================================
+ Coverage    97%     97%   +<1%     
=====================================
  Files        32      32            
  Lines      3899    3916    +17     
=====================================
+ Hits       3812    3830    +18     
+ Misses       87      86     -1

[johlju]

Review status: 0 of 6 files reviewed at latest revision, 1 unresolved discussion, some commit checks failed.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.schema.mof, line 9 at r1 (raw file):

    [Required, Description("The desired value of the SQL configuration option.")] SInt32 OptionValue;
    [Write, Description("Determines whether the instance should be restarted after updating the configuration option.")] Boolean RestartService;
    [Write, Description("The length of time, in seconds, to wait for the service to restart. Default is 120 seconds.")] UInt32 RestartTimeout;

We should fix this in the README.md as well.

---

Comments from Reviewable

[johlju]

Reviewed 6 of 6 files at r1.
Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 161 at r1 (raw file):

    if ($option.IsDynamic -eq $true)
    {
        Write-Verbose -Message (

This message should be above the if-block. Here it should instead say that a restart was not necessary.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 201 at r1 (raw file):

    .PARAMETER RestartService
    *** Not used in this function ***

All descriptive text should be indented one step more. Throughout.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 262 at r1 (raw file):

    }

    ## return whether the value matches the desired state

Only one # for comments. Throughout.

---

Comments from Reviewable

[johlju]

Reviewed 1 of 2 files at r2.
Review status: 3 of 7 files reviewed at latest revision, 5 unresolved discussions.

---

CHANGELOG.md, line 91 at r3 (raw file):

  - Now the verbose message say what option is changing and to what value
    ([issue #1014](https://github.com/PowerShell/SqlServerDsc/issues/1014)).
  - Change the type of the parameter from SInt32 to UInt32.

Should say the RestartTimeout parameter?

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 161 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

This message should be above the if-block. Here it should instead say that a restart was not necessary.

Done.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 201 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

All descriptive text should be indented one step more. Throughout.

Done.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.psm1, line 262 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Only one # for comments. Throughout.

Done.

---

DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.schema.mof, line 9 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

We should fix this in the README.md as well.

Done.

---

Comments from Reviewable

[johlju]

Review status: 2 of 7 files reviewed at latest revision, 5 unresolved discussions.

---

CHANGELOG.md, line 91 at r3 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Should say the RestartTimeout parameter?

Done.

---

Comments from Reviewable

[johlju]

Reviewed 1 of 2 files at r2, 3 of 3 files at r3, 1 of 1 files at r4.
Review status: all files reviewed at latest revision, all discussions resolved.

---

Comments from Reviewable