[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Support deployment with Bicep files #16857

shenglol · 2021-02-08T18:28:32Z

Description

The PR integrates Bicep CLI so that the ARM template deployment commands can deploy Bicep files.

Testing Guide

az deployment group create -g <rg> -f storage_account.bicep

History Notes

[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Add support for Bicep files
[ARM] az bicep install: New command for installing Bicep CLI
[ARM] az bicep upgrade: New command for upgrading Bicep CLI
[ARM] az bicep build: New command for building Bicep files
[ARM] az bicep version: New command for showing the current installed version of Bicep CLI
[ARM] az bicep list-versions: New command for showing the available Bicep CLI versions

This checklist is used to make sure that common guidelines for a pull request are followed.

The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.

yonzhan · 2021-02-08T23:24:23Z

ARM

zhoxing-ms · 2021-02-09T01:48:47Z

/azp run

azure-pipelines · 2021-02-09T01:49:01Z

Azure Pipelines successfully started running 2 pipeline(s).

shenglol · 2021-02-09T02:15:27Z

/azp run

azure-pipelines · 2021-02-09T02:15:31Z

Commenter does not have sufficient privileges for PR 16857 in repo Azure/azure-cli

zhoxing-ms · 2021-02-09T02:18:04Z

/azp run

azure-pipelines · 2021-02-09T02:18:17Z

Azure Pipelines successfully started running 2 pipeline(s).

zhoxing-ms · 2021-02-09T02:43:53Z

/azp run

azure-pipelines · 2021-02-09T02:44:06Z

Azure Pipelines successfully started running 2 pipeline(s).

shenglol · 2021-02-18T05:47:46Z

Hi @zhoxing-ms @Juliehzl could you take a look at this PR? We are hoping to get this merged to catch the release for ignite.

src/azure-cli/azure/cli/command_modules/resource/_bicep.py

Co-authored-by: Xing Zhou <[email protected]>

zhoxing-ms · 2021-02-18T07:14:04Z

src/azure-cli/azure/cli/command_modules/resource/_bicep.py

+
+        print(f'Successfully installed Bicep CLI to "{installation_path}".')
+    except IOError as err:
+        raise CLIError(f"Error while attempting to download Bicep CLI: {err}")


Could you change those CLIError to some more specific error?
Please refer to azure.cli.core.azclierror

Changed them to more specific error types.

src/azure-cli/azure/cli/command_modules/resource/_help.py

zhoxing-ms · 2021-02-18T07:37:07Z

[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Add support for Bicep files

Could we add some tests for this feature?

shenglol · 2021-02-18T18:19:47Z

[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Add support for Bicep files

Could we add some tests for this feature?

@zhoxing-ms I would like to hear your thoughts on how to properly test them. I added some e2e tests in e89fc1e, but I had to revert them because I realized that it won't pass CI. Since I'm using a Windows machine, the recording files will contain the binary data of the Bicep CLI exe, which cannot be invoked on Linux and macOS. The other thing that worries me is that with the Bicep CLI binary data significantly increases the size of recording files (60MB+ each), and I feel like I should not commit something that big...

Co-authored-by: Xing Zhou <[email protected]>

zhoxing-ms · 2021-02-19T01:38:53Z

I would like to hear your thoughts on how to properly test them. I added some e2e tests in e89fc1e, but I had to revert them because I realized that it won't pass CI. Since I'm using a Windows machine, the recording files will contain the binary data of the Bicep CLI exe, which cannot be invoked on Linux and macOS. The other thing that worries me is that with the Bicep CLI binary data significantly increases the size of recording files (60MB+ each), and I feel like I should not commit something that big...

@shenglol OK, how about changing them to live test? How long do these tests take in live mode?

shenglol · 2021-02-19T01:44:05Z

I would like to hear your thoughts on how to properly test them. I added some e2e tests in e89fc1e, but I had to revert them because I realized that it won't pass CI. Since I'm using a Windows machine, the recording files will contain the binary data of the Bicep CLI exe, which cannot be invoked on Linux and macOS. The other thing that worries me is that with the Bicep CLI binary data significantly increases the size of recording files (60MB+ each), and I feel like I should not commit something that big...

@shenglol OK, how about changing them to live test? How long do these tests take in live mode?

Changing them to live tests means that recording files won't be generated, right? If yes I'd be happy to do so. The tests takes about about 10 minutes to complete on my machine.

zhoxing-ms · 2021-02-19T02:11:53Z

Changing them to live tests means that recording files won't be generated, right? If yes I'd be happy to do so. The tests takes about about 10 minutes to complete on my machine.

These record files are too large, and the binary data contained in the record files will be different when recording on different system platforms, right?
If so, I personally think live test is more appropriate

shenglol · 2021-02-19T02:15:43Z

Changing them to live tests means that recording files won't be generated, right? If yes I'd be happy to do so. The tests takes about about 10 minutes to complete on my machine.

These record files are too large, and the binary data contained in the record files will be different when recording on different system platforms, right?
If so, I personally think live test is more appropriate

Got it. I'll add back the tests and change them to live tests.

src/azure-cli/azure/cli/command_modules/resource/_help.py

Co-authored-by: Xing Zhou <[email protected]>

zhoxing-ms · 2021-02-23T01:58:26Z

/azp run

azure-pipelines · 2021-02-23T01:58:40Z

Azure Pipelines successfully started running 2 pipeline(s).

jiasli · 2023-05-25T04:28:16Z

src/azure-cli/azure/cli/command_modules/resource/_bicep.py

+
+        installed_version = _get_bicep_installed_version(installation_path)
+        target_version = _extract_semver(release_tag)
+        if installed_version and target_version and semver.compare(installed_version, target_version) == 0:


@shenglol, if bicep has no fancy versioning schema and complies with PEP 440, can semver be replaced by packaging.version? packaging.version is used by az extension (#17667):

azure-cli/src/azure-cli-core/azure/cli/core/extension/__init__.py

Lines 287 to 298 in 22725b3

def ext_compat_with_cli(azext_metadata):

from azure.cli.core import __version__ as core_version

from packaging.version import parse

is_compatible, min_required, max_required = (True, None, None)

if azext_metadata:

min_required = azext_metadata.get(EXT_METADATA_MINCLICOREVERSION)

max_required = azext_metadata.get(EXT_METADATA_MAXCLICOREVERSION)

parsed_cli_version = parse(core_version)

if min_required and parsed_cli_version < parse(min_required):

is_compatible = False

elif max_required and parsed_cli_version > parse(max_required):

is_compatible = False

This will help us reduce Azure CLI’s packaging maintenance cost (#26523).

shenglol added 2 commits February 8, 2021 10:15

Add support to Bicep

4b2ff90

Add deployment with Bicep integration tests

e89fc1e

shenglol requested review from Juliehzl and zhoxing-ms as code owners February 8, 2021 18:28

shenglol added 6 commits February 8, 2021 11:39

Add a unit test

1d436dd

Add more tests

4538abc

Add help docs; some refacoring

266f5ec

Remove deployment with Bicep scenario tests

4c1c67e

Remove unused import

69d68a9

Fix style and linter issues

52b4de9

yonzhan assigned zhoxing-ms Feb 8, 2021

yonzhan added this to the S183 - For Ignite milestone Feb 8, 2021

yonzhan requested a review from jsntcy February 8, 2021 23:24

shenglol added 2 commits February 8, 2021 18:06

Add license header

38f85cb

Try add semver to setup.py

decec74

Fix a module name

95c039b

shenglol added 3 commits February 9, 2021 17:06

Fix Python 3.6 compatability issue

cff5e93

Implement bicep decompile command

a66c212

Update Bicep CLI installation location

895b289

zhoxing-ms reviewed Feb 18, 2021

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_bicep.py Outdated Show resolved Hide resolved

Update src/azure-cli/azure/cli/command_modules/resource/_bicep.py

277a4f8

Co-authored-by: Xing Zhou <[email protected]>

zhoxing-ms reviewed Feb 18, 2021

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_help.py Outdated Show resolved Hide resolved

Update src/azure-cli/azure/cli/command_modules/resource/_help.py

3208ddd

Co-authored-by: Xing Zhou <[email protected]>

shenglol added 2 commits February 19, 2021 11:25

Use more specific error types

1e6d746

Add live tests

bb0e6c9

shenglol requested a review from zhoxing-ms February 22, 2021 18:27

Make sample files consistent in help docs

19b6806

zhoxing-ms reviewed Feb 23, 2021

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_help.py Outdated Show resolved Hide resolved

Update src/azure-cli/azure/cli/command_modules/resource/_help.py

e579a7c

Co-authored-by: Xing Zhou <[email protected]>

zhoxing-ms approved these changes Feb 23, 2021

View reviewed changes

zhoxing-ms merged commit d9eec8d into Azure:dev Feb 24, 2021

StefanIvemo mentioned this pull request Feb 24, 2021

Support deployment with Bicep files - az bicep build does not output build warnings #17083

Closed

jiasli mentioned this pull request May 25, 2023

{packaging} Bump semver to 3.0.x #26523

Closed

3 tasks

jiasli reviewed May 25, 2023

View reviewed changes

shenglol mentioned this pull request May 31, 2023

az bicep: replace semver with packaging.version Azure/bicep#10859

Closed

shenglol mentioned this pull request Jun 30, 2023

{ARM} Fix race condition in bicep unit tests #26797

Merged

3 tasks

This was referenced May 21, 2025

Bump semver pin to ~=3 #31519

Closed

{Packaging} Bump semver to 3.0.4 #31523

Merged

	def ext_compat_with_cli(azext_metadata):
	from azure.cli.core import __version__ as core_version
	from packaging.version import parse
	is_compatible, min_required, max_required = (True, None, None)
	if azext_metadata:
	min_required = azext_metadata.get(EXT_METADATA_MINCLICOREVERSION)
	max_required = azext_metadata.get(EXT_METADATA_MAXCLICOREVERSION)
	parsed_cli_version = parse(core_version)
	if min_required and parsed_cli_version < parse(min_required):
	is_compatible = False
	elif max_required and parsed_cli_version > parse(max_required):
	is_compatible = False

[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Support deployment with Bicep files #16857

[ARM] az deployment group/sub/mg/tenant validate/create/what-if: Support deployment with Bicep files #16857

Uh oh!

Conversation

shenglol commented Feb 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yonzhan commented Feb 8, 2021

Uh oh!

zhoxing-ms commented Feb 9, 2021

Uh oh!

azure-pipelines bot commented Feb 9, 2021

Uh oh!

shenglol commented Feb 9, 2021

Uh oh!

azure-pipelines bot commented Feb 9, 2021

Uh oh!

zhoxing-ms commented Feb 9, 2021

Uh oh!

azure-pipelines bot commented Feb 9, 2021

Uh oh!

zhoxing-ms commented Feb 9, 2021

Uh oh!

azure-pipelines bot commented Feb 9, 2021

Uh oh!

shenglol commented Feb 18, 2021

Uh oh!

Uh oh!

zhoxing-ms Feb 18, 2021

Choose a reason for hiding this comment

Uh oh!

shenglol Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zhoxing-ms commented Feb 18, 2021

Uh oh!

shenglol commented Feb 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zhoxing-ms commented Feb 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shenglol commented Feb 19, 2021

Uh oh!

zhoxing-ms commented Feb 19, 2021

Uh oh!

shenglol commented Feb 19, 2021

Uh oh!

Uh oh!

zhoxing-ms commented Feb 23, 2021

Uh oh!

azure-pipelines bot commented Feb 23, 2021

Uh oh!

jiasli May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shenglol commented Feb 8, 2021 •

edited

Loading

shenglol commented Feb 18, 2021 •

edited

Loading

zhoxing-ms commented Feb 19, 2021 •

edited

Loading

jiasli May 25, 2023 •

edited

Loading