Page header does not take environment variables into account

[MaximeWeyl]

In pytest.ini, I have :

addopts = --html $APPRENTI_MOTEUR_LOGS_DIR_TEST/$APPRENTI_MOTEUR_LOGS_HTML_NAME

The path of the html report takes the content of the environment variable into account.

But the page header does not :

It would be nice if it would as well :-)

[BeyondEvil]

Thanks for reporting this! @MaximeWeyl

However, I think this is a limitation (bug?) with pytest itself, and not the plugin. And I'm not really, at least initially, comfortable with solving the symptom.

Thoughts @nicoddemus ?

[nicoddemus]

Not sure, how does pytest-html get that header?

[BeyondEvil]

Not sure, how does pytest-html get that header?

https://github.com/pytest-dev/pytest-html/blob/master/pytest_html/plugin.py#L435

@nicoddemus

[MaximeWeyl]

I think the trick (used for the HTML report filename) is here : logfile = os.path.expanduser(os.path.expandvars(logfile)) self.logfile = os.path.abspath(logfile)

[MaximeWeyl]

I feel like replacing session.config.option.htmlpath with self.logfile in html.h1(os.path.basename(session.config.option.htmlpath)), would work (but I have no computer to test it right now).

[nicoddemus]

addopts does not seem to expand environment variables at all:

[pytest]
addopts = %TEMP%

(I'm on Windows)

Results in:

ERROR: file not found: %TEMP%

Same if I use $TEMP.

As @MaximeWeyl just pointed all, this is the culprit:

pytest-html/pytest_html/plugin.py

Lines 86 to 90 in 27b6e77

	class HTMLReport(object):
	def __init__(self, logfile, config):
	logfile = os.path.expanduser(os.path.expandvars(logfile))
	self.logfile = os.path.abspath(logfile)

So this line:

pytest-html/pytest_html/plugin.py

Line 435 in 27b6e77

html.h1(os.path.basename(session.config.option.htmlpath)),

Should be using the expanded string as well. 👍

[RibeiroAna]

I'm not sure I understand, but you want to write the whole path of the test file, not only the tittle, right? Because if is that, you can use just put out the basename thing from it, right? Or am I not seing something?

[BeyondEvil]

addopts does not seem to expand environment variables at all:

Right, as I expected. So this is by design then, and not a bug?

If that's the case, I can create a PR with the suggested fix. :)

@nicoddemus

[BeyondEvil]

I'm not sure I understand, but you want to write the whole path of the test file, not only the tittle, right? Because if is that, you can use just put out the basename thing from it, right? Or am I not seing something?

What's happening is that the environment variable isn't being expanded "in" the report. It's using the name of the env var instead.

@RibeiroAna

[nicoddemus]

Right, as I expected. So this is by design then, and not a bug?

Exactly. 👍

If that's the case, I can create a PR with the suggested fix. :)

Sure, that would be great!

[BeyondEvil]

So, changing it to use self.logfile with:

addopts = --html $HTMLREP.html where $HTMLREP expands to "hello"

renders the entire path:

Is that the expected behaviour? 🤔

@nicoddemus @MaximeWeyl

[nicoddemus]

Sorry, I wasn't clear, the line should be changed to this:

html.h1(os.path.basename(self.logfile)), 

[BeyondEvil]

Sorry, I wasn't clear, the line should be changed to this:

html.h1(os.path.basename(self.logfile)), 

Oh, haha, duh! 😛

I'm going to see if I can add a test for it as well. PR incoming! (Probably not tonight tho..)

[nicoddemus]

Sure, sounds good! 😁