File size: 17,284 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
<############################################################################################
# File: Import-Counter.Tests.ps1
# Provides Pester tests for the Import-Counter cmdlet.
############################################################################################>
# Counter CmdLets are removed see issue #4272
# Tests are disabled
return
$cmdletName = "Import-Counter"
. "$PSScriptRoot/CounterTestHelperFunctions.ps1"
$SkipTests = SkipCounterTests
if ( ! $SkipTests )
{
$counterPaths = @(
(TranslateCounterPath "\Memory\Available Bytes")
(TranslateCounterPath "\processor(*)\% Processor time")
(TranslateCounterPath "\Processor(_Total)\% Processor Time")
(TranslateCounterPath "\PhysicalDisk(_Total)\Current Disk Queue Length")
(TranslateCounterPath "\PhysicalDisk(_Total)\Disk Bytes/sec")
(TranslateCounterPath "\PhysicalDisk(_Total)\Disk Read Bytes/sec")
)
$setNames = @{
Memory = (TranslateCounterName "memory")
PhysicalDisk = (TranslateCounterName "physicaldisk")
Processor = (TranslateCounterName "processor")
}
}
else
{
$counterPaths = @()
$setNames = @{}
}
$badSamplesBlgPath = Join-Path $PSScriptRoot "assets" "BadCounterSamples.blg"
$corruptBlgPath = Join-Path $PSScriptRoot "assets" "CorruptBlg.blg"
$notFoundPath = Join-Path $PSScriptRoot "DAD288C0-72F8-47D3-8C54-C69481B528DF.blg"
# Set script-scope variable values used by multiple Describes
function SetScriptVars([string]$rootPath, [int]$maxSamples, [bool]$export)
{
$rootFilename = "exportedCounters"
$script:blgPath = Join-Path $rootPath "$rootFilename.blg"
$script:csvPath = Join-Path $rootPath "$rootFilename.csv"
$script:tsvPath = Join-Path $rootPath "$rootFilename.tsv"
$script:counterSamples = $null
if ($maxSamples -and ! $SkipTests )
{
$script:counterSamples = Get-Counter -Counter $counterPaths -MaxSamples $maxSamples
}
if ($export -and ! $SkipTests )
{
Export-Counter -Force -FileFormat "blg" -Path $script:blgPath -InputObject $script:counterSamples
Export-Counter -Force -FileFormat "csv" -Path $script:csvPath -InputObject $script:counterSamples
Export-Counter -Force -FileFormat "tsv" -Path $script:tsvPath -InputObject $script:counterSamples
}
}
# Build up a command to execute
function ConstructCommand($testCase)
{
$filePath = ""
$pathParam = ""
$startTimeParam = ""
$endTimeParam = ""
if ($testCase.ContainsKey("Path"))
{
$filePath = $testCase.Path
}
else
{
$filePath = $script:blgPath
}
if ($testCase.NoDashPath)
{
$pathParam = $filePath
}
else
{
$pathParam = "-Path $filePath"
}
if ($testCase.ContainsKey("StartTime"))
{
$startTimeParam = "-StartTime `$testCase.StartTime"
}
if ($testCase.ContainsKey("EndTime"))
{
$endTimeParam = "-EndTime `$(`$testCase.EndTime)"
}
return "$cmdletName $pathParam $startTimeParam $endTimeParam $($testCase.Parameters)"
}
# Run a test that is expected to succeed
function RunTest($testCase)
{
$skipTest = $testCase.SkipTest -or (SkipCounterTests)
It "$($testCase.Name)" -Skip:$skipTest {
if ($testCase.TimestampIndexes)
{
if ($testCase.TimestampIndexes.ContainsKey("First"))
{
$testCase.StartTime = $script:counterSamples[$testCase.TimestampIndexes.First].Timestamp
# Exporting loses precision of DateTime objects, which results in almost always
# missing the first expected item when importing with a controlling StartTime.
# So, we'll adjust the precision of the timestamp we use for the StartTime value.
$testCase.StartTime = New-Object System.DateTime ([Int64]([math]::floor($testCase.StartTime.Ticks / 10000)) * 10000)
}
if ($testCase.TimestampIndexes.ContainsKey("Last"))
{
$testCase.EndTime = $script:counterSamples[$testCase.TimestampIndexes.Last].Timestamp
}
}
$cmd = ConstructCommand $testCase
$cmd = $cmd + " -ErrorAction SilentlyContinue -ErrorVariable errVar"
$errVar = $null
$sb = [scriptblock]::Create($cmd)
$result = &$sb
$errVar | Should -BeNullOrEmpty
if ($testCase.ContainsKey("Script"))
{
&$testCase.Script
}
else
{
if ($testCase.TimestampIndexes)
{
$start = 0
$end = $script:counterSamples.Length - 1
if ($testCase.TimestampIndexes.ContainsKey("First"))
{
$start = $testCase.TimestampIndexes.First
}
if ($testCase.TimestampIndexes.ContainsKey("Last"))
{
$end = $testCase.TimestampIndexes.Last
}
CompareCounterSets $result $script:counterSamples[$start..$end]
}
else
{
CompareCounterSets $result $script:counterSamples
}
}
}
}
# Run a test for each file format
function RunPerFileTypeTests($testCase)
{
if ($testCase.UseKnownSamples)
{
$basePath = Join-Path $PSScriptRoot "assets" "CounterSamples"
$formats = @{
"BLG" = "$basePath.blg"
"CSV" = "$basePath.blg"
"TSV" = "$basePath.blg"
}
}
else
{
$formats = @{
"BLG" = $script:blgPath
"CSV" = $script:csvPath
"TSV" = $script:tsvPath
}
}
foreach ($f in $formats.GetEnumerator())
{
$newCase = $testCase.Clone();
$newCase.Path = $f.Value
$newCase.Name = "$($newCase.Name) ($($f.Name) format)"
RunTest $newCase
}
}
# Run a test case that is expected to fail
function RunExpectedFailureTest($testCase)
{
It "$($testCase.Name)" -Skip:$(SkipCounterTests) {
$cmd = ConstructCommand $testCase
# Use $cmd to debug a test failure
# Write-Host "Command to run: $cmd"
$cmd = $cmd + " -ErrorAction Stop"
if ($testCase.ContainsKey("Script"))
{
# Here we want to run the command then do our own post-run checks
$sb = [ScriptBlock]::Create($cmd)
&$sb
&$testCase.Script
}
else
{
# Here we expect and want the command to fail
$sb = [ScriptBlock]::Create($cmd)
$e = { &$sb } | Should -Throw -ErrorId $testCase.ExpectedErrorId -PassThru
if ($testCase.ExpectedErrorCategory)
{
$e.CategoryInfo.Category | Should -BeExactly $testCase.ExpectedErrorCategory
}
}
}
}
Describe "CI tests for Import-Counter cmdlet" -Tags "CI" {
BeforeAll {
SetScriptVars $testDrive 0 $false
}
$performatTestCases = @(
@{
Name = "Can import all samples from known sample sets"
UseKnownSamples = $true
Script = {
$result.Length | Should -Be 25
}
}
@{
Name = "Can acquire summary information"
UseKnownSamples = $true
Parameters = "-Summary"
Script = {
$result.SampleCount | Should -Be 25
$result.OldestRecord | Should -Be (Get-Date -Year 2016 -Month 11 -Day 26 -Hour 13 -Minute 46 -Second 30 -Millisecond 874)
$result.NewestRecord | Should -Be (Get-Date -Year 2016 -Month 11 -Day 26 -Hour 13 -Minute 47 -Second 42 -Millisecond 983)
}
}
)
foreach ($testCase in $performatTestCases)
{
RunPerFileTypeTests $testCase
}
}
Describe "Feature tests for Import-Counter cmdlet" -Tags "Feature" {
BeforeAll {
SetScriptVars $testDrive 25 $true
}
AfterAll {
Remove-Item $script:blgPath -Force -ErrorAction SilentlyContinue
Remove-Item $script:csvPath -Force -ErrorAction SilentlyContinue
Remove-Item $script:tsvPath -Force -ErrorAction SilentlyContinue
}
Context "Validate incorrect usage" {
$testCases = @(
@{
Name = "Fails when given non-existent path"
Path = $notFoundPath
ExpectedErrorCategory = [System.Management.Automation.ErrorCategory]::ObjectNotFound
ExpectedErrorId = "Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given null path"
Path = "`$null"
ExpectedErrorId = "ParameterArgumentValidationErrorNullNotAllowed,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when -Path specified but no path given"
Path = ""
ExpectedErrorId = "MissingArgument,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -ListSet without set names"
Parameters = "-ListSet"
ExpectedErrorId = "MissingArgument,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -StartTime without DateTime"
Parameters = "-StartTime"
ExpectedErrorId = "MissingArgument,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -EndTime without DateTime"
Parameters = "-EndTime"
ExpectedErrorId = "MissingArgument,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -ListSet and -Summary"
Parameters = "-ListSet memory -Summary"
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -Summary and -Counter"
Parameters = "-Summary -Counter `"\processor(*)\% processor time`""
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -ListSet and -Counter"
Parameters = "-ListSet memory -Counter `"\processor(*)\% processor time`""
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -ListSet and -StartTime"
StartTime = Get-Date
Parameters = "-ListSet memory"
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -ListSet and -StartTime"
StartTime = Get-Date
Parameters = "-ListSet memory"
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -Summary and -EndTime"
EndTime = Get-Date
Parameters = "-Summary"
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when given -Summary and -EndTime"
EndTime = Get-Date
Parameters = "-Summary"
ExpectedErrorId = "AmbiguousParameterSet,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
@{
Name = "Fails when BLG file is corrupt"
Path = $corruptBlgPath
ExpectedErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidResult
ExpectedErrorId = "CounterApiError,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
)
foreach ($testCase in $testCases)
{
RunExpectedFailureTest $testCase
}
It "Multiple errors when BLG file contains bad sample data" -Skip:$(SkipCounterTests) {
$errVar = $null
$result = Import-Counter $badSamplesBlgPath -ErrorVariable errVar -ErrorAction SilentlyContinue
$result.Length | Should -Be 275
$errVar.Count | Should -Be 5
foreach ($err in $errVar)
{
$err.CategoryInfo.Category | Should -BeExactly "InvalidResult"
$err.FullyQualifiedErrorId | Should -BeExactly "CounterApiError,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
}
}
Context "Import tests" {
$performatTestCases = @(
@{
Name = "Can import all samples"
}
@{
Name = "Can import samples beginning at a given start time"
TimestampIndexes = @{
First = 6
}
}
@{
Name = "Can import samples ending at a given end time"
TimestampIndexes = @{
Last = 10
}
}
@{
Name = "Can import samples of a given timestamp range"
TimestampIndexes = @{
First = 4
Last = 19
}
}
@{
Name = "Can acquire a named list set"
UseKnownSamples = $true
Parameters = "-ListSet $($setNames.Memory)"
Script = {
$result.Length | Should -Be 1
$result[0].CounterSetName | Should -BeExactly $setNames.Memory
}
}
@{
Name = "Can acquire list set from an array of names"
UseKnownSamples = $true
Parameters = "-ListSet $(TranslateCounterName 'memory'), $(TranslateCounterName 'processor')"
Script = {
$result.Length | Should -Be 2
$names = @()
foreach ($set in $result)
{
$names = $names + $set.CounterSetName
}
$names -Contains $setNames.Memory | Should -BeTrue
$names -Contains $setNames.Processor | Should -BeTrue
}
}
@{
# This test will be skipped for non-English languages, since
# there is no reasonable way to construct a wild-card pattern
# that will, for every language, result in a known set of values
# or evan a set with a known minimum number of items.
Name = "Can acquire list set via wild-card name"
SkipTest = (-not (Get-Culture).Name.StartsWith("en-", [StringComparison]::InvariantCultureIgnoreCase))
UseKnownSamples = $true
Parameters = "-ListSet p*"
Script = {
$result.Length | Should -BeGreaterThan 1
$names = @()
foreach ($set in $result)
{
$names = $names + $set.CounterSetName
}
$names -Contains "physicaldisk" | Should -BeTrue
$names -Contains "processor" | Should -BeTrue
}
}
@{
# This test will be skipped for non-English languages, since
# there is no reasonable way to construct a wild-card pattern
# that will, for every language, result in a known set of values
# or evan a set with a known minimum number of items.
Name = "Can acquire list set from an array of names including wild-card"
SkipTest = (-not (Get-Culture).Name.StartsWith("en-", [StringComparison]::InvariantCultureIgnoreCase))
UseKnownSamples = $true
Parameters = "-ListSet memory, p*"
Script = {
$result.Length | Should -BeGreaterThan 2
$names = @()
foreach ($set in $result) { $names = $names + $set.CounterSetName }
$names -Contains "memory" | Should -BeTrue
$names -Contains "processor" | Should -BeTrue
$names -Contains "physicaldisk" | Should -BeTrue
}
}
)
foreach ($testCase in $performatTestCases)
{
RunPerFileTypeTests $testCase
}
}
}
Describe "Import-Counter cmdlet does not run on IoT" -Tags "CI" {
It "Import-Counter throws PlatformNotSupportedException" -Skip:$(-not [System.Management.Automation.Platform]::IsIoT) {
{ Import-Counter -Path "$testDrive\ProcessorData.blg" } |
Should -Throw -ErrorId "System.PlatformNotSupportedException,Microsoft.PowerShell.Commands.ImportCounterCommand"
}
}
|