From 02789fcb289531abba743243bc6d267610f15dfb Mon Sep 17 00:00:00 2001 From: Daniel Gibbs Date: Sat, 7 Nov 2015 15:42:30 +0000 Subject: [PATCH] testing bash linter --- .travis.yml | 7 +++- build/.shippable.yml | 8 ++++ build/.travis.yml | 8 ++++ build/LICENSE | 22 +++++++++++ build/README.md | 75 +++++++++++++++++++++++++++++++++++++ build/build.sh | 45 ++++++++++++++++++++++ build/install.sh | 10 +++++ build/shippable.yml.example | 8 ++++ build/tests/bash.sh | 2 + build/tests/ksh.sh | 2 + build/tests/sh.sh | 2 + build/tests/zsh.sh | 2 + build/travis.yml.example | 8 ++++ 13 files changed, 197 insertions(+), 2 deletions(-) create mode 100644 build/.shippable.yml create mode 100644 build/.travis.yml create mode 100644 build/LICENSE create mode 100644 build/README.md create mode 100644 build/build.sh create mode 100644 build/install.sh create mode 100644 build/shippable.yml.example create mode 100644 build/tests/bash.sh create mode 100644 build/tests/ksh.sh create mode 100644 build/tests/sh.sh create mode 100644 build/tests/zsh.sh create mode 100644 build/travis.yml.example diff --git a/.travis.yml b/.travis.yml index 7a1c63dcf..95aeadcb3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -20,7 +20,10 @@ addons: - telnet - expect -script: +install: + - ./build/install.sh +script: + - ./build/build.sh - bash tests/tests_jc2server.sh - - bash tests/tests_ts3server.sh \ No newline at end of file + - bash tests/tests_ts3server.sh diff --git a/build/.shippable.yml b/build/.shippable.yml new file mode 100644 index 000000000..421daea86 --- /dev/null +++ b/build/.shippable.yml @@ -0,0 +1,8 @@ +language: ruby +install: + - ./install.sh +script: + - ./build.sh +notifications: + email: false +sudo: required diff --git a/build/.travis.yml b/build/.travis.yml new file mode 100644 index 000000000..17f4c2c4f --- /dev/null +++ b/build/.travis.yml @@ -0,0 +1,8 @@ +language: bash +install: + - ./install.sh +script: + - ./build.sh +notifications: + email: false +sudo: required diff --git a/build/LICENSE b/build/LICENSE new file mode 100644 index 000000000..47ef4160e --- /dev/null +++ b/build/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2014 Carlos Alexandro Becker + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/build/README.md b/build/README.md new file mode 100644 index 000000000..9467a3c10 --- /dev/null +++ b/build/README.md @@ -0,0 +1,75 @@ +shell-ci-build [![Build Status](https://travis-ci.org/caarlos0/shell-ci-build.svg?branch=master)](https://travis-ci.org/caarlos0/shell-ci-build) +================== + +A submodule to lint your shell projects with shellcheck in travis.ci builds. + +## Build + +- The `install.sh` script will install shellckeck. +- The `build.sh` will lint all executable files with shellcheck, avoiding +Ruby, compdef and the like files. It will also ignore all files inside `.git` +directory and files of your `gitmodules`, if any. + +## Usage + +```sh +git submodule add https://github.com/caarlos0/shell-ci-build.git build +cp build/travis.yml.example .travis.yml +``` + +We also support Shippable: + +``` +cp build/shippable.yml.example .shippable.yml +``` + +Or tweak your `.travis.yml` to be like this: + +```yml +language: bash +install: + - ./build/install.sh +script: + - ./build/build.sh +``` + +## Customizing + +You might want to lint other files, to do that, you need your own +`build.sh` and a slight change in `.travis.yml` file. + +Example (from my [dotfiles](https://github.com/caarlos0/dotfiles)): + +```sh +#!/usr/bin/env bash +set -eo pipefail +source ./build/build.sh +check "./zsh/zshrc.symlink" +``` + +```yml +language: bash +install: + - ./build/install.sh +script: + - ./build.sh +notifications: + email: false +``` + +This will make travis ran the `build.sh` from this project first, +then, lint your custom files. + +You can also override the `find_cmd` function, which returns a string +containing the `find` command to `eval`. Check the source or open an +issue if you have any problems. + +## Updating + +Update your projects is easy. Just run this: + +```sh +git submodule update --remote --merge && \ + git commit -am 'updated shell-ci-build version' && \ + git push +``` diff --git a/build/build.sh b/build/build.sh new file mode 100644 index 000000000..5043a35b7 --- /dev/null +++ b/build/build.sh @@ -0,0 +1,45 @@ +#!/usr/bin/env bash +set -eo pipefail +[[ "${DEBUG:-}" ]] && set -x + +success() { + printf "\r\033[2K [ \033[00;32mOK\033[0m ] Linting %s...\n" "$1" +} + +fail() { + printf "\r\033[2K [\033[0;31mFAIL\033[0m] Linting %s...\n" "$1" + exit 1 +} + +check() { + local script="$1" + shellcheck "$script" || fail "$script" + success "$script" +} + +find_prunes() { + local prunes="! -path './.git/*'" + if [ -f .gitmodules ]; then + while read module; do + prunes="$prunes ! -path './$module/*'" + done < <(grep path .gitmodules | awk '{print $3}') + fi + echo "$prunes" +} + +find_cmd() { + echo "find . -type f -and \( -perm +111 -or -name '*.sh' \) $(find_prunes)" +} + +check_all_executables() { + echo "Linting all executables and .sh files, ignoring files inside git modules..." + eval "$(find_cmd)" | while read script; do + head=$(head -n1 "$script") + [[ "$head" =~ .*ruby.* ]] && continue + [[ "$head" =~ .*zsh.* ]] && continue + [[ "$head" =~ ^#compdef.* ]] && continue + check "$script" + done +} + +check_all_executables diff --git a/build/install.sh b/build/install.sh new file mode 100644 index 000000000..c66b56c59 --- /dev/null +++ b/build/install.sh @@ -0,0 +1,10 @@ +#!/bin/bash +set -eo pipefail + +main() { + local filename="shellcheck_0.3.7-1_amd64.deb" + wget "http://ftp.debian.org/debian/pool/main/s/shellcheck/$filename" + sudo dpkg -i "$filename" +} + +main diff --git a/build/shippable.yml.example b/build/shippable.yml.example new file mode 100644 index 000000000..c2f36c044 --- /dev/null +++ b/build/shippable.yml.example @@ -0,0 +1,8 @@ +language: ruby +install: + - ./build/install.sh +script: + - ./build/build.sh +notifications: + email: false +sudo: required diff --git a/build/tests/bash.sh b/build/tests/bash.sh new file mode 100644 index 000000000..8de506c94 --- /dev/null +++ b/build/tests/bash.sh @@ -0,0 +1,2 @@ +#!/bin/bash +echo "hi" diff --git a/build/tests/ksh.sh b/build/tests/ksh.sh new file mode 100644 index 000000000..c0db8626f --- /dev/null +++ b/build/tests/ksh.sh @@ -0,0 +1,2 @@ +#!/bin/ksh +echo "hi" diff --git a/build/tests/sh.sh b/build/tests/sh.sh new file mode 100644 index 000000000..279508d8e --- /dev/null +++ b/build/tests/sh.sh @@ -0,0 +1,2 @@ +#!/bin/sh +echo "hi" diff --git a/build/tests/zsh.sh b/build/tests/zsh.sh new file mode 100644 index 000000000..0fe81dfa7 --- /dev/null +++ b/build/tests/zsh.sh @@ -0,0 +1,2 @@ +#!/bin/zsh +echo "hi" diff --git a/build/travis.yml.example b/build/travis.yml.example new file mode 100644 index 000000000..3f7a7173a --- /dev/null +++ b/build/travis.yml.example @@ -0,0 +1,8 @@ +language: bash +install: + - ./build/install.sh +script: + - ./build/build.sh +notifications: + email: false +sudo: required