[devops] Move check for hard disk space to the setup logic. (#24364)

This way we always check for available hard disk space (currently we don't
check for the API Diff pipeline).

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: rolfbjarne

tools/devops/automation/run-nightly-codeql.yml

@@ -63,6 +63,7 @@ stages:
         use1ES: false
         disableCodeQL: false
         xcodeChannel: $(xcodeChannel)
+        statusContext: "Nightly CodeQL"
         buildSteps:
         - bash: $(Build.SourcesDirectory)/$(BUILD_REPOSITORY_TITLE)/tools/devops/automation/scripts/bash/build-nugets.sh
           displayName: 'Build Nugets'

tools/devops/automation/templates/build/api-diff-build-and-detect.yml

@@ -50,6 +50,8 @@ steps:
     makeParallelism: '4'
     xcodeChannel: ${{ parameters.xcodeChannel }}
     use1ES: false
+    requiredDiskSpace: 50
+    statusContext: "API diff"
 
 # detect changes
 - bash: $(Build.SourcesDirectory)/$(BUILD_REPOSITORY_TITLE)/tools/devops/automation/scripts/bash/compare.sh

tools/devops/automation/templates/build/build-mac-tests.yml

@@ -48,6 +48,8 @@ steps:
     xqaCertPass: ${{ parameters.xqaCertPass }}
     use1ES: ${{ parameters.use1ES }}
     xcodeChannel: ${{ parameters.xcodeChannel }}
+    statusContext: "Build macOS tests"
+    requiredDiskSpace: 10
     buildSteps:
 
     - bash: |

tools/devops/automation/templates/build/build.yml

@@ -50,6 +50,14 @@ parameters:
   - name: XcodeChannel
     type: string
 
+  - name: requiredDiskSpace
+    type: number
+    default: 20
+
+  - name: statusContext
+    type: string
+    default: "Unknown context"
+
 steps:
 
   - template: ../common/checkout.yml
@@ -62,6 +70,8 @@ steps:
     parameters:
       disableCodeQL: ${{ parameters.disableCodeQL }}
       keyringPass: ${{ parameters.keyringPass }}
+      requiredDiskSpace: ${{ parameters.requiredDiskSpace }}
+      statusContext: ${{ parameters.statusContext }}
 
   - template: install-certificates.yml@yaml-templates
     parameters:

tools/devops/automation/templates/common/setup.yml

@@ -6,6 +6,11 @@ parameters:
   default: true
 - name: keyringPass
   type: string
+- name: requiredDiskSpace
+  type: number
+  default: 20
+- name: statusContext
+  type: string
 
 steps:
 - template: agent-cleanser/v1.yml@yaml-templates # Uninstalls mono, Xamarin.Mac (if installed) plus cleanses the Provisionator Xcode cache and kills processes at the end
@@ -28,6 +33,21 @@ steps:
   continueOnError: true
   timeoutInMinutes: 60
 
+# Use a cmdlet to check if the space available in the device's root system is larger than the required amount (parameterized via 'requiredDiskSpace'). If there is not
+# enough space available it:
+# 1. Set the status of the build to error. It is not a failure since no tests have been ran.
+# 2. Set a comment stating the same as what was sent to the status.
+# 3. Cancel the pipeline and do not execute any of the following steps.
+- pwsh: |
+    Import-Module $Env:SYSTEM_DEFAULTWORKINGDIRECTORY\$Env:BUILD_REPOSITORY_TITLE\tools\devops\automation\scripts\MaciosCI.psd1
+    Assert-HDFreeSpace -Size ${{ parameters.requiredDiskSpace }}
+  env:
+    CONTEXT: ${{ parameters.statusContext }}
+    GITHUB_TOKEN: $(GitHub.Token)
+    SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+  displayName: 'Check HD Free Space'
+  timeoutInMinutes: 5
+
 - bash: $(System.DefaultWorkingDirectory)/$(BUILD_REPOSITORY_TITLE)/tools/devops/automation/scripts/bash/remove-ui-prompt.sh
   env:
     OSX_KEYCHAIN_PASS: ${{ parameters.keyringPass }}

tools/devops/automation/templates/mac/build.yml

@@ -96,21 +96,6 @@ steps:
 
   displayName: 'Set VM Vendor'
 
-# Use a cmdlet to check if the space available in the devices root system is larger than 50 gb. If there is not
-# enough space available it:
-# 1. Set the status of the build to error. It is not a failure since no tests have been ran.
-# 2. Set a comment stating the same as what was sent to the status.
-# 3. Cancel the pipeline and do not execute any of the following steps.
-- pwsh: |
-    Import-Module $Env:SYSTEM_DEFAULTWORKINGDIRECTORY\$Env:BUILD_REPOSITORY_TITLE\tools\devops\automation\scripts\MaciosCI.psd1
-    Assert-HDFreeSpace -Size 5
-  env:
-    CONTEXT: ${{ parameters.statusContext }}
-    GITHUB_TOKEN: $(GitHub.Token)
-    SYSTEM_ACCESSTOKEN: $(System.AccessToken)
-  displayName: 'Check HD Free Space'
-  timeoutInMinutes: 5
-
 - task: xamops.azdevex.provisionator-task.provisionator@2
   displayName: 'Provision Brew components'
   inputs:

tools/devops/automation/templates/tests/build.yml

@@ -85,23 +85,10 @@ steps:
 - template: ../common/setup.yml
   parameters:
     keyringPass: ${{ parameters.keyringPass }}
+    requiredDiskSpace: 20
+    statusContext: ${{ parameters.statusContext }}
 
-# Use a cmdlet to check if the space available in the devices root system is larger than 50 gb. If there is not
-# enough space available it:
-# 1. Set a comment stating the same as what was sent to the status.
-# 2. Cancel the pipeline and do not execute any of the following steps.
-- pwsh: | 
-    Import-Module ./MaciosCI.psd1
-    Assert-HDFreeSpace -Size 20
-  env:
-    CONTEXT: ${{ parameters.statusContext }}
-    GITHUB_TOKEN: $(GitHub.Token)
-    ACCESSTOKEN: $(System.AccessToken)
-  displayName: 'Check HD Free Space'
-  timeoutInMinutes: 5
-  workingDirectory: $(System.DefaultWorkingDirectory)/$(BUILD_REPOSITORY_TITLE)/tools/devops/automation/scripts/
-
-# if we got to this point, it means that we do have at least 50 Gb to run the test, should
+# if we got to this point, it means that we do have at least 20 Gb to run the test, should
 # be more than enough, else the above script would have stopped the pipeline
 - bash: |
     set -x