CSHARP-5399: Implement API compatibility validation EG script (#1533)

Author: sanych-sun

evergreen/evergreen.yml

@@ -100,7 +100,7 @@ functions:
       params:
         script: |
           ${PREPARE_SHELL}
-          OS=${OS} bash ${PROJECT_DIRECTORY}/evergreen/install-dotnet.sh
+          OS=${OS} DOTNET_SDK_VERSION=${DOTNET_SDK_VERSION} bash ${PROJECT_DIRECTORY}/evergreen/install-dotnet.sh
 
   prepare-resources:
     - command: shell.exec
@@ -1828,6 +1828,21 @@ tasks:
         - func: build-packages
         - func: upload-packages
 
+    - name: validate-apicompat
+      commands:
+        - func: install-dotnet
+          vars:
+            DOTNET_SDK_VERSION: 6.0
+        - func: download-packages
+        - command: shell.exec
+          type: test
+          params:
+            working_dir: mongo-csharp-driver
+            shell: "bash"
+            script: |
+              ${PREPARE_SHELL}
+              bash evergreen/validate-apicompat.sh
+
     - name: push-packages-nuget
       commands:
         - func: install-dotnet
@@ -2371,6 +2386,30 @@ task_groups:
     tasks:
       - test-serverless
 
+  - name: validate-apicompat-task-group
+    setup_group_can_fail_task: true
+    setup_group_timeout_secs: 1800 # 30 minutes
+    setup_group:
+      - func: fetch-source
+      - func: prepare-resources
+      - func: fix-absolute-paths
+      - func: make-files-executable
+      - func: install-dotnet
+    teardown_group:
+      - command: s3.put
+        params:
+          aws_key: ${aws_key}
+          aws_secret: ${aws_secret}
+          local_files_include_filter:
+            - mongo-csharp-driver/artifacts/apicompat/*.${PACKAGE_VERSION}.txt
+          remote_file: ${UPLOAD_BUCKET}/${revision}/
+          preserve_path: false
+          bucket: mciuploads
+          permissions: public-read
+          content_type: text/plain
+    tasks:
+      - validate-apicompat
+
 buildvariants:
 - matrix_name: stable-api-tests
   matrix_spec: { version: ["5.0", "6.0", "7.0", "8.0", "rapid", "latest"], topology: "standalone", auth: "auth", ssl: "nossl", os: "windows-64" }
@@ -2725,6 +2764,16 @@ buildvariants:
     - name: build-packages
       priority: 10
 
+- matrix_name: validate-apicompat
+  matrix_spec:
+    os: "ubuntu-2004"
+  display_name: "Validate API compatibility"
+  tasks:
+    - name: validate-apicompat-task-group
+      depends_on:
+        - name: build-packages
+          variant: ".build-packages"
+
 - matrix_name: validate-apidocs
   matrix_spec:
     os: "ubuntu-2004"

evergreen/install-dotnet.sh

@@ -2,15 +2,16 @@
 set -o errexit  # Exit the script with error if any of the commands fail
 
 DOTNET_SDK_PATH="${DOTNET_SDK_PATH:-./.dotnet}"
+DOTNET_SDK_VERSION="${DOTNET_SDK_VERSION:-8.0}"
 
 if [[ $OS =~ [Ww]indows.* ]]; then
   echo "Downloading Windows .NET SDK installer into $DOTNET_SDK_PATH folder..."
   curl -Lfo ./dotnet-install.ps1 https://dot.net/v1/dotnet-install.ps1
   echo "Installing .NET 8.0 SDK..."
-  powershell.exe ./dotnet-install.ps1 -Channel 8.0 -InstallDir "$DOTNET_SDK_PATH" -NoPath
+  powershell.exe ./dotnet-install.ps1 -Channel "$DOTNET_SDK_VERSION" -InstallDir "$DOTNET_SDK_PATH" -NoPath
 else
   echo "Downloading .NET SDK installer into $DOTNET_SDK_PATH folder..."
   curl -Lfo ./dotnet-install.sh https://dot.net/v1/dotnet-install.sh
   echo "Installing .NET 8.0 SDK..."
-  bash ./dotnet-install.sh --channel 8.0 --install-dir "$DOTNET_SDK_PATH" --no-path
-fi
+  bash ./dotnet-install.sh --channel "$DOTNET_SDK_VERSION" --install-dir "$DOTNET_SDK_PATH" --no-path
+fi

evergreen/packages.sh

@@ -0,0 +1 @@
+PACKAGES=("MongoDB.Bson" "MongoDB.Driver" "MongoDB.Driver.Authentication.AWS" "MongoDB.Driver.Encryption")

evergreen/push-packages.sh

@@ -55,7 +55,7 @@ if [ "$PACKAGES_SOURCE" = "https://api.nuget.org/v3/index.json" ] && [[ ! "$PACK
   exit 1
 fi
 
-PACKAGES=("MongoDB.Bson" "MongoDB.Driver" "MongoDB.Driver.Authentication.AWS" "MongoDB.Driver.Encryption")
+source ./evergreen/packages.sh
 
 for package in ${PACKAGES[*]}; do
   dotnet nuget verify ./artifacts/nuget/"$package"."$PACKAGE_VERSION".nupkg --certificate-fingerprint "$NUGET_SIGN_CERTIFICATE_FINGERPRINT"

evergreen/validate-apicompat.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+set -o errexit  # Exit the script with error if any of the commands fail
+
+# Environment variables used as input:
+# PACKAGE_VERSION
+
+if [ -z "$PACKAGE_VERSION" ]; then
+  PACKAGE_VERSION=$(bash ./evergreen/get-version.sh)
+  echo Calculated PACKAGE_VERSION value: "$PACKAGE_VERSION"
+fi
+
+BASELINE_VERSION="${PACKAGE_VERSION%%.*}.0.0"
+if [ "$PACKAGE_VERSION" == "$BASELINE_VERSION" ]; then
+  echo "Skipping package validation for major release."
+  exit 0
+fi
+
+echo "Installing package validation tool."
+dotnet new tool-manifest --force
+dotnet tool install Microsoft.DotNet.ApiCompat.Tool --version 8.0.* --local
+
+EXIT_CODE=0
+mkdir -p ./artifacts/apicompat/
+source ./evergreen/packages.sh
+for package in ${PACKAGES[*]}; do
+  echo "Validating ${package}:${PACKAGE_VERSION} for compatibility with ${BASELINE_VERSION}"
+
+  curl -L -o "./artifacts/nuget/${package}.${BASELINE_VERSION}.nupkg" "https://www.nuget.org/api/v2/package/${package}/${BASELINE_VERSION}"
+  # run apicompat tool and redirect stderr to file as apicompat reports problems as error output.
+  dotnet tool run apicompat package "./artifacts/nuget/${package}.${PACKAGE_VERSION}.nupkg" --baseline-package "./artifacts/nuget/${package}.${BASELINE_VERSION}.nupkg" --enable-rule-cannot-change-parameter-name 2> "./artifacts/apicompat/${package}.${PACKAGE_VERSION}.txt"
+  if [ -s "./artifacts/apicompat/${package}.${PACKAGE_VERSION}.txt" ] ; then
+    EXIT_CODE=1
+  else
+    # delete file if empty (no compatibility issues detected)
+    rm "./artifacts/apicompat/${package}.${PACKAGE_VERSION}.txt"
+  fi
+done
+
+exit $EXIT_CODE