AVRO-3423: Add build.sh step to encapsulate all the steps needed during release

.github/workflows/test-lang-php.yml

@@ -146,4 +146,4 @@ jobs:
         run: ./build.sh interop-data-generate
 
       - name: Run Interop Tests
-        run: ./build.sh test-interop
+        run: ./build.sh interop-data-test

build.sh

@@ -126,7 +126,7 @@ do
       (cd lang/csharp; ./build.sh interop-data-test)
       (cd lang/js; ./build.sh interop-data-test)
       (cd lang/ruby; ./build.sh interop-data-test)
-      (cd lang/php; ./build.sh test-interop)
+      (cd lang/php; ./build.sh interop-data-test)
       (cd lang/perl; ./build.sh interop-data-test)
 
       # java needs to package the jars for the interop rpc tests

lang/c/build.sh

@@ -20,84 +20,82 @@
 
 set -e        # exit on error
 
+cd "$(dirname "$0")" # If being called from another folder, cd into the directory containing this script.
+
+# shellcheck disable=SC1091
+source ../../share/build-helper.sh "C"
+
 root_dir=$(pwd)
-build_dir="../../build/c"
-dist_dir="../../dist/c"
+build_dir="$BUILD_ROOT/build/c"
+dist_dir="$BUILD_ROOT/dist/c"
 version=$(./version.sh project)
 tarball="avro-c-$version.tar.gz"
-doc_dir="../../build/avro-doc-$version/api/c"
+doc_dir="$BUILD_ROOT/build/avro-doc-$version/api/c"
 
-function prepare_build {
-  clean
-  mkdir -p $build_dir
-  (cd $build_dir && cmake $root_dir -DCMAKE_BUILD_TYPE=RelWithDebInfo)
+function prepare_build()
+{
+  command_clean
+  execute mkdir -p "$build_dir"
+  execute pushd "$build_dir"
+  execute cmake "$root_dir" -DCMAKE_BUILD_TYPE=RelWithDebInfo
+  execute popd
 }
 
-function clean {
-  if [ -d $build_dir ]; then
-    find $build_dir | xargs chmod 755
-    rm -rf $build_dir
+function command_clean()
+{
+  if [ -d "$build_dir" ]; then
+    execute find "$build_dir" -exec chmod 755 {} +
+    execute rm -rf "$build_dir"
   fi
-  rm -f VERSION.txt
-  rm -f examples/quickstop.db
+  execute rm -f VERSION.txt
+  execute rm -f examples/quickstop.db
 }
 
-for target in "$@"
-do
-
-  case "$target" in
-
-    interop-data-generate)
-      prepare_build
-      make -C $build_dir
-      $build_dir/tests/generate_interop_data "../../share/test/schemas/interop.avsc"  "../../build/interop/data"
-      ;;
-
-    interop-data-test)
-      prepare_build
-      make -C $build_dir
-      $build_dir/tests/test_interop_data "../../build/interop/data"
-      ;;
-
-    lint)
-      echo 'This is a stub where someone can provide linting.'
-      ;;
-
-    test)
-      prepare_build
-      make -C $build_dir
-      make -C $build_dir test
-      ;;
+function command_interop-data-generate()
+{
+  prepare_build
+  execute make -C "$build_dir"
+  execute "$build_dir/tests/generate_interop_data" "$BUILD_ROOT/share/test/schemas/interop.avsc"  "$BUILD_ROOT/build/interop/data"
+}
 
-    dist)
-      prepare_build
-      cp ../../share/VERSION.txt $root_dir
-      make -C $build_dir docs
-      # This is a hack to force the built documentation to be included
-      # in the source package.
-      cp $build_dir/docs/*.html $root_dir/docs
-      make -C $build_dir package_source
-      rm $root_dir/docs/*.html
-      if [ ! -d $dist_dir ]; then
-        mkdir -p $dist_dir
-      fi
-      if [ ! -d $doc_dir ]; then
-        mkdir -p $doc_dir
-      fi
-      mv $build_dir/$tarball $dist_dir
-      cp $build_dir/docs/*.html $doc_dir
-      clean
-      ;;
+function command_interop-data-test()
+{
+    prepare_build
+    execute make -C "$build_dir"
+    execute "$build_dir/tests/test_interop_data" "$BUILD_ROOT/build/interop/data"
+}
 
-    clean)
-      clean
-      ;;
+function command_lint()
+{
+  echo 'This is a stub where someone can provide linting.'
+}
 
-    *)
-      echo "Usage: $0 {interop-data-generate|interop-data-test|lint|test|dist|clean}"
-      exit 1
-  esac
+function command_test()
+{
+  prepare_build
+  execute make -C "$build_dir"
+  execute make -C "$build_dir" test
+}
 
-done
+function command_dist()
+{
+  prepare_build
+  execute cp "$BUILD_ROOT/share/VERSION.txt" "$root_dir"
+  execute make -C "$build_dir" docs
+  # This is a hack to force the built documentation to be included
+  # in the source package.
+  execute cp "$build_dir"/docs/*.html "$root_dir/docs"
+  execute make -C "$build_dir" package_source
+  execute rm "$root_dir"/docs/*.html
+  if [ ! -d "$dist_dir" ]; then
+    execute mkdir -p "$dist_dir"
+  fi
+  if [ ! -d "$doc_dir" ]; then
+    execute mkdir -p "$doc_dir"
+  fi
+  execute mv "$build_dir/$tarball" "$dist_dir"
+  execute cp "$build_dir"/docs/*.html "$doc_dir"
+  command_clean
+}
 
-exit 0
+build-run "$@"

lang/csharp/build.sh

@@ -15,85 +15,132 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -e                # exit on error
-set -x
-
-cd `dirname "$0"`                  # connect to root
-
-ROOT=../..
-VERSION=`cat $ROOT/share/VERSION.txt`
-
-for target in "$@"
-do
-
-  case "$target" in
-
-    lint)
-      echo 'This is a stub where someone can provide linting.'
-      ;;
-
-    test)
-      dotnet build --configuration Release Avro.sln
-
-      # AVRO-2442: Explicitly set LANG to work around ICU bug in `dotnet test`
-      LANG=en_US.UTF-8 dotnet test --configuration Release --no-build \
-          --filter "TestCategory!=Interop" Avro.sln
-      ;;
-
-    perf)
-      pushd ./src/apache/perf/
-      dotnet run --configuration Release --framework net7.0
-      ;;
-
-    dist)
-      # pack NuGet packages
-      dotnet pack --configuration Release Avro.sln
-
-      # add the binary LICENSE and NOTICE to the tarball
-      mkdir -p build/
-      cp LICENSE NOTICE build/
-
-      # add binaries to the tarball
-      mkdir -p build/main/
-      cp -R src/apache/main/bin/Release/* build/main/
-      # add codec binaries to the tarball
-      for codec in Avro.File.Snappy Avro.File.BZip2 Avro.File.XZ Avro.File.Zstandard
-      do
-        mkdir -p build/codec/$codec/
-        cp -R src/apache/codec/$codec/bin/Release/* build/codec/$codec/
-      done
-      # add codegen binaries to the tarball
-      mkdir -p build/codegen/
-      cp -R src/apache/codegen/bin/Release/* build/codegen/
-
-      # build the tarball
-      mkdir -p ${ROOT}/dist/csharp
-      (cd build; tar czf ${ROOT}/../dist/csharp/avro-csharp-${VERSION}.tar.gz main codegen codec LICENSE NOTICE)
-
-      # build documentation
-      doxygen Avro.dox
-      mkdir -p ${ROOT}/build/avro-doc-${VERSION}/api/csharp
-      cp -pr build/doc/* ${ROOT}/build/avro-doc-${VERSION}/api/csharp
-      ;;
-
-    interop-data-generate)
-      dotnet run --project src/apache/test/Avro.test.csproj --framework net7.0 ../../share/test/schemas/interop.avsc ../../build/interop/data
-      ;;
-
-    interop-data-test)
-      LANG=en_US.UTF-8 dotnet test --filter "TestCategory=Interop" --logger "console;verbosity=normal;noprogress=true" src/apache/test/Avro.test.csproj
-      ;;
-
-    clean)
-      rm -rf src/apache/{main,test,codegen,ipc,msbuild,perf}/{obj,bin}
-      rm -rf build
-      rm -f  TestResult.xml
-      ;;
-
-    *)
-      echo "Usage: $0 {lint|test|clean|dist|perf|interop-data-generate|interop-data-test}"
-      exit 1
-
-  esac
-
-done
+set -e
+
+shopt -s globstar # enable **/* globbing
+shopt -s nullglob # return nothing if no glob match
+
+cd "$(dirname "$0")" # If being called from another folder, cd into the directory containing this script.
+
+# shellcheck disable=SC1091
+source ../../share/build-helper.sh "C#"
+
+CSHARP_CODEC_LIBS="Avro.File.Snappy Avro.File.BZip2 Avro.File.XZ Avro.File.Zstandard"
+SUPPORTED_SDKS="3.1 5.0 6.0 7.0"
+DEFAULT_FRAMEWORK="net7.0"
+CONFIGURATION="Release"
+
+function command_lint()
+{
+  echo "This is a stub where someone can provide linting."
+}
+
+function command_test()
+{
+  execute dotnet build --configuration $CONFIGURATION Avro.sln
+
+  # AVRO-2442: Explicitly set LANG to work around ICU bug in `dotnet test`
+  execute LANG=en_US.UTF-8 dotnet test --configuration "$CONFIGURATION" --no-build --filter "TestCategory!=Interop" Avro.sln
+}
+
+function command_perf()
+{
+  execute pushd ./src/apache/perf/
+  execute dotnet run --configuration "$CONFIGURATION" --framework "$FRAMEWORK"
+}
+
+function command_dist()
+{
+  # pack NuGet packages
+  execute dotnet pack --configuration "$CONFIGURATION" Avro.sln
+
+  # add the binary LICENSE and NOTICE to the tarball
+  execute mkdir -p build/
+  execute cp LICENSE NOTICE build/
+
+  # add binaries to the tarball
+  execute mkdir -p build/main/
+  execute cp -R src/apache/main/bin/$CONFIGURATION/* build/main/
+  # add codec binaries to the tarball
+  for codec in $CSHARP_CODEC_LIBS
+  do
+    execute mkdir -p build/codec/"$codec"/
+    execute cp -R src/apache/codec/"$codec"/bin/$CONFIGURATION/* build/codec/"$codec"/
+  done
+  # add codegen binaries to the tarball
+  execute mkdir -p build/codegen/
+  execute cp -R src/apache/codegen/bin/$CONFIGURATION/* build/codegen/
+
+  # build the tarball
+  execute mkdir -p "${BUILD_ROOT}/dist/csharp"
+  execute pushd build
+  execute tar czf "${BUILD_ROOT}/../dist/csharp/avro-csharp-${BUILD_VERSION}.tar.gz" main codegen codec LICENSE NOTICE
+  execute popd
+
+  # build documentation
+  command_doc
+}
+
+function command_doc()
+{
+  # build documentation
+  execute doxygen Avro.dox
+  execute mkdir -p "${BUILD_ROOT}/build/avro-doc-${BUILD_VERSION}/api/csharp"
+  execute cp -pr build/doc/* "${BUILD_ROOT}/build/avro-doc-${BUILD_VERSION}/api/csharp"
+}
+
+function command_release()
+{
+  [ "$NUGET_SOURCE" ] || NUGET_SOURCE="https://api.nuget.org/v3/index.json"
+  [ "$NUGET_KEY" ] || fatal "NUGET_KEY not set"
+
+  command_dist
+
+  # Push packages to nuget.org
+  for package in ./build/**/*.nupkg
+  do
+    ask "Push $package to nuget.org" && execute dotnet nuget push "$package" -k "$NUGET_KEY" -s "$NUGET_SOURCE"
+  done
+}
+
+function command_verify-release()
+{
+  for sdk_ver in $SUPPORTED_SDKS
+  do
+    execute docker run -it --rm mcr.microsoft.com/dotnet/sdk:"$sdk_ver" /bin/bash -ce "\
+      mkdir test-project && \
+      cd test-project && \
+      dotnet new console && \
+      dotnet add package Apache.Avro --version $BUILD_VERSION && \
+      for codec in $CSHARP_CODEC_LIBS; do \
+        dotnet add package Apache.\$codec --version $BUILD_VERSION; \
+      done && \
+      dotnet build && \
+      dotnet tool install --global Apache.Avro.Tools --version $BUILD_VERSION && \
+      export PATH=\$PATH:/root/.dotnet/tools && \
+      avrogen --help"
+  done
+  echo "Verified"
+}
+
+function command_interop-data-generate()
+{
+  execute dotnet run --project src/apache/test/Avro.test.csproj --framework $DEFAULT_FRAMEWORK ../../share/test/schemas/interop.avsc ../../build/interop/data
+}
+
+function command_interop-data-test()
+{
+  execute LANG=en_US.UTF-8 dotnet test --filter 'TestCategory=Interop' --logger 'console\;verbosity=normal\;noprogress=true' src/apache/test/Avro.test.csproj
+}
+
+function command_clean()
+{
+  # Alternatively all the steps below can be replaced with `git clean -dXf`
+
+  execute rm -rf src/apache/{main,test,codegen,ipc,msbuild,perf,benchmark}/{obj,bin}
+  execute rm -rf src/apache/codec/Avro.File.*{,.Test}/{obj,bin}
+  execute rm -rf build
+  execute rm -f  TestResult.xml
+}
+
+build-run "$@"