Merge pull request #37 from jan-janssen/friendly_cmd

Provide a more user-friendly command line interface

Author: jan-janssen

pyauthenticator/__main__.py

@@ -2,6 +2,7 @@
 Generate two factor authentication codes on the command line
 """
 import argparse
+import sys
 from pyauthenticator.share import (
     list_services,
     load_config,
@@ -11,17 +12,25 @@
 )
 
 
-def command_line_parser():
+def command_line_parser(cmd_args=None):
     """
     Main function primarly used for the command line interface
     """
+    if cmd_args is None:
+        cmd_args = sys.argv[1:]
     parser = argparse.ArgumentParser(prog="pyauthenticator")
     config_dict = load_config()
-    parser.add_argument(
-        "service",
-        help="Service to generate optauth code for. Available services are: "
-        + str(list_services(config_dict=config_dict)),
-    )
+    if len(config_dict) > 0:
+        parser.add_argument(
+            "service",
+            help="Service to generate optauth code for. The config file ~/.pyauthenticator contains the following services: "
+            + ", ".join(list_services(config_dict=config_dict)),
+        )
+    else:
+        parser.add_argument(
+            "service",
+            help="Service to generate optauth code for. Currently no service is defined in the ~/.pyauthenticator config file.",
+        )
     parser.add_argument(
         "-qr",
         "--qrcode",
@@ -31,18 +40,41 @@ def command_line_parser():
     parser.add_argument(
         "-a",
         "--add",
-        help="Add service by providing the qrcode png file as additional argument.",
+        help="Add service by providing the <qrcode.png> file as additional argument.",
     )
-    args = parser.parse_args()
+    args = parser.parse_args(args=cmd_args)
     if args.qrcode:
         generate_qrcode(key=args.service, config_dict=config_dict)
+        print("The qrcode file <" + args.service + ".png> was generated.")
     elif args.add:
         add_service(
             key=args.service, qrcode_png_file_name=args.add, config_dict=config_dict
         )
-        print(args.service, "added.")
+        print(
+            "The service '"
+            + args.service
+            + "' was added, from file <"
+            + args.add
+            + ">."
+        )
     else:
-        print(get_two_factor_code(key=args.service, config_dict=config_dict))
+        try:
+            print(get_two_factor_code(key=args.service, config_dict=config_dict))
+        except ValueError:
+            if len(config_dict) > 0:
+                print(
+                    'The service "'
+                    + args.service
+                    + '" does not exist.\n\nThe config file ~/.pyauthenticator contains the following services:'
+                )
+                for service in list_services(config_dict=config_dict):
+                    print("  * " + service)
+                print("\nChoose one of these or add a new service using:")
+            else:
+                print(
+                    "The config file ~/.pyauthenticator does not contain any services. To add a new service use:"
+                )
+            print("  pyauthenticator --add <qr-code.png> <servicename>\n")
 
 
 if __name__ == "__main__":

tests/test_cmd.py

@@ -2,10 +2,13 @@
 import os
 import subprocess
 import json
+from contextlib import redirect_stdout
+from io import StringIO
 from pyauthenticator.share import expand_path, write_config, config_file
+from pyauthenticator.__main__ import command_line_parser
 
 
-class MyTestCase(unittest.TestCase):
+class CmdSubprocessTest(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         cls.config_dict = {
@@ -36,7 +39,49 @@ def test_main_generate_qr_code(self):
         )
         with open(self.config_path, "r") as f:
             config_dict = json.load(f)
-        self.assertEqual(len(config_dict.keys()), 2)
+        self.assertTrue("test2" in config_dict.keys())
+
+
+class CmdParserTest(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.config_dict = {
+            "test": "otpauth://totp/Test%3A%20root%40github.com?secret=6IQXETC4ADOSMMUN&issuer=Test"
+        }
+        cls.config_path = expand_path(config_file)
+        if not os.path.exists(cls.config_path):
+            write_config(
+                config_dict=cls.config_dict
+            )
+
+    def test_main_generate_two_factor(self):
+        with redirect_stdout(StringIO()) as sout:
+            command_line_parser(cmd_args=["test"])
+        self.assertEqual(len(sout.getvalue().rstrip('\n')), 6)
+        with redirect_stdout(StringIO()) as sout:
+            command_line_parser(cmd_args=["test3"])
+        self.assertEqual(
+            sout.getvalue().split("\n")[0],
+            "The service \"test3\" does not exist."
+        )
+
+    def test_main_generate_qr_code(self):
+        with redirect_stdout(StringIO()) as sout:
+            command_line_parser(cmd_args=["-qr", "test"])
+        self.assertEqual(
+            sout.getvalue(),
+            "The qrcode file <test.png> was generated.\n"
+        )
+        self.assertTrue(os.path.exists("test.png"))
+        with redirect_stdout(StringIO()) as sout:
+            command_line_parser(cmd_args=["-a", "test.png", "test4"])
+        self.assertEqual(
+            sout.getvalue(),
+            "The service 'test4' was added, from file <test.png>.\n"
+        )
+        with open(self.config_path, "r") as f:
+            config_dict = json.load(f)
+        self.assertTrue("test4" in config_dict.keys())
 
 
 if __name__ == '__main__':