IsRunningOnAzurePipelines doesn't work for Ubuntu

[matt40k]

What You Are Seeing?

IsRunningOnAzurePipelines returns false

What is Expected?

IsRunningOnAzurePipelines returns true

What version of Cake are you using?

Are you running on a 32 or 64 bit system?

What environment are you running on? Windows? Linux? Mac?

Linux

Are you running on a CI Server? If so, which one?

Azure Pipelines

How Did You Get This To Happen? (Steps to Reproduce)

https://cakebuild.net/docs/integrations/build-systems/azure-pipelines/

if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
	Information("Running on AzurePipelines");
}

trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: cake-build.cake.cake-build-task.Cake@2
  displayName: 'Cake build'
  inputs:
    script: build/build.cake
    target: CI

Output Log

Nothing

[augustoproiete]

@matt40k This is by design. IsRunningOnAzurePipelines returns true only when not running on a hosted agent. There's a separate property IsRunningOnAzurePipelinesHosted to detect if you're running on a hosted agent.

Docs:
https://cakebuild.net/api/Cake.Common.Build.AzurePipelines/IAzurePipelinesProvider/#Properties

---

public bool IsRunningOnAzurePipelines
    => !string.IsNullOrWhiteSpace(_environment.GetEnvironmentVariable("TF_BUILD")) && !IsHostedAgent; // <#<#<#

public bool IsRunningOnAzurePipelinesHosted
    => !string.IsNullOrWhiteSpace(_environment.GetEnvironmentVariable("TF_BUILD")) && IsHostedAgent; // <#<#<#

https://github.com/cake-build/cake/blob/v1.0.0/src/Cake.Common/Build/TFBuild/TFBuildProvider.cs#L30-L36

[pascalberger]

What was the name of the agent running the build?

The check tests for existence of TF_BUILD env variable and is not running on a hosted agent (agent name doesn't start with either Hosted or Azure Pipelines)

[matt40k]

@augustoproiete This isn't hosted, its just the cloud using the ubuntu-latest image - https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops&tabs=yaml

@pascalberger Just using the marketplace Cake - https://cakebuild.net/docs/integrations/build-systems/azure-pipelines/azure-devops-build-task-extension - reports:

==============================================================================
Task         : Cake
Description  : Build with Cake
Version      : 2.1.0
Author       : Patrik Svensson
Help         : [More Information about Cake](https://cakebuild.net)
==============================================================================
=====================================================
Root = /home/vsts/work/1/s/build
Tools = /home/vsts/work/1/s/build/tools
Cake Tool Path = /home/vsts/work/1/s/build/tools/dotnet-cake
Package Feed = 
=====================================================
Creating tools directory...
Installing Cake Tool (Latest)...
/usr/bin/dotnet tool install --tool-path /home/vsts/work/1/s/build/tools/ Cake.Tool
You can invoke the tool using the following command: dotnet-cake
Tool 'cake.tool' (version '1.0.0') was successfully installed.

[augustoproiete]

@matt40k You tricked me with "Ubuntu hosted" in the title 😄. I see that you changed the title now.

Can you inspect the environment variables to see what is in there? We're particularly interested in the TF_BUILD variable.

build.cake

var envVars = EnvironmentVariables();

Information("Environment Variables: ");
foreach(var envVar in envVars)
{
    Information("Key: {0}\tValue: \"{1}\"", envVar.Key, envVar.Value);
}

[pascalberger]

@pascalberger Just using the marketplace Cake - https://cakebuild.net/docs/integrations/build-systems/azure-pipelines/azure-devops-build-task-extension - reports:

@matt40k My question was not about the task used but what was the name of the agent which run the job:

[pascalberger]

If you're running on hosted pool you need to call IsRunningOnAzurePipelinesHosted not IsRunningOnAzurePipelinesHosted.

IsRunningOnAzurePipelines is defined as:

public bool IsRunningOnAzurePipelines
    => !string.IsNullOrWhiteSpace(_environment.GetEnvironmentVariable("TF_BUILD")) && !IsHostedAgent;

IsRunningOnAzurePipelinesHosted is defined as:

public bool IsRunningOnAzurePipelinesHosted
    => !string.IsNullOrWhiteSpace(_environment.GetEnvironmentVariable("TF_BUILD")) && IsHostedAgent;

[matt40k]

@augustoproiete

2021-02-15T21:46:15.2134378Z Key: TF_BUILD	Value: "True"

@pascalberger

Pool: Azure Pipelines
Image: ubuntu-latest
Agent: Hosted Agent
Started: Today at 21:45
Duration: 33s

So Cake is picking up the Linux Microsoft hosted pool as self-hosted?

[pascalberger]

Everything as expected. See #3148 (comment). It has nothing to do with Linux. If you want to know if you run on a Azure Pipelines hosted pool you need to run IsRunningOnAzurePipelinesHosted instead of IsRunningOnAzurePipelines.

IsRunningOnAzurePipelines is true when running on self-hosted agent. IsRunningOnAzurePipelinesHosted is true when running on Microsoft hosted agent.