Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test and Deprecate Publish HTML Report #67

Merged
merged 20 commits into from
Jan 9, 2024
Merged

Test and Deprecate Publish HTML Report #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
787ba9e
Add FF for deprecating Publish HTML Report
Dec 5, 2023
11ac2b3
Fix failing build
Dec 6, 2023
561b395
update FF state
Dec 8, 2023
d70253a
Will revert post testing local changes
Dec 11, 2023
43fdbb6
Local testing worked. Reverting changes
Dec 11, 2023
5e7d042
Cleanup + Address PR nit reviews
Dec 11, 2023
d38766d
Cleanup whitespace
Dec 11, 2023
c43d364
Local testing worked. Reverting changes
Dec 11, 2023
c4d92a3
Changing to warning for testing. Will discuss and revert post testing
Dec 14, 2023
ef3ace3
Changing the warning message for testing. Will discuss and revert pos…
Dec 14, 2023
49f2f25
Updated FF for testing
Dec 15, 2023
27dc843
Only for testing
Dec 15, 2023
ffbe4c6
Testing; Will revert
Dec 20, 2023
c11e19e
Testing completed; Reverting all changes
Dec 27, 2023
daa6660
update to tcm flag
Dec 27, 2023
5bf5ce0
Merge branch 'master' of https://github.com/microsoft/azure-pipelines…
Jan 5, 2024
f7d12a0
Updating FF call to use utility function
Jan 5, 2024
681433a
Clean up
Jan 8, 2024
6684dcd
restore unchanged files
Jan 8, 2024
0362bd0
Removing untracked files
Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions src/CoveragePublisher.Tests/CoverageProcessorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
using Microsoft.Azure.Pipelines.CoveragePublisher;
using Microsoft.Azure.Pipelines.CoveragePublisher.Model;
using Microsoft.Azure.Pipelines.CoveragePublisher.Parsers;
using Microsoft.Azure.Pipelines.CoveragePublisher.Publishers.DefaultPublisher;
using Microsoft.VisualStudio.Services.WebApi;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

Expand All @@ -20,16 +22,28 @@
private PublisherConfiguration _config = new PublisherConfiguration() { ReportDirectory = "directory" };
private Mock<Parser> _mockParser;
private Mock<ITelemetryDataCollector> _mockTelemetryDataCollector = new Mock<ITelemetryDataCollector>();
private IFeatureFlagHelper _featureFlagHelper;
private ICoveragePublisher _publisher;

Check warning on line 26 in src/CoveragePublisher.Tests/CoverageProcessorTests.cs

View workflow job for this annotation

GitHub Actions / build 

Field 'CoverageProcessorTests._publisher' is never assigned to, and will always have its default value null

Check warning on line 26 in src/CoveragePublisher.Tests/CoverageProcessorTests.cs

View workflow job for this annotation

GitHub Actions / build 

Field 'CoverageProcessorTests._publisher' is never assigned to, and will always have its default value null
private Mock<IFeatureFlagHelper> _mockFFHelper = new Mock<IFeatureFlagHelper>();

[TestInitialize]
public void TestInitialize()
public void TestInitialize(IFeatureFlagHelper featureFlagHelper)
{
_mockParser = new Mock<Parser>(_config, _mockTelemetryDataCollector.Object);

_mockPublisher.Setup(x => x.PublishCoverageSummary(It.IsAny<CoverageSummary>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
_mockPublisher.Setup(x => x.PublishNativeCoverageFiles(It.IsAny<IList<string>>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
_mockPublisher.Setup(x => x.PublishFileCoverage(It.IsAny<IList<FileCoverageInfo>>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
_mockPublisher.Setup(x => x.PublishHTMLReport(It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
_mockPublisher.Setup(x => x.IsUploadNativeFilesToTCMSupported()).Returns(false);
_mockFFHelper.Reset();
_featureFlagHelper = featureFlagHelper;
var IsUploadNativeFilesToTCMSupported = _publisher.IsUploadNativeFilesToTCMSupported;

if (IsUploadNativeFilesToTCMSupported.Equals(false))
{
// Feature Flag for testing and deprecating PublishHTMLReport; To be cleaned up post PCCRV2 upgrade
_mockPublisher.Setup(x => x.PublishHTMLReport(It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
}
}

[TestMethod]
Expand Down
23 changes: 15 additions & 8 deletions src/CoveragePublisher.Tests/Publishers/AzurePipelines/AzurePipelinesPublisherTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@
private Mock<IFeatureFlagHelper> _mockFFHelper = new Mock<IFeatureFlagHelper>();
private Mock<IHtmlReportPublisher> _mockHtmlPublisher = new Mock<IHtmlReportPublisher>();
private Mock<ILogStoreHelper> _mockLogStoreHelper = new Mock<ILogStoreHelper>();
private ICoveragePublisher _publisher;

Check warning on line 29 in src/CoveragePublisher.Tests/Publishers/AzurePipelines/AzurePipelinesPublisherTests.cs

View workflow job for this annotation

GitHub Actions / build 

Field 'AzurePipelinesPublisherTests._publisher' is never assigned to, and will always have its default value null

Check warning on line 29 in src/CoveragePublisher.Tests/Publishers/AzurePipelines/AzurePipelinesPublisherTests.cs

View workflow job for this annotation

GitHub Actions / build 

Field 'AzurePipelinesPublisherTests._publisher' is never assigned to, and will always have its default value null

[TestInitialize]
public void TestInitialize()
public void TestInitialize(IFeatureFlagHelper featureFlagHelper)
{
_context = new TestPipelinesExecutionContext(_logger);
_logger.Log = "";
Expand Down Expand Up @@ -99,16 +100,22 @@
[TestMethod]
public void WillPublishHtmlReport()
{
var publisher = new AzurePipelinesPublisher(_context, _mockClientFactory.Object, _mockFFHelper.Object, _mockHtmlPublisher.Object, _mockLogStoreHelper.Object, true);
var token = new CancellationToken();
var IsUploadNativeFilesToTCMSupported = _publisher.IsUploadNativeFilesToTCMSupported;

// Feature Flag for testing and deprecating PublishHTMLReport; To be cleaned up post PCCRV2 upgrade
if (IsUploadNativeFilesToTCMSupported.Equals(false))
{
var publisher = new AzurePipelinesPublisher(_context, _mockClientFactory.Object, _mockFFHelper.Object, _mockHtmlPublisher.Object, _mockLogStoreHelper.Object, true);
var token = new CancellationToken();

_mockHtmlPublisher.Setup(x => x.PublishHTMLReportAsync(It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
_mockHtmlPublisher.Setup(x => x.PublishHTMLReportAsync(It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);

publisher.PublishHTMLReport("directory", token).Wait();
publisher.PublishHTMLReport("directory", token).Wait();

_mockHtmlPublisher.Verify(x => x.PublishHTMLReportAsync(
It.Is<string>(a => a == "directory"),
It.Is<CancellationToken>(b => b == token)));
_mockHtmlPublisher.Verify(x => x.PublishHTMLReportAsync(
It.Is<string>(a => a == "directory"),
It.Is<CancellationToken>(b => b == token)));
}
}

[TestMethod]
Expand Down
22 changes: 12 additions & 10 deletions src/CoveragePublisher/CoverageProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using Microsoft.Azure.Pipelines.CoveragePublisher.Model;
using Microsoft.Azure.Pipelines.CoveragePublisher.Parsers;
using Microsoft.Azure.Pipelines.CoveragePublisher.Utils;
using Microsoft.Azure.Pipelines.CoveragePublisher.Publishers.DefaultPublisher;
using Microsoft.VisualStudio.Services.WebApi;

namespace Microsoft.Azure.Pipelines.CoveragePublisher
Expand Down Expand Up @@ -108,20 +109,21 @@ public async Task ParseAndPublishCoverage(PublisherConfiguration config, Cancell
}
}

if (config.GenerateHTMLReport)
{
if (!Directory.Exists(config.ReportDirectory))
{
TraceLogger.Warning(Resources.NoReportDirectoryGenerated);
}
else
//Feature Flag for testing and deprecating PublishHTMLReport; To be cleaned up post PCCRV2 upgrade
if (!uploadNativeCoverageFilesToLogStore && config.GenerateHTMLReport)
{
using (new SimpleTimer("CoverageProcesser", "PublishHTMLReport", _telemetry))
if (!Directory.Exists(config.ReportDirectory))
{
await _publisher.PublishHTMLReport(config.ReportDirectory, token);
TraceLogger.Warning(Resources.NoReportDirectoryGenerated);
}
else
{
using (new SimpleTimer("CoverageProcesser", "PublishHTMLReport", _telemetry))
{
await _publisher.PublishHTMLReport(config.ReportDirectory, token);
}
}
}
}
}
// Only catastrophic failures should trickle down to these catch blocks
catch(ParsingException ex)
Expand Down
Loading