Merge pull request #39 from PlagueHO/dev

Releasing 1.5.1.0

.MetaTestOptIn.json

@@ -5,5 +5,8 @@
         "Common Tests - Validate Script Files",
         "Common Tests - Flagged Script Analyzer Rules",
         "Common Tests - New Error-Level Script Analyzer Rules",
-        "Common Tests - Custom Script Analyzer Rules"
+        "Common Tests - Custom Script Analyzer Rules",
+        "Common Tests - Validate Example Files To Be Published",
+        "Common Tests - Validate Markdown Links",
+        "Common Tests - Relative Path Length"
 ]

.github/ISSUE_TEMPLATE/General.md

@@ -0,0 +1,7 @@
+---
+name: General question or documentation update
+about: If you have a general question or documentation update suggestion around the resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+-->

.github/ISSUE_TEMPLATE/Problem_with_resource.md

@@ -0,0 +1,57 @@
+---
+name: Problem with a resource
+about: If you have a problem, bug, or enhancement with a resource in this resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+
+    ISSUE TITLE:
+    Please prefix the issue title with the resource name, e.g.
+    'ResourceName: Short description of my issue'
+
+    ISSUE DESCRIPTION (this template):
+    Please provide information regarding your issue under each header below.
+    Write N/A under any headers that do not apply to your issue, or if the
+    information is not available.
+
+    NOTE! Sensitive information should be obfuscated.
+
+    PLEASE KEEP THE HEADERS.
+
+    You may remove this comment block, and the other comment blocks,
+    but please keep the headers.
+-->
+#### Details of the scenario you tried and the problem that is occurring
+
+#### Verbose logs showing the problem
+
+#### Suggested solution to the issue
+
+#### The DSC configuration that is used to reproduce the issue (as detailed as possible)
+```powershell
+# insert configuration here
+```
+
+#### The operating system the target node is running
+<!--
+    Please provide as much as possible about the target node, for example
+    edition, version, build and language.
+    On OS with WMF 5.1 the following command can help get this information.
+
+    Get-ComputerInfo -Property @(
+        'OsName',
+        'OsOperatingSystemSKU',
+        'OSArchitecture',
+        'WindowsVersion',
+        'WindowsBuildLabEx',
+        'OsLanguage',
+        'OsMuiLanguages')
+-->
+
+#### Version and build of PowerShell the target node is running
+<!--
+    To help with this information, please run this command:
+    $PSVersionTable
+-->
+
+#### Version of the DSC module that was used ('dev' if using current dev branch)

.github/ISSUE_TEMPLATE/Resource_proposal.md

@@ -0,0 +1,21 @@
+---
+name: New resource proposal
+about: If you have a new resource proposal that you think should be added to this resource module.
+---
+<!--
+    Thank you for contributing and making this resource module better!
+
+    ISSUE TITLE:
+    Please prefix the issue title with a proposed resource name,
+    e.g. 'NewResourceName: New resource proposal'
+
+    ISSUE DESCRIPTION (this template):
+    Please propose the new resource under each header below.
+
+    PLEASE KEEP THE HEADERS, but you may remove this comment block.
+-->
+### Description
+
+### Proposed properties
+
+### Special considerations or limitations

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,21 +1,47 @@
 <!--
-Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project is greatly appreciated!
+    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. 'iSCSIVirtualDisk: My short description'
-If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:', i.e. 'BREAKING CHANGE: iSCSIVirtualDisk: My short description'
+    Please prefix the PR title with the resource name,
+    e.g. 'ResourceName: My short description'.
+    If this is a breaking change, then also prefix the PR title
+    with 'BREAKING CHANGE:',
+    e.g. 'BREAKING CHANGE: ResourceName: 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.
+    You may remove this comment block, and the other comment blocks, but please
+    keep the headers and the task list.
+-->
+#### Pull Request (PR) description
+<!--
+    Replace this comment block with a description of your 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 -->
+#### This Pull Request (PR) fixes the following issues
+<!--
+    If this PR does not fix an open issue, replace this comment block with None.
+    If this PR resolves one or more open issues, replace this comment block with
+    a list the issues using a GitHub closing keyword, e.g.:
+    - Fixes #123
+    - Fixes #124
+-->
 
-**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?
+#### Task list
+<!--
+    To aid community reviewers in reviewing and merging your PR, please take
+    the time to run through the below checklist and make sure your PR has
+    everything updated as required.
+
+    Change to [x] for each task in the task list that applies to your PR.
+    For those task that don't apply to you PR, leave those as is.
+-->
+- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
+      Entry should say what was changed, and how that affects users (if applicable).
+- [ ] Resource documentation added/updated in README.md in resource folder.
+- [ ] Resource parameter descriptions added/updated in schema.mof
+      and comment-based help.
+- [ ] Comment-based help added/updated.
+- [ ] Localization strings added/updated in all localization files as appropriate.
+- [ ] Examples appropriately added/updated.
+- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).

.github/stale.yml

@@ -0,0 +1,44 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+limitPerRun: 30
+
+pulls:
+  daysUntilStale: 14
+  daysUntilClose: false
+  exemptProjects: true
+  exemptMilestones: true
+  staleLabel: abandoned
+  exemptLabels:
+    - needs review
+    - on hold
+    - waiting for CLA pass
+
+  markComment: >
+    Labeling this pull request (PR) as abandoned since it has gone 14 days or more
+    since the last update. An abandoned PR can be continued by another contributor.
+    The abandoned label will be removed if work on this PR is taken up again.
+
+issues:
+  daysUntilStale: 30
+  daysUntilClose: 40
+  exemptProjects: true
+  exemptMilestones: true
+  staleLabel: stale
+  exemptLabels:
+    - bug
+    - enhancement
+    - tests
+    - documentation
+    - resource proposal
+    - on hold
+
+  markComment: >
+    This issue has been automatically marked as stale because
+    it has not had activity from the community in the last 30 days. It will be
+    closed if no further activity occurs within 10 days. If the issue is labelled
+    with any of the work labels (e.g bug, enhancement, documentation, or tests)
+    then the issue will not auto-close.
+
+  closeComment: >
+    This issue has been automatically closed because it is has not had activity
+    from the community in the last 40 days.

.vscode/analyzersettings.psd1

@@ -0,0 +1,53 @@
+@{
+    <#
+        For the custom rules to work, the DscResource.Tests repo must be
+        cloned. It is automatically clone as soon as any unit or
+        integration tests are run.
+    #>
+    CustomRulePath = '.\DSCResource.Tests\DscResource.AnalyzerRules'
+
+    IncludeRules   = @(
+        # DSC Resource Kit style guideline rules.
+        'PSAvoidDefaultValueForMandatoryParameter',
+        'PSAvoidDefaultValueSwitchParameter',
+        'PSAvoidInvokingEmptyMembers',
+        'PSAvoidNullOrEmptyHelpMessageAttribute',
+        'PSAvoidUsingCmdletAliases',
+        'PSAvoidUsingComputerNameHardcoded',
+        'PSAvoidUsingDeprecatedManifestFields',
+        'PSAvoidUsingEmptyCatchBlock',
+        'PSAvoidUsingInvokeExpression',
+        'PSAvoidUsingPositionalParameters',
+        'PSAvoidShouldContinueWithoutForce',
+        'PSAvoidUsingWMICmdlet',
+        'PSAvoidUsingWriteHost',
+        'PSDSCReturnCorrectTypesForDSCFunctions',
+        'PSDSCStandardDSCFunctionsInResource',
+        'PSDSCUseIdenticalMandatoryParametersForDSC',
+        'PSDSCUseIdenticalParametersForDSC',
+        'PSMisleadingBacktick',
+        'PSMissingModuleManifestField',
+        'PSPossibleIncorrectComparisonWithNull',
+        'PSProvideCommentHelp',
+        'PSReservedCmdletChar',
+        'PSReservedParams',
+        'PSUseApprovedVerbs',
+        'PSUseCmdletCorrectly',
+        'PSUseOutputTypeCorrectly',
+        'PSAvoidGlobalVars',
+        'PSAvoidUsingConvertToSecureStringWithPlainText',
+        'PSAvoidUsingPlainTextForPassword',
+        'PSAvoidUsingUsernameAndPasswordParams',
+        'PSDSCUseVerboseMessageInDSCResource',
+        'PSShouldProcess',
+        'PSUseDeclaredVarsMoreThanAssignments',
+        'PSUsePSCredentialType',
+
+        <#
+            This is to test all the DSC Resource Kit custom rules.
+            The name of the function-blocks of each custom rule start
+            with 'Measure*'.
+        #>
+        'Measure-*'
+    )
+}

.vscode/settings.json

@@ -10,5 +10,6 @@
     "powershell.codeFormatting.ignoreOneLineBlock": false,
     "powershell.codeFormatting.preset": "Custom",
     "files.trimTrailingWhitespace": true,
-    "files.insertFinalNewline": true
+    "files.insertFinalNewline": true,
+    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1"
 }

CHANGELOG.md

@@ -1,10 +1,21 @@
 # Versions
 
-## Unreleased
+## 1.5.1.0
 
 - Enabled PSSA rule violations to fail build - Fixes [Issue #27](https://github.com/PlagueHO/iSCSIDsc/issues/27).
 - Updated tests to meet Pester v4 standard.
 - Added Open Code of Conduct.
+- Refactored module folder structure to move resource
+  to root folder of repository and remove test harness - Fixes [Issue #36](https://github.com/PlagueHO/iSCSIDsc/issues/36).
+- Converted Examples to support format for publishing to PowerShell
+  Gallery.
+- Opted into common tests:
+  - Common Tests - Validate Example Files To Be Published
+  - Common Tests - Validate Markdown Links
+  - Common Tests - Relative Path Length
+  - Common Tests - Relative Path Length
+- Update to new format LICENSE.
+- Added .VSCode settings for applying DSC PSSA rules - fixes [Issue #37](https://github.com/PlagueHO/iSCSIDsc/issues/37).
 
 ## 1.5.0.0
 

Examples/Resources/iSCSIInitiator/1-iSCSIInitiator_ConfigureTargetPortal_Config.ps1

@@ -0,0 +1,49 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID b5db6465-b609-4e35-b7aa-ddc62efc8553
+.AUTHOR Daniel Scott-Raynsford
+.COMPANYNAME
+.COPYRIGHT (c) 2018 Daniel Scott-Raynsford. All rights reserved.
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PlagueHO/iSCSIDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PlagueHO/iSCSIDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module iSCSIDsc
+
+<#
+    .DESCRIPTION
+    This example starts the MSiSCSI service on a cluster node and then configures an iSCSI Target
+    Portal and then connects to the iSCSI Target.
+#>
+Configuration iSCSIInitiator_ConfigureTargetPortal_Config
+{
+    Import-DscResource -Module iSCSIDSc
+
+    Node localhost
+    {
+        Service iSCSIService
+        {
+            Name        = 'MSiSCSI'
+            StartupType = 'Automatic'
+            State       = 'Running'
+        }
+
+        iSCSIInitiator iSCSIInitiator
+        {
+            Ensure                 = 'Present'
+            NodeAddress            = 'iqn.1991-05.com.microsoft:fileserver01-cluster-target'
+            TargetPortalAddress    = '192.168.128.10'
+            InitiatorPortalAddress = '192.168.128.20'
+            IsPersistent           = $true
+            iSNSServer             = 'isns.contoso.com'
+            DependsOn              = "[Service]iSCSIService"
+        } # End of iSCSIInitiator Resource
+    } # End of Node
+} # End of Configuration