util/git-pre-commit.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2016 ARM Limited
   4 # All rights reserved
   5 #
   6 # The license below extends only to copyright in the software and shall
   7 # not be construed as granting a license to any other intellectual
   8 # property including but not limited to intellectual property relating
   9 # to a hardware implementation of the functionality of the software
  10 # licensed hereunder.  You may use the software subject to the license
  11 # terms below provided that you ensure that this notice is replicated
  12 # unmodified and in its entirety in all distributions of the software,
  13 # modified or unmodified, in source code or in binary form.
  14 #
  15 # Redistribution and use in source and binary forms, with or without
  16 # modification, are permitted provided that the following conditions are
  17 # met: redistributions of source code must retain the above copyright
  18 # notice, this list of conditions and the following disclaimer;
  19 # redistributions in binary form must reproduce the above copyright
  20 # notice, this list of conditions and the following disclaimer in the
  21 # documentation and/or other materials provided with the distribution;
  22 # neither the name of the copyright holders nor the names of its
  23 # contributors may be used to endorse or promote products derived from
  24 # this software without specific prior written permission.
  25 #
  26 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37 #
  38 # Authors: Andreas Sandberg
  39
  40 import os
  41 import sys
  42
  43 from style.repo import GitRepo
  44 from style.verifiers import all_verifiers, all_regions
  45 from style.style import StdioUI
  46
  47 import argparse
  48
  49 parser = argparse.ArgumentParser(
  50     description="gem5 git style checker hook")
  51
  52 parser.add_argument("--verbose", "-v", action="store_true",
  53                     help="Produce verbose output")
  54
  55 args = parser.parse_args()
  56
  57 git = GitRepo()
  58
  59 opts = {}
  60 repo_base = git.repo_base()
  61 ui = StdioUI()
  62
  63 os.chdir(repo_base)
  64 failing_files = set()
  65
  66 for status, fname in git.status(filter="MA", cached=True):
  67     if args.verbose:
  68         print "Checking %s..." % fname
  69     if status == "M":
  70         regions = git.staged_regions(fname)
  71     else:
  72         regions = all_regions
  73
  74     verifiers = [ v(ui, opts, base=repo_base) for v in all_verifiers ]
  75     for v in verifiers:
  76         if v.check(fname, regions):
  77             failing_files.add(fname)
  78
  79 if failing_files:
  80     print >> sys.stderr
  81     print >> sys.stderr, "Style checker failed for the following files:"
  82     for f in failing_files:
  83         print >> sys.stderr, "\t%s" % f
  84     print >> sys.stderr
  85     print >> sys.stderr, \
  86         "Please run the style checker manually to fix the offending files.\n" \
  87         "To check your modifications, run: util/style.py -m"
  88     sys.exit(1)