platformio-core/tests/conftest.py

# Copyright (c) 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 email
import os
import poplib
import time

import pytest
from click.testing import CliRunner

from platformio import util


def pytest_configure(config):
    config.addinivalue_line("markers", "skip_ci: mark a test that will not run in CI")


@pytest.fixture(scope="session")
def validate_cliresult():
    def decorator(result):
        assert result.exit_code == 0, "{} => {}".format(result.exception, result.output)
        assert not result.exception, "{} => {}".format(result.exception, result.output)

    return decorator


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


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

    def fin():
        del os.environ["PLATFORMIO_CORE_DIR"]

    request.addfinalizer(fin)
    return home_dir


@pytest.fixture(scope="function")
def without_internet(monkeypatch):
    monkeypatch.setattr(util, "_internet_on", lambda: False)


@pytest.fixture
def receive_email():  # pylint:disable=redefined-outer-name, too-many-locals
    def _receive_email(from_who):
        test_email = os.environ.get("TEST_EMAIL_LOGIN")
        test_password = os.environ.get("TEST_EMAIL_PASSWORD")
        pop_server = os.environ.get("TEST_EMAIL_POP3_SERVER") or "pop.gmail.com"
        if "gmail" in pop_server:
            test_email = "recent:" + test_email

        def get_body(msg):
            if msg.is_multipart():
                return get_body(msg.get_payload(0))
            return msg.get_payload(None, True)

        result = None
        start_time = time.time()
        while not result:
            time.sleep(5)
            server = poplib.POP3_SSL(pop_server)
            server.user(test_email)
            server.pass_(test_password)
            _, mails, _ = server.list()
            for index, _ in enumerate(mails):
                _, lines, _ = server.retr(index + 1)
                msg_content = b"\n".join(lines)
                msg = email.message_from_string(
                    msg_content.decode("ASCII", errors="surrogateescape")
                )
                if from_who not in msg.get("To"):
                    continue
                server.dele(index + 1)
                result = get_body(msg).decode()
            if time.time() - start_time > 120:
                break
            server.quit()
        return result

    return _receive_email