Clean up Pester tests

This commit is contained in:
Kevin Marquette
2018-12-28 15:01:15 -08:00
parent 2eae9f2bb2
commit e5a0147d71
11 changed files with 312 additions and 164 deletions

View File

@@ -0,0 +1,126 @@
---
external help file: chronometer-help.xml
Module Name: chronometer
online version:
schema: 2.0.0
---
# Format-Chronometer
## SYNOPSIS
## SYNTAX
### Script (Default)
```
Format-Chronometer [-InputObject <MonitoredScript[]>] [-WarningAt <Int32>] [-ErrorAt <Int32>] [-ShowAll]
[<CommonParameters>]
```
### Line
```
Format-Chronometer [-Line <ScriptLine[]>] [-WarningAt <Int32>] [-ErrorAt <Int32>] [-ShowAll]
[<CommonParameters>]
```
## DESCRIPTION
Generates a report from a Chronometer
## EXAMPLES
### EXAMPLE 1
```
$script = ls C:\workspace\PSGraph\PSGraph -Recurse -Filter *.ps1
```
$resultes = Get-Chronometer -Path $script.fullname -ScriptBlock {Invoke-Pester C:\workspace\PSGraph}
$results | Format-Chronometer -WarnAt 20 -ErrorAt 200
## PARAMETERS
### -ErrorAt
If the average time of a comamand is more than this, the output is red
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 200
Accept pipeline input: False
Accept wildcard characters: False
```
### -InputObject
This is a MonitoredScript object from Get-Chronometer
```yaml
Type: MonitoredScript[]
Parameter Sets: Script
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -Line
This is a ScriptLine object from a MonitoredScript object
```yaml
Type: ScriptLine[]
Parameter Sets: Line
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -ShowAll
Forces the report to show scripts with no execution time
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -WarningAt
If the average time of a command is more than this, the output is yellow
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View File

@@ -0,0 +1,88 @@
---
external help file: chronometer-help.xml
Module Name: chronometer
online version:
schema: 2.0.0
---
# Get-Chronometer
## SYNOPSIS
## SYNTAX
```
Get-Chronometer [-Path <Object[]>] [-LineNumber <Int32[]>] [[-ScriptBlock] <ScriptBlock>] [<CommonParameters>]
```
## DESCRIPTION
Loads a script and then tracks the line by line execution times
## EXAMPLES
### EXAMPLE 1
```
Get-Chronometer -Path .\example.ps1 -Script {
```
.\example.ps1
}
## PARAMETERS
### -LineNumber
Line numbers within the script file to measure
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Script file to measure execution times on
```yaml
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -ScriptBlock
The script to start the scrupt or execute other commands
```yaml
Type: ScriptBlock
Parameter Sets: (All)
Aliases: Script, CommandScript
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

19
Docs/en-US/chronometer.md Normal file
View File

@@ -0,0 +1,19 @@
---
Module Name: chronometer
Module Guid: f3719c3c-008a-4b25-b94d-fc9f587f62dd
Download Help Link: {{Please enter FwLink manually}}
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
Locale: en-US
---
# chronometer Module
## Description
{{Manually Enter Description Here}}
## chronometer Cmdlets
### [Format-Chronometer](Format-Chronometer.md)
{{Manually Enter Format-Chronometer Description Here}}
### [Get-Chronometer](Get-Chronometer.md)
{{Manually Enter Get-Chronometer Description Here}}