BW3-Core/test/boswatch/test_timer.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
r"""!
    ____  ____  ______       __      __       __       _____
   / __ )/ __ \/ ___/ |     / /___ _/ /______/ /_     |__  /
  / __  / / / /\__ \| | /| / / __ `/ __/ ___/ __ \     /_ <
 / /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / /   ___/ /
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/   /____/
                German BOS Information Script
                     by Bastian Schroll

@file:        test_timer.py
@date:        21.09.2018
@author:      Bastian Schroll
@description: Unittests for BOSWatch. File have to run as "pytest" unittest
"""
# problem of the pytest fixtures
# pylint: disable=redefined-outer-name
import logging
import time
import pytest

from boswatch.timer import RepeatedTimer


def setup_function(function):
    logging.debug("[TEST] %s.%s", function.__module__, function.__name__)


def testTargetFast():
    r"""!Fast worker thread"""
    logging.debug("run testTargetFast")


def testTargetSlow():
    r"""!Slow worker thread"""
    logging.debug("run testTargetSlow start")
    time.sleep(0.51)
    logging.debug("run testTargetSlow end")


@pytest.fixture()
def useTimerFast():
    r"""!Server a RepeatedTimer instance with fast worker"""
    testTimer = RepeatedTimer(0.1, testTargetFast)
    yield testTimer
    if testTimer.isRunning:
        assert testTimer.stop()


@pytest.fixture()
def useTimerSlow():
    r"""!Server a RepeatedTimer instance slow worker"""
    testTimer = RepeatedTimer(0.1, testTargetSlow)
    yield testTimer
    if testTimer.isRunning:
        assert testTimer.stop()


def test_timerStartStop(useTimerFast):
    r"""!Try to start and stop a timer"""
    assert useTimerFast.start()
    assert useTimerFast.stop()


def test_timerDoubleStart(useTimerFast):
    r"""!Try to start a timer twice"""
    assert useTimerFast.start()
    assert useTimerFast.start()
    assert useTimerFast.stop()


def test_timerStopNotStarted(useTimerFast):
    r"""!Try to stop a timer where is not started"""
    assert useTimerFast.stop()


def test_timerIsRunning(useTimerFast):
    r"""!Check if a timer is running"""
    assert useTimerFast.start()
    assert useTimerFast.isRunning
    assert useTimerFast.stop()


def test_timerRun(useTimerFast):
    r"""!Run a timer and check overdue and lostEvents"""
    assert useTimerFast.start()
    time.sleep(0.2)
    assert useTimerFast.stop()
    assert useTimerFast.overdueCount == 0
    assert useTimerFast.lostEvents == 0


def test_timerOverdue(useTimerSlow):
    r"""!Run a timer and check overdue and lostEvents"""
    assert useTimerSlow.start()
    time.sleep(0.2)
    assert useTimerSlow.stop()
    assert useTimerSlow.overdueCount == 1
    assert useTimerSlow.lostEvents == 5


def test_timerOverdueLong(useTimerSlow):
    r"""!Run a timer and check overdue and lostEvents"""
    assert useTimerSlow.start()
    time.sleep(1)
    assert useTimerSlow.stop()
    assert useTimerSlow.overdueCount == 2
    assert useTimerSlow.lostEvents == 10