Update to commenting and verbose logging

Author: david-brett

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,11 +28,5 @@ If applicable, add screenshots to help explain your problem.
  - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
 **Additional context**
 Add any other context about the problem here.

.gitignore

@@ -1 +1,49 @@
+# bretty.me.uk Defined
+
+# Local Testing for XML File Generation
 *.xml
+
+#VSCode
+
+# vscode General
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Mac OS
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

CitrixOptimizerAutomation/CitrixOptimizerAutomation.psd1

@@ -1,5 +1,5 @@
 #
-# Module manifest for module 'Nutanix.Prism.Central'
+# Module manifest for module 'CitrixOptimizerAutomation'
 #
 # Generated by: David Brett
 #
@@ -101,7 +101,7 @@ PrivateData = @{
         LicenseUri = 'https://github.com/dbretty/CitrixOptimizer/blob/main/LICENSE'
 
         # A URL to the main website for this project.
-        ProjectUri = 'https://bretty.me.uk/CitrixOptimizer'
+        ProjectUri = 'https://bretty.me.uk/citrixoptimizerautomation'
 
         # A URL to an icon representing this module.
         # IconUri = ''

CitrixOptimizerAutomation/CitrixOptimizerAutomation.psm1

@@ -1,7 +1,3 @@
-<# INSERT HEADER ABOVE #>
-
-#Get public and private function definition files.
-
 #Requires -Version 5.1
 
 $Public  = @( Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 -ErrorAction SilentlyContinue )
@@ -21,5 +17,4 @@ Foreach($import in @($Public + $Private))
     }
 }
 
-Export-ModuleMember -Function $Public.Basename
-<# INSERT FOOTER BELOW #>
+Export-ModuleMember -Function $Public.Basename

CitrixOptimizerAutomation/Private/Get-TaskDetail.ps1

@@ -16,7 +16,7 @@ function Get-TaskDetail {
     Returns a custom PSObject with the Path and TaskName values
 
     .EXAMPLE
-    PS> Get-TaskDetail TaskPath '/Microsoft/Windows/AppID'
+    PS> Get-TaskDetail -TaskPath '/Microsoft/Windows/AppID'
     Decodes the Task Path passed in to a Task Path and Task Name.
 #>
 
@@ -57,6 +57,7 @@ process {
 
 end {
 
+    # Pass back return object
     return $Return
 
 } # end

CitrixOptimizerAutomation/Private/Get-Template.ps1

@@ -1,10 +1,10 @@
 function Get-Template {
     <#
     .SYNOPSIS
-    Checks if a template already exists.
+    Checks if a Citrix Optimizer template already exists.
 
     .DESCRIPTION
-    This function will take in a template file path and check if that template already exists.
+    This function will take in a Citrix Optimizer template file path and check if that template already exists.
     
     .PARAMETER Path
     Specifies the Path to the template file
@@ -13,7 +13,7 @@ function Get-Template {
     This function will take inputs via pipeline as string
 
     .OUTPUTS
-    Returns true or false base on the result of the template lookup
+    Returns true or false base on the result of the Citrix Optimizer template lookup
 
     .EXAMPLE
     PS> Get-Template -Path 'template.xml'
@@ -37,12 +37,14 @@ begin {
 
 process {
 
+    # Check for the existence of the template file
     $Return = Test-Path $Path
 
 } # process
 
 end {
 
+    # Pass back return object
     return $Return
 
 } # end

CitrixOptimizerAutomation/Private/Get-TemplateEntry.ps1

@@ -1,10 +1,10 @@
 function Get-TemplateEntry {
     <#
     .SYNOPSIS
-    Checks if a template entry already exists.
+    Checks if a template <entry> already exists.
 
     .DESCRIPTION
-    This function will take in a template file path and entry name check if the entry already exists.
+    This function will take in a template file path and entry name check if the <entry> already exists.
     
     .PARAMETER Path
     Specifies the XML template path
@@ -16,7 +16,7 @@ function Get-TemplateEntry {
     This function will take inputs via pipeline as string
 
     .OUTPUTS
-    Returns true or false base on the result of the template group lookup
+    Returns true or false base on the result of the template entry lookup
 
     .EXAMPLE
     PS> Get-TemplateEntry -Path $Path -EntryName 'Disable Print Spooler'
@@ -44,16 +44,23 @@ begin {
 
 process {
 
+    # Set the default return value
     $Return = $false
+
+    # Get the contents of the XML file passed in
     [XML]$xmlentries = Get-Content $Path
 
+    # Check if there are no entries yet and return false
     if(($xmlentries.SelectNodes("/root//group//entry")).Count -eq 0){
         $Return = $false
     } else {
+        # Get the entry name details from the XML variable
         $Entries = $xmlentries.SelectNodes("/root//group//entry") | where-object {$_.name -eq $($EntryName)}
         if($Null -eq $Entries){
+            # Entry not found, return false
             $Return = $false
         } else {
+            # Entry already in XML variable, return true
             $Return = $true 
         } 
     }
@@ -62,6 +69,7 @@ process {
 
 end {
 
+    # Pass back return object
     return $Return
 
 } # end

CitrixOptimizerAutomation/Private/Get-TemplateGroup.ps1

@@ -1,10 +1,10 @@
 function Get-TemplateGroup {
     <#
     .SYNOPSIS
-    Checks if a template group already exists.
+    Checks if a template <group> already exists.
 
     .DESCRIPTION
-    This function will take in a template file path and group name check if the group already exists.
+    This function will take in a template file path and group name check if the <group> already exists.
     
     .PARAMETER Path
     Specifies the XML template path
@@ -19,7 +19,7 @@ function Get-TemplateGroup {
     Returns true or false base on the result of the template group lookup
 
     .EXAMPLE
-    PS> Get-TemplateGroup -Path $xmlFile.path -GroupName 'Group1'
+    PS> Get-TemplateGroup -Path 'template.xml' -GroupName 'Group1'
     Checks for 'Group1' in template.xml.
 #>
 
@@ -44,15 +44,22 @@ begin {
 
 process {
 
+    # Set the default return value
     $Return = $false
+
+    # Get the contents of the XML file passed in
     [XML]$xmlgroups = Get-Content $Path
 
+    # Check if there are no groups yet and return false
     if(($xmlgroups.SelectNodes("/root//group")).Count -eq 0){
         $Return = $false
     } else {
+        # Get the group name details from the XML variable
         if($null -eq ($xmlfile.root.group | where-object {$_.id -eq $($GroupName)})){
+            # Group not found, return false
             $Return = $false
         } else {
+            # Group already in XML variable, return true
             $Return = $true 
         } 
     }
@@ -61,6 +68,7 @@ process {
 
 end {
 
+    # Pass back return object
     return $Return
 
 } # end

CitrixOptimizerAutomation/Public/New-CitrixTemplate.ps1

@@ -69,15 +69,16 @@ begin {
 
 process {
 
+    # Check if the template already exists
     if(!(Get-Template -Path $Path)){
 
-        # Set The Formatting
+        # Set the XML Formatting
         write-verbose "Set the XML formatting"
         $xmlsettings = New-Object System.Xml.XmlWriterSettings
         $xmlsettings.Indent = $true
         $xmlsettings.IndentChars = "  "
 
-        # Set the File Name Create The Document
+        # Set the XML File Name Create The Document
         write-verbose "Create Base XML Template for Citrix Optimizer"
         $XmlWriter = [System.XML.XmlWriter]::Create($Path, $xmlsettings)
 
@@ -91,7 +92,7 @@ process {
         $xmlWriter.WriteAttributeString("xmlns", "xsi", $null, "http://www.w3.org/2001/XMLSchema-instance")
 
             # Start the Metadata Element
-            write-verbose "Write metadata element  for Citrix Optimizer Template"
+            write-verbose "Write metadata element for the Citrix Optimizer Template"
             $xmlWriter.WriteStartElement("metadata") 
 
             # Write Metadata details
@@ -137,7 +138,7 @@ process {
 
 end {
 
-    # Return result
+    # Add the template path and pass back return object
     $Return | Add-Member -MemberType NoteProperty -Name "Path" -Value $Path
     return $Return
 

CitrixOptimizerAutomation/Public/New-CitrixTemplateGroup.ps1

@@ -4,7 +4,7 @@ function New-CitrixTemplateGroup {
     Creates a new Group in the Citrix Optimizer template.
 
     .DESCRIPTION
-    This function will create a Group in the Citrix Optimizer template. First it will check if that group exists, if not it will add it.
+    This function will create a Group in the Citrix Optimizer template. First it will check if that <group> exists, if not it will add it.
     
     .PARAMETER Path
     Specifies the Path to the template file
@@ -62,6 +62,7 @@ begin {
 
 process {
 
+    # Check if the template already exists
     if(Get-Template -Path $Path){
 
         write-verbose "Citrix Optimizer Template $($Path) found"
@@ -70,44 +71,53 @@ process {
         # Load Template and check for existing Group"
         [XML]$xmlfile = Get-Content $Path
 
+        # Check that the template group does not exist
         if(!(Get-TemplateGroup -Path $Path -GroupName $GroupName)){
 
             write-verbose "No existing Groups found, adding new group"
 
+            # Create the Group element
             write-verbose "Create Group element"
             $Group = $XMLFile.CreateElement("group")
 
+            # Create the ID element
             write-verbose "Create ID element"
             $ID = $XMLFile.CreateElement("id")
             $ID.InnerText = $GroupName
             $Group.AppendChild($ID)   
 
+            # Create the display name element
             write-verbose "Create DisplayName element"
             $Name = $XMLFile.CreateElement("displayname")
             $Name.InnerText = $GroupName
             $Group.AppendChild($Name)   
 
+            # Create the description element
             write-verbose "Create Description element"
             $Description = $XMLFile.CreateElement("description")
             $Description.InnerText = $GroupDescription
             $Group.AppendChild($Description)   
 
+            # Append the group ID element to the Group and save the XML file
             write-verbose "Add Group to Citrix Optimizer XML Template"
             $XMLFile.LastChild.AppendChild($Group)
             $XMLFile.Save($Path) 
 
+            # Add the GroupName to the return object
             $Return | Add-Member -MemberType NoteProperty -Name "GroupName" -Value $GroupName
             $Return.Complete = $true
 
         } else {
-    
+            
+            # Group already exists
             write-verbose "Group $($GroupName) already exists - quitting"
             write-error "Group $($GroupName) already exists - quitting"
 
         }
 
     } else {
 
+        # Template file not found
         write-verbose "Citrix Optimizer Template $($Path) not found - quitting"
         write-error "Citrix Optimizer Template $($Path) not found - quitting"
 
@@ -117,6 +127,7 @@ process {
 
 end {
 
+    # Pass back return object
     return $Return
 
 } # end