Skip to content

Issue with iReqnrollOutputHelper.WriteLine and AddAttachment in Reqnroll Version 3.0.0 and Higher #1007

Description

@Moshex

Reqnroll Version

3.3.2

Which test runner are you using?

NUnit

Test Runner Version Number

4.4.0

.NET Implementation

.NET 8.0

Test Execution Method

Visual Studio Test Explorer

Content of reqnroll.json configuration file

{
  "$schema": "https://schemas.reqnroll.net/reqnroll-config-latest.json",
  "bindingAssemblies": [
  ],
  "livingDocExecutionDataCollector": {
    "enabled": true,
    "filepath": "TestExecution.json"
  }
}

Issue Description

Subject: iReqnrollOutputHelper.WriteLine and AddAttachment Not Working in LivingDoc After Reqnroll Version 3.0.0+

Description of the Issue:

After upgrading to Reqnroll version 3.0.0 or higher, the following methods:

iReqnrollOutputHelper.WriteLine(SpecHelperText);  
iReqnrollOutputHelper.AddAttachment("attachment");  

no longer work when generating a LivingDoc. Additionally, the "Show Test Output" button is missing from the LivingDoc generated by Reqnroll.

This issue seems to be caused by the changes introduced in version 3.0.0, where new reporting formats and methods were introduced, as documented here: Reqnroll Formatters Documentation.

Impact:

The LivingDoc format is highly valuable to me due to its simplicity and the way it presents test results.

The new reporting introduced in version 3.0.0, while powerful, does not fit my use case as well as LivingDoc does. Losing the "Show Test Output" button and the ability to use the above methods diminishes the effectiveness of reporting for my workflow.

Request:

  1. Fix or Compatibility: Is there a way to restore compatibility for iReqnrollOutputHelper.WriteLine and AddAttachment methods so they work with LivingDoc in version 3.0.0 and higher?
  2. LivingDoc Support: Can you confirm whether LivingDoc is still supported in the newer versions of Reqnroll, or if there is a plan to continue supporting it alongside the new reporting format?
  3. Package Information: If the issue is related to the databinding.LivingDoc.ExecutionDataCollector NuGet package, could you provide information about the maintainer or author of this package so I can raise the issue with them directly?

Additional Notes:

I am aware of the new reporting features introduced in version 3.0.0 (Reqnroll Formatters Documentation), but I still prefer the LivingDoc format for my reports. The ability to use WriteLine and AddAttachment methods with LivingDoc was a crucial part of my workflow.

Please let me know if there is a way to make these methods work again with LivingDoc, or if you can provide information about who maintains the databinding.LivingDoc.ExecutionDataCollector package so I can escalate the issue to them.

Environment:

Reqnroll Version: 3.0.0 and higher
LivingDoc Version: Latest version
NuGet Package: databinding.LivingDoc.ExecutionDataCollector
Test Framework: SpecFlow / NUnit (if applicable)
Platform: Windows/MacOS/Linux (specify)

Steps to Reproduce

Steps to Reproduce:

  1. Upgrade to Reqnroll version 3.0.0 or higher.
  2. Use the following code snippet in a test:
iReqnrollOutputHelper.WriteLine("Test output");  
iReqnrollOutputHelper.AddAttachment("attachment_path");  
  1. Generate a LivingDoc report.
  2. Observe that the "Show Test Output" button is missing, and the above methods do not work.

Link to Repro Project

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions