|
| 1 | +#!/usr/bin/env bash |
| 2 | + |
| 3 | +# See: ./scripts/test_plugin.bash --help |
| 4 | + |
| 5 | +function fail() { |
| 6 | + echo "FAIL: $*" >&2 |
| 7 | + exit 1 |
| 8 | +} |
| 9 | + |
| 10 | +# Extract the link to a svg badge from a line of README. |
| 11 | +function badge_svg() { |
| 12 | + grep -o '(http[^)]*svg[^)]*)' | sed -e 's/(//;s/)//' |
| 13 | +} |
| 14 | + |
| 15 | +function check_plugins_from_diff() { |
| 16 | + local BASE_REF="$1" # Base commit of main branch. |
| 17 | + local HEAD_REF="$2" # Latest commit of PR |
| 18 | + |
| 19 | + local DIFF_CHANGES |
| 20 | + DIFF_CHANGES="$(git diff --name-only "${BASE_REF}" "${HEAD_REF}")" |
| 21 | + |
| 22 | + # Assert that the PR diff only includes a change to README and file(s) under plugins/ directory |
| 23 | + { |
| 24 | + test 1 -lt "$(echo "$DIFF_CHANGES" | wc --lines | xargs)" && |
| 25 | + echo "$DIFF_CHANGES" | grep README.md >/dev/null && |
| 26 | + echo "$DIFF_CHANGES" | grep plugins/ >/dev/null |
| 27 | + } || fail "Expected git diff ${REF_RANGE} to only include changes for a single plugin" |
| 28 | + |
| 29 | + local PLUGIN_FILES |
| 30 | + PLUGIN_FILES="$(git diff --name-only "${BASE_REF}" "${HEAD_REF}" -- plugins/)" |
| 31 | + for PLUGIN_FILE in $PLUGIN_FILES; do |
| 32 | + echo "Checking $PLUGIN_FILE" |
| 33 | + check_plugin_from_file "$PLUGIN_FILE" |
| 34 | + done |
| 35 | +} |
| 36 | + |
| 37 | +function check_plugin_from_file() { |
| 38 | + local PLUGIN_FILE="$1" |
| 39 | + |
| 40 | + # Assert that we have a file at plugins/PLUGIN_NAME |
| 41 | + test -f "$PLUGIN_FILE" || |
| 42 | + fail "Expected a plugin file at $PLUGIN_FILE" |
| 43 | + |
| 44 | + # Assert that PLUGIN_FILE file ends with new line. |
| 45 | + test 'X' == "$(tail --bytes=1 "$PLUGIN_FILE" | tr '\n' 'X')" || |
| 46 | + fail "Expected $PLUGIN_FILE to end with a new line." |
| 47 | + |
| 48 | + # Assert that PLUGIN_FILE has repository key and points to a git repo. |
| 49 | + local PLUGIN_REPO |
| 50 | + PLUGIN_REPO="$(sed -e 's/repository = //' "$PLUGIN_FILE")" |
| 51 | + test -n "$PLUGIN_REPO" || |
| 52 | + fail "File $PLUGIN_FILE does not specify a repository url" |
| 53 | + |
| 54 | + # Assert the plugin repo is reachable. |
| 55 | + git ls-remote --quiet "$PLUGIN_REPO" HEAD >/dev/null || |
| 56 | + fail "Repo is unreachable: $PLUGIN_REPO" |
| 57 | + |
| 58 | + local PLUGIN_REPO_NO_GIT |
| 59 | + PLUGIN_REPO_NO_GIT="$(echo "$PLUGIN_REPO" | sed -e 's/\.git$//' | tr '/' '\n' | tail --lines 1)" |
| 60 | + |
| 61 | + local README_LINE |
| 62 | + README_LINE="$(git grep -h --ignore-case -C0 "${PLUGIN_REPO_NO_GIT}" -- README.md | head --lines 1)" |
| 63 | + |
| 64 | + # Assert that a new line for plugin was added at README |
| 65 | + test -n "$README_LINE" || |
| 66 | + fail "Expected a line at README.md with a link to ${PLUGIN_REPO_NO_GIT}" |
| 67 | + |
| 68 | + BADGE_COLUMN="$(echo "${README_LINE}" | cut -d '|' -f4)" |
| 69 | + BADGE_URL="$(echo "${BADGE_COLUMN}" | badge_svg)" |
| 70 | + |
| 71 | + # Assert that the badge has "pass" text in it, indicating the plugin is healthy |
| 72 | + curl -qsL "${BADGE_URL}" | grep -o -i 'pass' >/dev/null || |
| 73 | + fail "Expected plugin CI badge SVG to be passing but it was not: $BADGE_URL" |
| 74 | + |
| 75 | + echo "OK $PLUGIN_FILE" |
| 76 | +} |
| 77 | + |
| 78 | +function check_all_plugins() { |
| 79 | + local fails=0 |
| 80 | + local total=0 |
| 81 | + local out |
| 82 | + for file in plugins/*; do |
| 83 | + |
| 84 | + total=$((total + 1)) |
| 85 | + out="$($0 --file "$file" 2>&1)" |
| 86 | + result=$? |
| 87 | + |
| 88 | + if test "${result}" == 0 && test ! "${CI}"; then |
| 89 | + # show successes locally, not in CI |
| 90 | + printf "* Checking %s %s\n" "$file" "[PASSED]" |
| 91 | + elif test "${result}" != 0; then |
| 92 | + # show failures locally and in CI |
| 93 | + fails=$((fails + 1)) |
| 94 | + printf "* Checking %s %s\n" "$file" "[FAILED]" |
| 95 | + printf "*\t%s\n" "$out" |
| 96 | + fi |
| 97 | + done |
| 98 | + |
| 99 | + printf "\n" |
| 100 | + printf "%s %s\n" "Plugins available:" "${total}" |
| 101 | + printf "%s %s\n" "Plugin build checks passed:" "$((total - fails))" |
| 102 | + printf "%s %s\n" "Plugin build checks failed:" "${fails}" |
| 103 | + exit ${fails} |
| 104 | +} |
| 105 | + |
| 106 | +if test "--all" == "$*"; then |
| 107 | + printf "%s\n" "Testing all registered plugins" |
| 108 | + check_all_plugins |
| 109 | + |
| 110 | +elif test "--diff" == "$1"; then |
| 111 | + printf "%s %s..%s" "Testing plugin introduced at git diff" "$2" "$3" |
| 112 | + check_plugins_from_diff "$2" "$3" |
| 113 | + |
| 114 | +elif test "--file" == "$1"; then |
| 115 | + check_plugin_from_file "$2" |
| 116 | +else |
| 117 | + cat <<-EOF |
| 118 | +Test that a plugin at PLUGIN_FILE follows basic sanity checks: |
| 119 | + * A plugins/<plugin> file contains the repository url. |
| 120 | + * A new line is added on README.md with a link mentioning the plugin. |
| 121 | + * The new plugin has CI badge and it's passing. |
| 122 | +
|
| 123 | +Usage: |
| 124 | +
|
| 125 | +> $0 --file plugins/PLUGIN_FILE |
| 126 | + Test only plugin at file. |
| 127 | +
|
| 128 | +> $0 --all |
| 129 | + Test all plugins registered under plugins/ |
| 130 | +
|
| 131 | +> $0 --diff BASE_REF HEAD_REF |
| 132 | + Test a single plugin introduced in git diff BASE_REF..HEAD_REF |
| 133 | +EOF |
| 134 | +fi |
0 commit comments