Merge pull request #212 from PowershellFrameworkCollective/DscModule

2.2.13.176

Author: FriedrichWeinmann

PSModuleDevelopment/PSModuleDevelopment.psd1

@@ -5,7 +5,7 @@
 
 	# Version number of this module.
 
-	ModuleVersion = '2.2.12.172'
+	ModuleVersion = '2.2.13.176'
 
   # ID used to uniquely identify this module
 	GUID = '37dd5fce-e7b5-4d57-ac37-832055ce49d6'

PSModuleDevelopment/changelog.md

@@ -1,8 +1,10 @@
 # Changelog
 
-## ???
+## 2.2.13.176 (2025-05-04)
 
 + New: Template AzureFunctionEventGrid - dedicated endpoint template for an EventGrid function
++ New: Template DscClassFile - a script file with a scaffold for individual DSC Resources. Intended for use with the DscModule template.
++ New: Template DscModule - a module designed to host one or multiple DSC Resources
 + Upd: Template AzureFunction - now also builds EventGrid triggers.
 
 ## 2.2.12.172 (2024-10-06)

templates/DscClassFile/PSMDInvoke.ps1

@@ -0,0 +1,5 @@
+param (
+	$Path
+)
+
+New-PSMDTemplate -FilePath "$PSScriptRoot\þnameþ.ps1" -TemplateName DscClassFile -OutPath $Path -Description "A DSC Resource Class definition" -Author "Friedrich Weinmann" -Tags 'function','file'

templates/DscClassFile/þnameþ.ps1

@@ -0,0 +1,71 @@
+[DscResource()]
+class þnameþ {
+	#region DSC Properties
+	<#
+	The properties you can define in configuration settings.
+	The [DscProperty(...)] attribute has a few possible values:
+	- <empty>: Nothing specified makes this an optional property you can leave empty when defining the configuration setting.
+	- Mandatory: A Property that MUST be set when defining the configuration setting.
+	- Key: The property is considered as the identifier for the resource modified. It is mandatory AND there cannot be multiple configuration entries with the same value for this property!
+	- NotConfigurable: ReadOnly property. Mostly used for integration into Azure Guest Configurations
+
+	Example Properties:
+
+    [DscProperty(Key)]
+    [string]$Path
+
+    [DscProperty(Mandatory)]
+    [string]$Text
+
+    [DscProperty(Mandatory)]
+    [Ensure]$Ensure
+	#>
+
+	[DscProperty(NotConfigurable)]
+	[Reason[]] $Reasons # Reserved for Azure Guest Configuration
+	#endregion DSC Properties
+
+    [void]Set() {
+        # Apply Desired State
+    }
+
+    [þnameþ]Get() {
+		# Return current actual state
+    }
+
+    [bool]Test() {
+        # Check whether current state = desired state
+    }
+
+	[Hashtable] GetConfigurableDscProperties()
+    {
+        # This method returns a hashtable of properties with two special workarounds
+        # The hashtable will not include any properties marked as "NotConfigurable"
+        # Any properties with a ValidateSet of "True","False" will beconverted to Boolean type
+        # The intent is to simplify splatting to functions
+        # Source: https://gist.github.com/mgreenegit/e3a9b4e136fc2d510cf87e20390daa44
+        $dscProperties = @{}
+        foreach ($property in [þnameþ].GetProperties().Name)
+        {
+            # Checks if "NotConfigurable" attribute is set
+            $notConfigurable = [þnameþ].GetProperty($property).GetCustomAttributes($false).Where({ $_ -is [System.Management.Automation.DscPropertyAttribute] }).NotConfigurable
+            if (!$notConfigurable)
+            {
+                $value = $this.$property
+                # Gets the list of valid values from the ValidateSet attribute
+                $validateSet = [þnameþ].GetProperty($property).GetCustomAttributes($false).Where({ $_ -is [System.Management.Automation.ValidateSetAttribute] }).ValidValues
+                if ($validateSet)
+                {
+                    # Workaround for boolean types
+                    if ($null -eq (Compare-Object @('True', 'False') $validateSet))
+                    {
+                        $value = [System.Convert]::ToBoolean($this.$property)
+                    }
+                }
+                # Add property to new
+                $dscProperties.add($property, $value)
+            } 
+        }
+        return $dscProperties
+    }
+}

templates/DscModule/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

templates/DscModule/.github/workflows/build.yml

@@ -0,0 +1,24 @@
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Prerequisites
+      run: .\build\vsts-prerequisites.ps1
+      shell: powershell
+    - name: Validate
+      run: .\build\vsts-validate.ps1
+      shell: powershell
+    - name: Build
+      run: .\build\vsts-build.ps1 -ApiKey $env:APIKEY
+      shell: powershell
+      env:
+        APIKEY: ${{ secrets.ApiKey }}

templates/DscModule/.github/workflows/validate.yml

@@ -0,0 +1,15 @@
+on: [pull_request]
+
+jobs:
+  validate:
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Prerequisites
+      run: .\build\vsts-prerequisites.ps1
+      shell: powershell
+    - name: Validate
+      run: .\build\vsts-validate.ps1
+      shell: powershell

templates/DscModule/.gitignore

@@ -0,0 +1,2 @@
+publish
+TestResults

templates/DscModule/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) þ!year!þ þauthorþ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

templates/DscModule/PSMDInvoke.ps1

@@ -0,0 +1,4 @@
+param (
+	$Path
+)
+New-PSMDTemplate -ReferencePath "$PSScriptRoot" -OutPath $Path