BREAKING CHANGE: SqlDatabasePermission: Refactored resource (class-based resource)

[johlju]

Pull Request (PR) description

• SqlServerDsc
  • Added a file prefix.ps1 which content is placed first in the built module (.psm1). This file imports dependent modules, and imports localized strings used by private and public commands.
  • The following classes were added to the module:
  • DatabasePermission - complex type for the DSC resource SqlDatabasePermission.
  • Ensure - Enum to be used for the property Ensure in class-based resources.
  • Reason - Used by method Get() to return the reason a property is not in desired state.
  • ResourceBase - class that can be inherited by class-based resource and provides functionality meant simplify the creating of class-based resource.
  • The following private functions were added to the module (see comment-based help for more information):
  • ConvertFrom-CompareResult
  • ConvertTo-Reason
  • Get-ClassName
  • Get-DscProperty
  • Get-LocalizedDataRecursive
  • Test-ResourceHasProperty
  • Test-ResourcePropertyIsAssigned
  • The following public functions were added to the module (see comment-based help for more information):
  • Connect-SqlDscDatabaseEngine
  • ConvertFrom-SqlDscDatabasePermission
  • ConvertTo-SqlDscDatabasePermission
  • Get-SqlDscDatabasePermission
  • Set-SqlDscDatabasePermission
  • Test-SqlDscIsDatabasePrincipal
  • Exclude Script Analyzer rule TypeNotFound in the file .vscode/analyzersettings.psd1.
  • Update CONTRIBUTING.md describing error handling in commands and class-based resources.
  • The QA tests are now run in Windows PowerShell due to a bug in PowerShell 7 that makes class-based resource using inheritance to not work.
  • The QA test are excluding the rule TypeNotFound because it cannot run on the source files (there is a new issue that is tracking so this rule is only run on the built module).
  • The Pester code coverage has been switched to use the older functionality that uses breakpoints to calculate coverage. Newer functionality sometimes throw an exception when used in conjunction with class-based resources.¨
  • The SMO stubs (used in the unit tests) was updated to remove a bug related to the type DatabasePermissionInfo when used with the type DatabasePermissionSet. The stubs suggested that the property PermissionType (of type DatabasePermissionSet) in DatabasePermissionInfo should have been a array DatabasePermissionSet[]. This conflicted with real SMO as it does not pass an array, but instead a single DatabasePermissionSet. The stubs was modified to mimic the real SMO. At the same time some old mock code in the SMO stubs was removed as it was no longer in use.
• SqlServerDsc.Common
  • The parameter SetupCredential of the function Connect-SQL was renamed to Credential and the parameter name SetupCredential was made a parameter alias.
• SqlDatabasePermission
  • BREAKING CHANGE: The resource has been refactored. The parameters ParameterState and Permissions has been replaced by parameters Permission, PermissionToInclude, and PermissionToExclude. These permissions parameters are now an instance of the type DatabasePermission. The type DatabasePermission contains two properties; State and Permission.
  • The resource was refactored into a class-based resource.

This Pull Request (PR) fixes the following issues

• Fixes #1555

Task list

• [x] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md. Entry should say what was changed and how that affects users (if applicable), and reference the issue being resolved (if applicable).
• [x] Resource documentation updated in the resource's README.md.
• [ ] Resource parameter descriptions updated in schema.mof.
• [x] Comment-based help updated, including parameter descriptions.
• [x] Localization strings updated.
• [x] Examples updated.
• [x] Unit tests updated. See DSC Community Testing Guidelines.
• [x] Integration tests updated (where possible). See DSC Community Testing Guidelines.
• [x] Code changes adheres to DSC Community Style Guidelines.

---

This change is 

[johlju]

I would be happy to get initial review on this while I get the integration tests finished.

[codecov[bot]]

Codecov Report

Merging #1769 (ce11053) into main (5b0a7e3) will decrease coverage by 1%. The diff coverage is 100%.

@@          Coverage Diff          @@
##           main   #1769    +/-   ##
=====================================
- Coverage    87%     86%    -2%     
=====================================
  Files        38      37     -1     
  Lines      6349    6261    -88     
=====================================
- Hits       5575    5422   -153     
- Misses      774     839    +65     

Flag	Coverage Δ
unit	86% <100%> (-2%)	:arrow_down:

Impacted Files	Coverage Δ
...dules/SqlServerDsc.Common/SqlServerDsc.Common.psm1	98% <100%> (ø)
...ces/DSC_SqlConfiguration/DSC_SqlConfiguration.psm1	94% <0%> (-6%)	:arrow_down:
...DSC_SqlAlwaysOnService/DSC_SqlAlwaysOnService.psm1	95% <0%> (-5%)	:arrow_down:
...efaultLocation/DSC_SqlDatabaseDefaultLocation.psm1	95% <0%> (-5%)	:arrow_down:
...ces/DSC_SqlAgentFailsafe/DSC_SqlAgentFailsafe.psm1	95% <0%> (-5%)	:arrow_down:
...urce/DSCResources/DSC_SqlScript/DSC_SqlScript.psm1	95% <0%> (-5%)	:arrow_down:
...sources/DSC_SqlScriptQuery/DSC_SqlScriptQuery.psm1	95% <0%> (-5%)	:arrow_down:
...SCResources/DSC_SqlWaitForAG/DSC_SqlWaitForAG.psm1	95% <0%> (-5%)	:arrow_down:
...lEndpointPermission/DSC_SqlEndpointPermission.psm1	95% <0%> (-5%)	:arrow_down:
...Resources/DSC_SqlPermission/DSC_SqlPermission.psm1	96% <0%> (-4%)	:arrow_down:
... and 13 more