Merge pull request #61 from PowerShell/dev

Release of version 4.0.0.0 of DFSDsc

.MetaTestOptIn.json

@@ -1,4 +1,6 @@
 [
         "Common Tests - Validate Markdown Files",
-        "Common Tests - Validate Example Files"
+        "Common Tests - Validate Example Files",
+        "Common Tests - Validate Module Files",
+        "Common Tests - Validate Script Files"
 ]

.github/CONTRIBUTING.md

@@ -0,0 +1 @@
+If you'd like to contribute to this project, please review the [Contribution Guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md).

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!--
+Your feedback and support is greatly appreciated, thanks for contributing!
+
+Please prefix the issue title with the resource name, i.e. 'DFSNameSpaceFolder: Short description of my issue'
+Please provide the following information regarding your issue (place N/A if the fields that don't apply to your issue):
+-->
+**Details of the scenario you tried and the problem that is occurring:**
+
+**The DSC configuration that is using the resource (as detailed as possible):**
+
+**Version of the Operating System and PowerShell the DSC Target Node is running:**
+
+**Version of the DSC module you're using, or 'dev' if you're using current dev branch:**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--
+Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project is greatly appreciated!
+
+Please prefix the PR title with the resource name, i.e. 'DFSNamespaceFolder: My short description'
+If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:', i.e. 'BREAKING CHANGE: DFSNamespaceFolder: My short description'
+
+To aid community reviewers in reviewing and merging your PR, please take the time to run through the below checklist.
+Change to [x] for each task in the task list that applies to this PR.
+-->
+**Pull Request (PR) description**
+<!-- Replace this with a description of your pull request -->
+
+**This Pull Request (PR) fixes the following issues:**
+<!-- Replace this with the list of issues or n/a. Use format: Fixes #123 -->
+
+**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](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)?
+- [ ] [Unit and (optional) Integration tests](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md) created/updated where possible?

.gitignore

@@ -6,8 +6,8 @@
 .sln
 DscResource.Tests
 DscResource.Tests/*
-Modules/xDFS/DscResource.Tests
-Modules/xDFS/DscResource.Tests/*
+Modules/DFSDsc/DscResource.Tests
+Modules/DFSDsc/DscResource.Tests/*
 node_modules
 node_modules/*
 markdownissues.txt

.markdownlint.json

@@ -1,3 +1,10 @@
 {
-    "MD013": true
+    "default": true,
+    "MD029": {
+        "style": "one"
+    },
+    "MD013": true,
+    "MD024": true,
+    "MD034": true,
+    "no-hard-tabs": true
 }

.vscode/RunAllTests.ps1

@@ -7,5 +7,5 @@ if ( (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.T
 
 Import-Module (Join-Path $PSScriptRoot "..\Tests\TestHarness.psm1" -Resolve)
 $dscTestsPath = Join-Path -Path $PSScriptRoot `
-                          -ChildPath "..\Modules\xDFS\DscResource.Tests\Meta.Tests.ps1"
+                          -ChildPath "..\Modules\DFSDsc\DscResource.Tests\Meta.Tests.ps1"
 Invoke-TestHarness -DscTestsPath $dscTestsPath

.vscode/settings.json

@@ -0,0 +1,14 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "powershell.codeFormatting.openBraceOnSameLine": false,
+    "powershell.codeFormatting.newLineAfterOpenBrace": false,
+    "powershell.codeFormatting.newLineAfterCloseBrace": true,
+    "powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
+    "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
+    "powershell.codeFormatting.whitespaceAroundOperator": true,
+    "powershell.codeFormatting.whitespaceAfterSeparator": true,
+    "powershell.codeFormatting.ignoreOneLineBlock": false,
+    "powershell.codeFormatting.preset": "Custom",
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true
+}

CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## Unreleased
 
+## 4.0.0.0
+
+- BREAKING CHANGE
+  - Renamed xDFS to DFSDsc - fixes [Issue #55](https://github.com/PowerShell/xDFS/issues/55).
+  - Changed all MSFT_xResourceName to MSFT_DFSResourceName.
+  - Updated DSCResources, Examples, Modules and Tests for new naming.
+  - Updated Year to 2018 in License and Manifest.
+  - Changed all Modules\DFSDsc\Examples\Resources to DFSResourceName.
+- Added the VS Code PowerShell extension formatting settings that cause PowerShell
+  files to be formatted as per the DSC Resource kit style guidelines.
+- Improve layout of badge area in README.MD.
+- Disabled MD013 rule checking to enable badge table.
+- Updated Year to 2017 in License and Manifest.
+- Added .github support files:
+  - CONTRIBUTING.md
+  - ISSUE_TEMPLATE.md
+  - PULL_REQUEST_TEMPLATE.md
+- Opted into Common Tests 'Validate Module Files' and 'Validate Script Files'.
+- Converted files with UTF8 with BOM over to UTF8 - fixes [Issue #47](https://github.com/PowerShell/xDFS/issues/47).
+- Added `Documentation and Examples` section to Readme.md file - see
+  [issue #49](https://github.com/PowerShell/xDFS/issues/49).
+- Prevent unit tests from DSCResource.Tests from running during test
+  execution - fixes [Issue #51](https://github.com/PowerShell/xDFS/issues/51).
+- Updated tests to meet Pester V4 guidelines - fixes [Issue #53](https://github.com/PowerShell/xDFS/issues/53).
+
 ## 3.2.0.0
 
 - Converted AppVeyor.yml to pull Pester from PSGallery instead of Chocolatey.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Microsoft Corporation.
+Copyright (c) 2018 Microsoft Corporation.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Modules/xDFS/xDFS.psd1 → Modules/DFSDsc/DFSDsc.psd1

@@ -1,6 +1,6 @@
 @{
     # Version number of this module.
-    ModuleVersion = '3.2.0.0'
+    moduleVersion = '4.0.0.0'
 
     # ID used to uniquely identify this module
     GUID = '3bcb9c66-ea0b-4675-bd46-c390a382c388'
@@ -12,7 +12,7 @@
     CompanyName = 'Microsoft Corporation'
 
     # Copyright statement for this module
-    Copyright = '(c) 2015 Microsoft Corporation. All rights reserved.'
+    Copyright = '(c) 2018 Microsoft Corporation. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description = 'DSC resources for configuring Distributed File System Replication and Namespaces.'
@@ -42,34 +42,38 @@
             Tags = @( 'DSC','DesiredStateConfiguration','DSCResourceKit','DSCResource','DFS','DistributedFileSystem' )
 
             # A URL to the license for this module.
-            LicenseUri = 'https://github.com/PowerShell/xDFS/blob/master/LICENSE'
+            LicenseUri = 'https://github.com/PowerShell/DFSDsc/blob/master/LICENSE'
 
             # A URL to the main website for this project.
-            ProjectUri = 'https://github.com/PowerShell/xDFS'
+            ProjectUri = 'https://github.com/PowerShell/DFSDsc'
 
             # ReleaseNotes of this module
-        ReleaseNotes = '- Converted AppVeyor.yml to pull Pester from PSGallery instead of Chocolatey.
-- Changed AppVeyor.yml to use default image.
-- Converted AppVeyor build process to use AppVeyor.psm1.
-- Resolved PSSA violations.
-- Resolved Readme.md style violations.
-- Converted Integration Tests to use Test Drive and stop using Invoke-Pester.
-- Move strings into separate language files.
-- Added CodeCov support.
-- Clean up manifest file by removing commented out sections.
-- Convert Examples to pass tests and meet minimum standards.
-- Convert to Wiki and auto-documentation generation.
-- Convert to TestHarness test execution method.
-- Correct parameter block format to meet guidelines.
-- Replaced all type accelerators with full type names.
-- Updated Readme.md to contain resource list.
-- Fixed xDFSNamespaceServerConfiguration by converting LocalHost to ComputerName
-  instead.
-- Added integration test to test for conflicts with other common resource kit modules.
-- Prevented ResourceHelper and Common module cmdlets from being exported to resolve
-  conflicts with other resource modules.
+        ReleaseNotes = '- BREAKING CHANGE
+  - Renamed xDFS to DFSDsc - fixes [Issue 55](https://github.com/PowerShell/xDFS/issues/55).
+  - Changed all MSFT_xResourceName to MSFT_DFSResourceName.
+  - Updated DSCResources, Examples, Modules and Tests for new naming.
+  - Updated Year to 2018 in License and Manifest.
+  - Changed all Modules\DFSDsc\Examples\Resources to DFSResourceName.
+- Added the VS Code PowerShell extension formatting settings that cause PowerShell
+  files to be formatted as per the DSC Resource kit style guidelines.
+- Improve layout of badge area in README.MD.
+- Disabled MD013 rule checking to enable badge table.
+- Updated Year to 2017 in License and Manifest.
+- Added .github support files:
+  - CONTRIBUTING.md
+  - ISSUE_TEMPLATE.md
+  - PULL_REQUEST_TEMPLATE.md
+- Opted into Common Tests "Validate Module Files" and "Validate Script Files".
+- Converted files with UTF8 with BOM over to UTF8 - fixes [Issue 47](https://github.com/PowerShell/xDFS/issues/47).
+- Added `Documentation and Examples` section to Readme.md file - see
+  [issue 49](https://github.com/PowerShell/xDFS/issues/49).
+- Prevent unit tests from DSCResource.Tests from running during test
+  execution - fixes [Issue 51](https://github.com/PowerShell/xDFS/issues/51).
+- Updated tests to meet Pester V4 guidelines - fixes [Issue 53](https://github.com/PowerShell/xDFS/issues/53).
+
 '
         } # End of PSData hashtable
     } # End of PrivateData hashtable
 }
 
+

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceFolder/MSFT_xDFSNamespaceFolder.psm1 → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceFolder/MSFT_DFSNamespaceFolder.psm1

@@ -7,7 +7,7 @@ Import-Module -Name (Join-Path -Path $modulePath `
 
 # Import Localization Strings
 $localizedData = Get-LocalizedData `
-    -ResourceName 'MSFT_xDFSNamespaceFolder' `
+    -ResourceName 'MSFT_DFSNamespaceFolder' `
     -ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)
 
 <#

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceFolder/MSFT_xDFSNamespaceFolder.schema.mof → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceFolder/MSFT_DFSNamespaceFolder.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xDFSNamespaceFolder")]
-class MSFT_xDFSNamespaceFolder : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("DFSNamespaceFolder")]
+class MSFT_DFSNamespaceFolder : OMI_BaseResource
 {
     [Key, Description("Specifies a path for the root of a DFS namespace.")] String Path;
     [Key, Description("Specifies a path for a root target of the DFS namespace.")] String TargetPath;

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceRoot/MSFT_xDFSNamespaceRoot.psm1 → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceRoot/MSFT_DFSNamespaceRoot.psm1

@@ -7,7 +7,7 @@ Import-Module -Name (Join-Path -Path $modulePath `
 
 # Import Localization Strings
 $localizedData = Get-LocalizedData `
-    -ResourceName 'MSFT_xDFSNamespaceRoot' `
+    -ResourceName 'MSFT_DFSNamespaceRoot' `
     -ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)
 
 <#

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceRoot/MSFT_xDFSNamespaceRoot.schema.mof → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceRoot/MSFT_DFSNamespaceRoot.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xDFSNamespaceRoot")]
-class MSFT_xDFSNamespaceRoot : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("DFSNamespaceRoot")]
+class MSFT_DFSNamespaceRoot : OMI_BaseResource
 {
     [Key, Description("Specifies a path for the root of a DFS namespace.")] String Path;
     [Key, Description("Specifies a path for a root target of the DFS namespace.")] String TargetPath;

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceServerConfiguration/MSFT_xDFSNamespaceServerConfiguration.psm1 → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceServerConfiguration/MSFT_DFSNamespaceServerConfiguration.psm1

@@ -7,7 +7,7 @@ Import-Module -Name (Join-Path -Path $modulePath `
 
 # Import Localization Strings
 $localizedData = Get-LocalizedData `
-    -ResourceName 'MSFT_xDFSNamespaceServerConfiguration' `
+    -ResourceName 'MSFT_DFSNamespaceServerConfiguration' `
     -ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)
 
 <#

Modules/xDFS/DSCResources/MSFT_xDFSNamespaceServerConfiguration/MSFT_xDFSNamespaceServerConfiguration.schema.mof → Modules/DFSDsc/DSCResources/MSFT_DFSNamespaceServerConfiguration/MSFT_DFSNamespaceServerConfiguration.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xDFSNamespaceServerConfiguration")]
-class MSFT_xDFSNamespaceServerConfiguration : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("DFSNamespaceServerConfiguration")]
+class MSFT_DFSNamespaceServerConfiguration : OMI_BaseResource
 {
     [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'."), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
     [Write, Description("Specifies a time-out value, in seconds, for Lightweight Directory Access Protocol (LDAP) requests for the DFS namespace server.")] Uint32 LdapTimeoutSec;