Merge pull request #1393 from jedwards4b/test_cli

Conforming command line All command line arguments should conform. I have allowed for one exception, the -value option to xmlquery. Test suite: scripts_regression_tests.py Test baseline: Test namelist changes: Test status: bit for bit Fixes #428 User interface changes?: YES, now accepting only conforming command line arguments Code review:
ESMCI · May 2, 2017 · 505ce67 · 505ce67
2 parents c1e5a38 + b552281
commit 505ce67
Show file tree

Hide file tree

Showing 58 changed files with 91 additions and 171 deletions.
diff --git a/config/acme/machines/template.case.run b/config/acme/machines/template.case.run
@@ -55,9 +55,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot",
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    CIME.utils.parse_args_and.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/acme/machines/template.case.test b/config/acme/machines/template.case.test
@@ -50,9 +50,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot",
                         help="Case directory to build")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/acme/machines/template.lt_archive b/config/acme/machines/template.lt_archive
@@ -49,9 +49,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/acme/machines/template.st_archive b/config/acme/machines/template.st_archive
@@ -48,9 +48,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/cesm/machines/template.case.run b/config/cesm/machines/template.case.run
@@ -52,9 +52,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot",
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/cesm/machines/template.case.test b/config/cesm/machines/template.case.test
@@ -46,9 +46,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot",
                         help="Case directory to build")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/cesm/machines/template.lt_archive b/config/cesm/machines/template.lt_archive
@@ -47,9 +47,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/config/cesm/machines/template.st_archive b/config/cesm/machines/template.st_archive
@@ -47,9 +47,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to build")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if args.caseroot is not None:
         os.chdir(args.caseroot)

diff --git a/scripts/Tools/acme_check_env b/scripts/Tools/acme_check_env
@@ -30,9 +30,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
 
     CIME.utils.setup_standard_logging_options(parser)
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
 ###############################################################################
 def check_sh():

diff --git a/scripts/Tools/bless_test_results b/scripts/Tools/bless_test_results
@@ -89,9 +89,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("bless_tests", nargs="*",
                         help="When blessing, limit the bless to tests matching these regex")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     expect(not (args.report_only and args.force),
            "Makes no sense to use -r and -f simultaneously")

diff --git a/scripts/Tools/case.build b/scripts/Tools/case.build
@@ -56,9 +56,7 @@ OR
     parser.add_argument("--clean-all", action="store_true",
                         help="clean all objects including sharedlibobjects that may be used by other builds")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     cleanlist = args.clean if args.clean is None or len(args.clean) else comps
 

diff --git a/scripts/Tools/case.cmpgen_namelists b/scripts/Tools/case.cmpgen_namelists
@@ -49,9 +49,7 @@ OR
                         help="Force generation to use baselines with this name. "
                         "Default will be to follow the case specification")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.caseroot, args.compare, args.generate, args.compare_name, args.generate_name
 

diff --git a/scripts/Tools/case.setup b/scripts/Tools/case.setup
@@ -45,9 +45,7 @@ OR
     parser.add_argument("-r", "--reset", action="store_true",
                         help="Does a clean followed by setup")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.caseroot, args.clean, args.test_mode, args.reset
 

diff --git a/scripts/Tools/case.submit b/scripts/Tools/case.submit
@@ -48,12 +48,10 @@ OR
     parser.add_argument("-a", "--batch-args",
                         help="Used to pass additional arguments to batch system. ")
 
-    args = parser.parse_args(args[1:])
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     CIME.utils.expect(args.prereq is None, "--prereq not currently supported")
 
-    CIME.utils.handle_standard_logging_options(args)
-
     return args.caseroot, args.job, args.no_batch, args.resubmit, args.batch_args
 
 ###############################################################################

diff --git a/scripts/Tools/case_diff b/scripts/Tools/case_diff
@@ -42,9 +42,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("-b", "--show-binary", action="store_true",
                         help="Show binary diffs")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.case1, args.case2, args.show_binary, args.skip_list
 

diff --git a/scripts/Tools/check_case b/scripts/Tools/check_case
@@ -38,9 +38,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
 
     CIME.utils.setup_standard_logging_options(parser)
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
 ###############################################################################
 def _main_func(description):
@@ -68,4 +66,3 @@ def _main_func(description):
 
 if __name__ == "__main__":
     _main_func(__doc__)
-
diff --git a/scripts/Tools/check_input_data b/scripts/Tools/check_input_data
@@ -52,9 +52,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("--download", action="store_true",
                         help="Attempt to download missing input files")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.svn_loc, args.input_data_root, args.data_list_dir, args.download
 
@@ -78,4 +76,3 @@ def _main_func(description):
 
 if (__name__ == "__main__"):
     _main_func(__doc__)
-
diff --git a/scripts/Tools/check_lockedfiles b/scripts/Tools/check_lockedfiles
@@ -29,9 +29,7 @@ OR
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to build")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.caseroot
 

diff --git a/scripts/Tools/cime_bisect b/scripts/Tools/cime_bisect
@@ -74,9 +74,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("-a", "--all-commits", action="store_true",
                         help="Test all commits, not just merges")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if (args.test_root is None):
         args.test_root = os.path.join(_MACHINE.get_value("CIME_OUTPUT_ROOT"), "cime_bisect")

diff --git a/scripts/Tools/code_checker b/scripts/Tools/code_checker
@@ -46,9 +46,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("files", nargs="*",
                         help="Restrict checking to specific files. Relative name is fine.")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.num_procs, args.files
 

diff --git a/scripts/Tools/compare_namelists b/scripts/Tools/compare_namelists
@@ -40,9 +40,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("-c", "--case", action="store", dest="case", default=None,
                         help="The case base id (<TESTCASE>.<GRID>.<COMPSET>). Helps us normalize data.")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     # Normalize case
     if (args.case is not None):

diff --git a/scripts/Tools/compare_test_results b/scripts/Tools/compare_test_results
@@ -90,9 +90,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("compare_tests", nargs="*",
                         help="When comparing, limit the comparison to tests matching these regex")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.baseline_name, args.baseline_root, args.test_root, args.compiler, args.test_id, args.compare_tests, args.namelists_only, args.hist_only
 

diff --git a/scripts/Tools/component_compare_baseline b/scripts/Tools/component_compare_baseline
@@ -35,9 +35,7 @@ OR
     parser.add_argument("-b", "--baseline-dir",
                         help="Use custom baseline dir")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.caseroot, args.baseline_dir
 

diff --git a/scripts/Tools/component_compare_copy b/scripts/Tools/component_compare_copy
@@ -36,9 +36,7 @@ OR
     parser.add_argument("caseroot", nargs="?", default=os.getcwd(),
                         help="Case directory")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.suffix, args.caseroot
 

diff --git a/scripts/Tools/component_compare_test b/scripts/Tools/component_compare_test
@@ -38,9 +38,7 @@ OR
     parser.add_argument("caseroot", nargs="?", default=os.getcwd(),
                         help="Case directory")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.suffix1, args.suffix2, args.caseroot
 

diff --git a/scripts/Tools/component_generate_baseline b/scripts/Tools/component_generate_baseline
@@ -40,9 +40,7 @@ OR
                         "will raise an error. Specifying this option allows "
                         "existing baseline directories to be silently overwritten.")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.caseroot, args.baseline_dir, args.allow_baseline_overwrite
 

diff --git a/scripts/Tools/getTiming b/scripts/Tools/getTiming
@@ -21,8 +21,8 @@ def parse_command_line(args, description):
                         default="999999-999999")
     parser.add_argument("--caseroot", default=os.getcwd(),
                         help="Case directory to get timing for")
-    args = parser.parse_args(args[1:])
-    CIME.utils.handle_standard_logging_options(args)
+
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
     return args.caseroot, args.lid
 
 def __main_func(description):

diff --git a/scripts/Tools/jenkins_generic_job b/scripts/Tools/jenkins_generic_job
@@ -84,9 +84,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
                         help="Number of tasks create_test should perform simultaneously. Default "
                         "will be min(num_cores, num_tests).")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     expect(not (args.submit_to_cdash and args.generate_baselines),
            "Does not make sense to use --generate-baselines and --submit-to-cdash together")

diff --git a/scripts/Tools/list_acme_tests b/scripts/Tools/list_acme_tests
@@ -43,9 +43,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("categories", nargs="*",
                         help="The test categories to list. Default will list all. Test categories: %s" % (", ".join(update_acme_tests.get_test_suites())))
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if (not args.categories):
         args.categories = update_acme_tests.get_test_suites()

diff --git a/scripts/Tools/normalize_cases b/scripts/Tools/normalize_cases
@@ -38,9 +38,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
 
     parser.add_argument("case2", help="Second case. This one will not be changed")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.case1, args.case2
 

diff --git a/scripts/Tools/pelayout b/scripts/Tools/pelayout
@@ -68,9 +68,7 @@ def parse_command_line(args):
     parser.add_argument("-caseroot" , "--caseroot", default=os.getcwd(),
                         help="Case directory to reference")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     if (args.no_header):
         args.header = None

diff --git a/scripts/Tools/preview_namelists b/scripts/Tools/preview_namelists
@@ -27,9 +27,7 @@ def parse_command_line(args, description):
     parser.add_argument('--test', action='store_true',
                         help="Run preview_namelist in test mode.")
 
-    args = parser.parse_args()
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args
 

diff --git a/scripts/Tools/save_provenance b/scripts/Tools/save_provenance
@@ -42,9 +42,7 @@ OR
     parser.add_argument("-l", "--lid",
                         help="Force system to save provenance with this LID")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     return args.mode, args.caseroot, args.lid
 

diff --git a/scripts/Tools/simple_compare b/scripts/Tools/simple_compare
@@ -40,9 +40,7 @@ formatter_class=argparse.ArgumentDefaultsHelpFormatter
     parser.add_argument("-c", "--case", action="store", dest="case", default=None,
                         help="The case base id (<TESTCASE>.<GRID>.<COMPSET>). Helps us normalize data.")
 
-    args = parser.parse_args(args[1:])
-
-    CIME.utils.handle_standard_logging_options(args)
+    args = CIME.utils.parse_args_and_handle_standard_logging_options(args, parser)
 
     # Normalize case
     if (args.case is not None):

diff --git a/scripts/Tools/testreporter.py b/scripts/Tools/testreporter.py
@@ -43,7 +43,7 @@ def parse_command_line(args):
     parser.add_argument("--dumpxml",action="store_true", 
                         help="Dump XML test results to sceen.")
     args = parser.parse_args()
-    CIME.utils.handle_standard_logging_options(args)
+    CIME.utils.parse_args_and_handle_standard_logging_options(args)
 
 
     return args.testroot, args.testid, args.tagname, args.testtype, args.dryrun, args.dumpxml