Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-16260] Change generate-stackbrew-library.sh to support new release.metadata file #31

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions generate-stackbrew-library-docker.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#!/usr/bin/env bash

exec docker run --rm \
--volume "${PWD}:/build:ro" \
plucas/docker-flink-build \
rmetzger/git-and-bash:latest \
/build/generate-stackbrew-library.sh
144 changes: 34 additions & 110 deletions generate-stackbrew-library.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

# This script generates a manifest compatibile with the expectations set forth
# by docker-library/official-images.
Expand All @@ -8,16 +8,9 @@

set -eu

declare -A aliases=(
[1.11]='latest'
)

self="$(basename "$BASH_SOURCE")"
cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"

# Identify directories matching '?.?' (e.g. '1.7') and remove trailing slashes
versions=( ?.?/ ?.??/ )
versions=( "${versions[@]%/}" )

# get the most recent commit which modified any of "$@"
fileCommit() {
Expand All @@ -41,21 +34,32 @@ dirCommit() {
)
}

getArches() {
local repo="$1"; shift
local officialImagesUrl='https://github.com/docker-library/official-images/raw/master/library/'
# Inputs:
# - tags: comma-seprated list of image tags
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

variable name does not match (I'd use tags)

# - latestVersion: latest version
# Output: comma-separated list of tags with "latest" removed if not latest version
pruneTags() {
local inTagsString=$1
local latestVersion=$2
if [[ $inTagsString =~ $latestVersion ]]; then
# tagsString contains latest version. keep "latest" tag
echo $inTagsString
else
# remove "latest" and any "scala_" tag, unless it is the latest version
# the "scala_" tag has a similar semantic as the "latest" tag in docker registries.
echo $inTagsString | sed -E 's|,(scala\|latest)[-_[:alnum:]]*||g'
fi
}

eval "declare -g -A parentRepoToArches=( $(
find -name 'Dockerfile' -exec awk '
toupper($1) == "FROM" && $2 !~ /^('"$repo"'|scratch|microsoft\/[^:]+)(:|$)/ {
print "'"$officialImagesUrl"'" $2
}
' '{}' + \
| sort -u \
| xargs bashbrew cat --format '[{{ .RepoName }}:{{ .TagName }}]="{{ join " " .TagEntry.Architectures }}"'
) )"
extractValue() {
local key="$1"
local file="$2"
local line=$(cat $file | grep "$key:")
echo $line | cut -d ':' -f 2 | tr -d ' ' # remove key from line, remove whitespace
Copy link
Contributor

@zentol zentol Jul 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at various entries in https://github.com/docker-library/official-images and they all separated tags with a comma and space , 😢

We could use sed again: echo $line | sed "s/${key}: //g"

}
getArches 'flink'

# get latest flink version
latest_version=`ls -1a | grep -E "[0-9]+.[0-9]+" | sort -V -r | head -n 1`

cat <<-EOH
# this file is generated via https://github.com/apache/flink-docker/blob/$(fileCommit "$self")/$self
Expand All @@ -65,105 +69,25 @@ Maintainers: Patrick Lucas <me@patricklucas.com> (@patricklucas),
GitRepo: https://github.com/apache/flink-docker.git
EOH

# prints "$2$1$3$1...$N"
join() {
local sep="$1"; shift
local out; printf -v out "${sep//%/%%}%s" "$@"
echo "${out#$sep}"
}

# Sorry for the style here, but it makes the nested code easier to read
for version in "${versions[@]}"; do

# Defaults, can vary between versions
source_variants=( debian )
scala_versions=( 2.11 2.12 )

# Version-specific variants (example)
# if [ "$flink_release" = "x.y" ]; then
# scala_versions=( 2.10 2.11 2.12 )
# fi

for source_variant in "${source_variants[@]}"; do
for scala_version in "${scala_versions[@]}"; do
dir="$version/scala_${scala_version}-${source_variant}"

# Not all variant combinations may exist
[ -f "$dir/Dockerfile" ] || continue
for dockerfile in $(find . -name "Dockerfile"); do
dir=$(dirname $dockerfile)

commit="$(dirCommit "$dir")"
metadata="$dir/release.metadata"
architectures=$(extractValue "Architectures" $metadata)
tags=$(extractValue "Tags" $metadata)
tags=$(pruneTags "$tags" $latest_version)

# Extract the full Flink version from the Dockerfile
flink_version="$(git show "$commit":"$dir/Dockerfile" | grep 'dist/flink/flink-[0-9.]*' | cut -d/ -f6 | cut -d- -f2)"

full_version=$flink_version-scala_$scala_version

variantParent="$(awk 'toupper($1) == "FROM" { print $2 }' "$dir/Dockerfile")"
variantArches="${parentRepoToArches[$variantParent]}"

# Start with the full version e.g. "1.2.0-scala_2.11" and add
# additional tags as relevant
tags=( $full_version )

is_latest_version=
[ "$version" = "${versions[-1]}" ] && is_latest_version=1

is_latest_scala=
[ "$scala_version" = "${scala_versions[-1]}" ] && is_latest_scala=1

add_tags=( $version )

# Add a scala version tag to each image
tags=(
${tags[@]}
${add_tags[@]/%/-scala_$scala_version}
)

# If this is the latest Flink release, add a tag with only the scala version
if [ -n "$is_latest_version" ]; then
tags=(
${tags[@]}
"scala_$scala_version"
)
fi

# For the latest supported Scala version, add tags that omit the scala version
if [ -n "$is_latest_scala" ]; then
tags=(
${tags[@]}
$flink_version
$version
)
fi

# Add -$variant suffix for non-debian-based images
if [ "$source_variant" != "debian" ]; then
tags=( ${tags[@]/%/-$source_variant} )
fi

# Finally, designate the 'latest' tag (or '$variant', for non-debian-based images)
if [ -n "$is_latest_scala" ]; then
alias_tag="${aliases[$version]:-}"
if [ -n "$alias_tag" ] && [ "$source_variant" != "debian" ]; then
alias_tag="$source_variant"
fi

tags=(
${tags[@]}
$alias_tag
)
fi

# newline
echo

# The tabs here are necessary for the heredoc to work right
cat <<-EOE
Tags: $(join ', ' "${tags[@]}")
Architectures: $(join ', ' $variantArches)
Tags: $tags
Architectures: $architectures
GitCommit: $commit
Directory: $dir
EOE

done
done
done