Extends allure-pytest functionality
Project description
pytest-glamor-allure
pytest plugin extending allure behaviour
- Why has it been created?
- What is it?
- Why is it named "glamor"?
- How to install?
- What does it can?
- Pleasant bonus 🎁
- How can I help?
Why has it been created?
Just because allure-python plugin accepts PRs very slowly. Sad but true.
I want to inject more functionality into it. That's why I've decided to create this plugin.
What is it?
As been said it is pytest plugin (tnx captain 😄). Consider this plugin just as some extension for allure-pytest.
Hopefully, they'll see this code and add some of this functionality later.
Why is it named "glamor"?
Because "glamor" is a synonym for "allure". Glamor does the same thing as allure-pytest does but a little more.
The main idea is to just replace imports in you project: instead of import allure
you type import glamor as allure
and everything works as before.
How to install?
pip install pytest-glamor-allure
That's it.
What does it can?
It's the most interesting part of the ReadMe.
Fancy names for setups and teardowns
allure-python provides possibility to set title for fixture with @allure.title
decorator.
But there is no chance to set different titles for setup and teardown. Glamor does can this!
import pytest
import glamor as allure
@pytest.fixture
@allure.title.setup('Fancy setup name')
@allure.title.teardown('Fancy teardown name')
def fixture():
yield
@allure.title('Test Title')
def test_test(fixture):
with allure.step('test step'):
pass
And moreover. You can dynamically change setup and teardown titles for fixtures.
Only one restriction: dynamic hook must be used inside the fixture's body.
import pytest
import glamor as allure
@pytest.fixture
def fixture():
yield
allure.dynamic.title.setup('Fancy dynamic setup name')
allure.dynamic.title.teardown('Fancy dynamic teardown name')
@allure.title('Test Title')
def test_test(fixture):
with allure.step('test step'):
pass
Hide setup and teardown
Have you ever wanted to conceal setup and/or teardown from 'allure' report?
Well, now you can.
import pytest
import glamor as allure
@pytest.fixture
@allure.title.setup(hidden=True)
@allure.title.teardown('Teardown ONE')
def fixture():
yield
@pytest.fixture
@allure.title.setup('Setup TWO')
def fixture2():
yield
if True:
allure.dynamic.title.teardown(hidden=True)
@allure.title('Test Title')
def test_test(fixture, fixture2):
with allure.step('test step'):
pass
But! If any exception (including Skipped
) is raised, then hidden setups and teardowns are shown forcefully.
import pytest
import glamor as allure
@pytest.fixture
@allure.title.setup('Setup is displayed in case of failure', hidden=True)
@allure.title.teardown('Teardown ONE')
def fixture():
with allure.step('fail step'):
assert False, 'some exception in setup'
yield
@pytest.fixture
@allure.title.setup('Setup TWO')
def fixture2():
yield
if True:
allure.dynamic.title.teardown(hidden=True)
pytest.skip('we decided to skip')
@allure.title('Test Title')
def test_test(fixture2, fixture):
with allure.step('test step'):
pass
Display 'scope' and 'autouse' fixture parameters in fixture title
Sometimes it is useful to know which scope this fixture is, and was it called manually or autoused.
Just call the function once per runtime include_scope_in_title
before pytest starts execution of any hook (during modules initialization).
import pytest
import glamor as allure
allure.include_scope_in_title('before', autouse=True)
@pytest.fixture(scope='session', autouse=True)
@allure.title.setup('Fancy setup name')
def fixture():
yield
@pytest.fixture
@allure.title.setup('Setup TWO')
def fixture2():
yield
@allure.title('Test Title')
def test_test(fixture2):
with allure.step('test step'):
pass
The big letter is the first letter of the scope name (one of 'function', 'class', 'module', 'package', 'session'). The lower letter 'a' says that fixture was autoused.
If you want to put this information to the end of the title, then just call the function as allure.include_scope_in_title('after', autouse=True)
and you get:
No more '::0' in teardown title
Have you noticed '::0' in raw teardown titles? No? That's because glamor strips such ending if fixture has not more than one finalizer.
Add allure.step titles into logging
Have you ever tried to understand when the particular allure step started looking at tests' logs? Of course, you have!
With "glamor" you can register you own logger, which is considered to print steps' titles into output.
import logging
import sys
import glamor as allure
# Create logger
logger = logging.getLogger('MyLogger')
logger.setLevel(logging.INFO)
fmt = logging.Formatter('[%(levelname)s] %(message)s')
handler = logging.StreamHandler(stream=sys.stdout)
handler.setLevel(logging.INFO)
handler.setFormatter(fmt)
logger.addHandler(handler)
# Register logger in allure
allure.logging_allure_steps(logger)
# Execute tests' code
logger.info("start message")
with allure.step("step message"):
pass
logger.error("end message")
[INFO] start message
[STEP] step message
[ERROR] end message
logging_allure_steps
should be called only once - during modules initialization. But who am I to restrict you?
If you need you can turn off this behaviour by calling the function with None
instead of logging.Logger
instance.
What else?
import glamor as allure
allure.listener # access to AllureListener plugin instance
allure.reporter # alias for allure.listener.allure_logger
allure.pytest_config # access to pytest.Config instance. alias for allure.listener.config
Also via 'glamor' module you get direct access to many objects from:
- allure_commons
- allure_commons._allure
- allure_commons.model2
- allure_commons.types
- allure_commons.utils
- allure_pytest.utils
Pleasant bonus 🎁
Type import pitest as pytest
instead of import pytest
and get direct access to a bunch of objects from pytest
and _pytest
modules.
How can I help?
Your contribution is highly appreciated. Please read CONTRIBUTING.md before you start.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest_glamor_allure-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 058bcf773e564dcb41a537d3aac87a3260a7ce74688af7cff6da294ed8cc98d6 |
|
MD5 | ac9ba65f8e8a21c4c3051517b09127e8 |
|
BLAKE2b-256 | 810e1fd39812daca171938025c69098c30953eccb9437e31f3cd07a8b6b5e2d4 |
Hashes for pytest_glamor_allure-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e82918f348b4bd342583fade7ddb421cb02f5dc700c36ae0e93a7fa160664ea |
|
MD5 | 65f34afc5dbc2f09e54fe80a2f2868b5 |
|
BLAKE2b-256 | 70cd24afa5074c73aaa656995826193f7f0498526a4b5237f32ada1ae393f5c0 |