admin/builds/clang-format.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 def do_build(context):
  36     context.env.set_env_var('CLANG_FORMAT', context.env.get_clang_format_command('7'))
  37     clangformat_log = context.workspace.get_path_for_logfile('clang-format.log', category='clang-format')
  38     copyright_log  = context.workspace.get_path_for_logfile('copyright.log', category='copyright')
  39     cmd = ['admin/clang-format.sh', 'check', '--rev=HEAD^', '--warnings=' + clangformat_log]
  40     ret = context.run_cmd(cmd, use_return_code=True)
  41     if ret == 1:
  42         with open(clangformat_log, 'r') as f:
  43             warnings = f.readlines()
  44         if len(warnings) <= 5:
  45             details = [x.rstrip() for x in warnings]
  46         else:
  47             format_count = 0
  48             for w in warnings:
  49                 if 'needs formatting' in w:
  50                     format_count += 1
  51             details = []
  52             if format_count > 0:
  53                 details.append('formatting issues in {0} files'.format(format_count))
  54         context.mark_unstable(reason='clang-format.sh found issues', details=details)
  55     elif ret != 0:
  56         raise BuildError('clang-format.sh failed to run')
  57
  58     cmd = ['admin/copyright.sh', 'check', '--rev=HEAD^', '--warnings=' + copyright_log]
  59     ret = context.run_cmd(cmd, use_return_code=True)
  60     if ret == 1:
  61         with open(copyright_log, 'r') as f:
  62             warnings = f.readlines()
  63         if len(warnings) <= 5:
  64             details = [x.rstrip() for x in warnings]
  65         else:
  66             cpyear_count = 0
  67             cpheader_count = 0
  68             for w in warnings:
  69                 if 'copyright year' in w:
  70                     cpyear_count += 1
  71                 if 'copyright header' in w:
  72                     cpheader_count += 1
  73             details = []
  74             if cpyear_count > 0:
  75                 details.append('copyright year missing in {0} files'.format(cpyear_count))
  76             if cpheader_count > 0:
  77                 details.append('copyright header issues in {0} files'.format(cpheader_count))
  78         context.mark_unstable(reason='copyright.sh found issues', details=details)
  79     elif ret != 0:
  80         raise BuildError('copyright.sh failed to run')