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 # Authors: Daniel Carvalho
  30
  31 # If your commit has been canceled because of this file, do not panic: a
  32 # copy of it has been stored in ./.git/COMMIT_EDITMSG
  33
  34 import os
  35 import re
  36 import sys
  37
  38 from style.repo import GitRepo
  39
  40 def _printErrorQuit(error_message):
  41     """
  42         Print an error message, followed my a help message and inform failure.
  43
  44         @param error_message A message describing the error that caused the
  45             failure.
  46     """
  47     print(error_message)
  48     print("""
  49 The commit has been canceled, but a copy of it can be found in
  50 .git/COMMIT_EDITMSG
  51
  52 The first line of a commit must contain one or more gem5 tags separated by
  53 commas (see MAINTAINERS for the possible tags), followed by a colon and a
  54 commit title. There must be no leading nor trailing whitespaces.
  55
  56 This header line must then be followed by an empty line. A detailed message,
  57 although highly recommended, is not mandatory and can follow that empty line.
  58
  59 e.g.:
  60     cpu: Refactor branch predictors
  61
  62     Refactor branch predictor code to improve its readability, moving functions
  63     X and Y to the base class...
  64
  65 e.g.:
  66     mem,mem-cache: Improve packet class readability
  67
  68     The packet class...
  69 """)
  70     print("A copy of your commit message can be found in " + sys.argv[1])
  71     sys.exit(1)
  72
  73 def _validateTags(commit_header):
  74     """
  75         Check if all tags in the commit header belong to the list of valid
  76         gem5 tags.
  77
  78         @param commit_header The first line of the commit message.
  79     """
  80
  81     # List of valid tags
  82     # @todo this is error prone, and should be extracted automatically from
  83     #       a file
  84
  85     valid_tags = ["arch", "arch-alpha", "arch-arm", "arch-hsail", "arch-mips",
  86         "arch-power", "arch-riscv", "arch-sparc", "arch-x86", "base",
  87         "configs", "cpu", "cpu-kvm", "cpu-minor", "cpu-o3", "cpu-simple",
  88         "dev", "dev-arm", "dev-virtio", "ext", "fastmodel", "gpu-compute",
  89         "learning-gem5", "mem", "mem-cache", "mem-garnet", "mem-ruby", "misc",
  90         "python", "scons", "sim", "sim-se", "sim-power", "stats", "system",
  91         "system-alpha", "system-arm", "systemc", "tests", "util", "RFC", "WIP"]
  92
  93     tags = ''.join(commit_header.split(':')[0].split()).split(',')
  94     if (any(tag not in valid_tags for tag in tags)):
  95         invalid_tag = next((tag for tag in tags if tag not in valid_tags))
  96         _printErrorQuit("Invalid Gem5 tag: " + invalid_tag)
  97
  98 # Go to git directory
  99 os.chdir(GitRepo().repo_base())
 100
 101 # Get the commit message
 102 commit_message = open(sys.argv[1]).read()
 103
 104 # The first line of a commit must contain at least one valid gem5 tag, and
 105 # a commit title
 106 commit_message_lines = commit_message.splitlines()
 107 commit_header = commit_message_lines[0]
 108 commit_header_match = \
 109     re.search("^(\S[\w\-][,\s*[\w\-]+]*:.+\S$)", commit_header)
 110 if ((commit_header_match is None)):
 111     _printErrorQuit("Invalid commit header")
 112 _validateTags(commit_header)
 113
 114 # Make sure commit title does not exceed threshold. This line is limited to
 115 # a smaller number because version control systems may add a prefix, causing
 116 # line-wrapping for longer lines
 117 commit_title = commit_header.split(':')[1]
 118 max_header_size = 65
 119 if (len(commit_header) > max_header_size):
 120     _printErrorQuit("The commit header (tags + title) is too long (" + \
 121         str(len(commit_header)) + " > " + str(max_header_size) + ")")
 122
 123 # Then there must be at least one empty line between the commit header and
 124 # the commit description
 125 if (commit_message_lines[1] != ""):
 126     _printErrorQuit("Please add an empty line between the commit title and " \
 127         "its description")
 128
 129 # Encourage providing descriptions
 130 if (re.search("^(Signed-off-by|Change-Id|Reviewed-by):",
 131     commit_message_lines[2])):
 132     print("Warning: Commit does not have a description")
 133
 134 sys.exit(0)