Merging upstream

This commit is contained in:
nicksharp 2017-06-26 19:39:28 +01:00
commit 461ef6aa52
31 changed files with 357 additions and 176 deletions

1
.gitignore vendored
View File

@ -183,6 +183,7 @@ ClientBin/
*.dbmdl *.dbmdl
*.dbproj.schemaview *.dbproj.schemaview
*.pfx *.pfx
!idsrv3test.pfx
*.publishsettings *.publishsettings
node_modules/ node_modules/
orleans.codegen.cs orleans.codegen.cs

View File

@ -1,3 +1,4 @@
using System;
using IdentityServer4.AccessTokenValidation; using IdentityServer4.AccessTokenValidation;
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;

View File

@ -34,8 +34,6 @@ namespace Ocelot.Authentication.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.TraceMiddlewareEntry();
if (IsAuthenticatedRoute(DownstreamRoute.ReRoute)) if (IsAuthenticatedRoute(DownstreamRoute.ReRoute))
{ {
_logger.LogDebug($"{context.Request.Path} is an authenticated route. {MiddlwareName} checking if client is authenticated"); _logger.LogDebug($"{context.Request.Path} is an authenticated route. {MiddlwareName} checking if client is authenticated");
@ -46,7 +44,6 @@ namespace Ocelot.Authentication.Middleware
{ {
_logger.LogError($"Error getting authentication handler for {context.Request.Path}. {authenticationHandler.Errors.ToErrorString()}"); _logger.LogError($"Error getting authentication handler for {context.Request.Path}. {authenticationHandler.Errors.ToErrorString()}");
SetPipelineError(authenticationHandler.Errors); SetPipelineError(authenticationHandler.Errors);
_logger.TraceMiddlewareCompleted();
return; return;
} }
@ -56,11 +53,7 @@ namespace Ocelot.Authentication.Middleware
if (context.User.Identity.IsAuthenticated) if (context.User.Identity.IsAuthenticated)
{ {
_logger.LogDebug($"Client has been authenticated for {context.Request.Path}"); _logger.LogDebug($"Client has been authenticated for {context.Request.Path}");
await _next.Invoke(context);
_logger.TraceInvokeNext();
await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
} }
else else
{ {
@ -72,8 +65,6 @@ namespace Ocelot.Authentication.Middleware
_logger.LogError($"Client has NOT been authenticated for {context.Request.Path} and pipeline error set. {error.ToErrorString()}"); _logger.LogError($"Client has NOT been authenticated for {context.Request.Path} and pipeline error set. {error.ToErrorString()}");
SetPipelineError(error); SetPipelineError(error);
_logger.TraceMiddlewareCompleted();
return; return;
} }
} }
@ -81,10 +72,7 @@ namespace Ocelot.Authentication.Middleware
{ {
_logger.LogTrace($"No authentication needed for {context.Request.Path}"); _logger.LogTrace($"No authentication needed for {context.Request.Path}");
_logger.TraceInvokeNext(); await _next.Invoke(context);
await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
} }
} }

View File

@ -33,8 +33,6 @@ namespace Ocelot.Authorisation.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started authorisation");
if (IsAuthenticatedRoute(DownstreamRoute.ReRoute)) if (IsAuthenticatedRoute(DownstreamRoute.ReRoute))
{ {
_logger.LogDebug("route is authenticated scopes must be checked"); _logger.LogDebug("route is authenticated scopes must be checked");
@ -73,7 +71,7 @@ namespace Ocelot.Authorisation.Middleware
if (authorised.IsError) if (authorised.IsError)
{ {
_logger.LogDebug("error authorising user"); _logger.LogDebug($"Error whilst authorising {context.User.Identity.Name} for {context.User.Identity.Name}. Setting pipeline error");
SetPipelineError(authorised.Errors); SetPipelineError(authorised.Errors);
return; return;
@ -81,30 +79,23 @@ namespace Ocelot.Authorisation.Middleware
if (IsAuthorised(authorised)) if (IsAuthorised(authorised))
{ {
_logger.LogDebug("user is authorised calling next middleware"); _logger.LogDebug($"{context.User.Identity.Name} has succesfully been authorised for {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}. Calling next middleware");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
else else
{ {
_logger.LogDebug("user is not authorised setting pipeline error"); _logger.LogDebug($"{context.User.Identity.Name} is not authorised to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}. Setting pipeline error");
SetPipelineError(new List<Error> SetPipelineError(new List<Error>
{ {
new UnauthorisedError( new UnauthorisedError($"{context.User.Identity.Name} is not authorised to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}")
$"{context.User.Identity.Name} unable to access {DownstreamRoute.ReRoute.UpstreamPathTemplate.Value}")
}); });
} }
} }
else else
{ {
_logger.LogDebug("AuthorisationMiddleware.Invoke route is not authorised calling next middleware"); _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} route does not require user to be authorised");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
} }

View File

@ -54,8 +54,6 @@ namespace Ocelot.Cache.Middleware
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
if (PipelineError) if (PipelineError)
{ {
_logger.LogDebug("there was a pipeline error for {downstreamUrlKey}", downstreamUrlKey); _logger.LogDebug("there was a pipeline error for {downstreamUrlKey}", downstreamUrlKey);

View File

@ -26,8 +26,6 @@ namespace Ocelot.Claims.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started claims middleware");
if (DownstreamRoute.ReRoute.ClaimsToClaims.Any()) if (DownstreamRoute.ReRoute.ClaimsToClaims.Any())
{ {
_logger.LogDebug("this route has instructions to convert claims to other claims"); _logger.LogDebug("this route has instructions to convert claims to other claims");
@ -42,12 +40,7 @@ namespace Ocelot.Claims.Middleware
return; return;
} }
} }
_logger.LogDebug("calling next middleware");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
} }
} }

View File

@ -13,6 +13,8 @@ namespace Ocelot.Configuration.Creator
var username = Environment.GetEnvironmentVariable("OCELOT_USERNAME"); var username = Environment.GetEnvironmentVariable("OCELOT_USERNAME");
var hash = Environment.GetEnvironmentVariable("OCELOT_HASH"); var hash = Environment.GetEnvironmentVariable("OCELOT_HASH");
var salt = Environment.GetEnvironmentVariable("OCELOT_SALT"); var salt = Environment.GetEnvironmentVariable("OCELOT_SALT");
var credentialsSigningCertificateLocation = Environment.GetEnvironmentVariable("OCELOT_CERTIFICATE");
var credentialsSigningCertificatePassword = Environment.GetEnvironmentVariable("OCELOT_CERTIFICATE_PASSWORD");
return new IdentityServerConfiguration( return new IdentityServerConfiguration(
"admin", "admin",
@ -28,7 +30,9 @@ namespace Ocelot.Configuration.Creator
new List<User> new List<User>
{ {
new User("admin", username, hash, salt) new User("admin", username, hash, salt)
} },
credentialsSigningCertificateLocation,
credentialsSigningCertificatePassword
); );
} }
} }

View File

@ -17,5 +17,7 @@ namespace Ocelot.Configuration.Provider
AccessTokenType AccessTokenType {get;} AccessTokenType AccessTokenType {get;}
bool RequireClientSecret {get;} bool RequireClientSecret {get;}
List<User> Users {get;} List<User> Users {get;}
string CredentialsSigningCertificateLocation { get; }
string CredentialsSigningCertificatePassword { get; }
} }
} }

View File

@ -17,7 +17,7 @@ namespace Ocelot.Configuration.Provider
IEnumerable<string> grantType, IEnumerable<string> grantType,
AccessTokenType accessTokenType, AccessTokenType accessTokenType,
bool requireClientSecret, bool requireClientSecret,
List<User> users) List<User> users, string credentialsSigningCertificateLocation, string credentialsSigningCertificatePassword)
{ {
ApiName = apiName; ApiName = apiName;
RequireHttps = requireHttps; RequireHttps = requireHttps;
@ -30,6 +30,8 @@ namespace Ocelot.Configuration.Provider
AccessTokenType = accessTokenType; AccessTokenType = accessTokenType;
RequireClientSecret = requireClientSecret; RequireClientSecret = requireClientSecret;
Users = users; Users = users;
CredentialsSigningCertificateLocation = credentialsSigningCertificateLocation;
CredentialsSigningCertificatePassword = credentialsSigningCertificatePassword;
} }
public string ApiName { get; private set; } public string ApiName { get; private set; }
@ -43,5 +45,7 @@ namespace Ocelot.Configuration.Provider
public AccessTokenType AccessTokenType {get;private set;} public AccessTokenType AccessTokenType {get;private set;}
public bool RequireClientSecret {get;private set;} public bool RequireClientSecret {get;private set;}
public List<User> Users {get;private set;} public List<User> Users {get;private set;}
public string CredentialsSigningCertificateLocation { get; private set; }
public string CredentialsSigningCertificatePassword { get; private set; }
} }
} }

View File

@ -41,6 +41,8 @@ using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Net.Http; using System.Net.Http;
using System.Reflection; using System.Reflection;
using System.Security.Cryptography.X509Certificates;
using Microsoft.IdentityModel.Tokens;
using Ocelot.Configuration; using Ocelot.Configuration;
using FileConfigurationProvider = Ocelot.Configuration.Provider.FileConfigurationProvider; using FileConfigurationProvider = Ocelot.Configuration.Provider.FileConfigurationProvider;
@ -87,8 +89,10 @@ namespace Ocelot.DependencyInjection
{ {
services.TryAddSingleton<IIdentityServerConfiguration>(identityServerConfiguration); services.TryAddSingleton<IIdentityServerConfiguration>(identityServerConfiguration);
services.TryAddSingleton<IHashMatcher, HashMatcher>(); services.TryAddSingleton<IHashMatcher, HashMatcher>();
services.AddIdentityServer() var identityServerBuilder = services
.AddTemporarySigningCredential() .AddIdentityServer(options => {
options.IssuerUri = "Ocelot";
})
.AddInMemoryApiResources(new List<ApiResource> .AddInMemoryApiResources(new List<ApiResource>
{ {
new ApiResource new ApiResource
@ -120,6 +124,16 @@ namespace Ocelot.DependencyInjection
RequireClientSecret = identityServerConfiguration.RequireClientSecret RequireClientSecret = identityServerConfiguration.RequireClientSecret
} }
}).AddResourceOwnerValidator<OcelotResourceOwnerPasswordValidator>(); }).AddResourceOwnerValidator<OcelotResourceOwnerPasswordValidator>();
if (string.IsNullOrEmpty(identityServerConfiguration.CredentialsSigningCertificateLocation) || string.IsNullOrEmpty(identityServerConfiguration.CredentialsSigningCertificatePassword))
{
identityServerBuilder.AddTemporarySigningCredential();
}
else
{
var cert = new X509Certificate2(identityServerConfiguration.CredentialsSigningCertificateLocation, identityServerConfiguration.CredentialsSigningCertificatePassword);
identityServerBuilder.AddSigningCredential(cert);
}
} }
var assembly = typeof(FileConfigurationController).GetTypeInfo().Assembly; var assembly = typeof(FileConfigurationController).GetTypeInfo().Assembly;
@ -169,6 +183,11 @@ namespace Ocelot.DependencyInjection
services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>(); services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();
services.TryAddScoped<IRequestScopedDataRepository, HttpDataRepository>(); services.TryAddScoped<IRequestScopedDataRepository, HttpDataRepository>();
services.AddMemoryCache(); services.AddMemoryCache();
//Used to log the the start and ending of middleware
services.TryAddSingleton<OcelotDiagnosticListener>();
services.AddMiddlewareAnalysis();
return services; return services;
} }
} }

View File

@ -30,8 +30,6 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.TraceMiddlewareEntry();
var upstreamUrlPath = context.Request.Path.ToString().SetLastCharacterAs('/'); var upstreamUrlPath = context.Request.Path.ToString().SetLastCharacterAs('/');
_logger.LogDebug("upstream url path is {upstreamUrlPath}", upstreamUrlPath); _logger.LogDebug("upstream url path is {upstreamUrlPath}", upstreamUrlPath);
@ -43,8 +41,6 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
_logger.LogError($"{MiddlwareName} setting pipeline errors. IDownstreamRouteFinder returned {downstreamRoute.Errors.ToErrorString()}"); _logger.LogError($"{MiddlwareName} setting pipeline errors. IDownstreamRouteFinder returned {downstreamRoute.Errors.ToErrorString()}");
SetPipelineError(downstreamRoute.Errors); SetPipelineError(downstreamRoute.Errors);
_logger.TraceMiddlewareCompleted();
return; return;
} }
@ -52,12 +48,7 @@ namespace Ocelot.DownstreamRouteFinder.Middleware
SetDownstreamRouteForThisRequest(downstreamRoute.Data); SetDownstreamRouteForThisRequest(downstreamRoute.Data);
_logger.TraceInvokeNext();
await _next.Invoke(context); await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
} }
} }
} }

View File

@ -30,8 +30,6 @@ namespace Ocelot.DownstreamUrlCreator.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started calling downstream url creator middleware");
var dsPath = _replacer var dsPath = _replacer
.Replace(DownstreamRoute.ReRoute.DownstreamPathTemplate, DownstreamRoute.TemplatePlaceholderNameAndValues); .Replace(DownstreamRoute.ReRoute.DownstreamPathTemplate, DownstreamRoute.TemplatePlaceholderNameAndValues);
@ -53,11 +51,7 @@ namespace Ocelot.DownstreamUrlCreator.Middleware
_logger.LogDebug("downstream url is {downstreamUrl.Data.Value}", DownstreamRequest.RequestUri); _logger.LogDebug("downstream url is {downstreamUrl.Data.Value}", DownstreamRequest.RequestUri);
_logger.LogDebug("calling next middleware");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
} }
} }

View File

@ -26,17 +26,15 @@ namespace Ocelot.Headers.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started calling headers builder middleware");
if (DownstreamRoute.ReRoute.ClaimsToHeaders.Any()) if (DownstreamRoute.ReRoute.ClaimsToHeaders.Any())
{ {
_logger.LogDebug("this route has instructions to convert claims to headers"); _logger.LogDebug($"{ DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} has instructions to convert claims to headers");
var response = _addHeadersToRequest.SetHeadersOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToHeaders, context.User.Claims, DownstreamRequest); var response = _addHeadersToRequest.SetHeadersOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToHeaders, context.User.Claims, DownstreamRequest);
if (response.IsError) if (response.IsError)
{ {
_logger.LogDebug("there was an error setting headers on context, setting pipeline error"); _logger.LogDebug("Error setting headers on context, setting pipeline error");
SetPipelineError(response.Errors); SetPipelineError(response.Errors);
return; return;
@ -45,11 +43,7 @@ namespace Ocelot.Headers.Middleware
_logger.LogDebug("headers have been set on context"); _logger.LogDebug("headers have been set on context");
} }
_logger.LogDebug("calling next middleware");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
} }
} }

View File

@ -28,11 +28,10 @@ namespace Ocelot.LoadBalancer.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started calling load balancing middleware");
var loadBalancer = _loadBalancerHouse.Get(DownstreamRoute.ReRoute.ReRouteKey); var loadBalancer = _loadBalancerHouse.Get(DownstreamRoute.ReRoute.ReRouteKey);
if(loadBalancer.IsError) if(loadBalancer.IsError)
{ {
_logger.LogDebug("there was an error retriving the loadbalancer, setting pipeline error");
SetPipelineError(loadBalancer.Errors); SetPipelineError(loadBalancer.Errors);
return; return;
} }
@ -40,6 +39,7 @@ namespace Ocelot.LoadBalancer.Middleware
var hostAndPort = await loadBalancer.Data.Lease(); var hostAndPort = await loadBalancer.Data.Lease();
if(hostAndPort.IsError) if(hostAndPort.IsError)
{ {
_logger.LogDebug("there was an error leasing the loadbalancer, setting pipeline error");
SetPipelineError(hostAndPort.Errors); SetPipelineError(hostAndPort.Errors);
return; return;
} }
@ -52,23 +52,19 @@ namespace Ocelot.LoadBalancer.Middleware
} }
DownstreamRequest.RequestUri = uriBuilder.Uri; DownstreamRequest.RequestUri = uriBuilder.Uri;
_logger.LogDebug("calling next middleware");
try try
{ {
await _next.Invoke(context); await _next.Invoke(context);
loadBalancer.Data.Release(hostAndPort.Data);
} }
catch (Exception) catch (Exception)
{ {
loadBalancer.Data.Release(hostAndPort.Data); _logger.LogDebug("Exception calling next middleware, exception will be thrown to global handler");
_logger.LogDebug("error calling next middleware, exception will be thrown to global handler");
throw; throw;
} }
finally
_logger.LogDebug("succesfully called next middleware"); {
loadBalancer.Data.Release(hostAndPort.Data);
}
} }
} }
} }

View File

@ -0,0 +1,34 @@
using System;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DiagnosticAdapter;
namespace Ocelot.Logging
{
public class OcelotDiagnosticListener
{
private IOcelotLogger _logger;
public OcelotDiagnosticListener(IOcelotLoggerFactory factory)
{
_logger = factory.CreateLogger<OcelotDiagnosticListener>();
}
[DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareStarting")]
public virtual void OnMiddlewareStarting(HttpContext httpContext, string name)
{
_logger.LogTrace($"MiddlewareStarting: {name}; {httpContext.Request.Path}");
}
[DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareException")]
public virtual void OnMiddlewareException(Exception exception, string name)
{
_logger.LogTrace($"MiddlewareException: {name}; {exception.Message}");
}
[DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareFinished")]
public virtual void OnMiddlewareFinished(HttpContext httpContext, string name)
{
_logger.LogTrace($"MiddlewareFinished: {name}; {httpContext.Response.StatusCode}");
}
}
}

View File

@ -1,29 +0,0 @@
using System;
using System.Collections.Generic;
using System.Text;
namespace Ocelot.Logging
{
public static class OcelotLoggerExtensions
{
public static void TraceMiddlewareEntry(this IOcelotLogger logger)
{
logger.LogTrace($"entered {logger.Name}");
}
public static void TraceInvokeNext(this IOcelotLogger logger)
{
logger.LogTrace($"invoking next middleware from {logger.Name}");
}
public static void TraceInvokeNextCompleted(this IOcelotLogger logger)
{
logger.LogTrace($"returned to {logger.Name} after next middleware completed");
}
public static void TraceMiddlewareCompleted(this IOcelotLogger logger)
{
logger.LogTrace($"completed {logger.Name}");
}
}
}

View File

@ -1,4 +1,5 @@
using System.Collections.Generic; using System.Collections.Generic;
using System.Diagnostics;
using IdentityServer4.AccessTokenValidation; using IdentityServer4.AccessTokenValidation;
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Builder;
using Ocelot.Authentication.Middleware; using Ocelot.Authentication.Middleware;
@ -8,6 +9,7 @@ using Ocelot.DownstreamRouteFinder.Middleware;
using Ocelot.DownstreamUrlCreator.Middleware; using Ocelot.DownstreamUrlCreator.Middleware;
using Ocelot.Errors.Middleware; using Ocelot.Errors.Middleware;
using Ocelot.Headers.Middleware; using Ocelot.Headers.Middleware;
using Ocelot.Logging;
using Ocelot.QueryStrings.Middleware; using Ocelot.QueryStrings.Middleware;
using Ocelot.Request.Middleware; using Ocelot.Request.Middleware;
using Ocelot.Requester.Middleware; using Ocelot.Requester.Middleware;
@ -53,6 +55,8 @@ namespace Ocelot.Middleware
{ {
await CreateAdministrationArea(builder); await CreateAdministrationArea(builder);
ConfigureDiagnosticListener(builder);
// This is registered to catch any global exceptions that are not handled // This is registered to catch any global exceptions that are not handled
builder.UseExceptionHandlerMiddleware(); builder.UseExceptionHandlerMiddleware();
@ -181,7 +185,6 @@ namespace Ocelot.Middleware
builder.Map(configuration.AdministrationPath, app => builder.Map(configuration.AdministrationPath, app =>
{ {
var identityServerUrl = $"{baseSchemeUrlAndPort}/{configuration.AdministrationPath.Remove(0,1)}"; var identityServerUrl = $"{baseSchemeUrlAndPort}/{configuration.AdministrationPath.Remove(0,1)}";
app.UseIdentityServerAuthentication(new IdentityServerAuthenticationOptions app.UseIdentityServerAuthentication(new IdentityServerAuthenticationOptions
{ {
Authority = identityServerUrl, Authority = identityServerUrl,
@ -206,5 +209,22 @@ namespace Ocelot.Middleware
builder.Use(middleware); builder.Use(middleware);
} }
} }
/// <summary>
/// Configure a DiagnosticListener to listen for diagnostic events when the middleware starts and ends
/// </summary>
/// <param name="builder"></param>
private static void ConfigureDiagnosticListener(IApplicationBuilder builder)
{
var env = (IHostingEnvironment)builder.ApplicationServices.GetService(typeof(IHostingEnvironment));
//https://github.com/TomPallister/Ocelot/pull/87 not sure why only for dev envs and marc disapeered so just merging and maybe change one day?
if (!env.IsProduction())
{
var listener = (OcelotDiagnosticListener)builder.ApplicationServices.GetService(typeof(OcelotDiagnosticListener));
var diagnosticListener = (DiagnosticListener)builder.ApplicationServices.GetService(typeof(DiagnosticListener));
diagnosticListener.SubscribeWithAdapter(listener);
}
}
} }
} }

View File

@ -26,10 +26,12 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.MiddlewareAnalysis" Version="1.1.1" />
<PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" /> <PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.DiagnosticAdapter" Version="1.1.0" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.1.1" />

View File

@ -26,11 +26,9 @@ namespace Ocelot.QueryStrings.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.LogDebug("started calling query string builder middleware");
if (DownstreamRoute.ReRoute.ClaimsToQueries.Any()) if (DownstreamRoute.ReRoute.ClaimsToQueries.Any())
{ {
_logger.LogDebug("this route has instructions to convert claims to queries"); _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate.Value} has instructions to convert claims to queries");
var response = _addQueriesToRequest.SetQueriesOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToQueries, context.User.Claims, DownstreamRequest); var response = _addQueriesToRequest.SetQueriesOnDownstreamRequest(DownstreamRoute.ReRoute.ClaimsToQueries, context.User.Claims, DownstreamRequest);
@ -43,11 +41,7 @@ namespace Ocelot.QueryStrings.Middleware
} }
} }
_logger.LogDebug("calling next middleware");
await _next.Invoke(context); await _next.Invoke(context);
_logger.LogDebug("succesfully called next middleware");
} }
} }
} }

View File

@ -31,18 +31,12 @@ namespace Ocelot.RateLimit.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.TraceMiddlewareEntry();
var options = DownstreamRoute.ReRoute.RateLimitOptions; var options = DownstreamRoute.ReRoute.RateLimitOptions;
// check if rate limiting is enabled // check if rate limiting is enabled
if (!DownstreamRoute.ReRoute.EnableEndpointEndpointRateLimiting) if (!DownstreamRoute.ReRoute.EnableEndpointEndpointRateLimiting)
{ {
_logger.LogDebug($"EndpointRateLimiting is not enabled for {DownstreamRoute.ReRoute.DownstreamPathTemplate}"); _logger.LogDebug($"EndpointRateLimiting is not enabled for {DownstreamRoute.ReRoute.DownstreamPathTemplate}");
_logger.TraceInvokeNext();
await _next.Invoke(context); await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
return; return;
} }
// compute identity from request // compute identity from request
@ -52,11 +46,7 @@ namespace Ocelot.RateLimit.Middleware
if (IsWhitelisted(identity, options)) if (IsWhitelisted(identity, options))
{ {
_logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate} is white listed from rate limiting"); _logger.LogDebug($"{DownstreamRoute.ReRoute.DownstreamPathTemplate} is white listed from rate limiting");
_logger.TraceInvokeNext();
await _next.Invoke(context); await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
return; return;
} }
@ -78,7 +68,6 @@ namespace Ocelot.RateLimit.Middleware
var retrystring = retryAfter.ToString(System.Globalization.CultureInfo.InvariantCulture); var retrystring = retryAfter.ToString(System.Globalization.CultureInfo.InvariantCulture);
// break execution // break execution
await ReturnQuotaExceededResponse(context, options, retrystring); await ReturnQuotaExceededResponse(context, options, retrystring);
_logger.TraceMiddlewareCompleted();
return; return;
} }
@ -91,10 +80,7 @@ namespace Ocelot.RateLimit.Middleware
context.Response.OnStarting(SetRateLimitHeaders, state: headers); context.Response.OnStarting(SetRateLimitHeaders, state: headers);
} }
_logger.TraceInvokeNext();
await _next.Invoke(context); await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
} }
public virtual ClientRequestIdentity SetIdentity(HttpContext httpContext, RateLimitOptions option) public virtual ClientRequestIdentity SetIdentity(HttpContext httpContext, RateLimitOptions option)

View File

@ -20,7 +20,7 @@ namespace Ocelot.RequestId.Middleware
public RequestIdMiddleware(RequestDelegate next, public RequestIdMiddleware(RequestDelegate next,
IOcelotLoggerFactory loggerFactory, IOcelotLoggerFactory loggerFactory,
IRequestScopedDataRepository requestScopedDataRepository) IRequestScopedDataRepository requestScopedDataRepository)
:base(requestScopedDataRepository) : base(requestScopedDataRepository)
{ {
_next = next; _next = next;
_logger = loggerFactory.CreateLogger<RequestIdMiddleware>(); _logger = loggerFactory.CreateLogger<RequestIdMiddleware>();
@ -29,14 +29,8 @@ namespace Ocelot.RequestId.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.TraceMiddlewareEntry();
SetOcelotRequestId(context); SetOcelotRequestId(context);
await _next.Invoke(context);
_logger.TraceInvokeNext();
await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
_logger.TraceMiddlewareCompleted();
} }
private void SetOcelotRequestId(HttpContext context) private void SetOcelotRequestId(HttpContext context)

View File

@ -34,10 +34,7 @@ namespace Ocelot.Responder.Middleware
public async Task Invoke(HttpContext context) public async Task Invoke(HttpContext context)
{ {
_logger.TraceMiddlewareEntry(); await _next.Invoke(context);
_logger.TraceInvokeNext();
await _next.Invoke(context);
_logger.TraceInvokeNextCompleted();
if (PipelineError) if (PipelineError)
{ {
@ -51,7 +48,6 @@ namespace Ocelot.Responder.Middleware
_logger.LogDebug("no pipeline errors, setting and returning completed response"); _logger.LogDebug("no pipeline errors, setting and returning completed response");
await _responder.SetResponseOnHttpContext(context, HttpResponseMessage); await _responder.SetResponseOnHttpContext(context, HttpResponseMessage);
} }
_logger.TraceMiddlewareCompleted();
} }
private void SetErrorResponse(HttpContext context, List<Error> errors) private void SetErrorResponse(HttpContext context, List<Error> errors)

View File

@ -15,7 +15,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<None Update="configuration.json"> <None Update="configuration.json;appsettings.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None> </None>
</ItemGroup> </ItemGroup>

View File

@ -0,0 +1,10 @@
{
"Logging": {
"IncludeScopes": true,
"LogLevel": {
"Default": "Error",
"System": "Error",
"Microsoft": "Error"
}
}
}

View File

@ -19,15 +19,19 @@ namespace Ocelot.IntegrationTests
public class AdministrationTests : IDisposable public class AdministrationTests : IDisposable
{ {
private readonly HttpClient _httpClient; private readonly HttpClient _httpClient;
private readonly HttpClient _httpClientTwo;
private HttpResponseMessage _response; private HttpResponseMessage _response;
private IWebHost _builder; private IWebHost _builder;
private IWebHostBuilder _webHostBuilder; private IWebHostBuilder _webHostBuilder;
private readonly string _ocelotBaseUrl; private readonly string _ocelotBaseUrl;
private BearerToken _token; private BearerToken _token;
private IWebHostBuilder _webHostBuilderTwo;
private IWebHost _builderTwo;
public AdministrationTests() public AdministrationTests()
{ {
_httpClient = new HttpClient(); _httpClient = new HttpClient();
_httpClientTwo = new HttpClient();
_ocelotBaseUrl = "http://localhost:5000"; _ocelotBaseUrl = "http://localhost:5000";
_httpClient.BaseAddress = new Uri(_ocelotBaseUrl); _httpClient.BaseAddress = new Uri(_ocelotBaseUrl);
} }
@ -70,6 +74,27 @@ namespace Ocelot.IntegrationTests
.BDDfy(); .BDDfy();
} }
[Fact]
public void should_be_able_to_use_token_from_ocelot_a_on_ocelot_b()
{
var configuration = new FileConfiguration
{
GlobalConfiguration = new FileGlobalConfiguration
{
AdministrationPath = "/administration"
}
};
this.Given(x => GivenThereIsAConfiguration(configuration))
.And(x => GivenIdentityServerSigningEnvironmentalVariablesAreSet())
.And(x => GivenOcelotIsRunning())
.And(x => GivenIHaveAnOcelotToken("/administration"))
.And(x => GivenAnotherOcelotIsRunning("http://localhost:5007"))
.When(x => WhenIGetUrlOnTheSecondOcelot("/administration/configuration"))
.Then(x => ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.BDDfy();
}
[Fact] [Fact]
public void should_return_file_configuration() public void should_return_file_configuration()
{ {
@ -193,6 +218,36 @@ namespace Ocelot.IntegrationTests
.BDDfy(); .BDDfy();
} }
private void GivenAnotherOcelotIsRunning(string baseUrl)
{
_httpClientTwo.BaseAddress = new Uri(baseUrl);
_webHostBuilderTwo = new WebHostBuilder()
.UseUrls(baseUrl)
.UseKestrel()
.UseContentRoot(Directory.GetCurrentDirectory())
.ConfigureServices(x => {
x.AddSingleton(_webHostBuilderTwo);
})
.UseStartup<Startup>();
_builderTwo = _webHostBuilderTwo.Build();
_builderTwo.Start();
}
private void GivenIdentityServerSigningEnvironmentalVariablesAreSet()
{
Environment.SetEnvironmentVariable("OCELOT_CERTIFICATE", "idsrv3test.pfx");
Environment.SetEnvironmentVariable("OCELOT_CERTIFICATE_PASSWORD", "idsrv3test");
}
private void WhenIGetUrlOnTheSecondOcelot(string url)
{
_httpClientTwo.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", _token.AccessToken);
_response = _httpClientTwo.GetAsync(url).Result;
}
private void WhenIPostOnTheApiGateway(string url, FileConfiguration updatedConfiguration) private void WhenIPostOnTheApiGateway(string url, FileConfiguration updatedConfiguration)
{ {
var json = JsonConvert.SerializeObject(updatedConfiguration); var json = JsonConvert.SerializeObject(updatedConfiguration);
@ -305,6 +360,8 @@ namespace Ocelot.IntegrationTests
public void Dispose() public void Dispose()
{ {
Environment.SetEnvironmentVariable("OCELOT_CERTIFICATE", "");
Environment.SetEnvironmentVariable("OCELOT_CERTIFICATE_PASSWORD", "");
_builder?.Dispose(); _builder?.Dispose();
_httpClient?.Dispose(); _httpClient?.Dispose();
} }

View File

@ -15,7 +15,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<None Update="configuration.json;appsettings.json"> <None Update="configuration.json;appsettings.json;idsrv3test.pfx">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None> </None>
</ItemGroup> </ItemGroup>

View File

@ -3,8 +3,8 @@
"IncludeScopes": true, "IncludeScopes": true,
"LogLevel": { "LogLevel": {
"Default": "Error", "Default": "Error",
"System": "Information", "System": "Error",
"Microsoft": "Information" "Microsoft": "Error"
} }
} }
} }

Binary file not shown.

View File

@ -0,0 +1,16 @@
using Ocelot.Configuration.Creator;
using Shouldly;
using Xunit;
namespace Ocelot.UnitTests.Configuration
{
public class IdentityServerConfigurationCreatorTests
{
[Fact]
public void happy_path_only_exists_for_test_coverage_even_uncle_bob_probably_wouldnt_test_this()
{
var result = IdentityServerConfigurationCreator.GetIdentityServerConfiguration();
result.ApiName.ShouldBe("admin");
}
}
}

View File

@ -0,0 +1,125 @@
using System;
using System.IO;
using System.Net;
using System.Net.Http;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
using Moq;
using Ocelot.DownstreamRouteFinder;
using Ocelot.DownstreamUrlCreator;
using Ocelot.DownstreamUrlCreator.UrlTemplateReplacer;
using Ocelot.Errors.Middleware;
using Ocelot.Infrastructure.RequestData;
using Ocelot.Logging;
using Ocelot.Responses;
using Ocelot.Values;
using Shouldly;
using TestStack.BDDfy;
using Xunit;
namespace Ocelot.UnitTests.Errors
{
public class ExceptionHandlerMiddlewareTests
{
private readonly Mock<IRequestScopedDataRepository> _scopedRepository;
private readonly string _url;
private TestServer _server;
private HttpClient _client;
private HttpResponseMessage _result;
public ExceptionHandlerMiddlewareTests()
{
_url = "http://localhost:52879";
_scopedRepository = new Mock<IRequestScopedDataRepository>();
}
[Fact]
public void should_call_next_middleware()
{
this.Given(_ => GivenASuccessfulRequest())
.When(_ => WhenIMakeTheRequest())
.Then(_ => ThenTheResponseIsOk())
.BDDfy();
}
[Fact]
public void should_call_return_error()
{
this.Given(_ => GivenAnError())
.When(_ => WhenIMakeTheRequest())
.Then(_ => ThenTheResponseIsError())
.BDDfy();
}
private void ThenTheResponseIsOk()
{
_result.StatusCode.ShouldBe(HttpStatusCode.OK);
}
private void ThenTheResponseIsError()
{
_result.StatusCode.ShouldBe(HttpStatusCode.InternalServerError);
}
private void WhenIMakeTheRequest()
{
_result = _client.GetAsync("/").Result;
}
private void GivenASuccessfulRequest()
{
var builder = new WebHostBuilder()
.ConfigureServices(x =>
{
x.AddSingleton<IOcelotLoggerFactory, AspDotNetLoggerFactory>();
x.AddLogging();
x.AddSingleton(_scopedRepository.Object);
})
.UseUrls(_url)
.UseKestrel()
.UseContentRoot(Directory.GetCurrentDirectory())
.UseIISIntegration()
.UseUrls(_url)
.Configure(app =>
{
app.UseExceptionHandlerMiddleware();
app.Run(async context =>
{
context.Response.StatusCode = 200;
});
});
_server = new TestServer(builder);
_client = _server.CreateClient();
}
private void GivenAnError()
{
var builder = new WebHostBuilder()
.ConfigureServices(x =>
{
x.AddSingleton<IOcelotLoggerFactory, AspDotNetLoggerFactory>();
x.AddLogging();
x.AddSingleton(_scopedRepository.Object);
})
.UseUrls(_url)
.UseKestrel()
.UseContentRoot(Directory.GetCurrentDirectory())
.UseIISIntegration()
.UseUrls(_url)
.Configure(app =>
{
app.UseExceptionHandlerMiddleware();
app.Use(async (context, next) =>
{
throw new Exception("BOOM");
});
});
_server = new TestServer(builder);
_client = _server.CreateClient();
}
}
}