diff options
| author | Billy O'Neal <bion@microsoft.com> | 2021-01-13 14:06:06 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-13 14:06:06 -0800 |
| commit | 8414e15973097e70fe40149e922c402799804b3d (patch) | |
| tree | ca46f3f317f0eef7924f3b76828868d51bb249cf /scripts/azure-pipelines/end-to-end-tests-dir | |
| parent | 4da47f758fb5e02fc017047e014d15174b85a848 (diff) | |
| download | vcpkg-8414e15973097e70fe40149e922c402799804b3d.tar.gz vcpkg-8414e15973097e70fe40149e922c402799804b3d.zip | |
[vcpkg] Use a tag file rather than conditional compilation to permanently disable metrics. (#15470)
Diffstat (limited to 'scripts/azure-pipelines/end-to-end-tests-dir')
| -rw-r--r-- | scripts/azure-pipelines/end-to-end-tests-dir/disable-metrics.ps1 | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/scripts/azure-pipelines/end-to-end-tests-dir/disable-metrics.ps1 b/scripts/azure-pipelines/end-to-end-tests-dir/disable-metrics.ps1 new file mode 100644 index 000000000..efec472b4 --- /dev/null +++ b/scripts/azure-pipelines/end-to-end-tests-dir/disable-metrics.ps1 @@ -0,0 +1,61 @@ +. $PSScriptRoot/../end-to-end-tests-prelude.ps1
+
+# Test that metrics are on by default
+$metricsTagName = 'vcpkg.disable-metrics'
+$metricsAreDisabledMessage = 'Warning: passed --sendmetrics, but metrics are disabled.'
+
+function Test-Metrics-Enabled() {
+ Param(
+ [Parameter(ValueFromRemainingArguments)]
+ [string[]]$TestArgs
+ )
+
+ $actualArgs = @('version', '--sendmetrics')
+ if ($TestArgs.Length -ne 0) {
+ $actualArgs += $TestArgs
+ }
+
+ $vcpkgOutput = Run-Vcpkg $actualArgs
+ if ($vcpkgOutput -contains $metricsAreDisabledMessage) {
+ Write-Host 'Metrics are disabled'
+ return $false
+ }
+
+ Write-Host 'Metrics are enabled'
+ return $true
+}
+
+# By default, metrics are enabled.
+Require-FileNotExists $metricsTagName
+if (-Not (Test-Metrics-Enabled)) {
+ throw "Metrics were not on by default."
+}
+
+if (Test-Metrics-Enabled '--disable-metrics') {
+ throw "Metrics were not disabled by switch."
+}
+
+$env:VCPKG_DISABLE_METRICS = 'ON'
+try {
+ if (Test-Metrics-Enabled) {
+ throw "Environment variable did not disable metrics."
+ }
+
+ if (-Not (Test-Metrics-Enabled '--no-disable-metrics')) {
+ throw "Environment variable to disable metrics could not be overridden by switch."
+ }
+} finally {
+ Remove-Item env:VCPKG_DISABLE_METRICS
+}
+
+# If the disable-metrics tag file exists, metrics are disabled even if attempted to be enabled on
+# the command line.
+Set-Content -Path $metricsTagName -Value ""
+try {
+ if (Test-Metrics-Enabled '--disable-metrics') {
+ throw "Metrics were not force-disabled by the disable-metrics tag file."
+ }
+}
+finally {
+ Remove-Item $metricsTagName
+}
|