Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 1 | #!/usr/bin/env bash |
| 2 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 3 | # SPDX-FileCopyrightText: 2018-2022 Open Networking Foundation |
| 4 | # SPDX-License-Identifier: Apache-2.0 |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 5 | |
| 6 | set -eu -o pipefail |
| 7 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 8 | VERSIONFILE="" # file path to file containing version number |
| 9 | NEW_VERSION="" # version number found in $VERSIONFILE |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 10 | TAG_VERSION="" # version file that might have a leading v to work around go mod funkyness |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 11 | |
Zack Williams | 6650000 | 2018-09-06 15:29:05 -0700 | [diff] [blame] | 12 | SEMVER_STRICT=${SEMVER_STRICT:-0} # require semver versions |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 13 | DOCKERPARENT_STRICT=${DOCKERPARENT_STRICT:-1} # require semver versions on parent images in dockerfiles |
Zack Williams | 6650000 | 2018-09-06 15:29:05 -0700 | [diff] [blame] | 14 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 15 | releaseversion=0 |
| 16 | fail_validation=0 |
| 17 | |
| 18 | # when not running under Jenkins, use current dir as workspace |
| 19 | WORKSPACE=${WORKSPACE:-.} |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 20 | BASEDIR=${BASEDIR:-} |
| 21 | |
| 22 | # cd to the code checkout location |
| 23 | cd "$WORKSPACE/$BASEDIR" |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 24 | |
| 25 | # find the version string in the repo, read into NEW_VERSION |
| 26 | # Add additional places NEW_VERSION could be found to this function |
| 27 | function read_version { |
| 28 | if [ -f "VERSION" ] |
| 29 | then |
| 30 | NEW_VERSION=$(head -n1 "VERSION") |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 31 | VERSIONFILE="VERSION" |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 32 | |
| 33 | # If this is a golang project, use funky v-prefixed versions |
| 34 | if [ -f "Gopkg.toml" ] || [ -f "go.mod" ] |
| 35 | then |
| 36 | echo "go-based project found, using v-prefixed version for git tags: v${NEW_VERSION}" |
| 37 | TAG_VERSION=v${NEW_VERSION} |
| 38 | else |
| 39 | TAG_VERSION=${NEW_VERSION} |
| 40 | fi |
| 41 | |
Zack Williams | 6a9d2e6 | 2018-06-22 15:18:23 -0700 | [diff] [blame] | 42 | elif [ -f "package.json" ] |
| 43 | then |
| 44 | NEW_VERSION=$(python -c 'import json,sys;obj=json.load(sys.stdin); print obj["version"]' < package.json) |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 45 | TAG_VERSION=$NEW_VERSION |
Zack Williams | 6a9d2e6 | 2018-06-22 15:18:23 -0700 | [diff] [blame] | 46 | VERSIONFILE="package.json" |
Zack Williams | 866ef3c | 2019-09-27 15:41:02 -0700 | [diff] [blame] | 47 | elif [ -f "pom.xml" ] |
| 48 | then |
| 49 | NEW_VERSION=$(xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml) |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 50 | TAG_VERSION=$NEW_VERSION |
Zack Williams | 866ef3c | 2019-09-27 15:41:02 -0700 | [diff] [blame] | 51 | VERSIONFILE="pom.xml" |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 52 | else |
| 53 | echo "ERROR: No versioning file found!" |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 54 | fail_validation=1 |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 55 | fi |
| 56 | } |
| 57 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 58 | # check if the version is a released version |
| 59 | function check_if_releaseversion { |
| 60 | if [[ "$NEW_VERSION" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)$ ]] |
| 61 | then |
| 62 | echo "Version string '$NEW_VERSION' found in '$VERSIONFILE' is a SemVer released version!" |
| 63 | releaseversion=1 |
| 64 | else |
Zack Williams | 6650000 | 2018-09-06 15:29:05 -0700 | [diff] [blame] | 65 | if [ "$SEMVER_STRICT" -eq "1" ] |
| 66 | then |
| 67 | echo "Version string '$NEW_VERSION' in '$VERSIONFILE' is not a SemVer released version, SEMVER_STRICT enabled, failing!" |
| 68 | fail_validation=1 |
| 69 | else |
| 70 | echo "Version string '$NEW_VERSION' in '$VERSIONFILE' is not a SemVer released version, skipping." |
| 71 | fi |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 72 | fi |
| 73 | } |
| 74 | |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 75 | # check if the version is already a tag in git |
| 76 | function is_git_tag_duplicated { |
Matteo Scandolo | e089043 | 2021-04-06 06:37:21 -0700 | [diff] [blame] | 77 | for existing_tag in $existing_tags |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 78 | do |
| 79 | if [ "$TAG_VERSION" = "$existing_tag" ] |
| 80 | then |
| 81 | echo "ERROR: Duplicate tag: $existing_tag" |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 82 | fail_validation=2 |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 83 | fi |
Matteo Scandolo | e089043 | 2021-04-06 06:37:21 -0700 | [diff] [blame] | 84 | done |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | # from https://github.com/cloudflare/semver_bash/blob/master/semver.sh |
| 88 | function semverParseInto() { |
| 89 | local RE='[^0-9]*\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)\([0-9A-Za-z-]*\)' |
| 90 | #MAJOR |
| 91 | eval $2=`echo $1 | sed -e "s#$RE#\1#"` |
| 92 | #MINOR |
| 93 | eval $3=`echo $1 | sed -e "s#$RE#\2#"` |
| 94 | #MINOR |
| 95 | eval $4=`echo $1 | sed -e "s#$RE#\3#"` |
| 96 | #SPECIAL |
| 97 | eval $5=`echo $1 | sed -e "s#$RE#\4#"` |
| 98 | } |
| 99 | |
| 100 | # if it's a -dev version check if a previous tag has been created (to avoid going from 2.7.0-dev to 2.7.1-dev) |
| 101 | function is_valid_version { |
| 102 | local MAJOR=0 MINOR=0 PATCH=0 SPECIAL="" |
| 103 | local C_MAJOR=0 C_MINOR=0 C_PATCH=0 C_SPECIAL="" # these are used in the inner loops to compare |
| 104 | |
| 105 | semverParseInto $NEW_VERSION MAJOR MINOR PATCH SPECIAL |
| 106 | |
| 107 | found_parent=false |
| 108 | |
| 109 | # if minor == 0, check that there was a release with MAJOR-1.X.X |
| 110 | if [[ "$MINOR" == 0 ]]; then |
| 111 | new_major=$(( $MAJOR - 1 )) |
| 112 | parent_version="$new_major.x.x" |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 113 | for existing_tag in $existing_tags |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 114 | do |
| 115 | semverParseInto $existing_tag C_MAJOR C_MINOR C_PATCH C_SPECIAL |
| 116 | if [[ "$new_major" == "$C_MAJOR" ]]; then |
| 117 | found_parent=true |
| 118 | fi |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 119 | done |
Matteo Scandolo | 9725cdb | 2021-06-03 09:03:43 -0700 | [diff] [blame] | 120 | fi |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 121 | |
| 122 | # if patch == 0, check that there was a release with MAJOR.MINOR-1.X |
Matteo Scandolo | 9725cdb | 2021-06-03 09:03:43 -0700 | [diff] [blame] | 123 | if [[ "$PATCH" == 0 ]]; then |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 124 | new_minor=$(( $MINOR - 1 )) |
| 125 | parent_version="$MAJOR.$new_minor.x" |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 126 | for existing_tag in $existing_tags |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 127 | do |
| 128 | semverParseInto $existing_tag C_MAJOR C_MINOR C_PATCH C_SPECIAL |
| 129 | if [[ "$new_minor" == "$C_MINOR" ]]; then |
| 130 | found_parent=true |
| 131 | fi |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 132 | done |
Matteo Scandolo | 9725cdb | 2021-06-03 09:03:43 -0700 | [diff] [blame] | 133 | fi |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 134 | |
| 135 | # if patch != 0 check that there was a release with MAJOR.MINOR.PATCH-1 |
Matteo Scandolo | 9725cdb | 2021-06-03 09:03:43 -0700 | [diff] [blame] | 136 | if [[ "$PATCH" != 0 ]]; then |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 137 | new_patch=$(( $PATCH - 1 )) |
| 138 | parent_version="$MAJOR.$MINOR.$new_patch" |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 139 | for existing_tag in $existing_tags |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 140 | do |
Matteo Scandolo | acccab4 | 2021-04-01 12:05:04 -0700 | [diff] [blame] | 141 | semverParseInto $existing_tag C_MAJOR C_MINOR C_PATCH C_SPECIAL |
| 142 | if [[ "$MAJOR" == "$C_MAJOR" && "$MINOR" == "$C_MINOR" && "$new_patch" == "$C_PATCH" ]] |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 143 | then |
| 144 | found_parent=true |
| 145 | fi |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 146 | done |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 147 | fi |
| 148 | |
| 149 | # if we are the beginning the is no parent, but that's fine |
| 150 | if [[ "$MAJOR" == 0 ]]; then |
| 151 | found_parent=true |
| 152 | fi |
| 153 | |
| 154 | if [[ $found_parent == false ]]; then |
| 155 | echo "Invalid $NEW_VERSION version. Expected parent version $parent_version does not exist." |
| 156 | fail_validation=1 |
| 157 | fi |
Zack Williams | 6e070f5 | 2019-10-04 11:08:59 -0700 | [diff] [blame] | 158 | } |
| 159 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 160 | # check if Dockerfiles have a released version as their parent |
| 161 | function dockerfile_parentcheck { |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 162 | if [ "$DOCKERPARENT_STRICT" -eq "0" ]; |
| 163 | then |
| 164 | echo "DOCKERPARENT_STRICT is disabled - skipping parent checks" |
| 165 | else |
| 166 | while IFS= read -r -d '' dockerfile |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 167 | do |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 168 | echo "Checking dockerfile: '$dockerfile'" |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 169 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 170 | # split on newlines |
| 171 | IFS=$'\n' |
| 172 | df_parents=($(grep "^FROM" "$dockerfile")) |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 173 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 174 | # check all parents in the Dockerfile |
| 175 | for df_parent in "${df_parents[@]}" |
| 176 | do |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 177 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 178 | df_pattern="[FfRrOoMm] +(--platform=[^ ]+ +)?([^@: ]+)(:([^: ]+)|@sha[^ ]+)?" |
| 179 | if [[ "$df_parent" =~ $df_pattern ]] |
| 180 | then |
Matteo Scandolo | c3aaa03 | 2021-04-07 10:33:40 -0700 | [diff] [blame] | 181 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 182 | p_image="${BASH_REMATCH[2]}" |
| 183 | p_sha=${BASH_REMATCH[3]} |
| 184 | p_version="${BASH_REMATCH[4]}" |
| 185 | |
| 186 | echo "IMAGE: '${p_image}'" |
| 187 | echo "VERSION: '$p_version'" |
| 188 | echo "SHA: '$p_sha'" |
| 189 | |
| 190 | if [[ "${p_image}" == "scratch" ]] |
| 191 | then |
| 192 | echo " OK: Using the versionless 'scratch' parent: '$df_parent'" |
| 193 | elif [[ "${p_image}:${p_version}" == "gcr.io/distroless/static:nonroot" ]] |
| 194 | then |
| 195 | echo " OK: Using static distroless image with nonroot: '${p_image}:${p_version}'" |
| 196 | elif [[ "${p_version}" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)$ ]] |
| 197 | then |
| 198 | echo " OK: Parent '$p_image:$p_version' is a released SemVer version" |
| 199 | elif [[ "${p_sha}" =~ ^@sha256:[0-9a-f]{64}.*$ ]] |
| 200 | then |
| 201 | # allow sha256 hashes to be used as version specifiers |
| 202 | echo " OK: Parent '$p_image$p_sha' is using a specific sha256 hash as a version" |
| 203 | elif [[ "${p_version}" =~ ^.*([0-9]+)\.([0-9]+).*$ ]] |
| 204 | then |
| 205 | # handle non-SemVer versions that have a Major.Minor version specifier in the name |
| 206 | # 'ubuntu:16.04' |
| 207 | # 'postgres:10.3-alpine' |
| 208 | # 'openjdk:8-jre-alpine3.8' |
| 209 | echo " OK: Parent '$p_image:$p_version' is using a non-SemVer, but sufficient, version" |
| 210 | elif [[ -z "${p_version}" ]] |
| 211 | then |
| 212 | echo " ERROR: Parent '$p_image' is NOT using a specific version" |
| 213 | fail_validation=1 |
| 214 | else |
| 215 | echo " ERROR: Parent '$p_image:$p_version' is NOT using a specific version" |
| 216 | fail_validation=1 |
| 217 | fi |
| 218 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 219 | else |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 220 | echo " ERROR: Couldn't find a parent image in $df_parent" |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 221 | fi |
| 222 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 223 | done |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 224 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 225 | done < <( find "${WORKSPACE}" -name 'Dockerfile*' ! -path "*/vendor/*" ! -name "*dockerignore" -print0 ) |
| 226 | fi |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 227 | } |
| 228 | |
Zack Williams | be54231 | 2022-06-23 21:51:32 -0700 | [diff] [blame] | 229 | # Start of actual code |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 230 | echo "Checking git repo with remotes:" |
| 231 | git remote -v |
| 232 | |
| 233 | echo "Branches:" |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 234 | branches=$(git branch -v) |
| 235 | echo $branches |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 236 | |
| 237 | echo "Existing git tags:" |
Matteo Scandolo | 3e89c07 | 2021-04-01 09:36:26 -0700 | [diff] [blame] | 238 | existing_tags=$(git tag -l) |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 239 | echo $existing_tags |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 240 | |
| 241 | read_version |
Matteo Scandolo | 93b531d | 2021-03-22 14:36:48 -0700 | [diff] [blame] | 242 | is_valid_version |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 243 | check_if_releaseversion |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 244 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 245 | # perform checks if a released version |
| 246 | if [ "$releaseversion" -eq "1" ] |
| 247 | then |
| 248 | is_git_tag_duplicated |
| 249 | dockerfile_parentcheck |
| 250 | fi |
Zack Williams | 12783ac | 2018-06-12 15:13:12 -0700 | [diff] [blame] | 251 | |
Zack Williams | 8e69efd | 2018-06-13 15:05:18 -0700 | [diff] [blame] | 252 | exit $fail_validation |