Skip to content

Commit 8598dd7

Browse files
authored
Fix an issue blocking CI during example analysis (Azure#18626)
* Generalize input MarkdownPaths * fix exampleIssues.csv * fix a bug * fix a bug * change severity * fix a bug * fix csv * restore
1 parent 84fa0d0 commit 8598dd7

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

tools/StaticAnalysis/ExampleAnalyzer/Measure-MarkdownOrScript.ps1

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,14 @@ if ($OutputScriptsInFile.IsPresent) {
5050
if ($PSCmdlet.ParameterSetName -eq "Markdown") {
5151
$null = New-Item -ItemType Directory -Path $OutputFolder -ErrorAction SilentlyContinue
5252
$null = New-Item -ItemType File $OutputFolder\TempScript.ps1
53-
$MarkdownPath = Get-Content $MarkdownPaths
53+
# When the input $MarkdownPaths is the path of txt file
54+
if ($MarkdownPaths -cmatch ".*\.txt") {
55+
$MarkdownPath = Get-Content $MarkdownPaths
56+
}
57+
# When the input $MarkdownPaths is the path of a folder
58+
else{
59+
$MarkdownPath = $MarkdownPaths
60+
}
5461
foreach($_ in Get-ChildItem $MarkdownPath){
5562
# Filter the .md of overview in "\help\"
5663
if ((Get-Item -Path $_.FullName).Directory.Name -eq "help" -and $_.FullName -cmatch ".*\.md" -and $_.BaseName -cmatch "^([A-Z][a-z]+)+-([A-Z][a-z0-9]*)+$") {

tools/StaticAnalysis/ExampleAnalyzer/utils.ps1

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -541,34 +541,44 @@ function Get-ScriptAnalyzerResult {
541541
}
542542
$results = @()
543543
foreach($analysisResult in $analysisResults){
544-
if($analysisResult.Severity -eq "Error"){
544+
if($analysisResult.Severity -eq "ParseError"){
545+
$Severity = 2
546+
}
547+
elseif($analysisResult.Severity -eq "Error"){
545548
$Severity = 2
546549
}
547550
elseif($analysisResult.Severity -eq "Warning"){
548551
$Severity = 3
549552
}
553+
elseif($analysisResult.Severity -eq "Information"){
554+
$Severity = 4
555+
}
550556
if($analysisResult.RuleSuppressionID -ge 5000 -and $analysisResult.RuleSuppressionID -le 5199){
551557
$result = [AnalysisOutput]@{
552558
Module = ($analysisResult.Message -split "-")[0]
553559
Cmdlet = ($analysisResult.Message -split "-")[1] + "-" + ($analysisResult.Message -split "-")[2]
554560
Example = ($analysisResult.Message -split "-")[3]
555561
RuleName = $analysisResult.RuleName
556-
Description = ($analysisResult.Message -split "@")[1] -replace "`"","`'"
562+
Description = ($analysisResult.Message -split "@")[1] -replace "`"","`'" -replace "`n"," " -replace "`r"," "
557563
Severity = $Severity
558-
Extent = $analysisResult.Extent -replace "`"","`'"
564+
Extent = $analysisResult.Extent.ToString().Trim() -replace "`"","`'" -replace "`n"," " -replace "`r"," "
559565
ProblemID = $analysisResult.RuleSuppressionID
560-
Remediation = ($analysisResult.Message -split "@")[2] -replace "`"","`'"
566+
Remediation = ($analysisResult.Message -split "@")[2] -replace "`"","`'" -replace "`n"," " -replace "`r"," "
561567
}
562568
}
563569
else{
564570
$result = [AnalysisOutput]@{
571+
Module = ""
572+
Cmdlet = ""
573+
Example = 0
565574
RuleName = $analysisResult.RuleName
566-
Description = $analysisResult.Message
575+
Description = $analysisResult.Message -replace "`"","`'" -replace "`n"," " -replace "`r"," "
567576
Severity = $Severity
568-
Extent = $analysisResult.Extent
569-
Remediation = "Unexpected Error! Please contact the Azure Powershell Team."
577+
Extent = $analysisResult.Extent.ToString().Trim() -replace "`"","`'" -replace "`n"," " -replace "`r"," "
578+
ProblemID = 5200
579+
Remediation = "Unexpected Error! Please check your example or contact the Azure Powershell Team."
580+
}
570581
}
571-
}
572582
$results += $result
573583
}
574584
#Except the suppressed records

0 commit comments

Comments
 (0)