Add pipeline parameters to build azure-functions-java-additions from source

ahmedmuhsin · ahmedmuhsin · commit be77bf42baa7 · 2026-06-12T15:14:20.000-05:00
The worker depends on `azure-functions-java-core-library:1.4.0-SNAPSHOT` during development of cross-repo changes, but ADO CI agents only resolve from Maven Central + OSS Sonatype snapshots. There was no way to validate a worker PR against a fork/branch of azure-functions-java-additions without first publishing the snapshot. This adds three opt-in pipeline parameters to `public-build.yml`: - buildAdditionsFromSource (bool, default: false) - additionsRepoUrl (string, default: official Azure repo) - additionsBranch (string, default: dev) When the toggle is true, an "Install azure-functions-java-additions from source" step runs before the worker's mvn build in every job (Build, TestWindows, TestLinux, TestDocker). The step delegates to the existing `installAdditionsLocally.ps1`, which is parameterized to accept a repo URL + branch and made idempotent for CI re-runs. When the toggle is false (the default for normal PRs against dev) the step is excluded at template-expansion time via `${{ if eq(...) }}`, so there is zero impact on existing builds. To use: queue the PR pipeline manually from the ADO UI, check "Build azure-functions-java-additions from source", and optionally override the repo URL/branch to point at a fork (e.g. `https://github.com/ahmedmuhsin/azure-functions-java-additions.git` on `feat/http-response-bodystream`).
diff --git a/eng/ci/public-build.yml b/eng/ci/public-build.yml
@@ -17,6 +17,24 @@ pr:
     include:
       - dev
 
+# Pipeline-level parameters surfaced in the ADO "Run pipeline" dialog so we can
+# build a custom branch of azure-functions-java-additions (e.g. a fork) before
+# the worker's mvn build. Defaults to a no-op so normal PRs continue to resolve
+# the library from Maven Central.
+parameters:
+  - name: buildAdditionsFromSource
+    displayName: 'Build azure-functions-java-additions from source (instead of resolving from Maven Central)'
+    type: boolean
+    default: false
+  - name: additionsRepoUrl
+    displayName: 'Git URL for azure-functions-java-additions (used only when buildAdditionsFromSource is true)'
+    type: string
+    default: 'https://github.com/Azure/azure-functions-java-additions.git'
+  - name: additionsBranch
+    displayName: 'Branch of azure-functions-java-additions to build (used only when buildAdditionsFromSource is true)'
+    type: string
+    default: 'dev'
+
 resources:
   repositories:
     - repository: 1es
@@ -51,24 +69,37 @@ extends:
       - stage: Build
         jobs:
           - template: /eng/ci/templates/jobs/build.yml@self
+            parameters:
+              buildAdditionsFromSource: ${{ parameters.buildAdditionsFromSource }}
+              additionsRepoUrl: ${{ parameters.additionsRepoUrl }}
+              additionsBranch: ${{ parameters.additionsBranch }}
 
       - stage: TestWindows
         dependsOn: []
         jobs:
           - template: /eng/ci/templates/jobs/run-emulated-tests-windows.yml@self
             parameters:
               poolName: 1es-pool-azfunc-public
+              buildAdditionsFromSource: ${{ parameters.buildAdditionsFromSource }}
+              additionsRepoUrl: ${{ parameters.additionsRepoUrl }}
+              additionsBranch: ${{ parameters.additionsBranch }}
 
       - stage: TestLinux
         dependsOn: []
         jobs:
           - template: /eng/ci/templates/jobs/run-emulated-tests-linux.yml@self
             parameters:
               poolName: 1es-pool-azfunc-public
+              buildAdditionsFromSource: ${{ parameters.buildAdditionsFromSource }}
+              additionsRepoUrl: ${{ parameters.additionsRepoUrl }}
+              additionsBranch: ${{ parameters.additionsBranch }}
 
       - stage: TestDocker
         dependsOn: []
         jobs:
           - template: /eng/ci/templates/jobs/run-docker-tests-linux.yml@self
             parameters:
-              poolName: 1es-pool-azfunc-public
+              poolName: 1es-pool-azfunc-public
+              buildAdditionsFromSource: ${{ parameters.buildAdditionsFromSource }}
+              additionsRepoUrl: ${{ parameters.additionsRepoUrl }}
+              additionsBranch: ${{ parameters.additionsBranch }}
diff --git a/eng/ci/templates/jobs/build.yml b/eng/ci/templates/jobs/build.yml
@@ -1,3 +1,14 @@
+parameters:
+  - name: buildAdditionsFromSource
+    type: boolean
+    default: false
+  - name: additionsRepoUrl
+    type: string
+    default: 'https://github.com/Azure/azure-functions-java-additions.git'
+  - name: additionsBranch
+    type: string
+    default: 'dev'
+
 jobs:
   - job: "Build"
     displayName: 'Build java worker'
@@ -14,6 +25,10 @@ jobs:
     - pwsh: |
         java -version
       displayName: 'Check default java version'
+    - ${{ if eq(parameters.buildAdditionsFromSource, true) }}:
+      - pwsh: |
+          ./installAdditionsLocally.ps1 -AdditionsRepoUrl '${{ parameters.additionsRepoUrl }}' -AdditionsBranch '${{ parameters.additionsBranch }}'
+        displayName: 'Install azure-functions-java-additions from source'
     - pwsh: |
         mvn clean package
       displayName: 'Build java worker'
diff --git a/eng/ci/templates/jobs/run-docker-tests-linux.yml b/eng/ci/templates/jobs/run-docker-tests-linux.yml
@@ -2,6 +2,15 @@ parameters:
   - name: poolName
     type: string
     default: ''
+  - name: buildAdditionsFromSource
+    type: boolean
+    default: false
+  - name: additionsRepoUrl
+    type: string
+    default: 'https://github.com/Azure/azure-functions-java-additions.git'
+  - name: additionsBranch
+    type: string
+    default: 'dev'
 
 jobs:
   - job: "TestDocker"
@@ -51,6 +60,11 @@ jobs:
           pip install -e dockertests/azure-functions-test-kit
         displayName: 'Install Python dependencies'
 
+      - ${{ if eq(parameters.buildAdditionsFromSource, true) }}:
+        - pwsh: |
+            ./installAdditionsLocally.ps1 -AdditionsRepoUrl '${{ parameters.additionsRepoUrl }}' -AdditionsBranch '${{ parameters.additionsBranch }}'
+          displayName: 'Install azure-functions-java-additions from source'
+
       - pwsh: |
           ./package-pipeline.ps1 -outputDir 'java-worker' -skipNuget
         displayName: 'Package Java worker'
diff --git a/eng/ci/templates/jobs/run-emulated-tests-linux.yml b/eng/ci/templates/jobs/run-emulated-tests-linux.yml
@@ -2,6 +2,15 @@ parameters:
   - name: poolName
     type: string
     default: ''
+  - name: buildAdditionsFromSource
+    type: boolean
+    default: false
+  - name: additionsRepoUrl
+    type: string
+    default: 'https://github.com/Azure/azure-functions-java-additions.git'
+  - name: additionsBranch
+    type: string
+    default: 'dev'
 
 jobs:
   - job: "TestLinux"
@@ -83,6 +92,10 @@ jobs:
           docker compose -f emulatedtests/utils/docker-compose.yml pull
           docker compose -f emulatedtests/utils/docker-compose.yml up -d
         displayName: 'Install Azurite and Start Emulators'
+      - ${{ if eq(parameters.buildAdditionsFromSource, true) }}:
+        - pwsh: |
+            ./installAdditionsLocally.ps1 -AdditionsRepoUrl '${{ parameters.additionsRepoUrl }}' -AdditionsBranch '${{ parameters.additionsBranch }}'
+          displayName: 'Install azure-functions-java-additions from source'
       - pwsh: |
           if ("$(isTag)"){
             $buildNumber="$(Build.SourceBranchName)"
diff --git a/eng/ci/templates/jobs/run-emulated-tests-windows.yml b/eng/ci/templates/jobs/run-emulated-tests-windows.yml
@@ -2,6 +2,15 @@ parameters:
   - name: poolName
     type: string
     default: ''
+  - name: buildAdditionsFromSource
+    type: boolean
+    default: false
+  - name: additionsRepoUrl
+    type: string
+    default: 'https://github.com/Azure/azure-functions-java-additions.git'
+  - name: additionsBranch
+    type: string
+    default: 'dev'
 
 jobs:
   - job: "TestWindows"
@@ -78,6 +87,10 @@ jobs:
           mkdir azurite
           azurite --silent --location azurite --debug azurite\debug.log &
         displayName: 'Install and Run Azurite'
+      - ${{ if eq(parameters.buildAdditionsFromSource, true) }}:
+        - pwsh: |
+            ./installAdditionsLocally.ps1 -AdditionsRepoUrl '${{ parameters.additionsRepoUrl }}' -AdditionsBranch '${{ parameters.additionsBranch }}'
+          displayName: 'Install azure-functions-java-additions from source'
       - pwsh: |
           if ("$(isTag)"){
             $buildNumber="$(Build.SourceBranchName)"
diff --git a/installAdditionsLocally.ps1 b/installAdditionsLocally.ps1
@@ -1,28 +1,50 @@
-# Variables for first repository
-$repoUrl1 = 'https://github.com/Azure/azure-functions-java-additions.git'
-$branchName1 = 'dev'
-$repoName1 = 'azure-functions-java-additions'
+[CmdletBinding()]
+param(
+    [string]$AdditionsRepoUrl = 'https://github.com/Azure/azure-functions-java-additions.git',
+    [string]$AdditionsBranch  = 'dev'
+)
 
-# Clone the first repository
-git clone $repoUrl1
+$ErrorActionPreference = 'Stop'
 
-# Change directory to the cloned repository
-Set-Location $repoName1
+$repoName       = 'azure-functions-java-additions'
+$workerRoot     = $PSScriptRoot
+$cloneDir       = Join-Path $workerRoot $repoName
+$mvnBuildScript = Join-Path $workerRoot 'mvnBuildAdditions.bat'
 
-# Checkout the desired branch
-git checkout $branchName1
+Write-Host "Installing $repoName from $AdditionsRepoUrl (branch: $AdditionsBranch)"
+Write-Host "Clone destination: $cloneDir"
 
-# Detect OS and execute build accordingly
-if ($IsWindows) {
-    # Run the batch script (mvnBuild.bat)
-    & "..\mvnBuildAdditions.bat"
-} else {
-    # Extract and explicitly invoke the mvn command from mvnBuild.bat
-    $mvnCommand = Get-Content "../mvnBuildAdditions.bat" | Where-Object { $_ -match '^mvn\s+' }
-    if ($null -ne $mvnCommand) {
-        # Execute the extracted mvn command explicitly as a single line
-        bash -c "$mvnCommand"
-    } else {
-        Write-Error "No mvn command found in mvnBuild.bat."
+# Make the clone idempotent for re-runs.
+if (Test-Path $cloneDir) {
+    Write-Host "Removing existing $cloneDir"
+    Remove-Item -Path $cloneDir -Recurse -Force
+}
+
+Push-Location $workerRoot
+try {
+    git clone --branch $AdditionsBranch --single-branch $AdditionsRepoUrl
+    if ($LASTEXITCODE -ne 0) { throw "git clone failed for $AdditionsRepoUrl ($AdditionsBranch)" }
+
+    Push-Location $repoName
+    try {
+        if ($IsWindows) {
+            # Run the batch script (mvnBuildAdditions.bat)
+            & $mvnBuildScript
+            if ($LASTEXITCODE -ne 0) { throw "mvnBuildAdditions.bat failed" }
+        } else {
+            # Extract and explicitly invoke the mvn command from mvnBuildAdditions.bat
+            $mvnCommand = Get-Content $mvnBuildScript | Where-Object { $_ -match '^mvn\s+' }
+            if ($null -ne $mvnCommand) {
+                # Execute the extracted mvn command explicitly as a single line
+                bash -c "$mvnCommand"
+                if ($LASTEXITCODE -ne 0) { throw "mvn command failed" }
+            } else {
+                throw "No mvn command found in $mvnBuildScript"
+            }
+        }
+    } finally {
+        Pop-Location
     }
+} finally {
+    Pop-Location
 }
