util/git-commit-msg.py

   1 #!/usr/bin/env python2.7
   2 #
   3 # Copyright (c) 2019 Inria
   4 # All rights reserved
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 # If your commit has been canceled because of this file, do not panic: a
  30 # copy of it has been stored in ./.git/COMMIT_EDITMSG
  31
  32 import os
  33 import re
  34 import sys
  35
  36 from style.repo import GitRepo
  37
  38 def _printErrorQuit(error_message):
  39     """
  40         Print an error message, followed my a help message and inform failure.
  41
  42         @param error_message A message describing the error that caused the
  43             failure.
  44     """
  45     print(error_message)
  46
  47     print("The commit has been cancelled, but a copy of it can be found in "
  48             + sys.argv[1] + " : ")
  49
  50     print("""
  51 --------------------------------------------------------------------------
  52     """)
  53     print(open(sys.argv[1], "r").read())
  54     print("""
  55 --------------------------------------------------------------------------
  56     """)
  57
  58     print("""
  59 The first line of a commit must contain one or more gem5 tags separated by
  60 commas (see MAINTAINERS for the possible tags), followed by a colon and a
  61 commit title. There must be no leading nor trailing whitespaces.
  62
  63 This header line must then be followed by an empty line. A detailed message,
  64 although highly recommended, is not mandatory and can follow that empty line.
  65
  66 e.g.:
  67     cpu: Refactor branch predictors
  68
  69     Refactor branch predictor code to improve its readability, moving functions
  70     X and Y to the base class...
  71
  72 e.g.:
  73     mem,mem-cache: Improve packet class readability
  74
  75     The packet class...
  76 """)
  77     sys.exit(1)
  78
  79 def _validateTags(commit_header):
  80     """
  81         Check if all tags in the commit header belong to the list of valid
  82         gem5 tags.
  83
  84         @param commit_header The first line of the commit message.
  85     """
  86
  87     # List of valid tags
  88     # @todo this is error prone, and should be extracted automatically from
  89     #       a file
  90
  91     valid_tags = ["arch", "arch-alpha", "arch-arm", "arch-gcn3", "arch-hsail",
  92         "arch-mips", "arch-power", "arch-riscv", "arch-sparc", "arch-x86",
  93         "base", "configs", "cpu", "cpu-kvm", "cpu-minor", "cpu-o3",
  94         "cpu-simple", "dev", "dev-arm", "dev-virtio", "ext", "fastmodel",
  95         "gpu-compute", "learning-gem5", "mem", "mem-cache", "mem-garnet",
  96         "mem-ruby", "misc", "python", "scons", "sim", "sim-se", "sim-power",
  97         "stats", "system", "system-alpha", "system-arm", "systemc", "tests",
  98         "util", "RFC", "WIP"]
  99
 100     tags = ''.join(commit_header.split(':')[0].split()).split(',')
 101     if (any(tag not in valid_tags for tag in tags)):
 102         invalid_tag = next((tag for tag in tags if tag not in valid_tags))
 103         _printErrorQuit("Invalid Gem5 tag: " + invalid_tag)
 104
 105 # Go to git directory
 106 os.chdir(GitRepo().repo_base())
 107
 108 # Get the commit message
 109 commit_message = open(sys.argv[1]).read()
 110
 111 # The first line of a commit must contain at least one valid gem5 tag, and
 112 # a commit title
 113 commit_message_lines = commit_message.splitlines()
 114 commit_header = commit_message_lines[0]
 115 commit_header_match = \
 116     re.search("^(\S[\w\-][,\s*[\w\-]+]*:.+\S$)", commit_header)
 117 if ((commit_header_match is None)):
 118     _printErrorQuit("Invalid commit header")
 119 _validateTags(commit_header)
 120
 121 # Make sure commit title does not exceed threshold. This line is limited to
 122 # a smaller number because version control systems may add a prefix, causing
 123 # line-wrapping for longer lines
 124 commit_title = commit_header.split(':')[1]
 125 max_header_size = 65
 126 if (len(commit_header) > max_header_size):
 127     _printErrorQuit("The commit header (tags + title) is too long (" + \
 128         str(len(commit_header)) + " > " + str(max_header_size) + ")")
 129
 130 # Then there must be at least one empty line between the commit header and
 131 # the commit description
 132 if (commit_message_lines[1] != ""):
 133     _printErrorQuit("Please add an empty line between the commit title and " \
 134         "its description")
 135
 136 # Encourage providing descriptions
 137 if (re.search("^(Signed-off-by|Change-Id|Reviewed-by):",
 138     commit_message_lines[2])):
 139     print("Warning: Commit does not have a description")
 140
 141 sys.exit(0)