iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve unit-testing

Browse Source 
use config class which reads from .env file
remove obsolete functions
update requirements
This commit is contained in:
aceisace 2023-01-11 22:24:39 +01:00
parent 9fa2f4a003
commit 8e754cb6cd
16 changed files with 237 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
inkycal/tests/__init__.py
View File

@ -0,0 +1 @@
from config import Config

35
inkycal/tests/config.py Normal file
View File

@ -0,0 +1,35 @@
#!python
"""
Tests config
"""
import os
from enum import Enum
from dotenv import load_dotenv
# relative import
basedir = os.path.abspath(os.path.dirname(__file__))
# load config from corresponding file
load_dotenv(os.path.join(basedir, '.env'))
class Config:
get = os.environ.get
# show generated images via preview?
USE_PREVIEW = False
# ical_parser_test
OPENWEATHERMAP_API_KEY = get("OPENWEATHERMAP_API_KEY")
TEST_ICAL_URL = get("TEST_ICAL_URL")
# inkycal_agenda_test & inkycal_calendar_test
SAMPLE_ICAL_URL = get("SAMPLE_ICAL_URL")
# inkycal_todoist_test
TODOIST_API_KEY = get("TODOIST_API_KEY")

24
inkycal/tests/helper_functions.py
View File

@ -1,24 +0,0 @@
#!/usr/bin/python3
# -*- coding: utf-8 -*-
"""
Helper functions for inkycal tests.
Copyright by aceisace
"""
import logging
import sys
from os.path import exists
from inkycal.modules.inky_image import Inkyimage
preview = Inkyimage.preview
merge = Inkyimage.merge
def get_environment():
# Check if this is running on the Raspberry Pi
environment = None
envir_path = '/sys/firmware/devicetree/base/model'
if exists(envir_path):
with open(envir_path) as file:
if 'Raspberry' in file.read():
environment = 'Raspberry'
return environment

13
inkycal/tests/ical_parser_test.py
View File

@ -1,20 +1,19 @@
#!python3
"""
iCalendar parser test (ical_parser)
Copyright by aceisace
"""
import logging
import os
import arrow
import sys
import unittest
from urllib.request import urlopen
import arrow
from inkycal.modules.ical_parser import iCalendar
from helper_functions import *
from inkycal.tests import Config
ical = iCalendar()
test_ical = 'https://calendar.google.com/calendar/ical/en.usa%23holiday%40group.v.calendar.google.com/public/basic.ics'
test_ical = Config.TEST_ICAL_URL
class ical_parser_test(unittest.TestCase):
@ -42,7 +41,7 @@ class ical_parser_test(unittest.TestCase):
def test_laod_from_file(self):
print('testing loading from file...', end="")
dummy = str(urlopen(test_ical).read().decode())
with open('dummy.ical', mode="w") as file:
with open('dummy.ical', mode="w", encoding="utf-8") as file:
file.write(dummy)
ical.load_from_file('dummy.ical')
print('OK')

19
inkycal/tests/inkycal_agenda_test.py
View File

@ -1,19 +1,18 @@
#!python3
"""
Agenda test (inkycal_agenda)
Copyright by aceisace
inkycal_agenda unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Agenda as Module
from helper_functions import *
environment = get_environment()
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
sample_url = "https://www.officeholidays.com/ics-fed/usa"
sample_url = Config.SAMPLE_ICAL_URL
tests = [
{
@ -74,7 +73,7 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))

21
inkycal/tests/inkycal_calendar_test.py
View File

@ -1,20 +1,19 @@
#!python3
"""
Calendar test (inkycal_calendar)
Copyright by aceisace
inkycal_calendar unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Calendar as Module
from helper_functions import *
environment = get_environment()
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
sample_url = "https://www.officeholidays.com/ics-fed/usa"
sample_url = Config.SAMPLE_ICAL_URL
tests = [
{
@ -80,7 +79,7 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))

18
inkycal/tests/inkycal_feeds_test.py
View File

@ -1,18 +1,16 @@
#!python3
"""
Feeds test (inykcal_feeds)
Copyright by aceisace
inkycal_feeds unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Feeds as Module
from helper_functions import *
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
preview = Inkyimage.preview
merge = Inkyimage.merge
tests = [
{
@ -57,7 +55,7 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
im = merge(im_black, im_colour)
im.show()

18
inkycal/tests/inkycal_image_test.py
View File

@ -1,23 +1,21 @@
#!python3
"""
Image test (inkycal_image)
Copyright by aceisace
inkycal_image unittest
"""
import logging
import sys
import unittest
import requests
from PIL import Image
from inkycal.modules import Inkyimage as Module
from inkycal.custom import top_level
from helper_functions import *
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
url = "https://github.com/aceisace/Inkycal/raw/assets/Repo/coffee.png"
@ -118,7 +116,7 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))

104
inkycal/tests/inkycal_jokes_test.py
View File

@ -1,62 +1,70 @@
#!python3
"""
Jokes test (inkycal_jokes)
Copyright by aceisace
inkycal_jokes unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Jokes as Module
from helper_functions import *
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
tests = [
{
"name": "Jokes",
"config": {
"size": [300, 60],
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
}
},
{
"name": "Jokes",
"config": {
"size": [300, 30],
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
}
},
{
"name": "Jokes",
"config": {
"size": [100, 800],
"padding_x": 10, "padding_y": 10, "fontsize": 18, "language": "en"
}
},
{
"name": "Jokes",
"config": {
"size": [300, 60],
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
"name": "Jokes",
"config": {
"size": [300, 30],
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
"name": "Jokes",
"config": {
"size": [100, 800],
"padding_x": 10,
"padding_y": 10,
"fontsize": 18,
"language": "en"
}
},
]
class module_test(unittest.TestCase):
def test_get_config(self):
print('getting data for web-ui...', end = "")
Module.get_config()
print('OK')
def test_generate_image(self):
for test in tests:
print(f'test {tests.index(test)+1} generating image..')
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview == True and environment == 'Raspberry':
preview(merge(im_black, im_colour))
class module_test(unittest.TestCase):
def test_get_config(self):
print('getting data for web-ui...', end="")
Module.get_config()
print('OK')
def test_generate_image(self):
for test in tests:
print(f'test {tests.index(test) + 1} generating image..')
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
if __name__ == '__main__':
logger = logging.getLogger()
logger.level = logging.DEBUG
logger.addHandler(logging.StreamHandler(sys.stdout))
logger = logging.getLogger()
logger.level = logging.DEBUG
logger.addHandler(logging.StreamHandler(sys.stdout))
unittest.main()
unittest.main()

57
inkycal/tests/inkycal_slideshow_test.py
View File

@ -2,22 +2,20 @@
"""
Slideshow test (inkycal_slideshow)
Copyright by aceisace
"""
import logging
import os
import sys
import unittest
import requests
from PIL import Image
from inkycal.modules import Slideshow as Module
from inkycal.custom import top_level
from helper_functions import *
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
preview = Inkyimage.preview
merge = Inkyimage.merge
if not os.path.exists("tmp"):
os.mkdir("tmp")
@ -42,7 +40,10 @@ tests = [
"palette": "bwy",
"autoflip": True,
"orientation": "vertical",
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
@ -53,7 +54,10 @@ tests = [
"palette": "bw",
"autoflip": True,
"orientation": "vertical",
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
@ -64,7 +68,10 @@ tests = [
"palette": "bwr",
"autoflip": False,
"orientation": "vertical",
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
@ -75,7 +82,10 @@ tests = [
"palette": "bwy",
"autoflip": True,
"orientation": "vertical",
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
@ -86,7 +96,10 @@ tests = [
"palette": "bwy",
"autoflip": True,
"orientation": "horizontal",
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
{
@ -97,7 +110,10 @@ tests = [
"palette": "bw",
"autoflip": True,
"orientation": "vertical",
"padding_x": 0, "padding_y": 0, "fontsize": 12, "language": "en"
"padding_x": 0,
"padding_y": 0,
"fontsize": 12,
"language": "en"
}
},
{
@ -109,7 +125,10 @@ tests = [
"palette": "bwr",
"autoflip": True,
"orientation": "vertical",
"padding_x": 20, "padding_y": 20, "fontsize": 12, "language": "en"
"padding_x": 20,
"padding_y": 20,
"fontsize": 12,
"language": "en"
}
},
]
@ -127,22 +146,22 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
def test_switch_to_next_image(self):
print(f'testing switching to next images..')
module = Module(tests[0])
im_black, im_colour = module.generate_image()
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
im_black, im_colour = module.generate_image()
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
im_black, im_colour = module.generate_image()
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
print('OK')

18
inkycal/tests/inkycal_stocks_test.py
View File

@ -1,18 +1,16 @@
#!python3
"""
Stocks test (inkycal_stocks)
Copyright by aceisace
inkycal_stocks unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Stocks as Module
from helper_functions import *
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
tests = [
{
@ -46,7 +44,7 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview == True and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))

27
inkycal/tests/inkycal_todoist_test.py
View File

@ -1,24 +1,30 @@
#!python3
import os
"""
inkycal_todoist unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Todoist as Module
from helper_functions import *
environment = get_environment()
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
api_key = os.environ["TODOIST_API_KEY"] or ""
api_key = Config.TODOIST_API_KEY
tests = [
{
"name": "Todoist",
"config": {
"size": [500, 200],
"size": [400, 1000],
"api_key": api_key,
"project_filter": None,
"padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en"
"padding_x": 10,
"padding_y": 10,
"fontsize": 12,
"language": "en"
}
},
]
@ -38,8 +44,9 @@ class module_test(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
merge(im_black, im_colour).show()
else:
print('No api key given, omitting test')

51
inkycal/tests/inkycal_weather_test.py
View File

@ -1,15 +1,18 @@
#!python3
import os
"""
inkycal_weather unittest
"""
import logging
import sys
import unittest
from inkycal.modules import Weather as Module
from helper_functions import *
environment = get_environment()
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
secret_key = os.environ["OPENWEATHERMAP_API_KEY"] or ""
owm_api_key = Config.OPENWEATHERMAP_API_KEY
location = 'Stuttgart, DE'
tests = [
@ -18,7 +21,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 100],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": True,
@ -37,7 +40,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 150],
"api_key": secret_key,
"api_key": owm_api_key,
"location": "2643123",
"round_temperature": True,
"round_windspeed": True,
@ -56,7 +59,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 200],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": False,
"round_windspeed": True,
@ -75,7 +78,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 100],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": False,
@ -94,7 +97,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 150],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": True,
@ -113,7 +116,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 150],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": True,
@ -132,7 +135,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 100],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": True,
@ -151,7 +154,7 @@ tests = [
"name": "Weather",
"config": {
"size": [500, 100],
"api_key": secret_key,
"api_key": owm_api_key,
"location": location,
"round_temperature": True,
"round_windspeed": True,
@ -175,16 +178,14 @@ class module_test(unittest.TestCase):
print('OK')
def test_generate_image(self):
if secret_key:
for test in tests:
print(f'test {tests.index(test) + 1} generating image..')
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview and environment == 'Raspberry':
preview(merge(im_black, im_colour))
else:
print('No key given, omitted testing')
for test in tests:
print(f'test {tests.index(test) + 1} generating image..')
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
if __name__ == '__main__':

6
inkycal/tests/main_test.py
View File

@ -1,8 +1,6 @@
#!python3
"""
Main test (main)
Copyright by aceisace
Inkycal main unittest
"""
import os
import unittest
@ -63,7 +61,7 @@ class ModuleTest(unittest.TestCase):
# Check if settings.json file exists in current directory
if not os.path.exists("settings.json"):
# Create temporary json settings file with the config from above
with open('settings.json', mode="w") as file:
with open('settings.json', mode="w", encoding="utf-8") as file:
file.write(test_config)
print('testing Inkycal in non-render-mode...', end="")
inky = Inkycal('settings.json', render=False)

18
inkycal/tests/test_inkycal_textfile_to_display.py
View File

@ -1,13 +1,14 @@
#!python3
import logging
import os
import sys
import unittest
from inkycal.modules import TextToDisplay as Module
from helper_functions import *
environment = get_environment()
# Set to True to preview images. Only works on Raspberry Pi OS with Desktop
use_preview = False
from inkycal.modules.inky_image import Inkyimage
from inkycal.tests import Config
preview = Inkyimage.preview
merge = Inkyimage.merge
file_path = None
@ -78,6 +79,7 @@ tests = [
class TestTextToDisplay(unittest.TestCase):
def test_get_config(self):
print('getting data for web-ui...', end="")
Module.get_config()
@ -91,7 +93,7 @@ class TestTextToDisplay(unittest.TestCase):
print("Filepath does not exist. Creating dummy file")
tmp_path = "tmp.txt"
with open(tmp_path, mode="w") as file:
with open(tmp_path, mode="w", encoding="utf-8") as file:
file.writelines(dummy_data)
# update tests with new temp path
@ -99,7 +101,7 @@ class TestTextToDisplay(unittest.TestCase):
test["config"]["filepath"] = tmp_path
else:
make_request = True if file_path.startswith("https://") else False
make_request = bool(file_path.startswith("https://"))
if not make_request and not os.path.exists(file_path):
raise FileNotFoundError("Your text file could not be found")
@ -108,7 +110,7 @@ class TestTextToDisplay(unittest.TestCase):
module = Module(test)
im_black, im_colour = module.generate_image()
print('OK')
if use_preview and environment == 'Raspberry':
if Config.USE_PREVIEW:
preview(merge(im_black, im_colour))
im = merge(im_black, im_colour)
im.show()

4
requirements.txt
View File

@ -27,4 +27,6 @@ six==1.16.0
todoist-api-python==2.0.2
typing_extensions==4.4.0
urllib3==1.26.13
yfinance==0.2.3
yfinance==0.2.3
python-dotenv~=0.21.0
setuptools==65.6.3