pytest-gitlab-fold

Pytest plugin that folds output sections in GitLab CI build log.

It is a port of Eldar Abusalimov's excellent pytest-travis-fold plugin, all credits go to him and contributors.

In addition, pytest-gitlab-fold recognizes presence of the pytest-cov plugin and folds coverage reports accordingly.

Installation and Usage

Just install the [pytest-gitlab-fold][linnk-pypi] package as part of your build.

When using tox, add the package to the deps list in your tox.ini and make sure the GITLAB_CI environment variable is passed:

[testenv]
deps =
    pytest-gitlab-fold
passenv = GITLAB_CI

If you don't use tox and invoke py.test directly from .gitlab-ci.yml, you may install the package as an additional install step:

install:
  - pip install -e .
  - pip install pytest-gitlab-fold

script: py.test

Output folding is enabled automatically when running inside GitLab CI. It is OK to have the plugin installed also in your dev environment: it is only activated by checking the presence of the GITLAB_CI environmental variable, unless the --gitlab-fold command line switch is used.

The gitlab fixture

The plugin by itself only makes the captured output sections appear folded. If you wish to make the same thing with arbitrary lines, you can do it manually by using the gitlab fixture.

It is possible to fold the output of a certain code block using the gitlab.folding_output() context manager:

def test_something(gitlab):
    with gitlab.folding_output():
        print("Lines, lines, lines...")
        print("Lots of them!")
        ...

Or you may want to use lower-level gitlab.fold_string() and gitlab.fold_lines() functions and then output the result as usual.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "pytest-gitlab-fold" is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.