Skip to content

fix same file access exception #3373

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

Merged
nohwnd merged 7 commits into from
May 30, 2022
Merged

fix same file access exception #3373

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4995c82
fix same file access exception
ntovas Feb 15, 2022
ca13bfb
dont use iteration when HtmlFileName is provided
ntovas Apr 14, 2022
93cc2d8
fixes from review
ntovas May 23, 2022
0b37208
Fix merge conflicts and apply some style refactorings
Evangelink May 24, 2022
7d5782d
Fix behavior
Evangelink May 24, 2022
41b6ec7
Fix broken tests
Evangelink May 25, 2022
8a42f01
Rename lock
Evangelink May 26, 2022
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
38 changes: 27 additions & 11 deletions src/Microsoft.TestPlatform.Extensions.HtmlLogger/HtmlLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public class HtmlLogger : ITestLoggerWithParameters
private readonly IFileHelper _fileHelper;
private readonly XmlObjectSerializer _xmlSerializer;
private readonly IHtmlTransformer _htmlTransformer;
private static readonly object LockObject = new();
Comment thread
Evangelink marked this conversation as resolved.
Outdated
private Dictionary<string, string> _parametersDictionary;

public HtmlLogger()
Expand Down Expand Up @@ -301,25 +302,26 @@ private void PopulateHtmlFile()
Environment.GetEnvironmentVariable("UserName"), Environment.MachineName,
FormatDateTimeForRunName(DateTime.Now));

XmlFilePath = GetFilePath(HtmlLoggerConstants.XmlFileExtension, fileName);
XmlFilePath = GenerateUniqueFilePath(fileName, HtmlLoggerConstants.XmlFileExtension);

using (var xmlStream = _fileHelper.GetStream(XmlFilePath, FileMode.Create))
using (var xmlStream = _fileHelper.GetStream(XmlFilePath, FileMode.OpenOrCreate))
{
_xmlSerializer.WriteObject(xmlStream, TestRunDetails);
}

if (string.IsNullOrEmpty(HtmlFilePath))
{
HtmlFilePath = GetFilePath(HtmlLoggerConstants.HtmlFileExtension, fileName);
}
HtmlFilePath = GenerateUniqueFilePath(
string.IsNullOrEmpty(HtmlFilePath)
? fileName
: Path.GetFileNameWithoutExtension(HtmlFilePath),
Comment thread
Evangelink marked this conversation as resolved.
Outdated
HtmlLoggerConstants.HtmlFileExtension);

_htmlTransformer.Transform(XmlFilePath, HtmlFilePath);
}
catch (Exception ex)
{
EqtTrace.Error("HtmlLogger : Failed to populate html file. Exception : {0}",
EqtTrace.Error("HtmlLogger: Failed to populate html file. Exception: {0}",
ex.ToString());
ConsoleOutput.Instance.Error(false, string.Concat(HtmlResource.HtmlLoggerError), ex.Message);

@Evangelink Evangelink May 24, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated change but there was no need for the string.Concat.

ConsoleOutput.Instance.Error(false, HtmlResource.HtmlLoggerError, ex.Message);
return;
}
finally
Expand All @@ -335,10 +337,24 @@ private void PopulateHtmlFile()
ConsoleOutput.Instance.Information(false, htmlFilePathMessage);
}

private string GetFilePath(string fileExtension, string fileName)
private string GenerateUniqueFilePath(string fileName, string fileExtension)
{
var fullFileFormat = $".{fileExtension}";
return Path.Combine(TestResultsDirPath, string.Concat("TestResult_", fileName, fullFileFormat));
string fullFilePath;
for (short i = 0; i < short.MaxValue; i++)
{
var fileNameWithIter = i == 0 ? fileName : Path.GetFileNameWithoutExtension(fileName) + $"[{i}]";
fullFilePath = Path.Combine(TestResultsDirPath, $"TestResult_{fileNameWithIter}.{fileExtension}");
lock (LockObject)
{
if (!File.Exists(fullFilePath))
{
File.Create(fullFilePath);
return fullFilePath;
}
}
}

throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, HtmlResource.CannotGenerateUniqueFilePath, fileName, TestResultsDirPath));
}

private string FormatDateTimeForRunName(DateTime timeStamp)
Expand Down
11 changes: 10 additions & 1 deletion src/Microsoft.TestPlatform.Extensions.HtmlLogger/Resources/Resources.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/Microsoft.TestPlatform.Extensions.HtmlLogger/Resources/Resources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="CannotGenerateUniqueFilePath" xml:space="preserve">
<value>Cannot generate a unique file name for name '{0}' on path '{1}'.</value>
</data>
<data name="HtmlFilePath" xml:space="preserve">
<value>Html test results file : {0}</value>
</data>
Expand Down
22 changes: 11 additions & 11 deletions test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlLoggerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ public void TestCompleteHandlerShouldKeepTackOfSummary()
}

[TestMethod]
public void TestCompleteHandlerShouldCreateCustumHtmlFileNamewithLogFileNameKey()
public void TestCompleteHandlerShouldCreateCustomHtmlFileNamewithLogFileNameKey()
{
var parameters = new Dictionary<string, string?>
{
Expand All @@ -415,7 +415,7 @@ public void TestCompleteHandlerShouldCreateCustumHtmlFileNamewithLogFileNameKey(
}

[TestMethod]
public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefix()
public void TestCompleteHandlerShouldCreateCustomHtmlFileNameWithLogPrefix()
{
var parameters = new Dictionary<string, string>
{
Expand All @@ -435,7 +435,7 @@ public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefix()
}

[TestMethod]
public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefixIfTargetFrameworkIsNull()
public void TestCompleteHandlerShouldCreateCustomHtmlFileNameWithLogPrefixIfTargetFrameworkIsNull()
{
var parameters = new Dictionary<string, string>
{
Expand All @@ -455,7 +455,7 @@ public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefixIfTarg
}

[TestMethod]
public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefixNull()
public void TestCompleteHandlerShouldCreateCustomHtmlFileNameWithLogPrefixNull()
{
var parameters = new Dictionary<string, string?>
{
Expand All @@ -468,14 +468,14 @@ public void TestCompleteHandlerShouldCreateCustumHtmlFileNameWithLogPrefixNull()
var result1 = new ObjectModel.TestResult(testCase1) { Outcome = TestOutcome.Failed };
var resultEventArg1 = new Mock<TestResultEventArgs>(result1);

_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
{
}).Returns(new Mock<Stream>().Object);

_htmlLogger.TestResultHandler(new object(), resultEventArg1.Object);
_htmlLogger.TestRunCompleteHandler(new object(), new TestRunCompleteEventArgs(null, false, true, null, null, null, TimeSpan.Zero));

_mockFileHelper.Verify(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite), Times.Once);
_mockFileHelper.Verify(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite), Times.Once);
}

[TestMethod]
Expand Down Expand Up @@ -514,14 +514,14 @@ public void TestCompleteHandlerShouldCreateFileCorrectly()
var result1 = new ObjectModel.TestResult(testCase1) { Outcome = TestOutcome.Failed };
var resultEventArg1 = new Mock<TestResultEventArgs>(result1);

_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
{
}).Returns(new Mock<Stream>().Object);

_htmlLogger.TestResultHandler(new object(), resultEventArg1.Object);
_htmlLogger.TestRunCompleteHandler(new object(), new TestRunCompleteEventArgs(null, false, true, null, null, null, TimeSpan.Zero));

_mockFileHelper.Verify(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite), Times.Once);
_mockFileHelper.Verify(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite), Times.Once);
}

[TestMethod]
Expand All @@ -548,7 +548,7 @@ public void TestCompleteHandlerShouldCallHtmlTransformerCorrectly()
var result1 = new ObjectModel.TestResult(testCase1) { Outcome = TestOutcome.Failed };
var resultEventArg1 = new Mock<TestResultEventArgs>(result1);

_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
{
}).Returns(new Mock<Stream>().Object);

Expand All @@ -564,7 +564,7 @@ public void TestCompleteHandlerShouldWriteToXmlSerializerCorrectly()
var testCase1 = CreateTestCase("TestCase1") ?? throw new ArgumentNullException($"CreateTestCase(\"TestCase1\")");
var result1 = new ObjectModel.TestResult(testCase1) { Outcome = TestOutcome.Failed };
var resultEventArg1 = new Mock<TestResultEventArgs>(result1);
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
{
}).Returns(new Mock<Stream>().Object);

Expand All @@ -579,7 +579,7 @@ public void TestCompleteHandlerShouldWriteToXmlSerializerCorrectly()
[TestMethod]
public void TestCompleteHandlerShouldNotDivideByZeroWhenThereAre0TestResults()
{
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.Create, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
_mockFileHelper.Setup(x => x.GetStream(It.IsAny<string>(), FileMode.OpenOrCreate, FileAccess.ReadWrite)).Callback<string, FileMode, FileAccess>((x, y, z) =>
{
}).Returns(new Mock<Stream>().Object);

Expand Down