Create Microsoft.Extensions.Configuration package to load azd environment variables

[ronaldbosma]

I've created several azd templates with Bicep and I'm in the process of adding a GitHub Actions workflow with .NET integration tests to each of them.

The integration tests need environment specific values like the name of a deployed API Management instance. I can use 'normal' environment variables in my pipeline, but locally I want to have the option to use the azd environment variables located in .azure/<defaultEnvironment>/.env.

I've created an extension on the IConfigurationBuilder class to load the azd environment variables from the default environment's .env file. The implementation is inspired by Microsoft.Extensions.Configuration.Json.

Example usage:

var configuration = new ConfigurationBuilder()
    .AddAzdEnvironmentVariables() 
    .Build();

var apimName = configuration["AZURE_API_MANAGEMENT_NAME"];

The source can be found here: https://github.com/ronaldbosma/azure-integration-services-quickstart/tree/custom-azd-configuration-source/tests/AISQuick.IntegrationTests/Configuration/Azd

It would be nice if this could be improved upon and turned into an official Microsoft.Extensions.Configuration.* NuGet package.

[vhvb1989]

@captainsafia @davidfowl see this

[ronaldbosma]

I was thinking that the only azd specific part is locating the correct .env file. The configuration source and provider could work for all .env files.

[davidfowl]

dotnet/runtime#49667

[ronaldbosma]

@vhvb1989 I've posted a comment on the issue David provided. Should we close this discussion?

[vhvb1989]

That issue seems pretty old (2021). It makes me wonder 🤠

One thing you can consider @ronaldbosma , is to run azd env list -o json and use the output to get the .env path instead of manually parsing the config files. That would keep you safe in case azd changes the implementation details about how the data is storaged.
The output is a json string with the list of all environments. you would need to find the one with IsDefault=true

example I had next to me:

[
  {
    "Name": "vivazqu-docdoc",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazqu-docdoc/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": false
  },
  {
    "Name": "vivazqu-doct1023",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazqu-doct1023/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": false
  },
  {
    "Name": "vivazqu-mongo6",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazqu-mongo6/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": true
  },
  {
    "Name": "vivazqu-newavmdoctor",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazqu-newavmdoctor/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": false
  },
  {
    "Name": "vivazqu-td",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazqu-td/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": false
  },
  {
    "Name": "vivazque-docsecure",
    "DotEnvPath": "/home/vivazqu/workspace/template-doctor/.azure/vivazque-docsecure/.env",
    "HasLocal": true,
    "HasRemote": false,
    "IsDefault": false
  }
]