Add unit tests for main

Author: benjhar

jokeapi/main.py

@@ -23,7 +23,11 @@ def build_request(
             for c in category:
                 if not c.lower() in ["programming", "miscellaneous", "dark"]:
                     raise Exception(
-                        'Invalid category selected. Available categories are "programming", "miscellaneous", and "dark". Leave blank for any.'
+                        '''Invalid category selected. Available categories are:
+                            "programming"
+                            "miscellaneous"
+                            "dark".
+                        Leave blank for any.'''
                     )
                     return
             cats = ",".join(category)
@@ -32,21 +36,38 @@ def build_request(
 
         if len(blacklist) > 0:
             for b in blacklist:
-                if not b in ["nsfw", "religious", "political", "racist", "sexist"]:
+                if b not in [
+                            "nsfw",
+                            "religious",
+                            "political",
+                            "racist",
+                            "sexist"
+                            ]:
                     raise Exception(
-                        'You have blacklisted flags which are not available. Available flags are:\n"racist"\n"religious"\n"political"\n"sexist"\n"nsfw"'
+                        '''\n\n
+                        You have blacklisted flags which are not available.
+                        Available flags are:
+                            "racist"
+                            "religious"
+                            "political"
+                            "sexist"
+                            "nsfw"
+                        '''
                     )
                     return
             blacklistFlags = ",".join(blacklist)
         else:
             blacklistFlags = None
 
         if response_format not in ["json", "xml", "yaml"]:
-            raise Exception("Response format must be either json, xml or yaml.")
+            raise Exception(
+                "Response format must be either json, xml or yaml."
+            )
         if type:
             if type not in ["single", "twopart"]:
                 raise Exception(
-                    'Invalid joke type. Available options are "single" or "twopart".'
+                    '''Invalid joke type.
+                    Available options are "single" or "twopart".'''
                 )
                 return
         else:
@@ -60,17 +81,22 @@ def build_request(
                 search_string = urllib.parse.quote(search_string)
         if id_range:
 
-            response = self.http.request('GET', "https://sv443.net/jokeapi/v2/info")
+            response = self.http.request(
+                                        'GET',
+                                        "https://sv443.net/jokeapi/v2/info"
+                                        )
             dict = json.loads(response.data)
             range_limit = dict["jokes"]["totalCount"]
 
             if len(id_range) > 2:
                 raise Exception("id_range must be no longer than 2 items.")
             elif id_range[0] < 0:
-                raise Exception("id_range[0] must be greater than or equal to 0.")
+                raise Exception(
+                             "id_range[0] must be greater than or equal to 0."
+                               )
             elif id_range[1] > range_limit:
                 raise Exception(
-                    f"id_range[1] must be less than or equal to {range_limit-1}."
+                 f"id_range[1] must be less than or equal to {range_limit-1}."
                 )
 
         r += cats

requirements.txt

@@ -0,0 +1,17 @@
+attrs==19.3.0
+coverage==5.0.3
+entrypoints==0.3
+flake8==3.7.9
+mccabe==0.6.1
+more-itertools==8.2.0
+packaging==20.1
+pluggy==0.13.1
+py==1.8.1
+pycodestyle==2.5.0
+pyflakes==2.1.1
+pyparsing==2.4.6
+pytest==5.3.5
+pytest-cov==2.8.1
+six==1.14.0
+wcwidth==0.1.8
+urllib3==1.25.8

setup.py

@@ -1,15 +1,16 @@
 from distutils.core import setup
 setup(
-  name = 'jokeapi',
-  packages = ['jokeapi'],   # Chose the same as "name"
-  version = '0.1',
+  name='jokeapi',
+  packages=['jokeapi'],   # Chose the same as "name"
+  version='0.1',
   license='GNU General Public License v3 (GPLv3)',
-  description = 'An API Wrapper for Sv443\'s JokeAPI',
-  author = 'thenamesweretakenalready',
-  author_email = 'leet_haker@cyber-wizard.com',
-  url = 'https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper',
-  download_url = 'https://github.com/user/reponame/archive/v0.1.tar.gz',
-  keywords = ['api wrapper', 'wrapper', 'api', 'jokes'],
+  description='An API Wrapper for Sv443\'s JokeAPI',
+  author='thenamesweretakenalready',
+  author_email='leet_haker@cyber-wizard.com',
+  url="""https://github.com/
+  thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper""",
+  download_url='https://github.com/user/reponame/archive/v0.1.tar.gz',
+  keywords=['api wrapper', 'wrapper', 'api', 'jokes'],
   install_requires=[],
   classifiers=[
     'Development Status :: 3 - Alpha',

test_main.py

@@ -0,0 +1,84 @@
+from jokeapi import Jokes
+
+j = Jokes()
+errors = []
+
+try:
+    j.get_joke()
+except Exception as e:
+    errors.append({'Error in':  'blank joke get',  'Error': e})
+
+"""Testing for errors in categories"""
+try:
+    j.get_joke(category=["programming"])
+except Exception as e:
+    errors.append({'Error in':  'category programming', 'Error': e})
+try:
+    j.get_joke(category=["miscellaneous"])
+except Exception as e:
+    errors.append({'Error in':  'category miscellaneous', 'Error': e})
+try:
+    j.get_joke(category=["dark"])
+except Exception as e:
+    errors.append({'Error in':  'category dark', 'Error': e})
+
+"""Testing for errors in blacklist"""
+try:
+    j.get_joke(blacklist=["nsfw"])
+except Exception as e:
+    errors.append({'Error in':  'blacklist nsfw', 'Error': e})
+try:
+    j.get_joke(blacklist=["religious"])
+except Exception as e:
+    errors.append({'Error in':  'blacklist religious', 'Error': e})
+try:
+    j.get_joke(blacklist=["political"])
+except Exception as e:
+    errors.append({'Error in':  'blacklist political', 'Error': e})
+try:
+    j.get_joke(blacklist=["racist"])
+except Exception as e:
+    errors.append({'Error in':  'blacklist political', 'Error': e})
+try:
+    j.get_joke(blacklist=["sexist"])
+except Exception as e:
+    errors.append({'Error in':  'blacklist sexist',  'Error': e})
+
+"""Testing for errors in response_format"""
+try:
+    j.get_joke(response_format="xml")
+except Exception as e:
+    errors.append({'Error in':  'response_format xml', 'Error': e})
+try:
+    j.get_joke(response_format="yaml")
+except Exception as e:
+    errors.append({'Error in':  'response_format yaml', 'Error': e})
+
+"""Testing for errors in type"""
+try:
+    j.get_joke(type="single")
+except Exception as e:
+    errors.append({'Error in':  'type single', 'Error': e})
+try:
+    j.get_joke(type="twopart")
+except Exception as e:
+    errors.append({'Error in':  'type double', 'Error': e})
+
+"""Testing for errors in search_string"""
+try:
+    j.get_joke(search_string="search")
+    # as long as this gets a response, the api wrapper is fine;
+    # it probably doesn't exist in a joke.
+except Exception as e:
+    errors.append({'Error in': 'search_string', 'Error': e})
+
+"""Testing for errors in id_range"""
+try:
+    j.get_joke(id_range=[30, 151])
+except Exception as e:
+    errors.append({'Error in': 'id_range', 'Error': e})
+
+if len(errors):
+    for e in errors:
+        print(f"Error in:  {e['Error in']}\nError: {e['Error']}")
+    raise Exception("Errors boii")