platformio-core/tests/conftest.py

# Copyright 2014-present PlatformIO <contact@platformio.org>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os

import pytest
from click.testing import CliRunner


@pytest.fixture(scope="session")
def platformio_setup(request):
    pioenvvars = ("ENABLE_PROMPTS", "ENABLE_TELEMETRY")
    for v in pioenvvars:
        os.environ["PLATFORMIO_SETTING_%s" % v] = "No"

    def platformio_teardown():
        for v in pioenvvars:
            _name = "PLATFORMIO_SETTING_%s" % v
            if _name in os.environ:
                del os.environ[_name]

    request.addfinalizer(platformio_teardown)


@pytest.fixture(scope="module")
def clirunner():
    return CliRunner()


@pytest.fixture(scope="session")
def validate_cliresult():
    def decorator(result):
        assert result.exit_code == 0
        assert not result.exception
        assert "error" not in result.output.lower()
    return decorator


@pytest.fixture(scope="module")
def isolated_pio_home(request, tmpdir_factory):
    home_dir = tmpdir_factory.mktemp(".platformio")
    os.environ['PLATFORMIO_HOME_DIR'] = str(home_dir)

    def fin():
        del os.environ['PLATFORMIO_HOME_DIR']

    request.addfinalizer(fin)
    return home_dir