ciq_tag: lib and command line tool to operate on CIQ commit tags

ciq-tag.py

@@ -0,0 +1,378 @@
+#!/usr/bin/env python3
+
+import ciq_tag
+import click
+import os
+from enum import Enum
+import sys
+import logging
+
+DEFAULT_LOGLEVEL = "INFO"
+
+LOGLEVEL = os.environ.get("LOGS", DEFAULT_LOGLEVEL).upper()
+logger = logging.getLogger(__name__)
+logger.propagate = False
+logger.setLevel(LOGLEVEL)
+log_handler = logging.StreamHandler()
+log_handler.setFormatter(logging.Formatter("%(levelname)s:%(name)s:%(funcName)s: %(message)s"))
+logger.addHandler(log_handler)
+
+
+CIQ_TAGS_LIST = ", ".join(c.arg_name for c in ciq_tag.CiqTag)
+
+
+class CmdException(Exception):
+    def __init__(self, exit_code, *rest):
+        super().__init__(*rest)
+        self._exit_code = exit_code
+
+
+def open_input(filename, **rest):
+    return sys.stdin if filename == "-" else open(filename, "r", **rest)
+
+
+def open_output(filename, **rest):
+    return sys.stdout if filename == "-" else open(filename, "w", **rest)
+
+
+def process_in_out(input, output, result_to_output_map, ciq_msg_method, *method_args_pos, **method_args_key):
+    with open_input(input) as in_file:
+        input_str = "".join(in_file.readlines())
+    msg = ciq_tag.CiqMsg(input_str)
+    ret, out = result_to_output_map(msg, ciq_msg_method(msg, *method_args_pos, **method_args_key))
+    if out:
+        with open_output(output) as out_file:
+            print(out, file=out_file, end="")
+    if ret != 0:
+        raise CmdException(ret)
+
+
+def parse_tag(tag_name):
+    tag = ciq_tag.CiqTag.get_by_arg_name(tag_name)
+    if tag:
+        return tag
+    else:
+        raise CmdException(1, f"Wrong TAG value. Must be one of: {CIQ_TAGS_LIST}")
+
+
+def read_value(value_arg, val_from_file_arg, trim_arg):
+    if val_from_file_arg:
+        with open_input(value_arg) as inFile:
+            value = "".join(inFile.readlines())
+    else:
+        value = value_arg
+    return value.strip() if trim_arg else value
+
+
+def getter_map(msg, result):
+    return (0, result + "\n") if result else (1, "")
+
+
+def setter_map(msg, modified):
+    out = msg.get_message()
+    return (0, out) if modified else (1, out)
+
+
+def args(*positional, **keyword):
+    return (positional, keyword)
+
+
+class ClickDef(Enum):
+    TAG = args("tag", type=str)
+
+    VALUE = args("value", type=str)
+
+    INDEX = args("index", type=int, required=False, default=0)
+
+    VAL_FROM_FILE = args(
+        "--val-from-file",
+        "-f",
+        flag_value=True,
+        help="""
+Treat the VALUE argument as a path to a file from which an actual value will be read (useful for
+multi-line formatted texts)
+""",
+    )
+
+    TRIM = args(
+        "--trim",
+        "-x",
+        flag_value=True,
+        help="""
+Trim the value from whitespaces at the beginning and end before inserting to a commit message as a
+tag value. Useful when reading the tag value from a file, which can have trailing newlines
+""",
+    )
+
+    INDENT = args(
+        "--indent",
+        "-t",
+        type=int,
+        default=ciq_tag.DEFAULT_INDENT,
+        help="""
+When inserting multi-line values indent them by this many spaces. Special value -1 means value
+indenting equal to the width of the tag keyword.
+""",
+    )
+
+    DEDENT = args("--dedent", "-T", flag_value=True, help="For the multi-line value remove the indent, if it has any.")
+
+    WRAP = args("--wrap", "-w", flag_value=(not ciq_tag.DEFAULT_INDENT), help="Enable value wrapping")
+
+    UNWRAP = args("--unwrap", "-W", flag_value=True, help="Unwrap multi-line values to a single line. Implies DEDENT.")
+
+    WRAP_WIDTH = args(
+        "--wrap-width",
+        "-c",
+        type=int,
+        default=ciq_tag.DEFAULT_WRAP_WIDTH,
+        help="If WRAP flag is given wrap the value text to this many columns.",
+    )
+
+    DELETE = args(
+        "--delete",
+        "-d",
+        type=str,
+        multiple=True,
+        help="<tag> to delete, exactly as would be done with the 'delete' command.",
+    )
+
+    SET = args(
+        "--set",
+        "-s",
+        type=(str, str),
+        multiple=True,
+        help="<tag> <value> pair to set in the message, exactly as would be done with the 'set' command.",
+    )
+
+    SET_FROM_FILE = args(
+        "--set-from-file",
+        "-S",
+        type=(str, str),
+        multiple=True,
+        help="""
+<tag> <file> pair, where <file> contains the <value> to set for the <tag> in the message, exactly as
+would be done with the 'set' command using --val-from-file option.
+""",
+    )
+
+    def __init__(self, positional, keyword):
+        self.positional = positional
+        self.keyword = keyword
+
+
+OPTIONS = {}
+
+
+@click.group(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.option(
+    "--input", "-i", type=click.Path(), default="-", show_default=True, help="File path to read, or '-' for stdin"
+)
+@click.option(
+    "--output", "-o", type=click.Path(), default="-", show_default=True, help="File path to write, or '-' for stdout"
+)
+def cli(input, output):
+    OPTIONS["input"] = input
+    OPTIONS["output"] = output
+
+
+@cli.command(
+    "get",
+    help=f"""
+Print to the output (--output) the value of the INDEXth TAG in the commit message given on
+the input (--input). If INDEX is not given assume it's 0, which is the first occurence of
+the TAG. Exit with nonzero if TAG not found. TAG can be one of: {CIQ_TAGS_LIST}
+""",
+)
+@click.argument(*ClickDef.TAG.positional, **ClickDef.TAG.keyword)
+@click.argument(*ClickDef.INDEX.positional, **ClickDef.INDEX.keyword)
+@click.option(*ClickDef.UNWRAP.positional, **ClickDef.UNWRAP.keyword)
+@click.option(*ClickDef.DEDENT.positional, **ClickDef.DEDENT.keyword)
+def command_get(tag, index, unwrap, dedent):
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        getter_map,
+        ciq_tag.CiqMsg.get_tag_value,
+        parse_tag(tag),
+        index,
+        unwrap=unwrap,
+        dedent=dedent,
+    )
+
+
+@cli.command(
+    "modify",
+    help="""
+Set the value of TAG, in its current place, using the current keyword. Return nonzero if the TAG
+wasn't defined already.
+""",
+)
+@click.argument(*ClickDef.TAG.positional, **ClickDef.TAG.keyword)
+@click.argument(*ClickDef.VALUE.positional, **ClickDef.VALUE.keyword)
+@click.argument(*ClickDef.INDEX.positional, **ClickDef.INDEX.keyword)
+@click.option(*ClickDef.VAL_FROM_FILE.positional, **ClickDef.VAL_FROM_FILE.keyword)
+@click.option(*ClickDef.TRIM.positional, **ClickDef.TRIM.keyword)
+@click.option(*ClickDef.INDENT.positional, **ClickDef.INDENT.keyword)
+@click.option(*ClickDef.WRAP.positional, **ClickDef.WRAP.keyword)
+@click.option(*ClickDef.WRAP_WIDTH.positional, **ClickDef.WRAP_WIDTH.keyword)
+def command_modify(tag, value, index, val_from_file, trim, indent, wrap, wrap_width):
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        setter_map,
+        ciq_tag.CiqMsg.modify_tag_value,
+        parse_tag(tag),
+        read_value(value, val_from_file, trim),
+        index,
+        indent=indent,
+        wrap=wrap,
+        wrap_width=wrap_width,
+    )
+
+
+@cli.command(
+    "add",
+    help="""
+Add a TAG with VALUE to the commit message. Attempt to locate the proper place to insert the tag then do it
+using the default keyword and value formatting defined by the options.
+""",
+)
+@click.argument(*ClickDef.TAG.positional, **ClickDef.TAG.keyword)
+@click.argument(*ClickDef.VALUE.positional, **ClickDef.VALUE.keyword)
+@click.option(*ClickDef.VAL_FROM_FILE.positional, **ClickDef.VAL_FROM_FILE.keyword)
+@click.option(*ClickDef.TRIM.positional, **ClickDef.TRIM.keyword)
+@click.option(*ClickDef.INDENT.positional, **ClickDef.INDENT.keyword)
+@click.option(*ClickDef.WRAP.positional, **ClickDef.WRAP.keyword)
+@click.option(*ClickDef.WRAP_WIDTH.positional, **ClickDef.WRAP_WIDTH.keyword)
+def command_add(tag, value, val_from_file, trim, indent, wrap, wrap_width):
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        setter_map,
+        ciq_tag.CiqMsg.add_tag,
+        parse_tag(tag),
+        read_value(value, val_from_file, trim),
+        indent=indent,
+        wrap=wrap,
+        wrap_width=wrap_width,
+    )
+
+
+@cli.command(
+    "set",
+    help="""
+Attempt to set TAG to the VALUE in place as it would be done with the 'modify' action, using INDEX
+(default 0). If that fails insert it as with the 'add' action.
+""",
+)
+@click.argument(*ClickDef.TAG.positional, **ClickDef.TAG.keyword)
+@click.argument(*ClickDef.VALUE.positional, **ClickDef.VALUE.keyword)
+@click.argument(*ClickDef.INDEX.positional, **ClickDef.INDEX.keyword)
+@click.option(*ClickDef.VAL_FROM_FILE.positional, **ClickDef.VAL_FROM_FILE.keyword)
+@click.option(*ClickDef.TRIM.positional, **ClickDef.TRIM.keyword)
+@click.option(*ClickDef.INDENT.positional, **ClickDef.INDENT.keyword)
+@click.option(*ClickDef.WRAP.positional, **ClickDef.WRAP.keyword)
+@click.option(*ClickDef.WRAP_WIDTH.positional, **ClickDef.WRAP_WIDTH.keyword)
+def command_set(tag, value, index, val_from_file, trim, indent, wrap, wrap_width):
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        setter_map,
+        ciq_tag.CiqMsg.set_tag,
+        parse_tag(tag),
+        read_value(value, val_from_file, trim),
+        index,
+        indent=indent,
+        wrap=wrap,
+        wrap_width=wrap_width,
+    )
+
+
+@cli.command(
+    "delete",
+    help="""
+Delete a tag from the commit message. Attempt to keep the message formatted nicely.
+""",
+)
+@click.argument(*ClickDef.TAG.positional, **ClickDef.TAG.keyword)
+@click.argument(*ClickDef.INDEX.positional, **ClickDef.INDEX.keyword)
+def command_delete(tag, index):
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        setter_map,
+        ciq_tag.CiqMsg.delete_tag,
+        ciq_tag.CiqTag.get_by_arg_name(tag),
+        index,
+    )
+
+
+@cli.command(
+    "seq",
+    help="""
+Set / delete multiple tags in sequence. The tags and their values (where applicable) are specified
+with options --delete, --set and --set-from-file, which can be provided multiple times. First
+process all --delete tags, then --set, then --set-from-file. Within the same group the tags are
+processed in the order given on the command line. For the --set-from-file tags the trimming is
+always on. The --wrap-width and --indent options apply to all tags specified by --set and
+--set-from-file.
+""",
+    epilog="<tag> ::= " + " | ".join(t.arg_name for t in ciq_tag.CiqTag),
+)
+@click.option(*ClickDef.DELETE.positional, **ClickDef.DELETE.keyword)
+@click.option(*ClickDef.SET.positional, **ClickDef.SET.keyword)
+@click.option(*ClickDef.SET_FROM_FILE.positional, **ClickDef.SET_FROM_FILE.keyword)
+@click.option(*ClickDef.INDENT.positional, **ClickDef.INDENT.keyword)
+@click.option(*ClickDef.WRAP.positional, **ClickDef.WRAP.keyword)
+@click.option(*ClickDef.WRAP_WIDTH.positional, **ClickDef.WRAP_WIDTH.keyword)
+def command_seq(delete, set, set_from_file, indent, wrap, wrap_width):
+    def process(msg):
+        modified = True
+        for delete_tag in delete:
+            modified = msg.delete_tag(parse_tag(delete_tag)) or modified
+        for set_tag, set_value in set:
+            modified = (
+                msg.set_tag(
+                    parse_tag(set_tag),
+                    read_value(set_value, False, False),
+                    indent=indent,
+                    wrap=wrap,
+                    wrap_width=wrap_width,
+                    suspend_ignore_warns=True,
+                )
+                or modified
+            )
+        for fset_tag, fset_value in set_from_file:
+            modified = (
+                msg.set_tag(
+                    parse_tag(fset_tag),
+                    read_value(fset_value, True, True),
+                    indent=indent,
+                    wrap=wrap,
+                    wrap_width=wrap_width,
+                    suspend_ignore_warns=True,
+                )
+                or modified
+            )
+        return msg, modified
+
+    process_in_out(
+        OPTIONS["input"],
+        OPTIONS["output"],
+        setter_map,
+        process,
+    )
+
+
+def main():
+    try:
+        cli()
+        return 0
+    except CmdException as exc:
+        logger.error(str(exc))
+        return exc._exit_code
+
+
+if __name__ == "__main__":
+    exit(main())