Skip to content

Latest commit

 

History

History
223 lines (169 loc) · 8.22 KB

CONTRIBUTING.md

File metadata and controls

223 lines (169 loc) · 8.22 KB
Raw

Contributing to SqlServerDsc

If you are keen to make SqlServerDsc better, why not consider contributing your work to the project? Every little change helps us make a better resource for everyone to use, and we would love to have contributions from the community.

Core contribution guidelines

Please check out common DSC Community contributing guidelines.

Documentation with Markdown

If using Visual Studio Code to edit Markdown files it can be a good idea to install the markdownlint extension. It will help to do style checking. The file .markdownlint.json is prepared with a default set of rules which will automatically be used by the extension.

Automatic formatting with VS Code

There is a VS Code workspace settings file within this project with formatting settings matching the style guideline. That will make it possible inside VS Code to press SHIFT+ALT+F, or press F1 and choose 'Format document' in the list. The PowerShell code will then be formatted according to the Style Guideline (although maybe not complete, but would help a long way).

SQL Server products supported by resources

Any resource should be able to target at least all SQL Server versions that are currently supported by Microsoft (also those in extended support). Unless the functionality that the resource targets does not exist in a certain SQL Server version. There can also be other limitations that restrict the resource from targeting all supported versions.

Those SQL Server products that are still supported can be listed at the Microsoft life cycle site.

Design patterns

Credentials that does not have password

Credential that needs to be passed to a DSC resource might include Manged Service Account (MSA), Group Managed Service Account (gMSA), and built-in accounts (e.g. 'NT AUTHORITY\NetworkService').

For a resource to support these types of accounts (credentials) the DSC resource need to ignore the password part of the credential object when it is passed to the DSC resource. We should not add separate parameters for passing such account names.

This was discussed in issue #738 and issue #1230.

Naming convention

The DSC resources contained in SqlServerDsc use the following naming convention:

<Module Identifier>[<Component>][<Action>]<Scope>{<Feature>|<Property>}

The following list describes the components that make up a resource name and lists possible names used for each of the components. The component names are not limited to the names in this list.

  • Module Identifier
    • Sql
  • Component
    • <none> - Database Engine (No component abbreviation)
    • AS - Analysis Services
    • IS - Integration Services
    • RS - Reporting Services
  • Action (not required)
    • Setup
    • WaitFor
  • Scope - Where the action, feature, or property is being applied.
    • AG (AvailabilityGroup)
    • Database
    • ServiceAccount
    • Windows
  • Feature
    • AlwaysOn - This is for the overall AlwaysOn feature
    • Endpoint
    • Firewall
    • Network
    • Script
  • Property (not required)
    • Alias
    • Configuration
    • Database
    • DatabaseMembership
    • DefaultLocation
    • Listener
    • Login
    • MaxDop
    • Memory
    • Owner
    • Permission
    • RecoveryModel
    • Replica
    • Replication
    • Role
    • SecureConnectionLevel
    • Service
    • State

Example of Resource Naming

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

  • Module Identifier: Sql
  • Component: <blank>
  • Action: <none>
  • Scope: Server
  • Feature: Endpoint
  • Property: Permission

mof-based resource

A mof-based resource is a resource tha has the functions Get-, Set-, and Test-TargetResource in a PowerShell module script file (.psm1) and a schema.mof that describes the properties of the resource.

Folder and file structure

Please note that for the examples folder we don't use the 'DSC_' prefix on the resource folders. This is to make those folders more user friendly, to resemble the name the user would use in the configuration file.

source/DSCResources/DSC_SqlConfiguration/DSC_SqlConfiguration.psm1
source/DSCResources/DSC_SqlConfiguration/DSC_SqlConfiguration.schema.mof
source/DSCResources/DSC_SqlConfiguration/en-US/DSC_SqlConfiguration.strings.psd1
source/DSCResources/DSC_SqlConfiguration/README.md

source/Examples/Resources/SqlConfiguration/1-AddConfigurationOption.ps1
source/Examples/Resources/SqlConfiguration/2-RemoveConfigurationOption.ps1

tests/Unit/DSC_SqlConfiguration.Tests.ps1

tests/Integration/DSC_SqlConfiguration.config.ps1
tests/Integration/DSC_SqlConfiguration.Integration.Tests.ps1
Schema mof file

The class name should be prefixed with 'DSC_Sql', e.g. DSC_SqlConfiguration. Please note that the FriendlyName in the schema mof file should not contain the prefix DSC\_.

[ClassVersion("1.0.0.0"), FriendlyName("SqlConfiguration")]
class DSC_SqlConfiguration : OMI_BaseResource
{
    # Properties removed for readability.
};

Composite or class-based resource

Any composite (with a Configuration) or class-based resources should be prefixed with just 'Sql'

Localization

In each resource folder there should be, at least, a localization folder for english language 'en-US'.

Read more about this in the localization style guideline.

Helper functions

Helper functions or wrapper functions that are used only by the resource can preferably be placed in the resource module file. If the functions are of a type that could be used by more than one resource, then the functions can also be placed in the common module SqlServerDsc.Common module file.

If a helper function can be used by more than one DSC module it is preferably that the helper function is added to the PowerShell module DscResource.Common. Once the helper function is in a full release (not preview) then it can be automatically be used by DSC resources in this module. This is because the DscResource.Common module is incorporating during the build phase.

Unit tests

For a review of a Pull Request (PR) to start, all tests must pass without error. If you need help to figure why some test don't pass, just write a comment in the Pull Request (PR), or submit an issue, and somebody will come along and assist.

If want to know how to run this module's tests you can look at the Testing Guidelines

Using SMO stub classes

There are stub classes for the SMO classes which can be used and improved on when creating tests where SMO classes are used in the code being tested.

Integration tests

Integration tests should be written for resources so they can be validated by the CI.

There are also configuration made by existing integration tests that can be reused to write integration tests for other resources. This is documented in Integration tests for SqlServerDsc.

Since integration tests must run in order because they are dependent on each other to some degree. Most resource are dependent on that integration tests for the DSC resource SqlSetup have installed the instance to connect to. To make sure a integration tests is run in the correct order the integration tests are grouped in the file azure-pipelines.yml in the integration tests jobs.

There are two integration tests jobs that each test SQL Server 2016 and SQL Server 2017.

Testing of examples files

When sending in a Pull Request (PR) all example files will be tested so they can be compiled to a .mof file. If the tests find any errors the build will fail.