Skip to content

Commit

Permalink
BREAKING CHANGE: SqlServerDsc: Rename resources (dsccommunity#1565)
Browse files Browse the repository at this point in the history
- SqlServerDsc
  - BREAKING CHANGE: Some DSC resources have been renamed (issue dsccommunity#1540).
    - `SqlServerConfiguration` was renamed to `SqlConfiguration`.
    - `SqlServerDatabaseMail` was renamed to `SqlDatabaseMail`.
    - `SqlServerEndpoint` was renamed to `SqlEndpoint`.
    - `SqlServerEndpointPermission` was renamed to `SqlEndpointPermission`.
    - `SqlServerLogin` was renamed to `SqlLogin`.
    - `SqlServerMaxDop` was renamed to `SqlMaxDop`.
    - `SqlServerMemory` was renamed to `SqlMemory`.
    - `SqlServerPermission` was renamed to `SqlPermission`.
    - `SqlServerProtocol` was renamed to `SqlProtocol`.
    - `SqlServerProtocolTcpIp` was renamed to `SqlProtocolTcpIp`.
    - `SqlServerReplication` was renamed to `SqlReplication`.
    - `SqlServerRole` was renamed to `SqlRole`.
    - `SqlServerSecureConnection` was renamed to `SqlSecureConnection`.
  • Loading branch information
johlju authored Jun 11, 2020
1 parent 71e5ac1 commit 932cbea
Show file tree
Hide file tree
Showing 137 changed files with 452 additions and 438 deletions.
46 changes: 30 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@ in a future release.
a property in the resource _SqlDatabase_ ([issue #967](https://github.com/dsccommunity/SqlServerDsc/issues/967)).
- SqlServerEndpointState
- This resource is now deprecated. The functionality is covered by a
property in the resource _SqlServerEndpoint_ ([issue #968](https://github.com/dsccommunity/SqlServerDsc/issues/968)).
property in the resource _SqlEndpoint_ ([issue #968](https://github.com/dsccommunity/SqlServerDsc/issues/968)).
- SqlServerNetwork
- This resource is now deprecated. The functionality is now covered by
the resources _SqlServerProtocol_ and _SqlServerProtocolTcpIp_.
the resources _SqlProtocol_ and _SqlProtocolTcpIp_.

### Added

- SqlSetup
- Added support for major version upgrade ([issue #1561](https://github.com/dsccommunity/SqlServerDsc/issues/1561)).
- SqlServerDsc
- Added new resource SqlServerProtocol ([issue #1377](https://github.com/dsccommunity/SqlServerDsc/issues/1377)).
- Added new resource SqlServerProtocolTcpIp ([issue #1378](https://github.com/dsccommunity/SqlServerDsc/issues/1378)).
- Added new resource SqlProtocol ([issue #1377](https://github.com/dsccommunity/SqlServerDsc/issues/1377)).
- Added new resource SqlProtocolTcpIp ([issue #1378](https://github.com/dsccommunity/SqlServerDsc/issues/1378)).
- Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
pipeline.
- Prepare repository for auto-documentation by adding README.md to each
Expand All @@ -54,7 +54,7 @@ in a future release.
- CommonTestHelper
- Added the functions `Get-InvalidOperationRecord` and `Get-InvalidResultRecord`
that is needed for evaluate localized error message strings for unit tests.
- SqlServerEndpoint
- SqlEndpoint
- BREAKING CHANGE: A new required property `EndpointType` was added to
support different types of endpoints in the future. For now the only
endpoint type that is supported is the database mirror endpoint type
Expand All @@ -67,7 +67,7 @@ in a future release.
if the instance is clustered.
- Added the properties `NpEnabled` and `TcpEnabled` ([issue #1161](https://github.com/dsccommunity/SqlServerDsc/issues/1161)).
- Added the property `UseEnglish` ([issue #1473](https://github.com/dsccommunity/SqlServerDsc/issues/1473)).
- SqlServerReplication
- SqlReplication
- Add integration tests ([issue #755](https://github.com/dsccommunity/SqlServerDsc/issues/755).
- SqlDatabase
- The property `OwnerName` was added.
Expand All @@ -87,6 +87,20 @@ in a future release.
### Changed

- SqlServerDsc
- BREAKING CHANGE: Some DSC resources have been renamed ([issue #1540](https://github.com/dsccommunity/SqlServerDsc/issues/1540)).
- `SqlServerConfiguration` was renamed to `SqlConfiguration`.
- `SqlServerDatabaseMail` was renamed to `SqlDatabaseMail`.
- `SqlServerEndpoint` was renamed to `SqlEndpoint`.
- `SqlServerEndpointPermission` was renamed to `SqlEndpointPermission`.
- `SqlServerLogin` was renamed to `SqlLogin`.
- `SqlServerMaxDop` was renamed to `SqlMaxDop`.
- `SqlServerMemory` was renamed to `SqlMemory`.
- `SqlServerPermission` was renamed to `SqlPermission`.
- `SqlServerProtocol` was renamed to `SqlProtocol`.
- `SqlServerProtocolTcpIp` was renamed to `SqlProtocolTcpIp`.
- `SqlServerReplication` was renamed to `SqlReplication`.
- `SqlServerRole` was renamed to `SqlRole`.
- `SqlServerSecureConnection` was renamed to `SqlSecureConnection`.
- Changed all resource prefixes from `MSFT_` to `DSC_` ([issue #1496](https://github.com/dsccommunity/SqlServerDsc/issues/1496)).
_Deprecated resource has not changed prefix._
- All resources are now using the common module DscResource.Common.
Expand Down Expand Up @@ -165,25 +179,25 @@ in a future release.
parameters `ServerName` and `InstanceName`. The parameter `InstanceName`
is the only one mandatory which fixes the issue that it was possible to
run the same query using different host names ([issue #925](https://github.com/dsccommunity/SqlServerDsc/issues/925)).
- SqlServerConfiguration
- SqlConfiguration
- BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- Normalize parameter descriptive text for default values.
- SqlServerDatabaseMail
- SqlDatabaseMail
- Normalize parameter descriptive text for default values.
- SqlServerEndpoint
- SqlEndpoint
- BREAKING CHANGE: Now the properties are only enforced if they are
specified in the configuration.
- Normalize parameter descriptive text for default values.
- SqlServerEndpointPermission
- SqlEndpointPermission
- BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- Normalize parameter descriptive text for default values.
- SqlServerLogin
- SqlLogin
- BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- Normalize parameter descriptive text for default values.
- SqlServerRole
- SqlRole
- BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- Normalize parameter descriptive text for default values.
Expand Down Expand Up @@ -242,19 +256,19 @@ in a future release.
- SqlRs
- Fix typo in the schema parameter `SuppressRestart` description
and in the parameter description in the `README.md`.
- SqlServerDatabaseMail
- SqlDatabaseMail
- The parameter `ServerName` now throws when passing an empty string or
null value (part of [issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- SqlServerEndpoint
- The parameter `ServerName` now throws when passing an empty string or
null value (part of [issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- SqlServerEndpointState
- SqlEndpoint
- The parameter `ServerName` now throws when passing an empty string or
null value (part of [issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- SqlServerPermission
- SqlPermission
- The parameter `ServerName` now throws when passing an empty string or
null value (part of [issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
- SqlServerReplication
- SqlReplication
- Enhanced the exception handling so it shows the inner exception error
message that have the actual error that occurred.
- Corrected the examples.
Expand Down
19 changes: 9 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ not limited to the names in this list.
- **Scope** - Where the action, feature, or property is being applied.
- **AG** (AvailabilityGroup)
- **Database**
- **Server**
- **ServiceAccount**
- **Windows**
- **Feature**
Expand Down Expand Up @@ -90,7 +89,7 @@ not limited to the names in this list.

#### Example of Resource Naming

The `SqlServerEndpointPermission` resource name is built using the defined
The `SqlEndpointPermission` resource name is built using the defined
naming structure using the following components.

- **Module Identifier**: Sql
Expand All @@ -115,14 +114,14 @@ This is to make those folders more user friendly, to resemble the name the user
would use in the configuration file.

```Text
DSCResources/DSC_SqlServerConfiguration/DSC_SqlServerConfiguration.psm1
DSCResources/DSC_SqlServerConfiguration/DSC_SqlServerConfiguration.schema.mof
DSCResources/DSC_SqlServerConfiguration/en-US/DSC_SqlServerConfiguration.strings.psd1
DSCResources/DSC_SqlConfiguration/DSC_SqlConfiguration.psm1
DSCResources/DSC_SqlConfiguration/DSC_SqlConfiguration.schema.mof
DSCResources/DSC_SqlConfiguration/en-US/DSC_SqlConfiguration.strings.psd1
Tests/Unit/DSC_SqlServerConfiguration.Tests.ps1
Tests/Unit/DSC_SqlConfiguration.Tests.ps1
Examples/Resources/SqlServerConfiguration/1-AddConfigurationOption.ps1
Examples/Resources/SqlServerConfiguration/2-RemoveConfigurationOption.ps1
Examples/Resources/SqlConfiguration/1-AddConfigurationOption.ps1
Examples/Resources/SqlConfiguration/2-RemoveConfigurationOption.ps1
```

##### Schema mof file
Expand All @@ -131,8 +130,8 @@ Please note that the `FriendlyName` in the schema mof file should not contain th
prefix `DSC\_`.

```powershell
[ClassVersion("1.0.0.0"), FriendlyName("SqlServerConfiguration")]
class DSC_SqlServerConfiguration : OMI_BaseResource
[ClassVersion("1.0.0.0"), FriendlyName("SqlConfiguration")]
class DSC_SqlConfiguration : OMI_BaseResource
{
# Properties removed for readability.
};
Expand Down
Loading

0 comments on commit 932cbea

Please sign in to comment.