Add Unit tests to the omdb parser

Author: Plamen Milenkov

days/40-42-json-data/log_book.py

@@ -0,0 +1,17 @@
+import logbook
+
+logbook.Logger('App')
+
+def init_logger(filename: str = None):
+    level = logbook.TRACE
+
+    if filename:
+        logbook.TimedRotatingFileHandler(filename, level=level).push_application()
+    else:
+        logbook.StreamHandler(sys.stdout, level=level).push_application()
+
+    msg = 'Logging initialized, level: {}, mode: {}'.format(
+        level, "stdout mode" if not filename else 'file mode: ' + filename)
+    logger = logbook.Logger('Startup')
+    logger.notice(msg)
+

days/40-42-json-data/omdb_parse.py

@@ -1,30 +1,63 @@
 import json
 from pprint import pprint
 import requests
+import logbook
+from log_book import init_logger
 
-user_input = input('Movie name: ')
+logger = logbook.Logger(__file__)
 
-request = requests.get('http://www.omdbapi.com/?apikey=3e6f7dd7&t={}'.format(user_input))
-json_result = json.loads(request.text)
 
-print("{}'s Awards: {}".format(user_input, json_result['Awards']))
+def main():
+    init_logger('movie-app.log')
+    logbook.info("Starting the omdb search app...")
 
+    logbook.debug("Getting user's input...")
+    movie_name = get_user_input()
+
+    logbook.debug("Loading '{0}' data...".format(movie_name))
+    movie_data = load_movie_data(movie_name)
+
+
+    logbook.debug("Displaying Awards...".format(movie_name))
+    display_awards(movie_data, movie_name)
+
+    logbook.debug("Displaying Ratings...".format(movie_name))
+    displays_ratings(movie_data)
+
+def get_user_input():
+    user_input = input('Movie name: ')
+    return user_input
+
+def load_movie_data(movie_name):
+    request = requests.get('http://www.omdbapi.com/?apikey=3e6f7dd7&t={}'.format(movie_name))
+    json_result = json.loads(request.text)
+    return json_result
+
+def display_awards(movie_data, movie_name):
+    print("{}'s Awards: {}".format(movie_name, movie_data['Awards']))
+
+def displays_ratings(movie_data):
+    for rating in movie_data['Ratings']:
+        display_rating(rating)
+
+def display_rating(rating):
+    value = rating['Value']
+    value = parse_value(value)
+    print(f"{rating['Source']} - {value}")
 
 def parse_value(value: str):
+    logbook.debug("Parsing value '{0}'...".format(value))
     if value.endswith('%'):
         value = value.replace('%','')
         return '{}/10'.format(int(value) / 10)
     elif value.endswith('100'):
         (value, _) = value.split('/')
         return '{}/10'.format(int(value) / 10)
-    return value
-
+    else:
+        (value, _) = value.split('/')
+        return '{}/10'.format(float(value) * 1.0)
 
-def display_rating(rating):
-    value = rating['Value']
-    value = parse_value(value)
-    print(f"{rating['Source']} - {value}")
 
 
-for rating in json_result['Ratings']:
-    display_rating(rating)
+if __name__ == '__main__':
+    main()

days/40-42-json-data/test_omdb_parser.py

@@ -0,0 +1,35 @@
+import pytest
+
+from omdb_parse import load_movie_data, parse_value
+
+def test_load_movie_data():
+    movie_data_it = load_movie_data('It')
+    assert movie_data_it != None
+
+    assert 'Title' in movie_data_it
+    assert 'It' == movie_data_it['Title']
+    assert 'Year' in movie_data_it
+    assert 'Awards' in movie_data_it
+
+def test_load_movie_data_empty_name():
+    empty_name = load_movie_data('')
+    assert empty_name != None
+    assert 'Response' in empty_name
+    assert 'Error' in empty_name
+
+@pytest.mark.parametrize("arg,ret", [
+    ('0%','0.0/10'),
+    ('1%','0.1/10'),
+    ('100%','10.0/10'),
+    ('67%','6.7/10'),
+    ('0/100','0.0/10'),
+    ('1/100','0.1/10'),
+    ('100/100','10.0/10'),
+    ('67/100','6.7/10'),
+    ('0/10','0.0/10'),
+    ('1/10','1.0/10'),
+    ('10/10','10.0/10'),
+    ('6.7/10','6.7/10'),
+])
+def test_parse_value(arg, ret):
+    assert ret == parse_value(arg)