Skip to content

Load environment variables from launch of AzureFunctions project#18689

Open
dsurys wants to merge 12 commits into
microsoft:mainfrom
dsurys:bugfix/16206-Add-AzureFunction-ignores-env-variables
Open

Load environment variables from launch of AzureFunctions project#18689
dsurys wants to merge 12 commits into
microsoft:mainfrom
dsurys:bugfix/16206-Add-AzureFunction-ignores-env-variables

Conversation

@dsurys

@dsurys dsurys commented Jul 8, 2026

Copy link
Copy Markdown

Description

AddAzureFunctionsProject extension method does not add env variables from the project's launch profile.

Added a loop that copies environment variables from launch profile to the resource builder analogously to AddProject method.
Applied only to Run mode.

Fixes #16206

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No

dawid.surys and others added 3 commits July 8, 2026 15:13
Updated AzureFunctionsProjectResourceExtensions to load Environment variables from project's launch profile in run mode.
Testing loading environment variables from launch profile
…res-env-variables

Bugfix/16206 add azure function ignores env variables
Copilot AI review requested due to automatic review settings July 8, 2026 13:28
@dsurys dsurys requested a review from eerhardt as a code owner July 8, 2026 13:28
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 18689

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18689"

@github-actions github-actions Bot added the area-integrations Issues pertaining to Aspire Integrations packages label Jul 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes issue #16206, where AddAzureFunctionsProject silently ignored environmentVariables defined in the project's launchSettings.json launch profile — unlike the standard AddProject<T> path. The fix adds a run-mode branch to the resource's WithEnvironment callback that copies launch-profile environment variables (with environment-variable expansion) onto the Functions resource, and adds tests validating that these variables are applied in Run mode but not in Publish mode.

Changes:

  • Adds an else if (IsRunMode) branch that reads the effective launch profile and copies its environment variables into the resource via TryAdd.
  • Adds two tests covering the Run-mode (applied) and Publish-mode (not applied) behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
src/Aspire.Hosting.Azure.Functions/AzureFunctionsProjectResourceExtensions.cs Adds run-mode branch to load launch-profile env vars; introduces an early return that unintentionally skips the storage configuration when no launch profile exists.
tests/Aspire.Hosting.Azure.Tests/AzureFunctionsTests.cs Adds a test project metadata fixture with launch-profile env vars and two tests for run/publish behavior; contains minor naming/value typos and does not cover the null-launch-profile path.

Key finding: the new return; inside the run-mode branch returns from the entire WithEnvironment callback, which skips the AzureWebJobsStorage storage configuration when no launch profile is selected/found in run mode — a regression from the prior behavior. The existing tests don't catch this because their fixture always provides a launch profile.

Comment on lines +228 to +237
var launchProfile = context.Resource.GetEffectiveLaunchProfile()?.LaunchProfile;
if (launchProfile is null)
{
return;
}
foreach (var envVar in launchProfile.EnvironmentVariables)
{
var value = Environment.ExpandEnvironmentVariables(envVar.Value);
context.EnvironmentVariables.TryAdd(envVar.Key, value);
}
}

[Fact]
public async Task AddAzureFunctionsProject_DoesNotAddsEnvironmentVariables_FromLaunchProfile_WhnInPublishMode()
{
CommandLineArgs = "--useHttps",
LaunchBrowser = false,
EnvironmentVariables = { { CustomEnvironmentVariable, "Somve value" } }
@dsurys

dsurys commented Jul 8, 2026

Copy link
Copy Markdown
Author

@dsurys please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

Copilot AI review requested due to automatic review settings July 8, 2026 13:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment on lines +229 to +241
if (context.ExecutionContext.IsRunMode)
{
var launchProfile = context.Resource.GetEffectiveLaunchProfile()?.LaunchProfile;
if (launchProfile is null)
{
return;
}
foreach (var envVar in launchProfile.EnvironmentVariables)
{
var value = Environment.ExpandEnvironmentVariables(envVar.Value);
context.EnvironmentVariables.TryAdd(envVar.Key, value);
}
}
Copilot AI review requested due to automatic review settings July 8, 2026 14:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

dawid.surys and others added 4 commits July 10, 2026 11:41
Copilot AI review requested due to automatic review settings July 10, 2026 10:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 10, 2026 10:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment on lines +230 to +241
if (context.ExecutionContext.IsRunMode)
{
var launchProfile = context.Resource.GetEffectiveLaunchProfile()?.LaunchProfile;
if (launchProfile is not null)
{
foreach (var envVar in launchProfile.EnvironmentVariables)
{
var value = Environment.ExpandEnvironmentVariables(envVar.Value);
context.EnvironmentVariables.TryAdd(envVar.Key, value);
}
}
}
@dsurys dsurys marked this pull request as draft July 10, 2026 10:35
Copilot AI review requested due to automatic review settings July 10, 2026 10:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread tests/Aspire.Hosting.Azure.Tests/AzureFunctionsTests.cs Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 10, 2026 10:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@dsurys dsurys marked this pull request as ready for review July 10, 2026 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-integrations Issues pertaining to Aspire Integrations packages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AddAzureFunctionsProject does not apply environmentVariables from launch profile

2 participants