Enable implicit plugin usage by using a `--reportportal` flag

[liiight]

Instead of activation the plugin by default and using pytest's disable plugin ability to shut it down, it would be nicer to enable it explicitly by sending a --reportportal flag:
pytest tests --reportportal
Which can also be used in the pytets.ini files:

[pytest]
addopts: --reportportal

If i'll have the time I'll try to push a PR with this change myself

[evjlobanova]

@liiight hello, unfortunately now we do not have any python specialist in a team. So feel free to send a pull request)

[DzmitryHumianiuk]

@reportportal/python-contributors what do you think?

[DzmitryHumianiuk]

@krasoffski @s0undt3ch
@ramriddick @frizzby @vakulich @KKoukiou
@sivashh @kleptog
@aliaksandr-trush
what do you think?

[aliaksandr-trush]

I vote to not implement this behavior.

1. I do not see benefits.
2. I think we need to have as less actions as possible for client activation.

[KKoukiou]

@liiight I don't see any reason for this change, can you please elaborate why you find it better?

Also pytest --trace-config for searching active plugins will give invalid results if we make this change, no?

[liiight]

The benefit is that after installing the plugin it is invoked by default on every run, crashing if config isn't correct.

Explicit is better than implicit...

[s0undt3ch]

I'm not opposed to this change in behavior. Usually we want to enable report portal on some circumstances, CI, not all.

[sivashh]

@KKoukiou if I'm not mistaken at the moment report portal plugin will always appear in trace config disregarding of plugin configuration.

I agree with @liiight on the fact it is handy to have ability of enabling/disabling plugin without changing pytest.ini code.

One solution (not sure if this is the one we need) is to make all rp properties available through command line arguments. If not all needed properties are provided - plugin will be disabled here

agent-python-pytest/pytest_reportportal/plugin.py

Line 123 in 67269d3

config._reportportal_configured = all([project, endpoint, uuid])

.

I did a proof-of-a-concept brunch for internal usage here https://github.com/sivashh/agent-python-pytest/blob/add_cli_args/pytest_reportportal/plugin.py. Here you have most of properties available through both cli and pytest.ini. Cli options override ini options.

[abotalov]

I think it would be better to solve such issues in general way on Pytest side.

Recently ability to disable autoloading of all plugins was added to Pytest - pytest-dev/pytest#3787. Then you probably should be able to explicitly load them using pytest_plugins variable or PYTEST_PLUGINS env variable.

[DzmitryHumianiuk]

@sivashh

Here you have most of properties available through both cli and pytest.ini. Cli options override ini options.

this is exactly how we make it for Java client.
initially agent search for System level variables, then override it by reportportal.property file variables, and then override it with command line variables.

this helps to manage execution combinations in CI, by enabling/disabling adapter, send it to debug, or change launch name, or tags, based on enviroment

[kleptog]

The way I fixed this in our CI tests is using the feature merged in master where reportalplugin only works if the configuration is complete. In my case I comment out the rp_endpoint configuration in the checked in code and the use the pytest "-o" option to activate reportalporal only for the CI.

This patch would remove the need for that hack, but I guess opinions will differ as to whether it's a hack or not.

[aliaksandr-trush]

@liiight I see benefits now.
I've created PR. Please review it and approve that it is what you mean.

[DzmitryHumianiuk]

@liiight @aliaksandr-trush accepted. merged