[ARM] az bicep lint: Add new command to lint a bicep file (#27378)

Author: polatengin

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

@@ -3101,6 +3101,18 @@
     text: az bicep generate-params --file {bicep_file} --output-format {output_format} --include-params {include_params}
 """
 
+helps['bicep lint'] = """
+type: command
+short-summary: Lint a Bicep file.
+examples:
+  - name: Lint a Bicep file.
+    text: az bicep lint --file {bicep_file}
+  - name: Lint a Bicep file without restoring external modules.
+    text: az bicep lint --file {bicep_file} --no-restore
+  - name: Lint a Bicep file with specified diagnostics format. Valid values are ( default | sarif ).
+    text: az bicep lint --file {bicep_file} --diagnostics-format {diagnostics_format}
+"""
+
 helps['resourcemanagement'] = """
 type: group
 short-summary: resourcemanagement CLI command group.

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

@@ -863,6 +863,11 @@ def load_arguments(self, _):
         c.argument('output_format', help="Set output format. Valid values are ( json | bicepparam ).")
         c.argument('include_params', help="Set include params. Valid values are ( all | required-only ).")
 
+    with self.argument_context('bicep lint') as c:
+        c.argument('file', arg_type=bicep_file_type, help="The path to the Bicep module file to lint in the file system.")
+        c.argument('no_restore', arg_type=bicep_no_restore_type, help="When set, generates the parameters file without restoring external modules.")
+        c.argument('diagnostics_format', arg_type=get_enum_type(['default', 'sarif']), help="Set diagnostics format.")
+
     with self.argument_context('resourcemanagement private-link create') as c:
         c.argument('resource_group', arg_type=resource_group_name_type,
                    help='The name of the resource group.')

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

@@ -616,6 +616,7 @@ def load_command_table(self, _):
         g.custom_command('version', 'show_bicep_cli_version')
         g.custom_command('list-versions', 'list_bicep_cli_versions')
         g.custom_command('generate-params', 'generate_params_file')
+        g.custom_command('lint', 'lint_bicep_file')
 
     with self.command_group('resourcemanagement private-link', resource_resourcemanagementprivatelink_sdk, resource_type=ResourceType.MGMT_RESOURCE_PRIVATELINKS) as g:
         g.custom_command('create', 'create_resourcemanager_privatelink')

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

@@ -4456,6 +4456,24 @@ def generate_params_file(cmd, file, no_restore=None, outdir=None, outfile=None,
         logger.error("az bicep generate-params could not be executed with the current version of Bicep CLI. Please upgrade Bicep CLI to v%s or later.", minimum_supported_version)
 
 
+def lint_bicep_file(cmd, file, no_restore=None, diagnostics_format=None):
+    ensure_bicep_installation(cmd.cli_ctx)
+
+    minimum_supported_version = "0.7.4"
+    if bicep_version_greater_than_or_equal_to(minimum_supported_version):
+        args = ["lint", file]
+        if no_restore:
+            args += ["--no-restore"]
+        if diagnostics_format:
+            args += ["--diagnostics-format", diagnostics_format]
+
+        output = run_bicep_command(cmd.cli_ctx, args)
+
+        print(output)
+    else:
+        logger.error("az bicep lint could not be executed with the current version of Bicep CLI. Please upgrade Bicep CLI to v%s or later.", minimum_supported_version)
+
+
 def create_resourcemanager_privatelink(
         cmd, resource_group, name, location):
     rcf = _resource_privatelinks_client_factory(cmd.cli_ctx)

src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource.py

@@ -5157,6 +5157,39 @@ def test_bicep_generate_params(self):
         if os.path.exists(params_path):
             os.remove(params_path)
 
+class BicepLintTest(LiveScenarioTest):
+    def setup(self):
+        super().setup()
+        self.cmd('az bicep uninstall')
+
+    def tearDown(self):
+        super().tearDown()
+        self.cmd('az bicep uninstall')
+
+    def test_bicep_lint(self):
+        curr_dir = os.path.dirname(os.path.realpath(__file__))
+        tf = os.path.join(curr_dir, 'sample_params.bicep').replace('\\', '\\\\')
+
+        self.cmd('az bicep lint -f {tf}')
+
+    def test_bicep_lint_no_restore(self):
+        curr_dir = os.path.dirname(os.path.realpath(__file__))
+        tf = os.path.join(curr_dir, 'sample_params.bicep').replace('\\', '\\\\')
+
+        self.cmd('az bicep lint -f {tf} --no-restore')
+
+    def test_bicep_lint_diagnostics_format_default(self):
+        curr_dir = os.path.dirname(os.path.realpath(__file__))
+        tf = os.path.join(curr_dir, 'sample_params.bicep').replace('\\', '\\\\')
+
+        self.cmd('az bicep lint -f {tf} --diagnostics-format default')
+
+    def test_bicep_lint_diagnostics_format_sarif(self):
+        curr_dir = os.path.dirname(os.path.realpath(__file__))
+        tf = os.path.join(curr_dir, 'sample_params.bicep').replace('\\', '\\\\')
+
+        self.cmd('az bicep lint -f {tf} --diagnostics-format sarif')
+
 class BicepInstallationTest(LiveScenarioTest):
     def setup(self):
         super().setup()

src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource_custom.py

@@ -397,6 +397,15 @@ def test_bicep_generate_params_include_params(self):
         is_generated_params_file_exists = os.path.exists(json_file)
         self.assertTrue(is_generated_params_file_exists)
 
+    @live_only()
+    def test_bicep_lint_defaults(self):
+        curr_dir = os.path.dirname(os.path.realpath(__file__))
+        param_file = os.path.join(curr_dir, 'sample_params.bicep').replace('\\', '\\\\')
+
+        run_bicep_command(cli_ctx, ["lint", param_file])
+
+        self.assertTrue(param_file)
+
     @live_only()
     def test_bicep_build_params_defaults(self):
         curr_dir = os.path.dirname(os.path.realpath(__file__))