dev-support/test-patch.d/perlcritic.sh

#!/usr/bin/env bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

add_plugin perlcritic

PERLCRITIC_TIMER=0

PERLCRITIC=${PERLCRITIC:-$(which perlcritic 2>/dev/null)}

function perlcritic_usage
{
  echo "Perl::Critic specific:"
  echo "--perlcritic=<path> path to perlcritic executable"
}

function perlcritic_parse_args
{
  local i

  for i in "$@"; do
    case ${i} in
    --perlcritic=*)
      PERLCRITIC=${i#*=}
    ;;
    esac
  done
}

function perlcritic_filefilter
{
  local filename=$1

  if [[ ${filename} =~ \.p[lm]$ ]]; then
    add_test perlcritic
  fi
}

function perlcritic_preapply
{
  local i

  verify_needed_test perlcritic
  if [[ $? == 0 ]]; then
    return 0
  fi

  big_console_header "Perl::Critic plugin: prepatch"

  if [[ ! -x ${PERLCRITIC} ]]; then
    yetus_error "${PERLCRITIC} does not exist."
    return 0
  fi

  start_clock

  echo "Running perlcritic against modified perl scripts/modules."
  pushd "${BASEDIR}" >/dev/null
  for i in ${CHANGED_FILES}; do
    if [[ ${i} =~ \.p[lm]$ && -f ${i} ]]; then
      ${PERLCRITIC} -1 --verbose 1 "${i}" 2>/dev/null >> "${PATCH_DIR}/branch-perlcritic-result.txt"
    fi
  done
  popd >/dev/null
  # keep track of how much as elapsed for us already
  PERLCRITIC_TIMER=$(stop_clock)
  return 0
}

function perlcritic_postapply
{
  local i
  local numPrepatch
  local numPostpatch
  local diffPostpatch

  verify_needed_test perlcritic
  if [[ $? == 0 ]]; then
    return 0
  fi

  big_console_header "Perl::Critic plugin: postpatch"

  if [[ ! -x ${PERLCRITIC} ]]; then
    yetus_error "${PERLCRITIC} is not available."
    add_vote_table 0 perlcritic "Perl::Critic was not available."
    return 0
  fi

  start_clock

  # add our previous elapsed to our new timer
  # by setting the clock back
  offset_clock "${PERLCRITIC_TIMER}"

  echo "Running perlcritic against modified perl scripts/modules."
  # we re-check this in case one has been added
  pushd "${BASEDIR}" >/dev/null
  for i in ${CHANGED_FILES}; do
    if [[ ${i} =~ \.p[lm]$ && -f ${i} ]]; then
      ${PERLCRITIC} -1 --verbose 1 "${i}" 2>/dev/null >> "${PATCH_DIR}/patch-perlcritic-result.txt"
    fi
  done
  popd >/dev/null

  PERLCRITIC_VERSION=$(${PERLCRITIC} --version 2>/dev/null)
  add_footer_table perlcritic "v${PERLCRITIC_VERSION}"

  calcdiffs "${PATCH_DIR}/branch-perlcritic-result.txt" "${PATCH_DIR}/patch-perlcritic-result.txt" > "${PATCH_DIR}/diff-patch-perlcritic.txt"
  # shellcheck disable=SC2016
  diffPostpatch=$(wc -l "${PATCH_DIR}/diff-patch-perlcritic.txt" | ${AWK} '{print $1}')

  if [[ ${diffPostpatch} -gt 0 ]] ; then
    # shellcheck disable=SC2016
    numPrepatch=$(wc -l "${PATCH_DIR}/branch-perlcritic-result.txt" | ${AWK} '{print $1}')

    # shellcheck disable=SC2016
    numPostpatch=$(wc -l "${PATCH_DIR}/patch-perlcritic-result.txt" | ${AWK} '{print $1}')

    add_vote_table -1 perlcritic "The applied patch generated "\
      "${diffPostpatch} new Perl::Critic issues (total was ${numPrepatch}, now ${numPostpatch})."
    add_footer_table perlcritic "@@BASE@@/diff-patch-perlcritic.txt"
    return 1
  fi

  add_vote_table +1 perlcritic "There were no new perlcritic issues."
  return 0
}

function perlcritic_postcompile
{
  declare repostatus=$1

  if [[ "${repostatus}" = branch ]]; then
    perlcritic_preapply
  else
    perlcritic_postapply
  fi
}