mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2025-12-06 07:12:04 +01:00
d4dcc75711
Without this change, many warnings like this will be generated while running pytest:
```
test/test_template.py:3
/build/source/test/test_template.py:3: DeprecationWarning: invalid escape sequence '\/'
"""!
```
This can also be seen when manually running python with warnings enabled.
This happens because the comment uses a multiline string and Python interprets the backslash in the logo as an escape character and complains that \/ is not a valid escape sequence. To fix this, prepend the string with the letter r to indicate that the backslash should be treated as a literal character, see https://docs.python.org/3/reference/lexical_analysis.html#index-20.
I also applied this change to all the comment strings since that shouldn't break anything and to establish it as a pattern for the future so this problem hopefully never happens again.
This is what I did specifically:
- Change the comment at the top of bw_client.py and bw_server.py to start with `"""!` since that seems to be the pattern here
- Search-and-Replace all occurances of `"""!` with `r"""!`
- Manually change the strings in `logoToLog()` in boswatch/utils/header.py
73 lines
2.3 KiB
Python
73 lines
2.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: test_descriptor.py
|
|
@date: 14.04.2020
|
|
@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 pytest
|
|
from boswatch.utils import paths
|
|
|
|
from boswatch.configYaml import ConfigYAML
|
|
from boswatch.packet import Packet
|
|
from module.descriptor import BoswatchModule as Descriptor
|
|
|
|
|
|
def setup_method(method):
|
|
logging.debug("[TEST] %s.%s", method.__module__, method.__name__)
|
|
|
|
|
|
@pytest.fixture
|
|
def makeDescriptor():
|
|
r"""!Build a descriptor object with loaded configuration"""
|
|
config = ConfigYAML()
|
|
assert config.loadConfigFile(paths.TEST_PATH + "test_config.yaml") is True
|
|
descriptor = Descriptor(config.get("descriptor_test"))
|
|
return descriptor
|
|
|
|
|
|
@pytest.fixture
|
|
def makePacket():
|
|
r"""!Build a BW Packet object"""
|
|
packet = Packet()
|
|
return packet
|
|
|
|
|
|
def test_descriptorFoundFirst(makeDescriptor, makePacket):
|
|
r"""!Run descriptor on the first entry in list"""
|
|
makePacket.set("tone", "12345")
|
|
makePacket = makeDescriptor.doWork(makePacket)
|
|
assert makePacket.get("description") == "Test 12345"
|
|
|
|
|
|
def test_descriptorFoundSecond(makeDescriptor, makePacket):
|
|
r"""!Run descriptor on the second entry in list"""
|
|
makePacket.set("tone", "23456")
|
|
makePacket = makeDescriptor.doWork(makePacket)
|
|
assert makePacket.get("description") == "Test 23456"
|
|
|
|
|
|
def test_descriptorNotFound(makeDescriptor, makePacket):
|
|
r"""!Run descriptor no matching data found"""
|
|
makePacket.set("tone", "99999")
|
|
makePacket = makeDescriptor.doWork(makePacket)
|
|
assert makePacket.get("description") == "99999"
|
|
|
|
|
|
def test_descriptorScanFieldNotAvailable(makeDescriptor, makePacket):
|
|
r"""!Run descriptor on a non existent scanField"""
|
|
makePacket = makeDescriptor.doWork(makePacket)
|
|
assert makePacket.get("description") is None
|