Additional reporters

[Gijsreyn]

As a user implementing the markdown-link-check in CI pipelines, it's helpful to have additional reporters like JUnit/XUnit to easily report on. The #364 PR addresses the JUnit reporter as additional option to the CLI, but this was later reverted.

Now I have to fallback to using regex and some PowerShell and convert it myself:

# Simple regex
$successPattern = [regex]::new('\[✓\] (http[^\s]+)')
$deadPattern = [regex]::new('\[✖\] (http[^\s]+) → Status: (\d+)')

# Do transformation on content generated and then use the following function to generate JUnit
function ConvertTo-JUnitXml {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [psobject[]]$InputObject
    )

    # Create XML document
    $xml = New-Object System.Xml.XmlDocument
    $xmlDeclaration = $xml.CreateXmlDeclaration("1.0", "UTF-8", $null)
    $xml.AppendChild($xmlDeclaration) | Out-Null

    # Create root element
    $root = $xml.CreateElement("testsuites")
    $root.SetAttribute("name", "Test run")
    $root.SetAttribute("tests", $InputObject.Count.ToString())
    $root.SetAttribute("failures", ($InputObject | Where-Object { $_.Status -eq 'Failure' }).Count.ToString())
    $root.SetAttribute("errors", "0")
    $root.SetAttribute("skipped", "0")
    $root.SetAttribute("assertions", "0")
    $root.SetAttribute("time", "0")
    $root.SetAttribute("timestamp", (Get-Date).ToString("yyyy-MM-ddTHH:mm:ss"))
    $xml.AppendChild($root) | Out-Null

    # Create a testsuite element
    $testsuite = $xml.CreateElement("testsuite")
    $testsuite.SetAttribute("name", "Brokenlink.Assertion")
    $testsuite.SetAttribute("time", "0")
    $root.AppendChild($testsuite) | Out-Null

    foreach ($item in $InputObject) {
        $testcase = $xml.CreateElement("testcase")
        $testcase.SetAttribute("classname", $item.URL)
        $testcase.SetAttribute("name", $item.URL)
        $testcase.SetAttribute("time", "0")

        if ($item.Status -eq 'Failure') {
            $failure = $xml.CreateElement("failure")
            $failure.SetAttribute("message", "Status Code: $($Item.StatusCode)")
            $failure.SetAttribute("type", "BrokenlinkError")
            $testcase.AppendChild($failure) | Out-Null
        }

        $testsuite.AppendChild($testcase) | Out-Null
    }

    return $xml.OuterXml
}

[smainil]

Hey @Gijsreyn , what you want us to do ? revert the deletion of the junit reporter ?

[Gijsreyn]

Hey @smainil thanks for the reply. If that's feasible, yes, I would really like that. However, I've seen the comments placed but couldn't fully understand why it was reverted (it broke something?).

[smainil]

@Gijsreyn I don't really know why it has been removed but will check if we can add back.

@tcort any clue why the reporters (junit) have been removed

[github-actions]

This issue has been marked as stale because it has been open 60 days with no activity. It will be closed in 30 days unless the stale label is removed or someone adds a comment.

[github-actions]

This issue was closed because it has been marked as stale for 30 days with no activity.

[Gijsreyn]

Ah pity that this one got closed :(

[smainil]

@Gijsreyn could you provide me with an example of markrdown-link-ckeck report you have and the Junit XML file generated by your script ?

[Gijsreyn]

@smainil Here you go:

In the test.md file, the following is:

# Introduction

[This link is broken](https://example.com/nonexistent-page)

The string was retrieved by running markdown-link-check test.md

[smainil]

My first try yesterday to add a junit reporter was not successful.

If I check a single file the report generated is correct

./markdown-link-check --reporters junit test.md        

FILE: test.md

Wrote junit.xml

<?xml version="1.0" encoding="UTF-8"?>
<testsuites>
  <testsuite name="test.md">
    <testcase classname="https://example.com/nonexistent-page" name="https://example.com/nonexistent-page" time="0">
      <error message="https://example.com/nonexistent-page is dead (404)" type="dead"/>
    </testcase>
  </testsuite>
</testsuites>

But if I check more than one md file, the junit.xml file is written for every file :-( due to where the reporters are called.

./markdown-link-check --reporters junit test.md test2.md  

FILE: test.md

Wrote junit.xml

FILE: test2.md

Wrote junit.xml

<?xml version="1.0" encoding="UTF-8"?>
<testsuites>
  <testsuite name="test2.md"/>
</testsuites>

I need to find a way to make it work.

[Gijsreyn]

Any luck @smainil ?