Ability to expose custom text on report page

[4ekki]

I run tests with multiple versions of SUT and it would be great to be able to see inside the report, what software version was actually tested.

I'd like to be able to run jest with some environment variable, that will be taken into account by jest-html-reporters and text from this variable would be added to report page, something like this:

[Hazyzh]

Hi @4ekki , How about adding a reporter option?
Just like this

You can fill a list of values in this field.

[4ekki]

@Hazyzh , yeah, this should work. Will it handle environment variables?

[Hazyzh]

@Hazyzh , yeah, this should work. Will it handle environment variables?

I can get environment variables, but hard to know which variables should show in the report.

[4ekki]

What about taking a single specific variable, smth like $JEST_HTML_REPORTERS_CUSTOM_TEXT, and exposing its value to the report, if it's defined? Such variable can be initialized in globalTeardown script, allowing me to put there anything I want.

[Hazyzh]

If so, what's structure would the value like of this variable? for a single string, it's hard to display every item one by one.

[4ekki]

For my specific case, I want to show this block in the report:

Environment:   		QA
Product branch:         feature/abc-4251-client-service-abc
Tests branch:  		master
Current time:  		2019-12-19T10:01:44.992Z

But I wanted to handle the formatting on my own (with all those \n and \t), since other people will definitely have their own structure.

However, I can put it into a json or an array of key-value pairs and you'll be able to parse it and put into a nice table-like structure.
So for this example, I'd define the following variable in globalTeardown:
process.env.JEST_HTML_REPORTERS_CUSTOM_TEXT_JSON="{'Environment':'QA','Product branch':'feature/abc-4251-client-service-abc','Tests branch':'master','Current time':'2019-12-19T10:01:44.992Z'}"

[Hazyzh]

Hi @4ekki,
New version(1.2.1) will include this feature, even though it's an uncommon way to set a JSON object in the env variable, notice I change the specific variable name to JEST_HTML_REPORTERS_CUSTOM_INFOS.

A common way to use this feature is to set values in the config's customInfos key.

[4ekki]

@Hazyzh , many thanks!!!

[4ekki]

Small note for anyone referring this in future. Since globalTeardown is actually run AFTER the report is being created, initializing JEST_HTML_REPORTERS_CUSTOM_INFOS should be done in globalSetup instead.