Html logger

[hvinett]

Description

Adding the html logger, which would output the test results in the html format.

Related issue

#2065

• Add Unit Tests
• Add docs for the public methods
• Add exception handling
• Add logging

Here is the draft html

[msftclas]

All CLA requirements met.

[singhsarab]

Remove this file

---

Refers to: src/Microsoft.TestPlatform.Extensions.HtmlLogger/html.html:1 in a5fe993. [](commit_id = a5fe993, deletion_comment = False)

[singhsarab]

// Copyright (c) Microsoft Corporation. All rights reserved.

Rename the file name of this file, make sure it is formatted correctly.
TestResult.cs

Also, put these files in a folder, name it ObjectModel

---

Refers to: src/Microsoft.TestPlatform.Extensions.HtmlLogger/Testresult.cs:1 in a5fe993. [](commit_id = a5fe993, deletion_comment = False)

[singhsarab]

Add some useful summary for the tests, repeating what's already there in the name of the test is not advisable.

[singhsarab]

Add tests for these

[singhsarab]

Incomplete test

[mayankbansal018]

Can you change this to TryDelete with bool return, In case file does not exists this API will throw.

[mayankbansal018]

GetFormattedDurationString [](start = 24, length = 26)

make it private

[hvinett]

i want to test the GetFormattedDurationString function.

[mayankbansal018]

Results [](start = 12, length = 7)

do we need concurrent dictionaries, I'm not sure if multiple threads are trying to add to results.

[hvinett]

@dotnet-bot test

[RehanSaeed]

How do we make use of the new HTML logger? The docs need updating:

https://github.com/Microsoft/vstest-docs/blob/master/docs/report.md#syntax-of-default-loggers

[singhsarab]

@RehanSaeed Thanks. the docs have been updated.

[RehanSaeed]

Is there a way to use it with dotnet test too? Executing this doesn't seem to work after upgrading my xUnit project to include 16.3.0 of the test SDK.

dotnet test --logger 'html;LogFileName=foo.html'

[singhsarab]

@RehanSaeed This will be part of the dotnet sdk, and the 3.1.xx release will have it, it is still not out yet.

[RehanSaeed]

Cool! Is the syntax to support multiple loggers like this?

dotnet test --logger trx;LogFileName=foo.trx --logger html;LogFileName=foo.html

[dracos1993]

How to use this html logger with runsettings file? I tried via cli and it works, but no luck through the config file.

<LoggerRunSettings> <Loggers> <Logger friendlyName="html"> <Configuration> <LogFileName>test.html</LogFileName> </Configuration> </Logger> </Loggers> </LoggerRunSettings>

[ViktorHofer]

@nohwnd can you please check if it's possible to enable the html logger via the .runsettings file? Thanks

[nohwnd]

@RehanSaeed yes that works, but you should put those options in quotes if you run them from bash / powershell because ; terminates the command and you would end up evaluating only half of the command. Or in powershell you can use the parsing terminator --%:

# cmd / bash / powershell
dotnet test --logger "trx;LogFileName=foo.trx" --logger "html;LogFileName=foo.html"

# or another way in powershell
dotnet test --% --logger trx;LogFileName=foo.trx --logger html;LogFileName=foo.html

@dracos1993

This is what you'd do from settings, I actually just copied it from the log and removed unneeded lines:

dotnet test --% --logger trx;LogFileName=foo.trx --logger html;LogFileName=foo.html --diag c:\temp\log.txt

<RunSettings>
  <RunConfiguration>
  </RunConfiguration>
  <LoggerRunSettings>
    <Loggers>
      <Logger friendlyName="trx" enabled="True">
        <Configuration>
          <LogFileName>foo.trx</LogFileName>
        </Configuration>
      </Logger>
      <Logger friendlyName="html" enabled="True">
        <Configuration>
          <LogFileName>foo.html</LogFileName>
        </Configuration>
      </Logger>
    </Loggers>
  </LoggerRunSettings>
</RunSettings>