Add release script for lfric (#50)

* some changes for release

* further apply_macros changes

* change apply_macros to print macros to all files, including science (#48)

* change apply_macros to print macros to all files, including science

* add fix for 2nd macro in chain

* comment fix and change to black filename

* add release_lfric script

* update unit test

* review changes

* review updates

* update order of import addition

* fix import order

* add exclude dirs

* add comment

Author: james-bruten-mo

lfric_macros/apply_macros.py

@@ -72,12 +72,19 @@ def get_root_path(wc_path):
     )
 
 
-def run_black(filepath):
+def apply_styling(filepath):
     """
     Run black on a given file
     Inputs:
         - filepath, the path to the file to run black on
     """
+    result = run_command(f"isort --profile black {filepath}")
+    if result.returncode:
+        raise Exception(
+            "Running 'isort' as a subprocess failed. This may indicate a "
+            "syntax error with your macro.\nThe error message produced "
+            f"was:\n\n{result.stderr}"
+        )
     result = run_command(f"{BLACK_COMMAND} {filepath}")
     if result.returncode:
         raise Exception(
@@ -212,7 +219,7 @@ class ApplyMacros:
     Object to hold data + methods to apply upgrade macros in lfric_apps
     """
 
-    def __init__(self, tag, cname, apps, core, jules):
+    def __init__(self, tag, cname, version, apps, core, jules):
         self.tag = tag
         if cname:
             self.class_name = cname
@@ -228,7 +235,10 @@ def __init__(self, tag, cname, apps, core, jules):
         # system needs modifying to enable this
         # self.jules_source = self.get_dependency_paths(jules, "jules")
         self.set_rose_meta_path()
-        self.version = re.search(r".*vn(\d+\.\d+)(_.*)?", tag).group(1)
+        if version is None:
+            self.version = re.search(r".*vn(\d+\.\d+)(_.*)?", tag).group(1)
+        else:
+            self.version = version
         self.ticket_number = None
         self.author = None
         self.parsed_macros = {}
@@ -473,7 +483,7 @@ def remove_macro(self, contents, meta_dir):
                 if not in_new_macro:
                     f.write(line)
 
-        run_black(temppath)
+        apply_styling(temppath)
 
         if not os.path.getsize(temppath) > 0:
             raise Exception(
@@ -742,7 +752,7 @@ def write_new_macro(self, meta_dir, full_command):
                 "        return config, self.reports\n"
             )
 
-        run_black(temppath)
+        apply_styling(temppath)
 
         os.rename(temppath, filepath)
 
@@ -956,6 +966,20 @@ def check_tag(opt):
     return opt
 
 
+def version_number(opt):
+    """
+    Check that the command line supplied version number is of a suitable format
+    """
+    if opt is None:
+        return opt
+    if not re.match(r"\d+.\d+", opt):
+        raise argparse.ArgumentTypeError(
+            f"The version number '{opt}' does not conform to the 'X.Y' format."
+            "Please modify the command line argument and rerun."
+        )
+    return opt
+
+
 def parse_args():
     """
     Read command line args
@@ -977,6 +1001,13 @@ def parse_args():
         help="The class name of the upgrade macro. This should only be used at "
         "a new release when the tag and classname differ.",
     )
+    parser.add_argument(
+        "-v",
+        "--version",
+        default=None,
+        type=version_number,
+        help="The new version number we are updating to (format X.Y)",
+    )
     parser.add_argument(
         "-a",
         "--apps",
@@ -1004,16 +1035,14 @@ def parse_args():
     return parser.parse_args()
 
 
-def main():
+def apply_macros_main(
+    tag, cname=None, version=None, apps=".", core=None, jules=None
+):
     """
     Main function for this program
     """
 
-    args = parse_args()
-
-    macro_object = ApplyMacros(
-        args.tag, args.cname, args.apps, args.core, args.jules
-    )
+    macro_object = ApplyMacros(tag, cname, version, apps, core, jules)
 
     # Pre-process macros
     banner_print("Pre-Processing Macros")
@@ -1043,4 +1072,7 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    args = parse_args()
+    apply_macros_main(
+        args.tag, args.cname, args.version, args.apps, args.core, args.jules
+    )

lfric_macros/files/template_versions.py

@@ -0,0 +1,30 @@
+import sys
+
+from metomi.rose.upgrade import MacroUpgrade
+
+class UpgradeError(Exception):
+    """Exception created when an upgrade fails."""
+
+    def __init__(self, msg):
+        self.msg = msg
+
+    def __repr__(self):
+        sys.tracebacklimit = 0
+        return self.msg
+
+    __str__ = __repr__
+
+
+"""
+Copy this template and complete to add your macro
+
+class vnXX_txxx(MacroUpgrade):
+    # Upgrade macro for <TICKET> by <Author>
+
+    BEFORE_TAG = "vnX.X"
+    AFTER_TAG = "vnX.X_txxx"
+
+    def upgrade(self, config, meta_config=None):
+        # Add settings
+        return config, self.reports
+"""