Adding in unit tests before moving further with web UI

Casey Boettcher · Casey Boettcher · commit 9a07da9d667b · 2017-09-30T20:27:00.000-04:00
diff --git a/test/test_xfipchk.py b/test/test_xfipchk.py
@@ -0,0 +1,25 @@
+import unittest
+import xfipchk
+
+
+class TestXfipchk(unittest.TestCase):
+    API_CREDS = './xforce.cfg'
+
+    def test_validate_ip(self):
+        ADDRESS_FILE = './ips.txt'
+        BAD_IPS = 4
+        GOOD_IPS = 16
+
+        good, bad = 0
+        with open(ADDRESS_FILE, 'r') as ipfile:
+            for ip in ipfile:
+                if xfipchk(ip):
+                    good += 1
+                else:
+                    bad += 1
+
+        assert (good == GOOD_IPS and bad == BAD_IPS)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/test/web/__init__.py b/test/web/__init__.py
diff --git a/test/web/test_webui.py b/test/web/test_webui.py
diff --git a/web/webui.py b/web/webui.py
@@ -1,9 +1,7 @@
 #!/usr/bin/env python
 
 import cherrypy
-import os
-import io
-
+import xfipchk
 
 class XforceForm(object):
     def __init__(self, address='127.0.0.1', port=8000):
@@ -13,13 +11,17 @@ def __init__(self, address='127.0.0.1', port=8000):
         cherrypy.config.update({'server.socket_port': port,
                                 'server.socket_host': address})
 
-    # def start_server(self):
-    #    cherrypy.quickstart(XforceForm(), '/', './web/server.cfg')
 
     @cherrypy.expose
     def index(self):
         return "/"
 
+    @cherrypy.expose()
+    def process_form(self, api_key, api_password, ip_addresses):
+        if isinstance(ip_addresses, list):
+            xfipchk.r
+        xfipchk.call_xforce_api(ip_addresses, api_key, api_password)
+
 
 if __name__ == '__main__':
     cherrypy.quickstart(XforceForm())
diff --git a/web/xfipchk.html b/web/xfipchk.html
@@ -10,7 +10,7 @@
 </head>
 <body>
 <div id="column">
-    <form id="the-form">
+    <form id="the-form" action="process_form">
         <div>
             <p><span>Instructions:</span>
             <ol>
@@ -20,15 +20,15 @@
             </ol>
             </p>
             <label for="api-key">X-Force API Key</label>
-            <input type="text" autofocus required class="api-cred" name="api-key" id="api-key" title="api-key"
+            <input type="text" autofocus required class="api-cred" name="api_key" id="api-key" title="api-key"
                    placeholder="01234567-9abc-def0-1234-56789abcdef0"/>
             <label for="api-password">X-Force API Password</label>
-            <input type="text" class="api-cred" required name="api-password" id="api-password" title="api-password"
+            <input type="text" class="api-cred" required name="api_password" id="api-password" title="api-password"
                    placeholder="01234567-9abc-def0-1234-56789abcdef0"/>
         </div>
         <div>
             <label for="ip-addresses">IP Addresses</label>
-            <input type="textarea" class="ip-addresses" id="ip-addresses"/>
+            <input type="textarea" class="ip-addresses" name="ip_addresses" id="ip-addresses"/>
         </div>
         <script>
                 $("the-form").validate();
diff --git a/xfipchk.py b/xfipchk.py
@@ -8,7 +8,7 @@
 method of IBM's X-Force API to retrieve data describing the address's reputation.
 
 """
-
+import tempfile
 import os
 import sys
 import re
@@ -19,7 +19,6 @@
 import web.webui
 import cherrypy
 
-
 XFORCE_API_BASE = 'https://api.xforce.ibmcloud.com'
 XFORCE_API_IP_REP = 'ipr'
 XFORCE_CRED_PATTERN = '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
@@ -35,11 +34,13 @@ def parse_args():
     subparsers = parser.add_subparsers(help="Mutually exclusive sub-commands")
 
     cli_parser = subparsers.add_parser('cli', help="Command-line Interface; run 'xfipchk cli -h' to see options")
-    cli_parser.add_argument('-o', '--out', metavar='output_file',
-                        type=argparse.FileType('w'), help="Write result of X-Force call to file.")
+    cli_parser.add_argument('-o', '--out', metavar='output_file', nargs='?',
+                            const=tempfile.NamedTemporaryFile(delete=False), type=argparse.FileType('w'),
+                            help="Write result of X-Force call to file; if this option is elected but no filename is "
+                                 "provided, a file will be created for the user.")
     cli_parser.add_argument('authN', type=argparse.FileType('r'),
-                            help='Path to a file containing your X-Force credentials, key and password on first and second '
-                             'lines, respectively.')
+                            help='Path to a file containing your X-Force credentials, key and password on first and '
+                                 'second lines, respectively.')
 
     # user should not be able to specify both IP on cmdline and in a file
     ip_group = cli_parser.add_mutually_exclusive_group()
@@ -115,6 +116,17 @@ def read_in_address_file(file):
     return address_list
 
 
+def validate_api_creds(xforce_api_token):
+    """
+    Validates the general form of a user submitted X-Force API key or password
+
+    :param xforce_api_token:        an X-Force key or password, as generated by the X-Force API
+    :return:                        True or False, as regards the validity of the token passed in
+    """
+    matcher = re.compile(XFORCE_CRED_PATTERN)
+    return matcher.match(xforce_api_token)
+
+
 def read_in_xforce_keys(file):
     """
     Read a plaintext file of two lines and return X-Force credentials in the form of a tuple, validating general form
@@ -123,19 +135,13 @@ def read_in_xforce_keys(file):
     :param file:  a two-line plaintext files; the first line contains the X-Force API key and the second the password
     :return:    a tuple of (key, password)
     """
-    matcher = re.compile(XFORCE_CRED_PATTERN)
-    for x in range(0, 2):
-        if x == 0:
-            key = file.readline().strip()
-            if not matcher.match(key):
-                print("API key invalid. Exiting...")
-                sys.exit(1)
-        if x == 1:
-            password = file.readline().strip()
-            if not matcher.match(password):
-                print("API password invalid. Exiting...")
-                sys.exit(1)
-    return key, password
+    key = file.readline().strip()
+    password = file.readline().strip()
+    if validate_api_creds(key) and validate_api_creds(password):
+        return key, password
+    else:
+        print("API credentials invalid. Please check your key and password. Exiting...")
+        sys.exit(1)
 
 
 def call_xforce_api(address_list, key, password):
@@ -148,7 +154,7 @@ def call_xforce_api(address_list, key, password):
     """
     results = []
     for a in address_list:
-        url = "{}/{}/{}".foGrmat(XFORCE_API_BASE, XFORCE_API_IP_REP, a)
+        url = "{}/{}/{}".format(XFORCE_API_BASE, XFORCE_API_IP_REP, a)
         results.append(requests.get(url, auth=(key, password)).json())
     return results
 
@@ -173,7 +179,7 @@ def print_json_file(results, file):
     :param results:     a list of json objects
     :param file:        the destination file for the printed list of json objects passed in
     """
-    print("Writing results to file...")
+    print("Writing results to {}...".format(file.name))
     for json in results:
         file.write("\n########## Result for IP {} ##########\n".format(json['ip']))
         pprint.pprint(json, stream=file)
@@ -188,7 +194,7 @@ def start_server(address='127.0.0.1', port=8000):
 def main():
     args = parse_args()
     # if port is in Namespace object, assume web interface
-    if args.port:
+    if hasattr(args, 'port'):
         # TODO: should use a context manager here
         current = os.curdir
         try:
@@ -198,15 +204,15 @@ def main():
             print(ose.strerror)
         finally:
             os.chdir(current)
-
-    elif args.cli:
+    # assume cli if user passed in api key file
+    elif hasattr(args, 'authN'):
         ip = None
         addresses = list()
-        if args.Ips:
+        if getattr(args, 'Ips', False):
             addresses = read_in_address_file(args.Ips)
         else:
             # get user-supplied IP address from the cmd line
-            if args.ip:
+            if getattr(args, 'ip', False):
                 ip = validate_ip(args.ip)
             # prompt user for valid IP in case of typo on cmdline
             while not ip:
