Add CreateWebHostBuilderMethod & AspNetCoreEnvironment setting, implement UseDocumentProvider & DocumentName

[RicoSuter]

Closes #1654, closes #1698

Update: API slightly changed/Improved by PR #1714

• Add CreateWebHostBuilderMethod setting for scenarios where no (default) Startup.cs is available
  • StartupType setting is ignored when CreateWebHostBuilderMethod is defined
• Add UseDocumentProvider setting support
  • Add DocumentName setting (default: v1)
• Add AspNetCoreEnvironment setting

Breaking changes:

• UseDocumentProvider will be set to true by default for new documents (previously it was false)
  • Old nswag.json documents without UseDocumentProvider setting will be transformed to false
  • To keep old behavior in the aspnetcore2swagger command you need to explicitly set /UseDocumentProvider:false
• Used NetFx in commands upgraded from 4.5.1 to 4.6.1

Usage of UseDocumentProvider:

[ilmax]

@RSuter Sorry for being late, I was able to try this one a bit more in depth, so I will write my findings here:

MsBuild integration
I was able to run the program, but there are a couple of issues here:

1. It will and run the program, but reading from configuration does not work because WebHost.CreateDefaultBuilder uses the current directory (which is e.g. bin/Debug/netcoreapp2.1 in my case) so I had to override it in Program.cs with:

.ConfigureAppConfiguration((context, config) =>
                {
                    config.SetBasePath(@"TheProperPath");
                })
                .UseStartup<Startup>();

2. after fixing this one, the app launches, but I got a BadImageFormatException

 System.BadImageFormatException: Could not load file or assembly 'System.Data.SqlClient, Version=4.4.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'. Reference assemblies should not be loaded for execution.  They can only be loaded in the Reflection-only loader context. (Exception from HRESULT: 0x80131058)
  File name: 'System.Data.SqlClient, Version=4.4.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' ---> System.BadImageFormatException: Cannot load a reference assembly for execution.
     at Microsoft.EntityFrameworkCore.SqlServerRetryingExecutionStrategy.ShouldRetryOn(Exception exception)
     at Microsoft.EntityFrameworkCore.Storage.ExecutionStrategy.ExecuteImplementation[TState,TResult](Func`3 operation, Func`3 verifySucceeded, TState state)
     at Microsoft.EntityFrameworkCore.Storage.ExecutionStrategy.Execute[TState,TResult](TState state, Func`3 operation, Func`3 verifySucceeded)
     at Microsoft.EntityFrameworkCore.ExecutionStrategyExtensions.Execute[TState,TResult](IExecutionStrategy strategy, Func`2 operation, Func`2 verifySucceeded, TState state)
     at Microsoft.EntityFrameworkCore.Storage.RelationalDatabaseCreator.EnsureCreated()
     at Test.Startup.Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory, IReflectedPermissionService reflectedPermissionService) in C:\Code\TicketingSolution\PortalAPI\Startup.cs:line 149
  --- End of stack trace from previous location where exception was thrown ---
     at Microsoft.AspNetCore.Hosting.ConventionBasedStartup.Configure(IApplicationBuilder app)
     at Microsoft.Extensions.DependencyInjection.IServiceCollectionExtensions.InjectApiVersionRoutePolicy.<>c__DisplayClass2_0.<Configure>b__0(IApplicationBuilder app)
     at Microsoft.AspNetCore.Hosting.Internal.WebHost.BuildApplication()

Please note I'm using the copy @ReferencePaths trick in my csproj e.g.

<Copy SourceFiles="@(ReferencePath)" DestinationFolder="$(OutDir)References" />

NSwagStudio
After setting the Environment via command line

set ASPNETCORE_ENVIRONMENT=Development
NSwagStudio.exe

Setting the new field appropriately and the correct runtime, I was able to generate the swagger document!

[RicoSuter]

It will and run the program, but reading from configuration does not work because WebHost.CreateDefaultBuilder uses the current directory (which is e.g. bin/Debug/netcoreapp2.1 in my case) so I had to override it in Program.cs with:

I think there is an option to set the working directory (WorkingDirectory setting?) - have you tried that?

[ilmax]

@RSuter yes, I've tried setting the correct location with:

.ConfigureAppConfiguration((context, config) =>
	{
		config.SetBasePath(@"TheProperPath");
	})
	.UseStartup<Startup>();

But it still result in an exception (see message above)

[RicoSuter]

Im talking about the workingDirectory setting of the nswag cli

[ilmax]

Oh, sorry I didn't get that one, I can try again and get back to you

[RicoSuter]

I'll add the AspNetCoreEnvironment setting in the next hours, fix your suggestions and merge this PR

[ilmax]

👍

[RicoSuter]

@ilmax ok, PR is ready and I now start running some integration tests with it... it should now completely cover your scenarios. Also see updated PR description.

If possible, please test with the following settings:

• use new CreateWebHostBuilderMethod setting
• use new AspNetCoreEnvironment setting
• use WorkingDirectory setting

If everything works as expected, we can merge.

[ViRuSTriNiTy]

@RicoSuter How exactly do i use the setting CreateWebHostBuilderMethod ? I cannot find any documentation. The comment in the sources stating The CreateWebHostBuilder method in the form 'assemblyName:fullTypeName.methodName' or 'fullTypeName.methodName'." is not saying much, i tried tousand different values getting various exceptions. I assume you had an example why testing this? Where can i find it?

:edit

Ok nevermind, i see that proper auto discovery is already implemented hence CreateWebHostBuilder method should be called when using the default Program.cs code ... which i do.