|
| 1 | +#!/usr/bin/env bash |
| 2 | +set -Eeuo pipefail |
| 3 | + |
| 4 | +workdir="$(readlink -f "$BASH_SOURCE")" |
| 5 | +workdir="$(dirname "$workdir")" |
| 6 | +#cd "$workdir" |
| 7 | + |
| 8 | +jsonFile='metadata.json' |
| 9 | +canonicalMetadataFile="$workdir/$jsonFile" |
| 10 | +maxCategories=3 |
| 11 | + |
| 12 | +self="$(basename "$0")" |
| 13 | + |
| 14 | +usage() { |
| 15 | + cat <<EOUSAGE |
| 16 | +
|
| 17 | +usage: $self [--categories] [--diff] [--fmt] repo [...] |
| 18 | + ie: $self debian |
| 19 | + $self -d */ |
| 20 | + $self -dc python |
| 21 | +
|
| 22 | +This script checks a repo's metadata.json and checks categories, diffs, or formats it. |
| 23 | +
|
| 24 | +-c, --categories Check that the categories are from the valid set of categories and that there are no more than $maxCategories. Exits non-zero if there are too many categories or they are unkown. |
| 25 | +-d, --diff Check formatting of the '[repo]/metadata.json' and print a diff. Default action if no flags are supplied. Exits non-zero if there is a difference. |
| 26 | +-f, --fmt, --format Apply the formatting that the '-d' flag would output. |
| 27 | +-h, --help Print this help output and exit. |
| 28 | +
|
| 29 | +Arguments are the list of repos with a 'metadata.json' in them. 'metadata.json' is expected in every repo |
| 30 | +'.' can also be passed to check the format of the canonical './metadata.json' at |
| 31 | +the root of the repo, but the max categories of '-c' is skipped for it. |
| 32 | +EOUSAGE |
| 33 | +} |
| 34 | + |
| 35 | +# arg handling |
| 36 | +opts="$(getopt -o 'cdfh' --long 'categories,diff,fmt,format,help' -- "$@" || { usage >&2 && false; })" |
| 37 | +eval set -- "$opts" |
| 38 | + |
| 39 | +categories= |
| 40 | +diff= |
| 41 | +fmt= |
| 42 | + |
| 43 | +while true; do |
| 44 | + flag="$1" |
| 45 | + shift |
| 46 | + case "$flag" in |
| 47 | + --categories|-c) categories=1 ;; |
| 48 | + --diff|-d) diff=1 ;; |
| 49 | + --fmt|--format|-f) fmt=1 ;; |
| 50 | + --help|-h) usage && exit 0 ;; |
| 51 | + --) break ;; |
| 52 | + *) |
| 53 | + { |
| 54 | + echo "error: unknown flag: $flag" |
| 55 | + usage |
| 56 | + } >&2 |
| 57 | + exit 1 |
| 58 | + ;; |
| 59 | + esac |
| 60 | +done |
| 61 | + |
| 62 | +# default to print diff |
| 63 | +if [ -z "$diff" ] && [ -z "$categories" ] && [ -z "$fmt" ]; then |
| 64 | + diff=1 |
| 65 | +fi |
| 66 | + |
| 67 | +repos=( "$@" ) |
| 68 | +if [ "${#repos[@]}" -eq 0 ]; then |
| 69 | + repos=( */ ) |
| 70 | +fi |
| 71 | +repos=( "${repos[@]%/}" ) |
| 72 | + |
| 73 | +canonicalMetadataFileJson="$(cat "$canonicalMetadataFile")" |
| 74 | +export canonicalMetadataFileJson |
| 75 | + |
| 76 | +failure= |
| 77 | +for repo in "${repos[@]}"; do |
| 78 | + repoFile="$workdir/$repo/$jsonFile" |
| 79 | + if [ ! -f "$repoFile" ]; then |
| 80 | + failure=1 |
| 81 | + echo "error file does not exist: $repo/$jsonFile" |
| 82 | + continue |
| 83 | + fi |
| 84 | + repoFile="$(readlink -f "$repoFile")" |
| 85 | + |
| 86 | + if [ -n "$diff" ] || [ -n "$fmt" ]; then |
| 87 | + # sort object keys and pretty print with jq as our "cannonical json" |
| 88 | + # sort categories array |
| 89 | + if ! repoFilejson="$(jq --sort-keys '.hub.categories |= sort' "$repoFile")"; then |
| 90 | + echo "error $repo/$jsonFile improper json" |
| 91 | + failure=1 |
| 92 | + continue |
| 93 | + fi |
| 94 | + if ! filediff="$(diff -u "$repoFile" <(echo "$repoFilejson"))"; then |
| 95 | + if [ -n "$diff" ]; then |
| 96 | + echo >&2 "$repoFile" |
| 97 | + # skip diff headers |
| 98 | + echo "$filediff" | tail -n +3 |
| 99 | + failure=1 |
| 100 | + fi |
| 101 | + if [ -n "$fmt" ]; then |
| 102 | + # TODO should fmt + categories remove invalid or categories over max? |
| 103 | + echo "$repoFilejson" > "$repoFile" |
| 104 | + fi |
| 105 | + fi |
| 106 | + fi |
| 107 | + |
| 108 | + # TODO also check for required keys and/or types? |
| 109 | + if [ -n "$categories" ]; then |
| 110 | + # the canonicalMetadataFile doesn't have too many categories since it is the source of categories |
| 111 | + # all other metadata.json files must not be more than maxCategories |
| 112 | + if [ "$canonicalMetadataFile" != "$repoFile" ]; then |
| 113 | + tooManyCategories="$(jq --raw-output ' |
| 114 | + .hub.categories |
| 115 | + | if length > '"$maxCategories"' then |
| 116 | + length |
| 117 | + else empty end |
| 118 | + ' "$repoFile")" |
| 119 | + if [ -n "$tooManyCategories" ]; then |
| 120 | + echo >&2 "$repo, error too many Docker Hub categories: $tooManyCategories, max $maxCategories" |
| 121 | + failure=1 |
| 122 | + fi |
| 123 | + fi |
| 124 | + # check for categories that aren't in the canonical set |
| 125 | + extraCategories="$(jq -c ' |
| 126 | + (env.canonicalMetadataFileJson | fromjson | .hub.categories) as $canonicalCategories |
| 127 | + | .hub.categories |
| 128 | + | map(. as $cat | select($canonicalCategories | index($cat) < 0)) |
| 129 | + | if length > 0 then . else empty end |
| 130 | + ' "$repoFile")" |
| 131 | + if [ -n "$extraCategories" ]; then |
| 132 | + echo >&2 "$repo, error unkown categories: $extraCategories" |
| 133 | + failure=1 |
| 134 | + fi |
| 135 | + fi |
| 136 | +done |
| 137 | + |
| 138 | +if [ "$failure" ]; then |
| 139 | + exit 1 |
| 140 | +fi |
0 commit comments