Add a (hidden, for now) `show` command for tooling use #616

ellismg · 2022-09-08T23:40:54Z

This change adds a new hidden command, show, which must be run with --output json to do anything. When run like this, azd show collects information about the project and presents it in a way suitable for consumption by tooling.

We include information about each service, including the language type and path to the project as well as the target resource in Azure that will be deployed to, if we can determine it (if you haven't yet run azd provision or there is some other transient error, this information will be missing from the resulting JSON).

An example (before provisioning):

C:\dd\azure\azure-dev\cli\azd\test\samples\webapp>azd show --output json
{
  "services": {
    "web": {
      "project": {
        "path": "C:\\dd\\azure\\azure-dev\\cli\\azd\\test\\samples\\webapp\\src\\dotnet\\webapp.csproj",
        "type": "dotnet"
      }
    }
  }
}

After:

C:\dd\azure\azure-dev\cli\azd\test\samples\webapp>azd show --output json
{
  "services": {
    "web": {
      "project": {
        "path": "C:\\dd\\azure\\azure-dev\\cli\\azd\\test\\samples\\webapp\\src\\dotnet\\webapp.csproj",
        "type": "dotnet"
      },
      "target": {
        "resourceIds": ["/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/rg-matell-tst-shw/providers/Microsoft.Web/sites/app-t4e7rfh6jsb5u"]
      }
    }
  }
}

@vijayrkn and @abpiskunov, I made some slight changes to the format we were discussing in #241 but this should contain all the information you need. Is this going to be suitable or do you prefer services to be an array instead of a map, with a name property? This felt slightly more jq-able, so I went with that, but not wed to the output format.

wbreza

Command looks good but have some questions around implementation.

cli/azd/pkg/project/project_config.go

azure-sdk · 2022-09-15T19:18:21Z

Azure Dev CLI Install Instructions

Install scripts

MacOS/Linux

May elevate using sudo on some platforms and configurations

bash:

curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/uninstall-azd.sh | bash;
curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/install-azd.sh | bash -s -- --base-url https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616 --version '' --verbose

pwsh:

Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/uninstall-azd.ps1' -OutFile uninstall-azd.ps1; ./uninstall-azd.ps1
Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/install-azd.ps1' -OutFile install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616' -Version '' -Verbose

Windows

powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/uninstall-azd.ps1' > uninstall-azd.ps1; ./uninstall-azd.ps1;"
powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616/install-azd.ps1' > install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/616' -Version '' -Verbose;"

Standalone Binary

Container

docker run -it azdevcliextacr.azurecr.io/azure-dev:pr-616

ellismg · 2022-09-15T22:31:09Z

@abpiskunov, could you confirm that the output here has all the information you need to unblock the VS work?

abpiskunov · 2022-09-15T22:39:51Z

we can work with that format - yes.

ellismg · 2022-09-16T17:31:36Z

@wbreza Please take a look again when you have a moment - would love to have this in the next release to make it easier for VS to consume.

cli/azd/cmd/show.go

wbreza

Added a few non-blocking additional comments. I think this is fine for now but we'll need to continue work on splitting out some expectations on our Project vs ProjectConfig so it is easier to move these type of framework or service target concerns back into their respective components.

cli/azd/cmd/show.go

cli/azd/pkg/project/service.go

cli/azd/cmd/show.go

This makes the set of values smaller and doesn't use the word "language" which can be sort of confusing when it's set to something like "dotnet". As part of this, we normalize the output so that `type` is always one of `dotnet`, `python` or `node` to make consumers lives easier.

Consumers like Visual Studio need to understand the project file that is assocated with a dotnet service, not just the path to the directory the service lives in. Initially, this logic was in it the project reader (which builds a ProjectConfig), but that felt like the wrong location for the logic. We can't add this logic to `ProjectConfig::GetProject` because that call fails when the infrastructure for an appliaction has not been provisioned, and we want `azd show` to work even in that case. Longer term we should look into something that allows `GetProject` to work evern when infrastructure is not created, and at that point move this logic there, but for now we have this as a specific implementation detail of the show command.

vhvb1989 · 2022-09-21T22:21:34Z

/check-enforcer override

ellismg self-assigned this Sep 8, 2022

ellismg modified the milestones: Release 0.3, Release 0.2 Sep 8, 2022

ellismg force-pushed the ellismg/add-hidden-show branch 3 times, most recently from d7eb333 to c630250 Compare September 9, 2022 20:47

ellismg marked this pull request as ready for review September 9, 2022 23:23

ellismg requested review from wbreza, vhvb1989, hemarina, jongio and weikanglim as code owners September 9, 2022 23:23

wbreza requested changes Sep 9, 2022

View reviewed changes

cli/azd/pkg/project/project_config.go Outdated Show resolved Hide resolved

ellismg force-pushed the ellismg/add-hidden-show branch from e98cda2 to ed1df65 Compare September 15, 2022 18:46

ellismg requested a review from wbreza September 15, 2022 18:49

weikanglim reviewed Sep 16, 2022

View reviewed changes

cli/azd/cmd/show.go Outdated Show resolved Hide resolved

weikanglim reviewed Sep 16, 2022

View reviewed changes

cli/azd/cmd/show.go Show resolved Hide resolved

weikanglim reviewed Sep 16, 2022

View reviewed changes

cli/azd/cmd/show.go Show resolved Hide resolved

weikanglim reviewed Sep 16, 2022

View reviewed changes

cli/azd/cmd/show.go Show resolved Hide resolved

wbreza approved these changes Sep 16, 2022

View reviewed changes

cli/azd/cmd/show.go Outdated Show resolved Hide resolved

cli/azd/pkg/project/service.go Show resolved Hide resolved

cli/azd/cmd/show.go Outdated Show resolved Hide resolved

cli/azd/cmd/show.go Outdated Show resolved Hide resolved

ellismg force-pushed the ellismg/add-hidden-show branch from 8df1d8c to afbef06 Compare September 21, 2022 16:31

ellismg requested a review from danieljurek as a code owner September 21, 2022 17:53

WIP: Spike 'show'

45a5f8d

ellismg added 9 commits September 21, 2022 15:01

Use show in an integration test

3d48efd

Only support --format json for now

a30518d

Allow a single service to target multiple resources

db1638e

Decrease nesting by inverting condition

eb28ba3

Fix build issues after merge

ba06e1c

Fixes

1f10b2f

Kick CI

7114dcd

ellismg force-pushed the ellismg/add-hidden-show branch from d14a549 to 7114dcd Compare September 21, 2022 22:01

vhvb1989 approved these changes Sep 21, 2022

View reviewed changes

hemarina merged commit bdd2dfe into Azure:main Sep 21, 2022

ellismg mentioned this pull request Sep 27, 2022

New Azd internal command for sharing proj/env context for Azd <-> VS integration #603

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a (hidden, for now) `show` command for tooling use #616

Add a (hidden, for now) `show` command for tooling use #616

ellismg commented Sep 8, 2022 •

edited

Loading

wbreza left a comment

azure-sdk commented Sep 15, 2022

ellismg commented Sep 15, 2022

abpiskunov commented Sep 15, 2022

ellismg commented Sep 16, 2022

wbreza left a comment

vhvb1989 commented Sep 21, 2022

Add a (hidden, for now) show command for tooling use #616

Add a (hidden, for now) show command for tooling use #616

Conversation

ellismg commented Sep 8, 2022 • edited Loading

wbreza left a comment

Choose a reason for hiding this comment

azure-sdk commented Sep 15, 2022

Azure Dev CLI Install Instructions

Install scripts

MacOS/Linux

Windows

Standalone Binary

Container

ellismg commented Sep 15, 2022

abpiskunov commented Sep 15, 2022

ellismg commented Sep 16, 2022

wbreza left a comment

Choose a reason for hiding this comment

vhvb1989 commented Sep 21, 2022

Add a (hidden, for now) `show` command for tooling use #616

Add a (hidden, for now) `show` command for tooling use #616

ellismg commented Sep 8, 2022 •

edited

Loading