control-repo/scripts/lint_check.sh
Jeff McCune de08460ef6 Add Gitlab CI jobs
Without this patch the control repository does not contain any scripts
to execute CI jobs for Puppet code deployment.  This patch addresses the
problem by adding a Gitlab CI job configuration with three jobs defined
across two stages.  The test stage executes first with a Syntax and a
Lint job executing in parallel.  If an environment branch has been
pushed, one matching `developemnt`, `testing`, `production` or starting
with the prefix `playground`, the deploy stage is executed.

The deploy stage requires a Gitlab secret environment variable,
PUPPET_TOKEN.  This environment variable is the puppet access token
configured with Code Manager.

The test stage runs the following syntax checks:

 * yaml files (*.yml, *.yaml)
 * json files (*.json)
 * bash scripts (*.sh)
 * ruby scripts (*.rb)
 * puppet manifests (*.pp)
 * erb files (*.erb)

The behavior of the checks are to check only files modified relative to
a base branch, defaulting to `production`.  This avoids running syntax
checks against files which have not been modified by the merge request.
The check uses `git diff --name-status` to identify changed files across
multiple commits in a topic branch.

The lint checks rely on bundler and the Gemfile to install numerous lint
checks.

Gem libraries are installed in a per-job location in $HOME.  This is an
intentional compromise between installing into a system GEM_PATH
element, which would create library conflicts with other jobs, and the
job workspace, which would cause gem libraries to be installed from the
network on each job invocation.
2017-06-14 16:50:17 -04:00

73 lines
1.9 KiB
Bash
Executable File

#!/bin/bash
# Error out if there are any failures
set -e
set -o pipefail
set -u
# Notes
# xargs -P2 is used to run 2 parallel processes at once. This speeds up
# performance on multi-core systems.
if [ -e /proc/cpuinfo ]; then
cores=$(awk 'BEGIN { c = 0 }; $1 == "processor" { c++ }; END { print c }' /proc/cpuinfo)
else
cores=2
fi
# Use Puppet Enterprise Ruby to check ruby and yaml files
export PATH="/opt/puppetlabs/puppet/bin:/opt/puppetlabs/bin:$PATH"
# Localize Gems on a per-job basis to prevent conflicts
gem_home="$(gem env gempath | cut -d: -f1)"
# Trim off the leading part of $HOME
gem_suffix=${gem_home##*/.gem/}
# Set GEM_HOME to a job specific location
export GEM_HOME="${HOME}/jobs/${CI_JOB_NAME:-lint}/gem/${gem_suffix}"
# If we need to install a gem, do so into HOME
# e.g. /home/gitlab-runner/.gem/ruby/2.1.0
export PATH="${GEM_HOME}/bin:$PATH"
echo '######## BEGIN DEPENDENCY SETUP #########'
# Display the gem environment
gem env
if ! (which bundle 2>&1 >/dev/null); then
gem install bundler --no-ri --no-rdoc
fi
# List the files changes from $BASEBRANCH on stdout
files_changed() {
# File status flags:
# M modified - File has been modified
# C copy-edit - File has been copied and modified
# R rename-edit - File has been renamed and modified
# A added - File has been added
# D deleted - File has been deleted
# U unmerged - File has conflicts after a merge
git diff --name-status "${BASEBRANCH:=production}" \
| awk '$1 ~ /^[MCRA]$/' \
| cut -f2-
}
# Install dependencies
bundle install
echo '######## END DEPENDENCY SETUP #########'
echo
echo
echo '######## BEGIN LINT CHECKS #########'
# Lint only the manifest files changed
files_changed \
| awk '/manifests\/.*\.(pp)$/' \
| xargs --no-run-if-empty -t -P$cores -n1 \
bundle exec puppet-lint
echo '######## END LINT CHECKS #########'
# vim:tabstop=2
# vim:shiftwidth=2
# vim:expandtab