Rework to move to wiki format

dscottraynsford · dscottraynsford · commit 9df5570678a7 · 2017-06-11T20:57:28.000+12:00
diff --git a/.MetaTestOptIn.json b/.MetaTestOptIn.json
@@ -0,0 +1,4 @@
+[
+        "Common Tests - Validate Markdown Files",
+        "Common Tests - Validate Example Files"
+]
diff --git a/.codecov.yml b/.codecov.yml
@@ -0,0 +1,26 @@
+codecov:
+  notify:
+    require_ci_to_pass: no
+  # dev should be the baseline for reporting
+  branch: dev
+
+comment:
+  layout: "reach, diff"
+  behavior: default
+
+coverage:
+  range: 50..80
+  round: down
+  precision: 0
+
+  status:
+    project:
+      default:
+        # Set the overall project code coverage requirement to 70%
+        target: 70
+    patch:
+      default:
+        # Set the pull request requirement to not regress overall coverage by more than 5%
+        # and let codecov.io set the goal for the code changed in the patch.
+        target: auto
+        threshold: 5
diff --git a/.gitignore b/.gitignore
@@ -1 +1,14 @@
-DSCResource.Tests
+*.suo
+*.user
+*.coverage
+.vs
+.psproj
+.sln
+DscResource.Tests
+DscResource.Tests/*
+Modules/xNetworking/DscResource.Tests
+Modules/xNetworking/DscResource.Tests/*
+node_modules
+node_modules/*
+markdownissues.txt
+TestResults.xml
diff --git a/.vscode/RunAllTests.ps1 b/.vscode/RunAllTests.ps1
@@ -0,0 +1,11 @@
+[string] $repoRoot = Split-Path -Path (Split-Path -Path $Script:MyInvocation.MyCommand.Path)
+if ( (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests'))) -or `
+     (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
+{
+    & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $repoRoot -ChildPath '\DSCResource.Tests\'))
+}
+
+Import-Module (Join-Path $PSScriptRoot "..\Tests\TestHarness.psm1" -Resolve)
+$dscTestsPath = Join-Path -Path $PSScriptRoot `
+                          -ChildPath "..\Modules\FileContentDsc\DscResource.Tests\Meta.Tests.ps1"
+Invoke-TestHarness -DscTestsPath $dscTestsPath
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "PowerShell",
+            "type": "PowerShell",
+            "request": "launch",
+            "program": "${file}",
+            "args": [],
+            "cwd": "${file}"
+        },
+        {
+            "name": "Run all tests",
+            "type": "PowerShell",
+            "request": "launch",
+            "program": "${workspaceRoot}/.vscode/RunAllTests.ps1"
+        }
+    ]
+}
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2016 PowerShell Team
+Copyright (c) 2017 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
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/MSFT_ReplaceText.mof b/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/MSFT_ReplaceText.mof
diff --git a/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/MSFT_ReplaceText.psm1 b/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/MSFT_ReplaceText.psm1
diff --git a/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/README.md b/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/README.md
@@ -0,0 +1,3 @@
+# Description
+
+The resource is used to replaces strings matching a regular expression in a file.
diff --git a/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/en-US/MSFT_ReplaceText.schema.mfl b/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/en-US/MSFT_ReplaceText.schema.mfl
diff --git a/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/en-US/MSFT_ReplaceText.strings.psd1 b/Modules/FIleContentDsc/DSCResources/MSFT_ReplaceText/en-US/MSFT_ReplaceText.strings.psd1
diff --git a/Modules/FIleContentDsc/FileContentDsc.psd1 b/Modules/FIleContentDsc/FileContentDsc.psd1
@@ -19,10 +19,10 @@ Author = 'Microsoft Corporation'
 CompanyName = 'MicrosoftCorporation'
 
 # Copyright statement for this module
-Copyright = '(c) 2016 Microsoft Corporation. All rights reserved.'
+Copyright = '(c) 2017 Microsoft Corporation. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'This module contains the DSC resources for manipulating text files.'
+Description = 'This module contains the DSC resources for manipulating the content of text files.'
 
 # Minimum version of the Windows PowerShell engine required by this module
 PowerShellVersion = '4.0'
diff --git a/Modules/FIleContentDsc/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1 b/Modules/FIleContentDsc/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1
@@ -0,0 +1,11 @@
+﻿# Import the Networking Resource Helper Module
+Import-Module -Name (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) `
+                               -ChildPath (Join-Path -Path 'FileContentDsc.ResourceHelper' `
+                                                     -ChildPath 'FileContentDsc.ResourceHelper.psm1'))
+
+# Import Localization Strings
+$script:localizedData = Get-LocalizedData `
+    -ResourceName 'FileContentDsc.Common' `
+    -ResourcePath $PSScriptRoot
+
+Export-ModuleMember -Function *
diff --git a/Modules/FIleContentDsc/Modules/FileContentDsc.Common/en-us/FileContentDsc.Common.strings.psd1 b/Modules/FIleContentDsc/Modules/FileContentDsc.Common/en-us/FileContentDsc.Common.strings.psd1
@@ -0,0 +1,2 @@
+ConvertFrom-StringData @'
+'@
diff --git a/Modules/FIleContentDsc/Modules/FileContentDsc.ResourceHelper/FileContentDsc.ResourceHelper.psm1 b/Modules/FIleContentDsc/Modules/FileContentDsc.ResourceHelper/FileContentDsc.ResourceHelper.psm1
@@ -1,14 +1,38 @@
 ﻿<#
+    .SYNOPSIS
+    Tests if the specified command can be found.
+
+    .PARAMETER name
+    The name of the command to test.
+#>
+function Test-Command
+{
+    param
+    (
+        [String] $Name
+    )
+
+    return ($null -ne (Get-Command -Name $Name -ErrorAction Continue 2> $null))
+}
+
+<#
     .SYNOPSIS
     Tests if the current machine is a Nano server.
 #>
 function Test-IsNanoServer
 {
-    [OutputType([Boolean])]
-    [CmdletBinding()]
-    param ()
+    if(Test-Command -Name Get-ComputerInfo)
+    {
+        $computerInfo = Get-ComputerInfo
+
+        if("Server" -eq $computerInfo.OsProductType `
+            -and "NanoServer" -eq $computerInfo.OsServerLevel)
+        {
+            return $true
+        }
+    }
 
-    return $PSVersionTable.PSEdition -ieq 'Core'
+    return $false
 }
 
 <#
@@ -118,16 +142,20 @@ function Get-LocalizedData
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [String]
-        $ResourceName
+        $ResourceName,
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [String]
+        $ResourcePath
     )
 
-    $resourceDirectory = (Join-Path -Path $PSScriptRoot -ChildPath $ResourceName)
-    $localizedStringFileLocation = Join-Path -Path $resourceDirectory -ChildPath $PSUICulture
+    $localizedStringFileLocation = Join-Path -Path $ResourcePath -ChildPath $PSUICulture
 
     if (-not (Test-Path -Path $localizedStringFileLocation))
     {
         # Fallback to en-US
-        $localizedStringFileLocation = Join-Path -Path $resourceDirectory -ChildPath 'en-US'
+        $localizedStringFileLocation = Join-Path -Path $ResourcePath -ChildPath 'en-US'
     }
 
     Import-LocalizedData `
@@ -138,5 +166,8 @@ function Get-LocalizedData
     return $localizedData
 }
 
-Export-ModuleMember -Function @( 'Test-IsNanoServer', 'New-InvalidArgumentException',
-    'New-InvalidOperationException', 'Get-LocalizedData' )
+Export-ModuleMember -Function `
+    Test-IsNanoServer, `
+    New-InvalidArgumentException, `
+    New-InvalidOperationException, `
+    Get-LocalizedData
diff --git a/PSScriptAnalyzerSettings.psd1 b/PSScriptAnalyzerSettings.psd1
@@ -0,0 +1,10 @@
+@{
+    ExcludeRules=@('PSDSCDscExamplesPresent',
+                'PSDSCDscTestsPresent',
+                'PSUseBOMForUnicodeEncodedFile',
+                'PSUseShouldProcessForStateChangingFunctions',
+                'PSUseSingularNouns',
+                'PSUseToExportFieldsInManifest',
+                'PSUseUTF8EncodingForHelpFile',
+                'PSUseDeclaredVarsMoreThanAssignments')
+}
diff --git a/README.md b/README.md
@@ -1,52 +1,17 @@
 # FileContentDsc
 
-FileContentDsc contains DSC resources for manipulating the content of files on the target node.
-This is most commonly used to set the content of configuration files.
+[![Build status](https://ci.appveyor.com/api/projects/status/obmudad7gy8usbx2/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/xnetworking/branch/master)
+[![codecov](https://codecov.io/gh/PowerShell/xNetworking/branch/master/graph/badge.svg)](https://codecov.io/gh/PowerShell/xNetworking)
 
-These resources meet the DSC Resource Kit [High Quality Resource Module (HQRM) guidelines](https://github.com/PowerShell/DscResources/blob/master/HighQualityModuleGuidelines.md).
+The **FileContent** module contains the following resources:
+
+- **ReplaceText**: Replaces strings matching a regular expression in a file.
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
+additional questions or comments.
 
 ## Contributing
 
-Please check out the common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).
-
-## Resources
-
-* [ReplaceText](#ReplaceText): Uses RegEx to find and replace strings in a text file.
-
-### ReplaceText
-
-This resource uses RegEx to find and replace strings in a text file.
-It can replace the items matched with the RegEx with either a string or the password from a ```pscredential``` object.
-This resource works on Nano Server.
-
-#### Requirements
-
-None
-
-#### Parameters
-
-* **[String] Path** _(Key)_: The path to the text file to replace the string in.
-* **[String] Search** _(Key)_: The RegEx string to use to search the text file.
-* **[String] Type** _(Write)_: Specifies the value type to use as the replacement string. { *Text* | Password }. Defaults to Text.
-* **[String] Text** _(Write)_: The text to replace the text identifed by the RegEx. Only used when Type is set to 'Text'.
-* **[String] Password** _(Write)_: The password to replace the text identified by the RegEx. Only used when Type is set to 'Password'.
-
-#### Read-Only Properties from Get-TargetResource
-
-None
-
-#### Examples
-
-* [Create or modify a group with Members](https://github.com/PowerShell/PSDscResources/blob/master/Examples/Sample_Group_Members.ps1)
-* [Create or modify a group with MembersToInclude and/or MembersToExclude](https://github.com/PowerShell/PSDscResources/blob/master/Examples/Sample_Group_Members.ps1)
-
-## Versions
-
-### Unreleased
-
-### 1.0.0.0
-
-* Initial release of FileContentDsc
+Please check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).
diff --git a/Tests/Integration/MSFT_ReplaceText.Integration.Tests.ps1 b/Tests/Integration/MSFT_ReplaceText.Integration.Tests.ps1
@@ -86,4 +86,5 @@ try
 finally
 {
     Exit-DscResourceTestEnvironment -TestEnvironment $script:testEnvironment
+    Remove-Module -Name CommonTestHelper
 }
diff --git a/Tests/TestHarness.psm1 b/Tests/TestHarness.psm1
@@ -0,0 +1,52 @@
+function Invoke-TestHarness
+{
+    [CmdletBinding()]
+    param
+    (
+        [System.String]
+        $TestResultsFile,
+
+        [System.String]
+        $DscTestsPath
+    )
+
+    Write-Verbose -Message 'Commencing all FileContentDsc tests'
+
+    $repoDir = Join-Path -Path $PSScriptRoot -ChildPath '..\' -Resolve
+
+    $testCoverageFiles = @()
+    Get-ChildItem -Path "$repoDir\modules\FileContentDsc\DSCResources\**\*.psm1" -Recurse | ForEach-Object {
+        if ($_.FullName -notlike '*\DSCResource.Tests\*') {
+            $testCoverageFiles += $_.FullName
+        }
+    }
+
+    $testResultSettings = @{ }
+    if ([String]::IsNullOrEmpty($TestResultsFile) -eq $false) {
+        $testResultSettings.Add('OutputFormat', 'NUnitXml' )
+        $testResultSettings.Add('OutputFile', $TestResultsFile)
+    }
+
+    Import-Module -Name "$repoDir\modules\FileContentDsc\FileContentDsc.psd1"
+    $testsToRun = @()
+
+    # Run Unit Tests
+    $unitTestsPath = Join-Path -Path $repoDir -ChildPath 'Tests\Unit'
+    $testsToRun += @( (Get-ChildItem -Path $unitTestsPath).FullName )
+
+    # Integration Tests
+    $integrationTestsPath = Join-Path -Path $repoDir -ChildPath 'Tests\Integration'
+    $testsToRun += @( (Get-ChildItem -Path $integrationTestsPath -Filter '*.Tests.ps1').FullName )
+
+    # DSC Common Tests
+    if ($PSBoundParameters.ContainsKey('DscTestsPath') -eq $true)
+    {
+        $testsToRun += @( $DscTestsPath )
+    }
+
+    $results = Invoke-Pester -Script $testsToRun `
+        -CodeCoverage $testCoverageFiles `
+        -PassThru @testResultSettings
+
+    return $results
+}
diff --git a/Tests/TestHelpers/CommonTestHelper.psm1 b/Tests/TestHelpers/CommonTestHelper.psm1
diff --git a/Tests/Unit/FileContentDsc.Common.tests.ps1 b/Tests/Unit/FileContentDsc.Common.tests.ps1
diff --git a/appveyor.yml b/appveyor.yml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[
 +        "Common Tests - Validate Markdown Files",
 +        "Common Tests - Validate Example Files"
 +]
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Description`
	`2`	`+`
	`3`	`+The resource is used to replaces strings matching a regular expression in a file.`