forked from Azure/azure-powershell
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implementation of interface IPSCmdletAction for test coverage (Azure#…
…19904) * Added implementation for interface ITestCoverage and registered in Azure session * Updated the reference of Azure PowerShell Common to 1.3.65-preview * Renamed environment variable from Azure_PS_TestCoverage to EnableTestCoverage
- Loading branch information
1 parent
f8a78a1
commit d5b3360
Showing
11 changed files
with
382 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| // ---------------------------------------------------------------------------------- | ||
| // | ||
| // Copyright Microsoft Corporation | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // ---------------------------------------------------------------------------------- | ||
|
|
||
| using Microsoft.WindowsAzure.Commands.Common; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Runtime.InteropServices; | ||
| using System.Text; | ||
| using System.Text.RegularExpressions; | ||
| using System.Threading; | ||
|
|
||
| namespace Microsoft.Azure.Commands.Common.Authentication | ||
| { | ||
| public class TestCoverage : ITestCoverage | ||
| { | ||
| private const string CsvHeaderCommandName = "CommandName"; | ||
| private const string CsvHeaderParameterSetName = "ParameterSetName"; | ||
| private const string CsvHeaderParameters = "Parameters"; | ||
| private const string CsvHeaderSourceScript = "SourceScript"; | ||
| private const string CsvHeaderScriptLineNumber = "LineNumber"; | ||
| private const string CsvHeaderIsSuccess = "IsSuccess"; | ||
| private const string Delimiter = ","; | ||
|
|
||
| private readonly IList<string> ExcludedSource = new List<string> | ||
| { | ||
| "Common.ps1", | ||
| "Assert.ps1", | ||
| "AzureRM.Resources.ps1", | ||
| "AzureRM.Storage.ps1" | ||
| }; | ||
|
|
||
|
|
||
| private static readonly string s_testCoverageRootPath; | ||
|
|
||
| private static readonly ReaderWriterLockSlim s_lock = new ReaderWriterLockSlim(); | ||
|
|
||
| static TestCoverage() | ||
| { | ||
|
|
||
| var repoRootPath = ProbeRepoDirectory(); | ||
| if (!string.IsNullOrEmpty(repoRootPath)) | ||
| { | ||
| s_testCoverageRootPath = Path.Combine(repoRootPath, "artifacts", "TestCoverageAnalysis", "Raw"); | ||
| DirectoryInfo rawDir = new DirectoryInfo(s_testCoverageRootPath); | ||
| if (!rawDir.Exists) | ||
| { | ||
| Directory.CreateDirectory(s_testCoverageRootPath); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static string ProbeRepoDirectory() | ||
| { | ||
| string directoryPath = ".."; | ||
| while (Directory.Exists(directoryPath) && (!Directory.Exists(Path.Combine(directoryPath, "src")) || !Directory.Exists(Path.Combine(directoryPath, "artifacts")))) | ||
| { | ||
| directoryPath = Path.Combine(directoryPath, ".."); | ||
| } | ||
|
|
||
| string result = Directory.Exists(directoryPath) ? Path.GetFullPath(directoryPath) : null; | ||
| return result; | ||
| } | ||
|
|
||
| private string GenerateCsvHeader() | ||
| { | ||
| StringBuilder headerBuilder = new StringBuilder(); | ||
| headerBuilder.Append(CsvHeaderCommandName).Append(Delimiter) | ||
| .Append(CsvHeaderParameterSetName).Append(Delimiter) | ||
| .Append(CsvHeaderParameters).Append(Delimiter) | ||
| .Append(CsvHeaderSourceScript).Append(Delimiter) | ||
| .Append(CsvHeaderScriptLineNumber).Append(Delimiter) | ||
| .Append(CsvHeaderIsSuccess); | ||
|
|
||
| return headerBuilder.ToString(); | ||
| } | ||
|
|
||
| private string GenerateCsvItem(string commandName, string parameterSetName, string parameters, string sourceScript, int scriptLineNumber, bool isSuccess) | ||
| { | ||
| StringBuilder itemBuilder = new StringBuilder(); | ||
| itemBuilder.Append(commandName).Append(Delimiter) | ||
| .Append(parameterSetName).Append(Delimiter) | ||
| .Append(parameters).Append(Delimiter) | ||
| .Append(sourceScript).Append(Delimiter) | ||
| .Append(scriptLineNumber).Append(Delimiter) | ||
| .Append(isSuccess.ToString().ToLowerInvariant()); | ||
|
|
||
| return itemBuilder.ToString(); | ||
| } | ||
|
|
||
| public void LogRawData(AzurePSQoSEvent qos) | ||
| { | ||
| #if DEBUG || TESTCOVERAGE | ||
| string moduleName = qos.ModuleName; | ||
| string commandName = qos.CommandName; | ||
| string sourceScript = qos.SourceScript; | ||
|
|
||
| if (string.IsNullOrEmpty(moduleName) || string.IsNullOrEmpty(commandName) || ExcludedSource.Contains(sourceScript)) | ||
| return; | ||
|
|
||
| var pattern = @"\\(?:artifacts\\Debug|src)\\(?:Az\.)?(?<ModuleName>[a-zA-Z]+)\\"; | ||
| var match = Regex.Match(sourceScript, pattern, RegexOptions.IgnoreCase); | ||
| var testingModuleName = $"Az.{match.Groups["ModuleName"].Value}"; | ||
| if (string.Compare(testingModuleName, moduleName, true) != 0) | ||
| return; | ||
|
|
||
| var csvFilePath = Path.Combine(s_testCoverageRootPath, $"{moduleName}.csv"); | ||
| StringBuilder csvData = new StringBuilder(); | ||
|
|
||
| s_lock.EnterWriteLock(); | ||
| try | ||
| { | ||
| if (!File.Exists(csvFilePath)) | ||
| { | ||
| var csvHeader = GenerateCsvHeader(); | ||
| csvData.Append(csvHeader); | ||
| } | ||
|
|
||
| csvData.AppendLine(); | ||
| var csvItem = GenerateCsvItem(commandName, qos.ParameterSetName, qos.Parameters, Path.GetFileName(sourceScript), qos.ScriptLineNumber, qos.IsSuccess); | ||
| csvData.Append(csvItem); | ||
|
|
||
| File.AppendAllText(csvFilePath, csvData.ToString()); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Console.WriteLine($"##[group]Error occurred when generating raw data of test coverage for module {moduleName}"); | ||
| Console.WriteLine($"##[error]Error Message: {ex.Message}"); | ||
| Console.WriteLine($"##[error]Source: {ex.Source}"); | ||
| Console.WriteLine($"##[error]Stack Trace: {ex.StackTrace}"); | ||
| Console.WriteLine("##[endgroup]"); | ||
| } | ||
| finally | ||
| { | ||
| s_lock.ExitWriteLock(); | ||
| } | ||
| #endif | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.