Add experimental 'local-deploy' command group to Bicep CLI #14243

anthony-c-martin · 2024-06-05T20:05:29Z

This change brings in the following:

New local-deploy command group to deploy a Bicep file using the local extensibility preview.
Additions to publish-provider command group to allow publishing a binary extension to an ACR or to file system.

To test it out (see "Test this change out" comment below first):

bicepconfig.json:

{
  "experimentalFeaturesEnabled": {
    "extensibility": true,
    "localDeploy": true,
    "providerRegistry": true
  }
}

main.bicep:

provider 'br:biceplocaldeploy.azurecr.io/providers/http:0.1.9'

param coords {
  lattitude: string
  longitude: string
}

resource gridpointsReq 'HttpRequest' = {
  uri: 'https://api.weather.gov/points/${coords.lattitude},${coords.longitude}'
  format: 'raw'
}

var gridpoints = json(gridpointsReq.body).properties

resource forecastReq 'HttpRequest' = {
  uri: 'https://api.weather.gov/gridpoints/${gridpoints.gridId}/${gridpoints.gridX},${gridpoints.gridY}/forecast'
  format: 'raw'
}

var forecast = json(forecastReq.body).properties

type forecastType = {
  name: string
  temperature: int
}

output forecast forecastType[] = map(forecast.periods, p => {
  name: p.name
  temperature: p.temperature
})

main.bicepparam:

using 'main.bicep'

param coords = {
  lattitude: '47.6363726'
  longitude: '-122.1357068'
}

CLI command:

~/.azure/bin/bicep local-deploy ~/path/to/main.bicepparam

Microsoft Reviewers: Open in CodeFlow

github-actions · 2024-06-05T20:13:48Z

Test this change out locally with the following install scripts (Action run 9421684319)

VSCode

Mac/Linux

bash <(curl -Ls https://aka.ms/bicep/nightly-vsix.sh) --run-id 9421684319

Windows

iex "& { $(irm https://aka.ms/bicep/nightly-vsix.ps1) } -RunId 9421684319"

Azure CLI

Mac/Linux

bash <(curl -Ls https://aka.ms/bicep/nightly-cli.sh) --run-id 9421684319

Windows

iex "& { $(irm https://aka.ms/bicep/nightly-cli.ps1) } -RunId 9421684319"

github-actions · 2024-06-05T20:18:14Z

Dotnet Test Results

72 files - 36 72 suites - 36 23m 12s ⏱️ - 9m 3s
10 878 tests - 19 10 877 ✅ - 19 1 💤 ±0 0 ❌ ±0
25 652 runs - 12 819 25 650 ✅ - 12 818 2 💤 - 1 0 ❌ ±0

Results for commit df86f76. ± Comparison against base commit 664d4db.

♻️ This comment has been updated with latest results.

src/Bicep.Core/Emit/TemplateWriter.cs

src/Bicep.Core/Registry/OciArtifactRegistry.cs

src/Bicep.Core/Registry/LocalModuleRegistry.cs

anthony-c-martin · 2024-06-06T19:09:44Z

The VS test failure appears to be caused by microsoft/vstest-action#31 - not a problem with the PR.

src/Bicep.Core.UnitTests/Utils/ProviderTestHelper.cs

jorgecotillo · 2024-06-07T00:43:17Z

src/Bicep.Core.UnitTests/Utils/RegistryHelper.cs

@@ -153,7 +153,7 @@ public static async Task PublishProviderToRegistryAsync(IDependencyHelper servic
            throw new InvalidOperationException($"Failed to get reference '{errorBuilder(DiagnosticBuilder.ForDocumentStart()).Message}'.");
        }

-        await dispatcher.PublishProvider(targetReference, new(tgzData));
+        await dispatcher.PublishProvider(targetReference, new(tgzData, false, []));


Is not using named args in bicep repo the norm? In this case I had to look into what argument - in PublishProvider -corresponds to a record and find its bool argument, which corresponds to LocalDeployEnabled.

Yeah, my personal style is to avoid named args by default. I will sometimes use them if I feel like they add clarity, but IMO they often get in the way of code readability without adding any useful context.

IMHO I'd argue that having a naked "false" or "true" argument is much less readable. When possible I prefer to redesign the API (e.g. use an enum), but otherwise I like using named args or inline comments for this case.

Not that this is a big deal...

jorgecotillo · 2024-06-07T04:16:29Z

src/Bicep.Local.Deploy/Extensibility/LocalExtensibilityHandler.cs

+        this.moduleDispatcher = moduleDispatcher;
+        this.providerFactory = providerFactory;
+        // Built in provider for handling nested deployments
+        RegisteredProviders[new("LocalNested", "0.0.0")] = new AzExtensibilityProvider(this);


Don't recall if we have a way to load nested deployments provider version, I think it might be good to let users decide which version to use rather than picking a specific version?

Bicep doesn't expose the nested deployment API version to end users in the module syntax, so it's not possible to pick a different version. This is by design - Bicep should be in control of the behavior; if we need to opt-in to new behavior, then we will do so in a new Bicep release.

jorgecotillo · 2024-06-07T04:28:09Z

src/Bicep.Core/Registry/Providers/ProviderV1Archive.cs

+        }
+
+        return new(
+            Types: dataDict["types.tgz"],


Is types.tgz going to contain types + providers right?

also, is it possible for types.tgz to not be present in the dict and a key not found exception to be thrown?

Yeah, the error handling here could use some work before we remove the "experimental" feature flag.

src/Bicep.Core/Registry/Providers/ProviderV1Archive.cs

shenglol

StephenWeatherford · 2024-06-07T17:41:48Z

src/Bicep.Cli/Commands/PublishProviderCommand.cs

+                    return null;
+                }
+
+                var data = BinaryData.FromStream(fileSystem.FileStream.New(PathHelper.ResolvePath(binaryPath), FileMode.Open, FileAccess.Read, FileShare.Read));


"using" to close the stream?

StephenWeatherford · 2024-06-07T17:46:21Z

src/Bicep.Core/Emit/TemplateWriter.cs

+
+                this.EmitDependsOn(emitter, module.DependsOn);
+
+                // Since we don't want to be mutating the body of the original ObjectSyntax, we create an placeholder body in place


nit

Suggested change

// Since we don't want to be mutating the body of the original ObjectSyntax, we create an placeholder body in place

// Since we don't want to be mutating the body of the original ObjectSyntax, we create a placeholder body in place

StephenWeatherford · 2024-06-07T17:56:01Z

src/Bicep.Core/Registry/OciArtifactRegistry.cs

+                {
+                    if (SupportedArchitectures.TryGetCurrent() is not {} architecture)
+                    {
+                        throw new InvalidOperationException($"Unsupported architecture: {RuntimeInformation.ProcessArchitecture}");


Probably these error messages should be different, different causes.

StephenWeatherford · 2024-06-07T18:03:30Z

src/Bicep.Cli/Commands/LocalDeployCommand.cs

@@ -0,0 +1,102 @@
+// Copyright (c) Microsoft Corporation.


I didn't see this documented for --help. I assume that's intentional for now?

@StephenWeatherford

Addressing some comments that @StephenWeatherford raised in #14243. ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/14252)

anthony-c-martin force-pushed the ant/local_cli branch from 5a30edf to d2ebeef Compare June 5, 2024 20:11

anthony-c-martin commented Jun 5, 2024

View reviewed changes

src/Bicep.Core/Emit/TemplateWriter.cs Outdated Show resolved Hide resolved

anthony-c-martin commented Jun 5, 2024

View reviewed changes

src/Bicep.Core/Registry/OciArtifactRegistry.cs Outdated Show resolved Hide resolved

anthony-c-martin commented Jun 5, 2024

View reviewed changes

src/Bicep.Core/Registry/LocalModuleRegistry.cs Outdated Show resolved Hide resolved

anthony-c-martin force-pushed the ant/local_cli branch 8 times, most recently from e3f9cb7 to 608232b Compare June 6, 2024 18:03

jorgecotillo reviewed Jun 7, 2024

View reviewed changes

anthony-c-martin force-pushed the ant/local_cli branch 3 times, most recently from ee3d413 to dac6641 Compare June 7, 2024 13:34

anthony-c-martin added 4 commits June 7, 2024 10:08

Add experimental 'local-deploy' command group to Bicep CLI

b81707f

Refactoring based on self-review

f955d47

Fix tests

d3e8798

Fix OCI config deserialization issue

878bde0

anthony-c-martin force-pushed the ant/local_cli branch 4 times, most recently from 3c86a4f to 21eb401 Compare June 7, 2024 15:38

shenglol approved these changes Jun 7, 2024

View reviewed changes

jorgecotillo approved these changes Jun 7, 2024

View reviewed changes

Add e2e CLI test for local-deploy

df86f76

anthony-c-martin force-pushed the ant/local_cli branch from 21eb401 to df86f76 Compare June 7, 2024 17:01

anthony-c-martin enabled auto-merge (squash) June 7, 2024 17:01

StephenWeatherford reviewed Jun 7, 2024

View reviewed changes

anthony-c-martin merged commit 91b64d4 into main Jun 7, 2024
45 of 46 checks passed

anthony-c-martin deleted the ant/local_cli branch June 7, 2024 18:41

anthony-c-martin added a commit that referenced this pull request Jun 7, 2024

Address PR feedback for #14243

84b8147

anthony-c-martin mentioned this pull request Jun 7, 2024

Address PR feedback for #14243 #14252

Merged

marsontret mentioned this pull request Jun 27, 2024

Execute local scripts as a part of bicep deployment #7259

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add experimental 'local-deploy' command group to Bicep CLI #14243

Add experimental 'local-deploy' command group to Bicep CLI #14243

anthony-c-martin commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

anthony-c-martin commented Jun 6, 2024

jorgecotillo Jun 7, 2024

anthony-c-martin Jun 7, 2024

StephenWeatherford Jun 7, 2024 •

edited

Loading

jorgecotillo Jun 7, 2024

anthony-c-martin Jun 7, 2024

jorgecotillo Jun 7, 2024

jorgecotillo Jun 7, 2024

anthony-c-martin Jun 7, 2024

shenglol left a comment

StephenWeatherford Jun 7, 2024

StephenWeatherford Jun 7, 2024

StephenWeatherford Jun 7, 2024 •

edited

Loading

StephenWeatherford Jun 7, 2024


		this.EmitDependsOn(emitter, module.DependsOn);

		// Since we don't want to be mutating the body of the original ObjectSyntax, we create an placeholder body in place

Add experimental 'local-deploy' command group to Bicep CLI #14243

Add experimental 'local-deploy' command group to Bicep CLI #14243

Conversation

anthony-c-martin commented Jun 5, 2024 • edited Loading

Microsoft Reviewers: Open in CodeFlow

github-actions bot commented Jun 5, 2024 • edited Loading

github-actions bot commented Jun 5, 2024 • edited Loading

Dotnet Test Results

anthony-c-martin commented Jun 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenWeatherford Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shenglol left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenWeatherford Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anthony-c-martin commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

StephenWeatherford Jun 7, 2024 •

edited

Loading

StephenWeatherford Jun 7, 2024 •

edited

Loading