Downloads:

1,574

Downloads of v 0.9.53:

366

Last Update:

08 Nov 2014

Package Maintainer(s):

Software Author(s):

  • Glenn Sarti

Tags:

posh powershell puppet

Posh Puppet Reports

This is not the latest version of Posh Puppet Reports available.

0.9.53 | Updated: 08 Nov 2014

Downloads:

1,574

Downloads of v 0.9.53:

366

Maintainer(s):

Software Author(s):

  • Glenn Sarti

Posh Puppet Reports 0.9.53

This is not the latest version of Posh Puppet Reports available.

All Checks are Unknown

2 Test of Unknown Status


Validation Testing Unknown


Verification Testing Unknown

To install Posh Puppet Reports, run the following command from the command line or from PowerShell:

>

To upgrade Posh Puppet Reports, run the following command from the command line or from PowerShell:

>

To uninstall Posh Puppet Reports, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade poshpuppetreports -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade poshpuppetreports -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure poshpuppetreports installed
  win_chocolatey:
    name: poshpuppetreports
    state: present
    version: 0.9.53
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'poshpuppetreports' do
  action    :install
  version  '0.9.53'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: poshpuppetreports,
    Version: 0.9.53,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller poshpuppetreports
{
   Name     = 'poshpuppetreports'
   Ensure   = 'Present'
   Version  = '0.9.53'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'poshpuppetreports':
  provider => 'chocolatey',
  ensure   => '0.9.53',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install poshpuppetreports version="0.9.53" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator ferventcoder on 16 Nov 2014.

Description

Powershell scripts to convert Puppet YAML reports into different formats (HTML, TeamCity events), and includes a GUI to convert reports on the fly


tools\chocolateyInstall.ps1
$packageName = 'poshpuppetreports' # arbitrary name for the package, used in messages

try { 
  $installDir = Join-Path (Join-Path $PSHome "Modules") "POSHPuppetReports"

  $sourceDir = Join-Path (Split-Path -parent $MyInvocation.MyCommand.Definition) "module"

  # Copy the folder to the powershell modules directory
  [void] (Copy-Item -Path $sourceDir -Destination $installDir -Recurse -Confirm:$false -Force -ErrorAction 'Stop')
  
  # Create a shortcut for the reports into the "Start Menu"
  $shortcutPath = ([Environment]::GetFolderPath('CommonStartMenu')) + '\POSH Puppet Reports\Report GUI.lnk'
  if (! (Test-Path $shortcutPath)) {
    Write-Debug 'Creating shortcut folder...'
    [void](New-Item -Path $shortcutPath -ItemType Directory -Force)
  }
  $shortcutFile = $shortcutPath + '\Puppet Report GUI.lnk'  
  $targetPath = '%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe'  

  # TODO: Waiting on FerventCoder to release new chocolatey package with the Install-ChocolateyShortcut function available. Until then, use old-school WScript.
  #Install-ChocolateyShortcut -shortcutFilePath $shortcutPath -targetPath $targetPath  
  $WshShell = New-Object -ComObject WScript.Shell
  $Shortcut = $WshShell.CreateShortcut($shortcutFile)
  $Shortcut.TargetPath = $targetPath
  $Shortcut.Arguments = "`"& { . '$($installDir)\reportgui\reportgui.ps1'}`""
  $Shortcut.Save()
  
  
  # Add in the file assocication and command for YAML files...
  $fileExtRegKey = "HKEY_LOCAL_MACHINE\SOFTWARE\Classes\.yaml"

  # Create the file extension if it doesn't exist
  if (! (Test-Path -Path "Registry::$($fileExtRegKey)")) {
    [void](New-Item -Path "Registry::$($fileExtRegKey)")
  }
  
  # Create the file association to extension if it doesn't exist
  [string]$yamlFileClass = ""
  try
  {
    $yamlFileClass = (Get-ItemProperty -Path "Registry::$($fileExtRegKey)").PSObject.Properties["(default)"].Value.ToString();
  }
  catch
  {
    $yamlFileClass = ""
  }
  if ($yamlFileClass -eq "") {
    $yamlFileClass = "YAMLFile"
    [void](Set-Item -Path "Registry::$($fileExtRegKey)" -Value $yamlFileClass)
  }
  $fileAssocRegKey = "HKEY_LOCAL_MACHINE\SOFTWARE\Classes\$yamlFileClass"
  
  # Create the file association if it doesn't exist
  if (! (Test-Path -Path "Registry::$($fileAssocRegKey)")) {  
    [void](New-Item -Path "Registry::$($fileAssocRegKey)")
  }
  # Create the file association name
  try
  {
    $ignoreThis = (Get-ItemProperty -Path "Registry::$($fileAssocRegKey)").PSObject.Properties["(default)"].Value.ToString();
  }
  catch
  {
    [void](Set-Item -Path "Registry::$($fileAssocRegKey)" -Value "YAML Ain't Markup Language File")
  }
  
  # Now the basic YAML file stuff is associated, just splat in the Puppet Report Viewer bits...
  [void](New-Item -Path "Registry::$($fileAssocRegKey)\Shell" -ErrorAction "Ignore")
  [void](New-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer" -ErrorAction "Ignore")
  [void](Set-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer" -Value "Open in Puppet Report Viewer"  -ErrorAction "Ignore" -Force -Confirm:$false)
  [void](New-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer\Command" -ErrorAction "Ignore")
  [void](Set-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer\Command" -ErrorAction "Ignore" -Force -Confirm:$false `
         -Value "$($targetPath) `"& { . '$($installDir)\reportgui\reportgui.ps1' '%1'}`"" -Type 'ExpandString')
    
  Write-ChocolateySuccess "$packageName"
} catch {
  Write-ChocolateyFailure "$packageName" "$($_.Exception.Message)"
  throw 
}

tools\chocolateyUninstall.ps1
$packageName = 'poshpuppetreports' # arbitrary name for the package, used in messages

try { 
  $installDir = Join-Path (Join-Path $PSHome "Modules") "POSHPuppetReports"

  # Remove the folder from the powershell modules directory
  if (Test-Path  $installDir) {
    [void] (Remove-Item $installDir -Recurse -Confirm:$false -Force -ErrorAction 'Stop')
  }
  else
  {
    Write-Debug "Installation directory doesn't exist"
  }

  # Removing shortcuts for the reports into the "Start Menu"
  $shortcutPath = ([Environment]::GetFolderPath('CommonStartMenu')) + '\POSH Puppet Reports\Report GUI.lnk'
  if (Test-Path $shortcutPath) {
    [void] (Remove-Item $shortcutPath -Recurse -Confirm:$false -Force -ErrorAction 'Stop')
  }

  # Remove the file assocication and command for YAML files...
  $fileExtRegKey = "HKEY_LOCAL_MACHINE\SOFTWARE\Classes\.yaml"
  # Create the file extension if it doesn't exist
  if (Test-Path -Path "Registry::$($fileExtRegKey)") {
    [string]$yamlFileClass = ""
    try
    {
      $yamlFileClass = (Get-ItemProperty -Path "Registry::$($fileExtRegKey)").PSObject.Properties["(default)"].Value.ToString();
    }
    catch
    {
      $yamlFileClass = ""
    }
    if ($yamlFileClass -ne "") {
      $fileAssocRegKey = "HKEY_LOCAL_MACHINE\SOFTWARE\Classes\$yamlFileClass"      
      [void](Remove-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer\Command" -ErrorAction "Ignore" -Confirm:$false -Force)
      [void](Remove-Item -Path "Registry::$($fileAssocRegKey)\Shell\OpenWithPOSHPuppetReportViewer" -ErrorAction "Ignore"  -Confirm:$false -Force)
    }
  }

  Write-ChocolateySuccess "$packageName"
} catch {
  Write-ChocolateyFailure "$packageName" "$($_.Exception.Message)"
  throw 
}

tools\module\ConvertFrom-PuppetReport.ps1
function ConvertFrom-PuppetReport {
  [cmdletBinding(SupportsShouldProcess=$false,ConfirmImpact='Low')]
  param(
    [Parameter(Mandatory=$true,ValueFromPipeline=$true)]
    [string[]]$Report

    ,[Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [string[]]$Transform

    ,[Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [string]$TransformDir = ''

    ,[Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [string]$OutputDir

    ,[Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [switch]$OutputXML = $false

    ,[Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [switch]$TeeToWriteHost = $false

  )
  
  Begin {
    # References
    # Report v3/4 Reference for Puppet 2.7.x and 3.x
    # http://docs.puppetlabs.com/puppet/3/reference/format_report.html

    # Fatal Sanity Checks
    #   Can't check for piped output until the Process section
    if ($TransformDir -eq '') { $TransformDir = "$PSScriptRoot\..\transforms" }
    if ($Transform -eq '') { Throw 'No transform was specified'; return; }
    $Transform | % {
      if (!(Test-Path "$TransformDir\$($_).xsl")) { Throw ('Transform file ' + $_ + '.xsl does not exist'); return; }
    }
    if ($OutputDir -ne '') {
      if (!(Test-Path $OutputDir)) { Throw ('Output directory of ' + $OutputDir + ' does not exist'); return; }
    }
  }
  
  Process {
    # Somewhat fatal Sanity Checks
    if ($Report -eq '') { Throw 'No puppet report file was specified'; return; }
    if (!(Test-Path $Report)) { Throw ('Report file ' + $Report + ' does not exist'); return; }

    # Process the report and transforms...
    $yamlFile = $Report

    try {
      Write-Verbose "Reading $yamlFile ..."
      $objYaml = Get-Yaml -FromFile $yamlFile -ErrorAction Stop
  
      $xmlDoc = [xml]"<report />"
      Write-Verbose "Creating Resource Status Summary XML..."
      Write-ResourceStatusSummary $objYaml $xmlDoc
      
      # TODO: Write out the Metric.Time table to determine the total time
      
      Write-Verbose "Creating Resource Status XML..."
      Write-ResourceStatus $objYaml $xmlDoc
  
      if ($OutputXML) {    
        $filename = Join-Path -Path $OutputDir -ChildPath ( (Get-ChildItem $yamlFile).BaseName + '.xml')
        Write-Verbose "Writing XML to $filename ..."
        $xmlDoc.innerXml | Out-File $filename -Encoding ASCII -Force -Confirm:$false
      }
  
      $Transform | % {
        $transformFile = "$TransformDir\$($_).xsl"
        $filename = Join-Path -Path $OutputDir -ChildPath ( (Get-ChildItem $yamlFile).BaseName + '.' + $_)
        Write-Verbose "Applying transform $transformFile , output to $filename ..."
        [void] (Transform-XML -XMLDocument $xmlDoc -transformFilename $transformFile | Out-File $filename -Force -Confirm:$false )
        
        if ($TeeToWriteHost) {
          # TODO Write out the file content to Write-Host.  Useful if the caller is trapping Stdout
        }
  
        Write-Output $filename
      }
    }
    catch
    {
      Write-Verbose ("ERROR " + $_.ToString())
      Throw $_
      return ;
    }
  }
  
  End {
  }
  
 }
tools\module\POSHPuppetReports.psd1
 
tools\module\POSHPuppetReports.psm1
# Import this modules functions etc.
Get-ChildItem -Path $PSScriptRoot | Unblock-File
Get-ChildItem -Path $PSScriptRoot\*.ps1 | ForEach-Object {
  Write-Verbose "Importing $($_.Name)..."
  . ($_.Fullname)
}
tools\module\reportgui\Get-WPFControl.ps1
function Get-WPFControl {
  [cmdletBinding(SupportsShouldProcess=$false,ConfirmImpact='Low')]
  param(
    [Parameter(Mandatory=$true,ValueFromPipeline=$true)]
    [string]$ControlName

    ,[Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [System.Windows.Window]$Window
  )  
  Process {
    Write-Output $Window.FindName($ControlName)
  }
}

tools\module\reportgui\Invoke-ConvertReport.ps1
Function Invoke-ConvertReport() {
  [cmdletBinding(SupportsShouldProcess=$false,ConfirmImpact='Low')]
  param(
    [Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [string]$YAMLFilename

    ,[Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [string]$TransformFilename

    ,[Parameter(Mandatory=$true,ValueFromPipeline=$false)]
    [string]$TransformParentPath

    ,[Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [object]$WPFWindow = $null
  )  
  Process {
    $outputDir = ($Env:Temp)
    
    $resultContent = (ConvertFrom-PuppetReport -Report $YAMLFilename -Transform $TransformFilename -TransformDir $TransformParentPath -OutputDir $outputDir -Verbose:($VerbosePreference -eq 'Continue'))
    $fileContent = [IO.File]::ReadAllText($resultContent)

    if ($TransformFilename.EndsWith('.stdout')) {
      $fileContent = "<html><body><pre>" + $fileContent + "</pre></body></html>"
    }
    if ($WPFWindow -ne $null) {
      (Get-WPFControl 'reportBrowser' -Window $WPFWindow).NavigateToString($fileContent)
    }
    Write-Verbose "Removing temporary file $resultContent ..."
    [void](Remove-Item -Path $resultContent -Force -Confirm:$false)
  }
}
tools\module\reportgui\Invoke-ShowMainWindow.ps1
Function Invoke-ShowMainWindow() {
  [cmdletBinding(SupportsShouldProcess=$false,ConfirmImpact='Low')]
  param(
    [Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [AllowEmptyString()]
    [string]$autoloadTransform = ""

    ,[Parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [AllowEmptyString()]
    [string]$AutoloadReport = ""
  )  
  Process {
    # Load XAML from the external file
    Write-Verbose "Loading the window XAML..."
    [xml]$xaml = (Get-Content (Join-Path -Path $global:ScriptDirectory -ChildPath 'reportgui.xaml'))
    
    # Build the GUI
    Write-Verbose "Parsing the window XAML..."
    $reader = (New-Object System.Xml.XmlNodeReader $xaml)
    $thisWindow = [Windows.Markup.XamlReader]::Load($reader)

    # Wire up the XAML
    Write-Verbose "Adding XAML event handlers..."
    (Get-WPFControl 'buttonBrowseReportPath' -Window $thisWindow).Add_Click({
      # TODO Perhaps create a wizard to enter a server name and automatically create a UNC to the default puppet path? \\<server>\c$\ProgramData....
      $dialogWindow = New-Object System.Windows.Forms.FolderBrowserDialog -Property @{
        SelectedPath = (Get-WPFControl 'textReportPath' -Window $thisWindow).Text;
        ShowNewFolderButton = $false;
        Description = "Browse for Puppet Report path";
      }
      
      $result = $dialogWindow.ShowDialog()
      
      if ($result.ToString() -eq 'Ok') {
        (Get-WPFControl 'textReportPath' -Window $thisWindow).Text = $dialogWindow.SelectedPath
      }
    })
    (Get-WPFControl 'buttonConnect' -Window $thisWindow).Add_Click({
      $location = ((Get-WPFControl 'textReportPath' -Window $thisWindow).Text)
      
      if (Test-Path -Path $location) {
        # Remove the PuppetReports Drive if it exists...
        (Get-PSDrive 'PuppetReports' -ErrorAction 'SilentlyContinue' | Remove-PSDrive)
        # Create a PuppetReports: drive
        [void](New-PSDrive -Name 'PuppetReports' -PSProvider FileSystem -Root $location -Scope Script)
      
        # Populate the list box
        Write-Verbose 'Populating the report list...'
        [xml]$xmlDoc = '<reports xmlns=""></reports>'
       	Get-Item -Path 'PuppetReports:\*.yaml' | Sort-Object ($_.LastWriteTime) -Descending | % {
       	  $xmlNode = $xmlDoc.CreateElement('report')
       	  $xmlNode.SetAttribute('name',$_.name.ToString())
       	  $xmlNode.SetAttribute('datemodified',($_.LastWriteTime.ToString('dd MMM yyyy HH:mm:ss')))
       	  $xmlNode.innerText = ($_.FullName)
       	  $xmlDoc.reports.AppendChild($xmlNode)
        }
        # Write the xml document to the XAML for databinding
        (Get-WPFControl 'xmlReportList' -Window $thisWindow).Document = $xmlDoc
      
        Write-Verbose 'Expanding the report list'
        # Expand the Reports List
        (Get-WPFControl 'expandReportList' -Window $thisWindow).IsExpanded = $true   
        # Contract the Report Location
        (Get-WPFControl 'expandReportLocation' -Window $thisWindow).IsExpanded = $false
        
        $thisWindow.Title = "Puppet Report Viewer - $location"
      }
      else
      {
        [void] ([System.Windows.MessageBox]::Show('The report path does not exist','Error','Ok','Information'))
        return
      }
    })
    (Get-WPFControl 'listReports' -Window $thisWindow).Add_MouseDoubleClick({
      param($sender,$e)
    
      # Parse the control tree looking for the descendant ListViewItem
    	$originalSource = [System.Windows.DependencyObject]$e.OriginalSource;
      while ( ($originalSource -ne $null) -and ($originalSource.GetType().ToString() -ne 'System.Windows.Controls.ListViewItem') )  {
      	$originalSource = [System.Windows.Media.VisualTreeHelper]::GetParent($originalSource)
      }
      if ($originalSource -eq $null) { return; }
      
      # Get the data context (XMLElement)
      $dc = $originalSource.DataContext
      $reportName = ($dc."#text")
    	
      # Get the template name
      $index = (Get-WPFControl 'comboReportList' -Window $thisWindow).selectedIndex
      if ($index -eq -1) {  # No transform has been selected
        [void] ([System.Windows.MessageBox]::Show('Please select a Report Type to use','Error','Ok','Information'))
        return;
      }
      $transformName = (Get-WPFControl 'comboReportList' -Window $thisWindow).Items[$index]
      
      # Actually do the conversion
      Write-Verbose "Parsing report $($reportName) with transform $($transformName)..."
      Invoke-ConvertReport -YAMLFilename $reportName -TransformFilename $transformName -TransformParentPath $transformPath -WPFWindow $thisWindow
      Write-Verbose "Conversion finished..."
    })

    # Populate XAML items
    Write-Verbose "Populating XAML controls..."
    Get-ChildItem -Path $transformPath | % {
      $transfromName = ($_.Name) -replace '.xsl',''
      [void]( (Get-WPFControl 'comboReportList' -Window $thisWindow).Items.Add($transfromName) )
    }
    
    # Show the readme or autoload a report if specified
    if ( ($autoloadReport -ne "") -and ($autoloadTransform -ne "") )
    {
      Write-Verbose "Converting the report $($autoloadReport) with transform $($autoloadTransform) specified on the command line..."
      Invoke-ConvertReport -YAMLFilename $autoloadReport -TransformFilename $autoloadTransform -TransformParentPath $transformPath -WPFWindow $thisWindow
      Write-Verbose "Conversion finished..."
      
      # Set the UI to specified report path and transform name
      (Get-WPFControl 'textReportPath' -Window $thisWindow).Text = (Split-Path -Path $autoloadReport -Parent)  
      $comboBox = (Get-WPFControl 'comboReportList' -Window $thisWindow)
      for($index = 0; $index -lt $comboBox.Items.Count; $index++) {
        if ($comboBox.Items[$index] -eq $autoloadTransform) {
          $comboBox.SelectedIndex = $index
          break
        }
      }  
    }
    else
    {
      $readMe = $global:ScriptDirectory + '\reportgui.readme.html'
      if (Test-Path -Path $readMe) {
        Write-Verbose "Displaying ReadMe..."
        (Get-WPFControl 'reportBrowser' -Window $thisWindow).NavigateToString( ([IO.File]::ReadAllText($readMe) ) )
      }
    }

    # Show the GUI
    Write-Verbose "Showing the window..."
    [void]($thisWindow.ShowDialog())
    Write-Verbose "Cleanup..."
    $thisWindow.Close()
    $thisWindow = $null
  }
}
tools\module\reportgui\Invoke-ShowSelectTransformWindow.ps1
Function Invoke-ShowSelectTransformWindow() {
  [cmdletBinding(SupportsShouldProcess=$false,ConfirmImpact='Low')]
  param(
  )  
  Process {
    # Load XAML from the external file
    Write-Verbose "Loading the Select Transform window XAML..."
    [xml]$xaml = (Get-Content (Join-Path -Path $global:ScriptDirectory -ChildPath 'selecttransform.xaml'))
    
    # Build the GUI
    Write-Verbose "Parsing the window XAML..."
    $reader = (New-Object System.Xml.XmlNodeReader $xaml)
    $thisWindow = [Windows.Markup.XamlReader]::Load($reader)

    # Wire up the XAML
    (Get-WPFControl 'listTransforms' -Window $thisWindow).Add_MouseDoubleClick({
      param($sender,$e)
    
      # Parse the control tree looking for the descendant ListViewItem
    	$originalSource = [System.Windows.DependencyObject]$e.OriginalSource;
      while ( ($originalSource -ne $null) -and ($originalSource.GetType().ToString() -ne 'System.Windows.Controls.ListViewItem') )  {
      	$originalSource = [System.Windows.Media.VisualTreeHelper]::GetParent($originalSource)
      }
      if ($originalSource -eq $null) { return; }
      
      $thisWindow.DialogResult = "ok"
    })
    (Get-WPFControl 'buttonUseTransform' -Window $thisWindow).Add_Click({
      $listView = (Get-WPFControl 'listTransforms' -Window $thisWindow)      
      if ($listView.SelectedItem -eq $null) {
        [void] ([System.Windows.MessageBox]::Show('Please select a transform from the list','Error','Ok','Information'))
        return
      }
      
      $thisWindow.DialogResult = "ok"      
    })

    # Populate XAML items
     [xml]$xmlDoc = '<transforms xmlns=""></transforms>'
    Get-ChildItem -Path $transformPath | Sort-Object ($_.Name) | % {
      $transfromName = ($_.Name) -replace '.xsl',''
      
      $index = $transfromName.LastIndexOf('.')
      if ($index -gt -1)
      {
        $typeText = $transfromName.SubString($index + 1, $transfromName.Length - $index - 1)
        if ($typeText -eq 'html') { $typeText = 'HTML' }
        if ($typeText -eq 'stdout') { $typeText = 'Text' }
      }
      else
      {
        $typeText = "Unknown"
      }
   	  $xmlNode = $xmlDoc.CreateElement('transform')
   	  $xmlNode.SetAttribute('transformname',$transfromName)
   	  $xmlNode.SetAttribute('typetext',$typeText)
   	  $xmlNode.innerText = ($transfromName)
   	  $xmlDoc.documentElement.AppendChild($xmlNode)
    } | Out-Null
    (Get-WPFControl 'xmlTransformList' -Window $thisWindow).Document = $xmlDoc

    # Show the GUI
    Write-Verbose "Showing the window..."
    [string]$selectedTransformName = ""    
    [void]($thisWindow.ShowDialog())
    if ($thisWindow.dialogResult) {
      $listView = (Get-WPFControl 'listTransforms' -Window $thisWindow)    
      $xmlElement = $listView.SelectedItem
      if ($xmlElement -ne $null) {
        $selectedTransformName = $xmlElement.transformName
        Write-Verbose "Selected transform from the dialog is $selectedTransformName"
      }
    }
    
    Write-Verbose "Cleanup..."
    [void] ($thisWindow.Close())
    $thisWindow = $null
    
    Write-Output $selectedTransformName
  }
}
tools\module\reportgui\reportgui.ps1
param([string]$Report = '', [string]$Transform = '')
# Setup script defaults
$ErrorActionPreference = "Stop"
$VerbosePreference = "Continue"

# Bootstrap
function Get-ScriptDirectory
{
  $Invocation = (Get-Variable MyInvocation -Scope 1).Value
  $global:ScriptDirectory = (Split-Path ($Invocation.MyCommand.Path))
  $global:ScriptDirectory
}
[void] (Get-ScriptDirectory)

$transformPath = (Join-Path -Path $global:ScriptDirectory -ChildPath '..\transforms')

#Load Required Assemblies
Write-Verbose 'Loading WPF assemblies'
Add-Type �assemblyName PresentationFramework
Add-Type �assemblyName PresentationCore
Add-Type �assemblyName WindowsBase
Write-Verbose 'Loading Windows Forms assemblies'
Add-Type -AssemblyName System.Windows.Forms
Write-Verbose 'Loading the POSHPuppetReports module'
Import-Module "$PSScriptRoot\..\POSHPuppetReports.psd1"

# Check the command line
$cmdLineError = ""
$autoloadReport = ""
$autoloadTransform = ""
if ($Report -ne '') {
  Write-Verbose "Report path was specified on the command line"
  if (!(Test-Path -Path $Report)) {
    Write-Verbose "Report does not exist"
    $cmdLineError += "The specified report does not exist`n`r"
  }
  else
  {
    Write-Verbose "Report exists"
    $autoloadReport = $Report
  }  
}
if ($Transform -ne '') {
  Write-Verbose "Transform name was specified on the command line"
  $TransformFile = (Join-Path -Path $transformPath -ChildPath ($Transform + ".xsl"))
  if (!(Test-Path -Path $TransformFile)) {
    Write-Verbose "Transform does not exist"
    $cmdLineError += "The specified transform does not exist`n`r"
  }
  else
  {
    Write-Verbose "Transform exists"
    $autoloadTransform = $Transform
  }  
}
if ($cmdLineError -ne '') {
  [void] ([System.Windows.MessageBox]::Show($cmdLineError,'Error','Ok','Information'))
}

# Load other PS1 files
Get-ChildItem -Path $global:ScriptDirectory | Where-Object { ($_.Name -imatch '\.ps1$') -and ($_.Name -ne 'reportgui.ps1') } | % {
  Write-Verbose "Importing $($_.Name)..."
  . ($_.Fullname)
}

if (($autoloadTransform -eq "") -and ($autoloadReport -ne "")) {  
  # Passed in only the report name.  Prompt for the transform name
  Write-Verbose "Report name was passed in the command line but no transform.  Prompting for which transform to use..."
  $autoloadTransform = Invoke-ShowSelectTransformWindow
  Write-Verbose "Selected transform is [$autoloadTransform]"
}

Invoke-ShowMainWindow -AutoloadTransform $autoloadTransform -AutoloadReport $autoloadReport
tools\module\reportgui\reportgui.readme.html
 
tools\module\reportgui\reportgui.xaml
 
tools\module\reportgui\selecttransform.xaml
 
tools\module\Transform-XML.ps1
function Transform-XML($xmlDocument, $transformFilename) {
	$xmlContentReader = ([System.Xml.XmlReader]::Create( (New-Object System.IO.StringReader($xmlDocument.innerXML))))

	$StyleSheet = New-Object System.Xml.Xsl.XslCompiledTransform
	$StyleSheet.Load($transformFile)

	$stringWriter = New-Object System.IO.StringWriter
	$XmlWriter = New-Object System.XMl.XmlTextWriter $StringWriter 
		
	$StyleSheet.Transform( [System.Xml.XmlReader]$xmlContentReader, [System.Xml.XmlWriter]$XmlWriter)
	Write-Output $stringWriter.ToString()
}
tools\module\transforms\basic.report.html.xsl
 
tools\module\transforms\detailed.report.html.xsl
 
tools\module\transforms\teamcity.tests.stdout.xsl
 
tools\module\Write-HashTableToXML.ps1
function Write-HashTableToXML($attrName, $attrValue, $rootNode) {
  $xmlNode = $rootNode.OwnerDocument.createElement($attrName)
  if ($attrValue -ne $null) {
    switch ($attrValue.GetType().ToString()) {
      'System.String' {
        # Special property.  Convert it to ms as well
        if ($attrName -eq 'evaluation_time') {
          $xmlMSnode = $rootNode.OwnerDocument.createElement($attrName + '_ms')
          $xmlMSnode.innerText = [int](([float]$attrValue)*1000)
          [void]($rootNode.appendChild($xmlMSnode))
        }
        $xmlNode.innerText = $attrValue;
        break ;
      }
      'System.Object[]' {
        if ( ($attrValue[0]).GetType().ToString() -eq 'System.Collections.HashTable' ) {
          $attrValue | % { Write-HashTableToXML $attrName $_ $xmlNode }
        } else {
          $xmlNode.innerText = $attrValue;
        }
        break ;
      }
      'System.Collections.Hashtable' { $attrValue.Keys | % { Write-HashTableToXML $_ $attrValue[$_] $xmlNode }; break ; }
      default { $xmlNode.innerText = ('Unknown type ' + $attrValue.GetType().ToString()); break ; }
    }
    
  }
  [void]($rootNode.appendChild($xmlNode))
}
tools\module\Write-ResourceStatus.ps1
function Write-ResourceStatus($objYaml, $xmlDoc) {
  $resourcesNode = $xmlDoc.createElement('resources')

  $objYaml.resource_statuses.Keys | % {
    $resourceNode = $xmlDoc.createElement('resource')
    [void]($resourceNode.SetAttribute('name',$_))
    $resource = $objYaml.resource_statuses[$_]

    $resource.Keys | % {
      $eventsObject = $resource[$_]
      if ($_ -eq 'events')
      {
        # The events resource is special as it can come in as null, an array or hashtable. Need to tailor the XML rendering based on object type
        $eventsNode = $xmlDoc.createElement('events')
        if ($eventsObject -ne $null) {        
          switch ($eventsObject.GetType().ToString() ) {
            "System.Collections.Hashtable" {
              Write-HashTableToXML 'event' $eventsObject $eventsNode
              break;
            }
            "System.Object[]" {
              $eventsObject | % {
                Write-HashTableToXML 'event' $_ $eventsNode
              }
              break;
            }
            default { Throw "Write-ResourceStatus: Unknown object type $($eventsObject.GetType().ToString())"; return $null; }
          }
        }
        [void]($resourceNode.AppendChild($eventsNode))
      }
      else
      {    
        Write-HashTableToXML $_ $eventsObject $resourceNode
      }
    }
    [void]($resourcesNode.AppendChild($resourceNode))
  }
  [void]($xmlDoc.DocumentElement.AppendChild($resourcesNode))
}
tools\module\Write-ResourceStatusSummary.ps1
function Write-ResourceStatusSummary($objYaml, $xmlDoc) {
  $reportInfoNode = $xmlDoc.createElement('reportinformation')  
  $node = $xmlDoc.createElement('host'); $node.innerText = $objYaml.host; [void]($reportInfoNode.appendChild($node))
  $node = $xmlDoc.createElement('time'); $node.innerText = $objYaml.time; [void]($reportInfoNode.appendChild($node))
  $node = $xmlDoc.createElement('reportformat'); $node.innerText = $objYaml.report_format; [void]($reportInfoNode.appendChild($node))
  $node = $xmlDoc.createElement('puppetversion'); $node.innerText = $objYaml.puppet_version; [void]($reportInfoNode.appendChild($node))
  $node = $xmlDoc.createElement('status'); $node.innerText = $objYaml.status; [void]($reportInfoNode.appendChild($node))
  $node = $xmlDoc.createElement('environment'); $node.innerText = $objYaml.environment; [void]($reportInfoNode.appendChild($node))
  [void]($xmlDoc.DocumentElement.appendChild($reportInfoNode))

  $statuses = @{}
  $resourceMetrics = $objYaml.metrics['resources'].values
  $total = 0
  for($index = $resourceMetrics.GetLowerBound(0); $index -lt $resourceMetrics.GetUpperBound(0); $index = $index + 3) {
    
    if ($resourceMetrics[$index] -eq 'total')
    {
      $total = $resourceMetrics[$index + 2]
    } 
    else
    {
      $statusInfo = @{}
      $statusInfo['count'] = $resourceMetrics[$index + 2]
      $statusInfo['id'] = $resourceMetrics[$index]
      $statuses[$resourceMetrics[$index + 1]] = $statusInfo
    } 
  }
  $statusInfo = @{}
    
  $summaryNode = $xmlDoc.createElement('resourcesummary')
  [void]($summaryNode.SetAttribute('total',$total))
  
  $statuses.Keys | ForEach-Object {
    $node = $xmlDoc.createElement('status')
    $node.SetAttribute('name',$_)
    $node.SetAttribute('id',$statuses[$_].id)
    $node.SetAttribute('count',$statuses[$_].count)
    if ($total -gt 0)
    { $node.SetAttribute('percent',[int](($statuses[$_].count / $total)*100)) }
    else
    { $node.SetAttribute('percent',0) }

    [void]($summaryNode.AppendChild($node))
    
  }
  [void]($xmlDoc.DocumentElement.AppendChild($summaryNode))
}

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Posh Puppet Reports 0.9.53 366 Saturday, November 8, 2014 Approved
Posh Puppet Reports 0.9.51 317 Saturday, September 27, 2014 Unknown
Posh Puppet Reports 0.9.47 262 Sunday, September 14, 2014 Unknown

Full list of changes are available on GitHub; https://github.com/glennsarti/Puppet-Reports-in-Powershell/commits/master

Version 0.9.53

BUG FIXES:

  • Minor - Refactored code so that each function is in its own file.

IMPROVEMENTS:

  • Added context menu to open YAML files in the puppet report viewer.
  • If you call the ReportGUI with only a puppet report, the user is prompted to select a transform to use.
  • Added the ability to pass command line parameters to ReportGUI.CMD.

Version 0.9.51

BUG FIXES:

  • Fix - Incorrectly thought the resource status were mutually exclusive however a resource can be counted as both out-of-sync and changed. Removed this logic for the moment until I can come up with a better definition of unchanged
  • Fix - The events resource is special as it can come in as null, an array or hashtable. I changed the rendering based on the object type. So now there will always be one 'events' xml node with zero or more 'event' nodes as children. This makes the stylesheet much easier to write and makes more sense in the long run.

IMPROVEMENTS:

  • Added better event output to the stylesheet. Failed resources are now coloured red.
  • Added creating a shortcut called "Puppet Report GUI" to the 'Start Menu'. This functionality only works in .Net Framework 4.0 or above for the moment.

This package has no dependencies.

Discussion for the Posh Puppet Reports Package

Ground Rules:

  • This discussion is only about Posh Puppet Reports and the Posh Puppet Reports package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Posh Puppet Reports, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus