1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
JENKINS_SITE='https://jenkins.open-scap.org'
GITHUB_ROOT='https://github.com/OpenSCAP/openscap'
test -f .env && . .env
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
OSCAP_REPO_ROOT="$(cd "$SCRIPT_DIR" && cd .. && pwd)"
LIBRARY_STASH="/tmp/library-stash"
BUILDDIR="$OSCAP_REPO_ROOT/build"
FILE_WITH_VERSIONS="$SCRIPT_DIR/versions.sh"
. "$FILE_WITH_VERSIONS"
die()
{
echo "$1"
exit 1
}
clean_repository()
{
make distclean
git clean -f
}
clean_repository_aggressively()
{
git reset --hard
git clean -x -f -d
}
# Args:
# $1: Python version
check_python_binding()
{
local _python_major
_python_major="${1%%.*}"
(
cd "$BUILDDIR"
if LD_PRELOAD="/usr/lib64/libpython$1.so" ldd -r "$BUILDDIR/swig/python$_python_major/_openscap_py.so" | grep -q '^undefined' ; then
die "Python $1 bindings seem to have undefined symbols"
fi
)
}
trigger_tests()
{
xdg-open "$JENKINS_SITE/job/openscap-parametrized/build"
}
trigger_docbuild()
{
xdg-open "$JENKINS_SITE/job/static_openscap_docs/build"
}
build_all()
{
(mkdir -p "$BUILDDIR" && cd "$BUILDDIR" && cmake -DENABLE_SCE=TRUE .. && make) || die "Error building pristine OpenSCAP"
}
execute_local_tests()
{
build_all
(cd "$BUILDDIR" && ctest || die "Error during test run")
check_python_binding 3
}
make_dist()
{
(
cd "$BUILDDIR"
make package_source
sha1sum openscap-$version.tar.gz > openscap-$version.tar.gz.sha1sum
sha512sum openscap-$version.tar.gz > openscap-$version.tar.gz.sha512sum
)
}
check_abi()
{
rpm -q abi-compliance-checker || sudo dnf install abi-compliance-checker
test -d openscap-abi-check || git clone --recurse-submodules git@github.com:OpenSCAP/openscap-abi-check.git
openscap_git_branch=$(git branch | grep '^\* ' | cut -f2 -d' ')
(
cd openscap-abi-check
perl run_check.pl "$previous_version" "$openscap_git_branch"
echo 'Read the report, if there is an ABI issue (some symbols were changed / removed), fix it before proceeding further!'
printf "%s\n" "Then, Change directory to '$(pwd)' and add the reports. Then, commit with the appropriate message:" "" "cd $(pwd)" "git add reports/${previous_version}_${openscap_git_branch}.html'" "git commit -m 'Report before $version release'"
)
}
parse_variable_assignment_from_file()
{
local _variable="$1" _fname="$2"
test "$(grep "set(\s*$_variable\s\+[0-9]\+\s*)" "$_fname" | wc -l)" = 1 || die "More than one occurence of numerical assignment to '$_variable'"
echo $(grep "set(\s*$_variable\s\+[0-9]\+\s*)" "$_fname" | sed -e "s/set(\s*$_variable\s\+\([0-9]\+\)\s*)/\1/")
}
substitute_variable_assignment_value_in_file()
{
local _variable="$1" _old_value="$2" _new_value="$3" _fname="$4"
sed -i "s/set(\s*$_variable\s\+$_old_value\s*)/set($_variable $_new_value)/" "$_fname"
}
# $1 ... File to probe
get_lt_triplet_from_file()
{
local _varname _fname="$1"
for _varname in LT_CURRENT LT_REVISION LT_AGE
do
printf "%s " "$(parse_variable_assignment_from_file "$_varname" "$_fname")"
done
echo
}
increment_on_backwards_compatible()
{
local triplet
triplet=( $1 )
(( triplet[0]++ ))
(( triplet[2]++ ))
printf "%s %s %s \n" "${triplet[@]}"
}
increment_on_bugfix()
{
local triplet
triplet=( $1 )
(( triplet[1]++ ))
printf "%s %s %s \n" "${triplet[@]}"
}
increment_on_breaking_change()
{
local triplet
triplet=( $1 )
(( triplet[0]++ ))
triplet[2]=0
printf "%s %s %s \n" "${triplet[@]}"
}
# Args:
# $1: Triplet to be replaced
# $2: The replacement
# $3: The concerned file
apply_triplets_to_file()
{
local _previous=( $1 ) _replacement=( $2 ) _file="$3" _varnames=(LT_CURRENT LT_REVISION LT_AGE)
for i in 0 1 2
do
substitute_variable_assignment_value_in_file "${_varnames[$i]}" "${_previous[$i]}" "${_replacement[$i]}" "$_file"
done
}
#
# $1: Strategy (backwards_compatible, bugfix, breaking_change)
increment_ltversions()
{
local _cmake_file="$OSCAP_REPO_ROOT/CMakeLists.txt" _old_versions _new_versions _new_soname _old_soname
# check_for_clean_repo
_old_versions="$(get_lt_triplet_from_file "$_cmake_file")" || die "Unable to get current LT versions"
_new_versions="$(increment_on_$1 "$_old_versions")" || die "Unable to get calculate refreshed LT version with strategy '$1'"
_old_soname="$(get_soname_from_triplet "$_old_versions")"
_new_soname="$(get_soname_from_triplet "$_new_versions")"
test "$_old_soname" = "$_new_soname" && die "The new and old sonames are the same '$_new_soname', which doesn't make sense."
check_for_clean_repo
clean_library_stash
echo "Building with the old soname"
build_all 2> /dev/null > /dev/null || die "Build with the old soname failed"
stash_library
check_stash_for_soname "$_old_soname" || die "Couldn't find the expected (old) soname $_old_soname, did it compile?"
check_stash_for_soname "$_new_soname" && die "Unexpectedly found new soname $_new_soname where only the old soname $_old_soname is supposed to be."
apply_triplets_to_file "$_old_versions" "$_new_versions" "$_cmake_file"
echo "Building with the new soname"
build_all 2> /dev/null > /dev/null || die "Build with the new soname failed"
stash_library
check_stash_for_soname "$_new_soname" || die "Couldn't find the expected (old) soname $_old_soname, did it compile?"
echo "Build went as expected, showing git diff."
git diff
printf "%s\n" "If you are satisfied with the diff, you can commit. Execute " "git add $_cmake_file" "" "Then 'git commit' with message" "" "Bump soname from $_old_soname to $_new_soname" "" "<X> new symbols were added, <Y> were removed."
}
# Args:
# $1: The string in form of "LT_CURRENT LT_REVISION LT_AGE"
get_soname_from_triplet()
{
local _triplet=( $1 )
printf "%s.%s.%s" $((_triplet[0] - _triplet[2])) ${_triplet[2]} ${_triplet[1]}
}
# Args:
# $1: Filename that contains possible duplications.
resolve_name_duplication()
{
. "$SCRIPT_DIR/naming.sh"
local _tempfile=/tmp/names-dedup
cp "$1" "$_tempfile"
for bad_name in "${!name_mapping[@]}"
do
sed -i "s/$bad_name/${name_mapping[$bad_name]}/" "$_tempfile"
done
cat "$_tempfile" | sort | uniq > "$1"
rm -- "$_tempfile"
}
get_new_authors()
{
local _all_time_authors="/tmp/all_time_authors" _recent_authors="$1" _new_authors="$2"
git log | grep '^Author' | cut -f 1 --complement -d ' ' | sort | uniq > "$_all_time_authors"
resolve_name_duplication "$_all_time_authors"
git log "$previous_version".. | grep '^Author' | sort | cut -f 1 --complement -d ' ' | uniq > "$_recent_authors"
resolve_name_duplication "$_recent_authors"
diff -U 0 "$_all_time_authors" "$_recent_authors" | grep -e '^+Author' | sort > "$_new_authors"
rm "$_all_time_authors"
}
clean_library_stash()
{
rm -rf "$LIBRARY_STASH"
}
stash_library()
{
mkdir -p "$LIBRARY_STASH"
cp "$BUILDDIR/src/"libopenscap.so.* "$LIBRARY_STASH/"
}
# Args:
# $1: The soname to check for (e.g. 1.2.3)
check_stash_for_soname()
{
local _regex
_regex="\.so\.$(echo "$1" | sed -e 's/\./\\./g')$"
ls "$LIBRARY_STASH" | grep -q "$_regex"
}
check_for_clean_repo()
{
# check that there is nothing to report by 'status' except untracked files.
git status --porcelain=v2 | grep -q --invert-match '^?' && die "The repository is not clean, stash your changes to proceed."
}
check_that_bump_is_appropriate()
{
check_for_clean_repo
# check that there is the tag
git tag | grep -q "$version" || die "The version '$version' doesn't have a tag, so I refuse to bump version that would make it the 'old' version."
# check that tarball with current version is already on GitHub.
curl --output /dev/null --silent --head --fail "$GITHUB_ROOT/releases/download/$version/openscap-$version.tar.gz" || die "There is not the tarball with '$version' available for download from GitHub."
}
release_to_git()
{
git tag | grep -q "$version" && die "Something is wrong - there already is a tag $version"
git tag "$version"
git push
git push --tags
}
# Args:
# $1: The filename
# $2: The next version
bump_release_in_release_script()
{
sed -i "s/\(^previous_version=\).*/\1$version/" "$1"
sed -i "s/\(^version=\).*/\1$2/" "$1"
}
# Args:
# $1: The filename
# $2: The next version
bump_release_in_cmake()
{
local _version_triplet=($(echo "$version" | tr "." "\n"))
local _version_names=(OPENSCAP_VERSION_MAJOR OPENSCAP_VERSION_MINOR OPENSCAP_VERSION_PATCH)
local _cmake="$OSCAP_REPO_ROOT/CMakeLists.txt"
for i in 0 1 2
do
sed -i "s/set(\s*${_version_names[$i]}\s\+\"[0-9]\+\"\s*)/set(${_version_names[$i]} \"${_version_triplet[$i]}\")/" $_cmake
done
}
# Args:
# $1: The next version
bump_release()
{
test $# -lt 2 || die "Provide the version number as an argument"
check_that_bump_is_appropriate
bump_release_in_cmake "$1"
bump_release_in_release_script "$FILE_WITH_VERSIONS" "$1"
git diff
git add "$OSCAP_REPO_ROOT/CMakeLists.txt" "$FILE_WITH_VERSIONS"
printf "Commit with this message:\n%s\n\n%s\n" "Version bump after release." "Next release from the maint-${1%.*} branch will be $1"
}
# Args:
# $1: Username
# $2: Repository owner
upload_to_git()
{
local _username="$1" _repo_owner="$2"
make_dist > /dev/null 2> /dev/null
curl -u ":$GITHUB_TOKEN" --data '{"tag_name":"'$version'"}' "https://api.github.com/repos/$_repo_owner/openscap/releases"
xdg-open "$GITHUB_ROOT/$_repo_owner/openscap/releases/$version"
}
# Args:
# $1: Token
# $2: Repository owner
# $3: The new version
flip_milestones()
{
"$SCRIPT_DIR/move-milestones.py" --owner "$2" --auth-token "$1" "$version" "$3"
}
make_news_template()
{
local _right_boundary=75 _oscap_version_string _oscap_version_length _news_template=NEWS.template _recent_authors="/tmp/recent_authors" _new_authors="/tmp/new_authors"
get_new_authors "$_recent_authors" "$_new_authors"
_oscap_version_string="openscap-$version"
_oscap_version_length="$(echo "$_oscap_version_string" | wc -m)"
printf "%s%$((_right_boundary - _oscap_version_length))s\n" "$_oscap_version_string" "$(date +%d-%m-%Y)" > "$_news_template"
printf " - %s\n" "Stats@STATS@" "New features" "Maintenance" >> "$_news_template"
stats=
stats="$stats\n - $(git log "$previous_version".. | grep '^Author' | wc -l) commits from $(cat "$_recent_authors" | wc -l) distinct persons."
stats="$stats\n - $(cat "$_new_authors" | wc -l) new contributors."
stats="$stats\n - $("$SCRIPT_DIR/query-milestones.py" --auth-token "$GITHUB_TOKEN" "$version" issues-closed | wc -l) issues closed, $("$SCRIPT_DIR/query-milestones.py" --auth-token "$GITHUB_TOKEN" "$version" prs-merged | wc -l) PRs merged."
sed -i "s/@STATS@/$stats/" "$_news_template"
echo >> "$_news_template"
echo >> "$_news_template"
echo "####################### Summaries #######################" >> "$_news_template"
echo >> "$_news_template"
echo "Closed issues:" >> "$_news_template"
"$SCRIPT_DIR/query-milestones.py" --auth-token "$GITHUB_TOKEN" "$version" issues-closed | sed -e 's/^/ - /' >> "$_news_template"
echo "Merged PRs:" >> "$_news_template"
"$SCRIPT_DIR/query-milestones.py" --auth-token "$GITHUB_TOKEN" "$version" prs-merged | sed -e 's/^/ - /' >> "$_news_template"
echo "New authors:" >> "$_news_template"
sed -e 's/^/ - /' "$_new_authors" >> "$_news_template"
echo "Recent authors:" >> "$_news_template"
sed -e 's/^/ - /' "$_recent_authors" >> "$_news_template"
rm -- "$_recent_authors" "$_new_authors"
}
check_release_is_ok()
{
grep -q "^openscap-$version" "$OSCAP_REPO_ROOT/NEWS" || die "The version '$version' isn't mentioned in the NEWS file."
git log -1 | grep -q "^\s*openscap-$version$" || die "The openscap release commit is not the previous commit."
}
# Args:
# $1: The future version number
release_to_git_and_bump_release()
{
local _new_version="$1"
test -n "$GITHUB_TOKEN" || die "We don't know your GitHub token, so we can't proceed. Get one on https://github.com/settings/tokens and put it in the .env file, so it contains the line GITHUB_TOKEN='<your token here>'"
test "$1" = "$version" && die "The new version is the same as current version, I am not doing anything."
check_release_is_ok
# release_to_git # GH now add tags to the release automatically
# upload_to_git # to be done when https://github.com/PyGithub/PyGithub/pull/525 is merged.
flip_milestones "$GITHUB_TOKEN" openscap "$_new_version"
bump_release "$_new_version"
}
|