Visual Studio Net Core: Switch Environment Variables for Multiple Projects

Question

We have multiple Projects in a Solution, and need a way to quickly change Environment to Another One, say QA. There are 8 projects in our solution. How can this be done, without manually going through each ?

Is there quick setting in Visual Studio?

Note: We have a multiple number of API projects, which have non dependencies.

You should checkout https://stackoverflow.com/questions/46364293/automatically-set-appsettings-json-for-dev-and-release-environments-in-asp-net-c — Daniel Leach, Aug 10 '20 at 20:38
hi @DanielLeach we have that setup in Azure devops, but testing locally for right now — , Aug 10 '20 at 21:03
This link might be helful: https://stackoverflow.com/questions/46364293/automatically-set-appsettings-json-for-dev-and-release-environments-in-asp-net-c/50331886#50331886 — Roksana, Aug 11 '20 at 20:52
Do you mean U need a way to quickly change environment from VS say from Dev to QA or Staging? — Ismail Umar, Aug 16 '20 at 08:18
And have you tried using different configurations for different environments? — Ismail Umar, Aug 16 '20 at 08:23
It's a little bit unclear what need you want to fulfill by doing this. Care to clarify on your actual need? There might be another solution to fulfill your need other than doing this. — 8DH, Aug 19 '20 at 20:28

ajawad987 · Answer 1 · 2020-08-19T03:35:13.723

One way to solve this is to have a solution-level "environment" text file, that each API project can "link" to. Then in each API project's Program or Startup logic, have them read this global file to set the environment at run time.

As an example, here's my sample solution which has 2 API projects in it:

Step 1: Create The 'Global' Environment File

Firstly, I added a solution-level text file Environment.txt that simply has the name of the 'current' environment I wish to run all my API's under:

Performance

Step 2: Link The Environment.txt File To Each API Project

Second is linking the Environment.txt file to each API project, using Visual Studio's Add Existing Item dialog, and choosing the Add As Link option:

Notice that the icon on linked files is slightly different than a normal file.

Step 3: Ensure Environment.txt Actually Gets Copied To The Bin Directory(s)

Thirdly is ensuring that each of the added linked file's Copy to Output option is set to Copy Always:

Step 4: A Small Bit Of Code...

And finally, in each API project's Program.cs file, you can read this file and set the environment at run-time:

namespace MicroserviceSandbox.ApiTwo
{
    using System.IO;
    using Microsoft.AspNetCore.Hosting;
    using Microsoft.Extensions.Hosting;

    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args)
        {
            return Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    // *** Dynamically set the environment.
                    var binDirectoryPath = new FileInfo(typeof(Program).Assembly.Location).Directory.FullName;
                    var environmentFilePath = Path.Combine(binDirectoryPath, "Environment.txt");
                    var environment = File.ReadAllText(environmentFilePath);
                    webBuilder.UseEnvironment(environment);
                    // ***

                    webBuilder.UseStartup<Startup>();
                });
        }
    }
}

Assumptions

The above C# code snippet assumes your API projects are using ASP.NET Core v3.1.

Yes, that'll ensure each project is using the same environment. But it doesn't solve the 2nd part of the question: What if you have DEV, QA, UAT, ... environments? How can you switch these easily? I know, similar to "Debug" and "Release" you can create multiple configurations in VS, but how to reference these with the C# code snippet? — Matt, Aug 20 '20 at 10:09
@Matt - Are you referring to environmental specific appsettings.json files? I believe that's already taken care of as long as they follow the standard naming convention appsettings.[environment].json where environment can be the same as you specify in the solution level environment file. And any shared setting can be in the appsetting.json file (non environment specific one). — ajawad987, Aug 21 '20 at 03:30
this is a great answer, I upvoted, but asks us to make too many changes to current project setup which exists — , Aug 21 '20 at 04:17
@ajawad987 - Yes, indeed, in the .json file there can be an environment section so you don't need to do that separately. I have updated that in my [answer](https://stackoverflow.com/a/63504548/1016343). — Matt, Aug 21 '20 at 07:25

DarkSigma · Accepted Answer · 2020-08-10T20:37:07.187

1

As shown on your screenshot, the "app environment" is determined by that "windows process environment variable". Only the project that is being run needs to set that environment variable, not the projects refenced by that one.

If you are running multiple projects at the same time: The environment variable is saved to the launchSettings.json file in the project folder. You could us a PowerShell script to update the launchSettings of many projects at once.

edited Aug 10 '20 at 20:37

answered Aug 10 '20 at 20:29

DarkSigma

416
2
9

Note: We have a multiple number of API projects, which have non dependencies. and all 5 api projects are running – Aug 10 '20 at 20:36
is there a native way, in VS without using powershell? thanks – Aug 11 '20 at 17:44
Not that I know of – DarkSigma Aug 11 '20 at 18:45
do you have a sample powershell script by any chance? I can use as example template – Aug 15 '20 at 05:28
1

this is a great answer, probably most straightforward, if someone is a powershell expert, feel free to add on – Aug 21 '20 at 04:23
You don't specifically have to use PowerShell. You could make a C# console app that edits the launchSettings.json files using the Newtonsoft.Json library. Whatever you are most comfortable with. – DarkSigma Aug 21 '20 at 04:51

score 1 · Answer 3 · answered Aug 19 '20 at 10:46

Instead of using the environment variables from the project launchsettings, you can also use the system environment variables.

To do so, you have to remove the "ASPNETCORE_ENVIRONMENT" from the launchsettings and set in system enviroment variables. See docu here: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/environments?view=aspnetcore-3.1#set-the-environment

Caution: Every project on the same machinge not having the "ASPNETCORE_ENVIRONMENT" set in the launchsetting will use the system enviroment variable

Matt · Answer 4 · 2020-09-03T15:17:08.223

There a couple of things described in the articles below:

The first one is a step by step instruction how to set up appsettings.json for multiple environments; in the 2nd article you find important information about launchSettings.json and how different sets of environment variables can be configured. Here you'll find an example how you can set up environment variables for 3 different configurations like "Development", "Staging" and "Production".

Also there are startup conventions in Startup.cs like "StartupDevelopment" or "StartupProduction" being called if you switched the deployment platform.

Essentially, to set this up, you'll need a combination of these to set up your environment variables properly. I'd use ajawad987's answer but change the environment file path to var environmentFilePath = Path.Combine(binDirectoryPath,$"Environment.{env.EnvironmentName}.txt");, allowing to set it depending to the environment (the variable comes from Startup(IHostingEnvironment env) - you might need to add a global property accessible from his code). His code should be added to all projects. Note that you can either set up ASPNETCORE_ENVIRONMENT as system environment variable or run it via commandline like dotnet run --environment "Development".

But note you can also declare environment variables in the launchSetting.json file, e.g.

"IIS Express": {
  "commandName": "IISExpress",
  "launchBrowser": true,
  "environmentVariables": {
    "Hosting:Environment": "Development"
  }
},

This JSON file holds project specific settings associated with each profile Visual Studio is configured to use to launch the application.

What is also worthwhile is to look into is the 3rd article about Various configuration json files in ASP.NET, there you can find a description of all json files that exist in current ASP.NET Core projects, and what role they are playing in your project.

It is a pitty that the inventors of .NET core didn't implement that more straightforward!

these are great resources, however, I need to change it for Multiple Projects in one click, rather than many environments, wish I had more direct answer — , Aug 21 '20 at 04:20