.net 核心集成测试：API 控制器操作未从测试中调用。 如何在测试项目中模拟开放连接身份验证？

Question

start up cs file .net core: (This is also get called while creating test server)

 public class Startup
{
    private IHostingEnvironment env;
    private Dictionary<string, string> secretlist = new Dictionary<string, string>();

    public Startup(IConfiguration configuration, IHostingEnvironment env)
    {         
        this.Configuration = configuration;
        this.CurrentEnvironment = env;

    }

    public Startup(IHostingEnvironment env)
    {
        this.env = env;
    }

    public IConfiguration Configuration { get; }

    private IHostingEnvironment CurrentEnvironment { get; set; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<FormOptions>(x =>
        {
            x.ValueLengthLimit = int.MaxValue;
            x.MultipartBodyLengthLimit = int.MaxValue;
            x.MultipartHeadersLengthLimit = int.MaxValue;
        });

        services.AddApplicationInsightsTelemetry(this.Configuration);
        services.AddSingleton<ITelemetryInitializer, AppInsightsInitializer>();

        // Adds services required for using options.
        services.AddOptions();

        services.Configure<AppSettingsConfig>(this.Configuration.GetSection("AppSettings"));

        if (this.CurrentEnvironment.IsDevelopment())
        {
            services.AddDataProtection()
               .PersistKeysToFileSystem(new DirectoryInfo(Environment.ExpandEnvironmentVariables(this.Configuration.GetValue<string>("AppSettings:KeyStorage_UNCPath"))))
               .ProtectKeysWithDpapiNG();
        }
        else
        {
            CloudStorageAccount storageAccount = new CloudStorageAccount(
                new Microsoft.WindowsAzure.Storage.Auth.StorageCredentials(
                                                 this.Configuration.GetValue<string>("AppSettings:StorageAccountName"),
                                                this.Configuration.GetValue<string>("AppSettings:StorageAccessValue")), true);

            //Create blob client
            CloudBlobClient blobClient = storageAccount.CreateCloudBlobClient();
            // Get a reference to a container named "keycontainer."
            CloudBlobContainer container = blobClient.GetContainerReference("keycontainer");
            services.AddDataProtection().PersistKeysToAzureBlobStorage(container, "keys.xml");
        }

        services.Configure<AppSettingsConfig>(options =>
        {
            if (!this.CurrentEnvironment.IsDevelopment())
            {

            }
        });

        var azureAdConfig = new AzureAdConfig();
        this.Configuration.GetSection("Authentication:AzureAd").Bind(azureAdConfig);
        services.Configure<AzureAdConfig>(this.Configuration.GetSection("Authentication:AzureAd"));

        var connectionStringsConfig = new ConnectionStringsConfig();
        connectionStringsConfig.oneConnection = this.secretlist["ConnectionStrings"];
        //this.Configuration.GetSection("ConnectionStrings").Bind(connectionStringsConfig);
        //services.Configure<ConnectionStringsConfig>(this.Configuration.GetSection("ConnectionStrings"));



        if (this.RequireAAD())
        {
            // Add framework services.
            services.Configure<MvcOptions>(options =>
            {
                options.Filters.Add(new RequireHttpsAttribute());
            });
        }
        else
        {
            services.Configure<MvcOptions>(options =>
            {
            });
        }

        // Add Authentication services.
        if (this.RequireAAD())
        {
            // Configure the OWIN pipeline to use cookie auth.
            services.AddAuthentication(options =>
            {
                options.DefaultScheme = CookieAuthenticationDefaults.AuthenticationScheme;
                options.DefaultChallengeScheme = OpenIdConnectDefaults.AuthenticationScheme;
            })
            .AddCookie()
            // Configure the OWIN pipeline to use OpenID Connect auth.
            // https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-openid-connect-code
            .AddOpenIdConnect(options =>
            {
                options.ClientId = azureAdConfig.ClientId;
                options.ClientSecret = azureAdConfig.ClientSecret;
                options.Authority = string.Format(azureAdConfig.AADInstance, azureAdConfig.Tenant);
                options.ResponseType = OpenIdConnectResponseType.CodeIdToken;
                options.Resource = azureAdConfig.ResourceURI_Graph;
                // PostLogoutRedirectUri = Configuration["AzureAd:PostLogoutRedirectUri"],
                options.Events = new AuthEvents(azureAdConfig, connectionStringsConfig);
            });




        if (this.RequireAAD())
        {
            services.AddMvc(config =>
            {
                var policy = new AuthorizationPolicyBuilder()
                                 .RequireAuthenticatedUser()
                                 .Build();
                config.Filters.Add(new Microsoft​.AspNetCore​.Mvc​.Authorization.AuthorizeFilter(policy));
                config.Filters.Add(typeof(ExceptionFilter));
            });
        }
        else
        {
            services.AddMvc();
        }
        if (this.Configuration.GetValue<bool>("API: SWITCH_ENABLE_API", true))
        {
            //services.AddScoped<IDBOperation, Operations>();
            services.AddScoped<ILookupSearch, Operations>();
            services.AddScoped<IFullSearch, Operations>();
        }

        services.AddSingleton<Common.Data.RepositoryFactories>(new Common.Data.RepositoryFactories(new Dictionary<Type, Func<DbContext, object>>
            {
                { typeof(IQueryRepository), dbcontext => new QueryRepository(dbcontext) },
                { typeof(IDomainValuesRepository), dbcontext => new DomainValuesRepository(dbcontext) },
                { typeof(IRequestsRepository), dbcontext => new RequestsRepository(dbcontext) },

                // { typeof(IoneDomainValuesRepository), dbcontext => new oneDomainValuesRepository(dbcontext) }
        }));

        services.AddTransient<Common.Contracts.IRepositoryProvider, Common.Data.RepositoryProvider>();
        services.AddScoped<one.Data.Contracts.IoneUow, one.Data.oneUow>();
        services.AddTransient<IUow,Uow>();
        // For accessing appinsights for dependency injection?
        services.AddApplicationInsightsTelemetry();

        // For Storing Tokens in DB
        services.AddDistributedSqlServerCache(o =>
        {
            o.ConnectionString = this.secretlist["ConnectionStrings"];
           // o.ConnectionString = this.Configuration.GetConnectionString("oneConnection");
            // o.ConnectionString = this.Configuration[this.Configuration.GetSection("KeyVaultSeetings")["oneConnectionString"]];
            o.SchemaName = "dbo";
            o.TableName = "CacheTable";
        });
        services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
        services.AddSingleton<IEntityExtractor, EntityExtractor>();
        services.AddScoped<ITokenCacheService, DistributedTokenCacheService>();
        services.AddScoped<ITokenService, TokenService>();
        services.AddTransient<IAPIClient,APIClient>();
    }

    /// <summary>
    ///  This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    /// </summary>
    /// <param name="app"></param>
    /// <param name="env"></param>
    /// <param name="loggerFactory"></param>
    /// <param name="tc"></param>
    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory, TelemetryClient tc)
    {
        var azureAdConfig = new AzureAdConfig();
        this.Configuration.GetSection("Authentication:AzureAd").Bind(azureAdConfig);
        loggerFactory.AddConsole(this.Configuration.GetSection("Logging"));
        loggerFactory.AddDebug();
        loggerFactory.AddProvider(new MyFilteredLoggerProvider(tc));
        loggerFactory.AddApplicationInsights(app.ApplicationServices, this.Configuration.GetValue<string>("Logging:LogLevel:Default") == "Information" ? Microsoft.Extensions.Logging.LogLevel.Information : Microsoft.Extensions.Logging.LogLevel.Warning);

        this.SetupStore(app);

        app.UseRewriter(new RewriteOptions().AddRedirectToHttps());

        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
            app.UseWebpackDevMiddleware(new WebpackDevMiddlewareOptions
            {
                HotModuleReplacement = true
            });
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }

        // TODO . Switch
        app.UseStaticFiles();

        if (this.RequireAAD())
        {
            app.UseAuthentication();
        }

        app.UseMiddleware(typeof(ErrorHandlingMiddleware));
        app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller=Home}/{action=Index}/{id?}");

            routes.MapSpaFallbackRoute(
                name: "spa-fallback",
                defaults: new { controller = "Home", action = "Index" });
        });
    }

}

Controller is decorated as :

 [Route("api/[controller]")]
    public class SearchController : BaseController

Controller Action is decorated as :

[Route("TestMethod")]
        [ActionName("TestMethod")]
        [HttpGet]
        public async Task<EmptyResult> Test()

Configuration of TestServer Test CS file :

    public DemoTest()
     {
        // Set up server configuration
        var configuration = new ConfigurationBuilder()                                                              
                            .AddJsonFile(@"appsettings.json")
                            .Build();
        // Create builder
        var builder = new WebHostBuilder()                                                     
                        .UseStartup<Startup>()
                        .UseConfiguration(configuration);
        // Create test server
        var server = new TestServer(builder);
        // Create database context
        this._context = server.Host.Services.GetService(typeof(DBContext)) as DBContext;

        // Create client to query server endpoints
        this._client = server.CreateClient();
        _client.BaseAddress = new Uri("https://localhost:44316/");
}

Test as a Fact :

  [Fact]
    public async Task Test()
    {
        try
        {

            var response = await this._client.GetAsync("/api/Search/TestMethod");
            response.EnsureSuccessStatusCode();
            var responseString = await response.Content.ReadAsStringAsync();
            //Assert.False(result != null);
        }
        catch (Exception ex)
        {
            throw;
        }

    }

Getting Status as 302 and SearchController action is not getting called. All the dependencies are resolved using start up configuration file

Any idea ???

Answer 1

You could check the content for var responseString = await response.Content.ReadAsStringAsync(); to see what the content is.

I assume it is the login page which is due to that you required Authorize .

First, try to remove the code below for a try.

services.AddMvc(config =>
        {
            //var policy = new AuthorizationPolicyBuilder()
                             .RequireAuthenticatedUser()
                             .Build();
            //config.Filters.Add(new Microsoft​.AspNetCore​.Mvc​.Authorization.AuthorizeFilter(policy));
            config.Filters.Add(typeof(ExceptionFilter));
        });

For Authentication , you will need to imitate the login process, here is a link for Identity, you could try implement your own login for AAD.

Razor Pages .NET Core 2.1 Integration Testing post authentication