ci: Restore Integration Tests failing on MacOS due to docker daemon unavailable.

[ellismg]

On macOS we're seeing failures in our integration tests that run azd restore (from a recent run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4394706&view=logs&j=c8fbea3f-f5ea-553e-32cf-eaf013f8156e&t=0406ef3f-de29-5cc3-ca4b-05f62e17b6ba)

=== FAIL: cli/azd/test/functional Test_CLI_Telemetry_UsageData_EnvProjectLoad (1.20s)
    telemetry_test.go:141: DIR: /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Telemetry_UsageData_EnvProjectLoad1380466290/001
    cli.go:241: 120ms [stdout] 
    cli.go:241: 130ms [stdout] Initializing an app to run on Azure (azd init)
    cli.go:241: 130ms [stdout] 
    cli.go:241: 142ms [stdout] Enter a new environment name: 
    cli.go:241: 146ms [stdout] SUCCESS: Initialized environment azdtest-m07162c.
    cli.go:241: 48ms [stdout] 
    cli.go:241: 49ms [stdout] Restoring services (azd restore)
    cli.go:241: 49ms [stdout] 
    cli.go:241: 947ms [stdout] 
    cli.go:241: 951ms [stdout] ERROR: required external tools are missing:
    cli.go:241: 969ms [stdout]  - error checking for external tool Docker: the Docker daemon is not running, please start the Docker service: exit code: 1, stdout: , stderr: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    cli.go:241: 969ms [stdout] 
    telemetry_test.go:162: 
        	Error Trace:	/Users/runner/work/1/s/cli/azd/test/functional/telemetry_test.go:162
        	Error:      	Received unexpected error:
        	            	command 'azd restore csharpapptest --trace-log-file /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Telemetry_UsageData_EnvProjectLoad1380466290/001/trace.json in /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Telemetry_UsageData_EnvProjectLoad1380466290/001' had non-zero exit code: exit status 1
        	Test:       	Test_CLI_Telemetry_UsageData_EnvProjectLoad

=== FAIL: cli/azd/test/functional Test_CLI_Restore_UsingServiceName (0.94s)
    restore_test.go:119: DIR: /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Restore_UsingServiceName1186787145/001
    restore_test.go:122: AZURE_ENV_NAME: azdtest-m5cff6f
    cli.go:241: 80ms [stdout] 
    cli.go:241: 87ms [stdout] Initializing an app to run on Azure (azd init)
    cli.go:241: 87ms [stdout] 
    cli.go:241: 94ms [stdout] Enter a new environment name: 
    cli.go:241: 96ms [stdout] SUCCESS: Initialized environment azdtest-m5cff6f.
    cli.go:241: 41ms [stdout] 
    cli.go:241: 44ms [stdout] Restoring services (azd restore)
    cli.go:241: 44ms [stdout] 
    cli.go:241: 814ms [stdout] 
    cli.go:241: 816ms [stdout] ERROR: required external tools are missing:
    cli.go:241: 831ms [stdout]  - error checking for external tool Docker: the Docker daemon is not running, please start the Docker service: exit code: 1, stdout: , stderr: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    cli.go:241: 831ms [stdout] 
    restore_test.go:138: 
        	Error Trace:	/Users/runner/work/1/s/cli/azd/test/functional/restore_test.go:138
        	Error:      	Received unexpected error:
        	            	command 'azd restore csharpapptest in /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Restore_UsingServiceName1186787145/001' had non-zero exit code: exit status 1
        	Test:       	Test_CLI_Restore_UsingServiceName

=== FAIL: cli/azd/test/functional Test_CLI_RestoreAll_UsingFlags (0.70s)
    restore_test.go:185: DIR: /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_RestoreAll_UsingFlags4258743850/001
    restore_test.go:188: AZURE_ENV_NAME: azdtest-m90eb5e
    cli.go:241: 48ms [stdout] 
    cli.go:241: 52ms [stdout] Initializing an app to run on Azure (azd init)
    cli.go:241: 52ms [stdout] 
    cli.go:241: 62ms [stdout] Enter a new environment name: 
    cli.go:241: 64ms [stdout] SUCCESS: Initialized environment azdtest-m90eb5e.
    cli.go:241: 39ms [stdout] 
    cli.go:241: 42ms [stdout] Restoring services (azd restore)
    cli.go:241: 42ms [stdout] 
    cli.go:241: 595ms [stdout] 
    cli.go:241: 598ms [stdout] ERROR: required external tools are missing:
    cli.go:241: 623ms [stdout]  - error checking for external tool Docker: the Docker daemon is not running, please start the Docker service: exit code: 1, stdout: , stderr: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    cli.go:241: 623ms [stdout] 
    restore_test.go:209: 
        	Error Trace:	/Users/runner/work/1/s/cli/azd/test/functional/restore_test.go:209
        	Error:      	Received unexpected error:
        	            	command 'azd restore --all in /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_RestoreAll_UsingFlags4258743850/001/infra' had non-zero exit code: exit status 1
        	Test:       	Test_CLI_RestoreAll_UsingFlags

=== FAIL: cli/azd/test/functional Test_CLI_RestoreAll_InProjectDir (0.88s)
    restore_test.go:150: DIR: /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_RestoreAll_InProjectDir4171661352/001
    restore_test.go:153: AZURE_ENV_NAME: azdtest-mc96d32
    cli.go:241: 49ms [stdout] 
    cli.go:241: 57ms [stdout] Initializing an app to run on Azure (azd init)
    cli.go:241: 57ms [stdout] 
    cli.go:241: 61ms [stdout] Enter a new environment name: 
    cli.go:241: 63ms [stdout] SUCCESS: Initialized environment azdtest-mc96d32.
    cli.go:241: 41ms [stdout] 
    cli.go:241: 45ms [stdout] Restoring services (azd restore)
    cli.go:241: 46ms [stdout] 
    cli.go:241: 786ms [stdout] 
    cli.go:241: 787ms [stdout] ERROR: required external tools are missing:
    cli.go:241: 800ms [stdout]  - error checking for external tool Docker: the Docker daemon is not running, please start the Docker service: exit code: 1, stdout: , stderr: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    cli.go:241: 800ms [stdout] 
    restore_test.go:170: 
        	Error Trace:	/Users/runner/work/1/s/cli/azd/test/functional/restore_test.go:170
        	Error:      	Received unexpected error:
        	            	command 'azd restore in /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_RestoreAll_InProjectDir4171661352/001' had non-zero exit code: exit status 1
        	Test:       	Test_CLI_RestoreAll_InProjectDir

=== FAIL: cli/azd/test/functional Test_CLI_Restore_InServiceDirectory (0.52s)
    restore_test.go:87: DIR: /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Restore_InServiceDirectory4189353399/001
    restore_test.go:90: AZURE_ENV_NAME: azdtest-m762014
    cli.go:241: 40ms [stdout] 
    cli.go:241: 42ms [stdout] Initializing an app to run on Azure (azd init)
    cli.go:241: 42ms [stdout] 
    cli.go:241: 53ms [stdout] Enter a new environment name: 
    cli.go:241: 54ms [stdout] SUCCESS: Initialized environment azdtest-m762014.
    cli.go:241: 30ms [stdout] 
    cli.go:241: 32ms [stdout] Restoring services (azd restore)
    cli.go:241: 33ms [stdout] 
    cli.go:241: 449ms [stdout] 
    cli.go:241: 451ms [stdout] ERROR: required external tools are missing:
    cli.go:241: 461ms [stdout]  - error checking for external tool Docker: the Docker daemon is not running, please start the Docker service: exit code: 1, stdout: , stderr: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    cli.go:241: 462ms [stdout] 
    restore_test.go:107: 
        	Error Trace:	/Users/runner/work/1/s/cli/azd/test/functional/restore_test.go:107
        	Error:      	Received unexpected error:
        	            	command 'azd restore in /var/folders/xc/58rwcyyd6sg521ksqbll5qr00000gn/T/Test_CLI_Restore_InServiceDirectory4189353399/001/csharpapp' had non-zero exit code: exit status 1
        	Test:       	Test_CLI_Restore_InServiceDirectory

DONE 139 tests, 6 skipped, 5 failures in 5134.007s

The problem here is that our integration test app has a docker based project, so part of azd restore runs the check to see if docker is both installed (it is) and that the docker daemon is running (it isn't) and then fails.

[ellismg]

Checking to ensure that the docker daemon is running was added as part of #4567, so this is newish code, but it did seem to pass CI at some point.

[rajeshkamal5050]

fyi @v-xuto and @v-weiyding #4567 seems to have caused build failures.

[v-xuto]

fyi @v-xuto and @v-weiyding #4567 seems to have caused build failures.

@rajeshkamal5050 Apologize for causing build failures for other commands. We have also noticed this issue. When fixing issues in the future, we will pay attention to whether it will cause build failures for other commands. Besides, why our PRs do not directly trigger the azure-dev-cli pipeline？

For the latest docker design, we require that the docker daemon be running to consider docker "installed", which is reasonable. The fix by ellismg looks good to me. He has added a new method, EnsureRestoreTools, which no longer calls EnsureFrameworkTools. The EnsureRestoreTools method selects different methods to acquire the required tools based on whether the framework service type is a dockerProject type.