Remove the -m option and request the input from the user if -c or -l is null in add mode.

Author: bjk7119

src/fosslight_reuse/_add.py

@@ -15,7 +15,6 @@
 from reuse._main import parser as reuse_arg_parser
 
 _PKG_NAME = "fosslight_reuse"
-_auto_add_mode = False
 _result_log = {}
 logger = logging.getLogger(constant.LOGGER_NAME)
 
@@ -68,12 +67,39 @@ def check_input_format(input_copyright):
     check_ok = True
 
     if regex.match(input_copyright) is None:
-        logger.warning(" You have to input with following format - 'Copyright <year> <name>'")
+        logger.warning(" You have to input with following format - Copyright <year> <name>")
         check_ok = False
 
     return check_ok
 
 
+def input_license_while_running():
+    input_license = ""
+
+    logger.info("# Select a license to write in the license missing files ")
+    select = input("   1.MIT,  2.Apache-2.0,  3.LGE-Proprietary,  4.Manaully Input,  5.Not select now : ")
+    if select == '1' or select == 'MIT':
+        input_license = 'MIT'
+    elif select == '2' or select == 'Apache-2.0':
+        input_license = 'Apache-2.0'
+    elif select == '3' or select == 'LGE Proprietary License':
+        input_license = 'LicenseRef-LGE-Proprietary'
+    elif select == '4' or select == 'Manually Input':
+        input_license = input("   ## Input your License : ")
+    elif select == '5' or select == 'Quit' or select == 'quit':
+        logger.info(" Not selected any license to write ")
+    return input_license
+
+
+def input_copyright_while_running():
+    input_copyright = ""
+    input_copyright = input("# Input Copyright to write in the copyright missing files (ex, Copyright <year> <name>) : ")
+    if input_copyright == 'Quit' or input_copyright == 'quit' or input_copyright == 'Q':
+        return
+
+    return input_copyright
+
+
 def set_missing_license_copyright(missing_license_filtered, missing_copyright_filtered, project, path_to_find, license, copyright):
     input_license = None
     input_copyright = None
@@ -85,33 +111,17 @@ def set_missing_license_copyright(missing_license_filtered, missing_copyright_fi
 
     # Print missing license
     if missing_license_filtered is not None and len(missing_license_filtered) > 0:
-        input_str = ""
         missing_license_list = []
 
         logger.info("# Missing license File(s) ")
         for lic_file in sorted(missing_license_filtered):
             logger.info(f"  * {lic_file}")
             missing_license_list.append(path_to_find + '/' + lic_file)
 
-        if _auto_add_mode:
-            # Automatic add mode
-            input_license = license
+        if license == "" and copyright == "":
+            input_license = input_license_while_running()
         else:
-            # Manual add Mode
-            logger.info("# Select a license to write in the license missing files ")
-            select = input("   1.MIT,  2.Apache-2.0,  3.LGE-Proprietary,  4.Manaully Input,  5.Not select now : ")
-            if select == '1' or select == 'MIT':
-                input_license = 'MIT'
-            elif select == '2' or select == 'Apache-2.0':
-                input_license = 'Apache-2.0'
-            elif select == '3' or select == 'LGE Proprietary License':
-                input_license = 'LicenseRef-LGE-Proprietary'
-            elif select == '4' or select == 'Manually Input':
-                input_str = input("   ## Input your License : ")
-                input_license = input_str
-            elif select == '5' or select == 'Quit' or select == 'quit':
-                logger.info(" Not selected any license to write ")
-                return
+            input_license = license
 
         if input_license != "":
             logger.warning(f"  * Your input license : {input_license}")
@@ -130,18 +140,14 @@ def set_missing_license_copyright(missing_license_filtered, missing_copyright_fi
             logger.info(f"  * {cop_file}")
             missing_copyright_list.append(os.getcwd() + '/' + path_to_find + '/' + cop_file)
 
-        if _auto_add_mode:
-            # Automatic add mode
-            input_copyright = copyright
-        else:
-            # Manual add Mode
-            input_copyright = input("# Input Copyright to write in the copyright missing files (ex, 'Copyright <year> <name>'') : ")
-            if input_copyright == 'Quit' or input_copyright == 'quit' or input_copyright == 'Q':
-                return
+        if license == "" and copyright == "":
+            input_copyright = input_copyright_while_running()
 
             input_ok = check_input_format(input_copyright)
             if input_ok is False:
                 return
+        else:
+            input_copyright = copyright
 
         if input_copyright != "":
             logger.warning(f"  * Your input Copyright : {input_copyright}")
@@ -178,10 +184,9 @@ def save_result_log():
         logger.warning("Failed to print add result log. " + str(ex))
 
 
-def add_content(path_to_find, file, manual_mode, input_license="", input_copyright=""):
-    global _auto_add_mode, _result_log
+def add_content(path_to_find, file, input_license="", input_copyright=""):
+    global _result_log
     file_to_check_list = []
-    _auto_add_mode = False
     _check_only_file_mode = False
 
     if path_to_find == "":
@@ -192,7 +197,7 @@ def add_content(path_to_find, file, manual_mode, input_license="", input_copyrig
     logger, _result_log = init_log(os.path.join(output_dir, "fosslight_reuse_add_log_"+now+".txt"),
                                    True, logging.INFO, logging.DEBUG, _PKG_NAME, path_to_find)
 
-    if input_copyright != "" and manual_mode is False:
+    if input_copyright != "":
         input_ok = check_input_format(input_copyright)
         if input_ok is False:
             return
@@ -201,30 +206,31 @@ def add_content(path_to_find, file, manual_mode, input_license="", input_copyrig
         file_to_check_list = file.split(',')
         _check_only_file_mode = True
 
-    if not manual_mode and _check_only_file_mode is False:
-        if input_license == "" and input_copyright == "":
-            logger.info(" You have to input license and copyright to add with -l and -c option")
-            return
-        _auto_add_mode = True
-
     if _check_only_file_mode:
         main_parser = reuse_arg_parser()
-
         missing_license_list, missing_copyright_list, error_occurred, project = reuse_for_files(path_to_find, file_to_check_list)
 
         if missing_license_list is not None and len(missing_license_list) > 0:
-            logger.warning(f"  * Your input license : {input_license}")
-            parsed_args = main_parser.parse_args(['addheader', '--license', str(input_license)] + missing_license_list)
-            try:
-                run(parsed_args, project)
-            except Exception as ex:
-                print_error('Error_call_run_in_license_file_only :' + str(ex))
+            if input_license == "" and input_copyright == "":
+                input_license = input_license_while_running()
+
+            if input_license != "":
+                logger.warning(f"  * Your input license : {input_license}")
+                parsed_args = main_parser.parse_args(['addheader', '--license', str(input_license)] + missing_license_list)
+                try:
+                    run(parsed_args, project)
+                except Exception as ex:
+                    print_error('Error_call_run_in_license_file_only :' + str(ex))
 
         if missing_copyright_list is not None and len(missing_copyright_list) > 0:
-            logger.warning(f"  * Your input Copyright : {input_copyright}")
-            parsed_args = main_parser.parse_args(['addheader', '--copyright',
-                                                  'SPDX-FileCopyrightText: ' + str(input_copyright),
-                                                  '--exclude-year'] + missing_copyright_list)
+            if input_license == "" and input_copyright == "":
+                input_copyright = input_copyright_while_running()
+
+            if input_copyright != "":
+                logger.warning(f"  * Your input Copyright : {input_copyright}")
+                parsed_args = main_parser.parse_args(['addheader', '--copyright',
+                                                      'SPDX-FileCopyrightText: ' + str(input_copyright),
+                                                      '--exclude-year'] + missing_copyright_list)
             try:
                 run(parsed_args, project)
             except Exception as ex:

src/fosslight_reuse/_help.py

@@ -7,7 +7,7 @@
 _HELP_MESSAGE_REUSE = """
     Usage: fosslight_reuse [Mode] [option1] <arg1> [option2] <arg2>...
         ex) fosslight_reuse lint -p /home/test/ -f "notice/sample.py,src/init.py"
-            fosslight_reuse add -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0"
+            fosslight_reuse add -p /home/test/ -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
 
     FOSSLight Reuse is a Tool to check REUSE compliance in source code.
 
@@ -25,8 +25,7 @@
             -n\t\t\t    Don't exclude venv*, node_modules, and .*/ from the analysis
         Options for only 'add' mode
             -l <license>\t    License name(SPDX format) to add
-            -c <copyright>\t    Copyright to add(ex, "Copyright 2015-2021 LGE Electronics")
-            -m\t\t\t    Add manually your input license and copyright (using without -l or -c option)  """
+            -c <copyright>\t    Copyright to add(ex, Copyright 2015-2021 LGE Electronics Inc.)"""
 
 
 def print_help_msg(exitOpt=True):

src/fosslight_reuse/cli.py

@@ -16,7 +16,6 @@ def main():
     parser.add_argument('--file', '-f', help='Files to check', type=str, dest='file', default="")
     parser.add_argument('--output', '-o', help='Output file name', type=str, dest='output', default="")
     parser.add_argument('--no', '-n', help='Disable automatic exclude mode', action='store_true', dest='disable')
-    parser.add_argument('--manual', '-m', help='Manual input mode', action='store_true', dest='manual')
     parser.add_argument('--license', '-l', help='License name to add', type=str, dest='license', default="")
     parser.add_argument('--copyright', '-c', help='Copyright to add', type=str, dest='copyright', default="")
     args = parser.parse_args()
@@ -26,7 +25,7 @@ def main():
     elif args.mode == "report":
         convert_report(args.path, args.file, args.output)
     elif args.mode == "add":
-        add_content(args.path, args.file, args.manual, args.license, args.copyright)
+        add_content(args.path, args.file, args.license, args.copyright)
     else:
         pass
 

tests/add/test_both_have_1.py

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: Copyright 2019-2021 LG Electronics Inc.
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+import os
+from fosslight_util.set_log import init_log
+
+
+def main():
+    output_dir = "tests"
+    logger, _result_log = init_log(os.path.join(output_dir, "test_add_log.txt"))
+    logger.warning("TESTING - add mode")
+
+
+if __name__ == '__main__':
+    main()

tests/add/test_both_have_2.py

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: Copyright (c) 2011 LG Electronics Inc.
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+import os
+from fosslight_util.set_log import init_log
+
+
+def main():
+    output_dir = "tests"
+    logger, _result_log = init_log(os.path.join(output_dir, "test_add_log.txt"))
+    logger.warning("TESTING - add mode")
+
+
+if __name__ == '__main__':
+    main()

tests/add/test_add.py tests/add/test_no_copyright.pytests/add/test_add.py renamed to tests/add/test_no_copyright.py

@@ -1,3 +1,4 @@
+# SPDX-License-Identifier: GPL-3.0-only
 
 import os
 from fosslight_util.set_log import init_log

tests/add/test_no_license.py

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: Copyright 2019-2021 LG Electronics Inc.
+import os
+from fosslight_util.set_log import init_log
+
+
+def main():
+    output_dir = "tests"
+    logger, _result_log = init_log(os.path.join(output_dir, "test_add_log.txt"))
+    logger.warning("TESTING - add mode")
+
+
+if __name__ == '__main__':
+    main()

tox.ini

@@ -29,7 +29,7 @@ commands =
     cat test_report/output.yaml
     rm -rf tests/add_result
     cp -r tests/add tests/add_result
-    fosslight_reuse add -p tests/add_result -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0"
+    fosslight_reuse add -p tests/add_result -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
 [testenv:release]
 deps =
     -r{toxinidir}/requirements-dev.txt
@@ -41,5 +41,5 @@ commands =
     fosslight_reuse report -p tests/report
     fosslight_reuse report -f tests/report/OSS-Report-Sample_1_BOM.xlsx -o test_report/output
     cp -r tests/add tests/add_result
-    fosslight_reuse add -p tests/add_result -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0"
+    fosslight_reuse add -p tests/add_result -c "Copyright 2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
     pytest -v --flake8