Add options

Author: NikiforovAll

DebugViewEndpoint.sln

@@ -13,8 +13,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
-		appveyor.yml = appveyor.yml
-		azure-pipelines.yml = azure-pipelines.yml
 		build.cake = build.cake
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets

README.md

@@ -26,13 +26,8 @@ After:
 ```csharp
 app.UseEndpoints(endpoints =>
 {
-    endpoints.MapConfigurationDebugView("/config");
+    endpoints.MapConfigurationDebugView("/config", (options) => options.AllowDevelopmentOnly = true);
 });
 ```
 
-## TODO
-
-* core impl
-* options to control (?)
-  * enable for env
-* samples based on `dotnet/samples`
+For more examples, please see: [tests](.\Tests\ConfigurationDebugViewEndpoint.Test\EndpointRouteBuilderExtensionsTests.cs)

Samples/webapi-net5/.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (web)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/bin/Debug/net5.0/WebEmpty.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}",
+            "stopAtEntry": false,
+            "serverReadyAction": {
+                "action": "openExternally",
+                "pattern": "\\\\bNow listening on:\\\\s+(https?://\\\\S+)"
+            },
+            "env": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            },
+            "sourceFileMap": {
+                "/Views": "${workspaceFolder}/Views"
+            }
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach",
+            "processId": "${command:pickProcess}"
+        },
+        {
+            "name": "Docker .NET Core Launch",
+            "type": "docker",
+            "request": "launch",
+            "preLaunchTask": "docker-run: debug",
+            "netCore": {
+                "appProject": "${workspaceFolder}/WebEmpty.csproj"
+            }
+        }
+    ]
+}

Samples/webapi-net5/.vscode/tasks.json

@@ -0,0 +1,98 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/WebEmpty.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/WebEmpty.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "${workspaceFolder}/WebEmpty.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "type": "docker-build",
+            "label": "docker-build: debug",
+            "dependsOn": [
+                "build"
+            ],
+            "dockerBuild": {
+                "tag": "webapinet5:dev",
+                "target": "base",
+                "dockerfile": "${workspaceFolder}/Dockerfile",
+                "context": "${workspaceFolder}",
+                "pull": true
+            },
+            "netCore": {
+                "appProject": "${workspaceFolder}/WebEmpty.csproj"
+            }
+        },
+        {
+            "type": "docker-build",
+            "label": "docker-build: release",
+            "dependsOn": [
+                "build"
+            ],
+            "dockerBuild": {
+                "tag": "webapinet5:latest",
+                "dockerfile": "${workspaceFolder}/Dockerfile",
+                "context": "${workspaceFolder}",
+                "pull": true
+            },
+            "netCore": {
+                "appProject": "${workspaceFolder}/WebEmpty.csproj"
+            }
+        },
+        {
+            "type": "docker-run",
+            "label": "docker-run: debug",
+            "dependsOn": [
+                "docker-build: debug"
+            ],
+            "dockerRun": {},
+            "netCore": {
+                "appProject": "${workspaceFolder}/WebEmpty.csproj",
+                "enableDebugging": true
+            }
+        },
+        {
+            "type": "docker-run",
+            "label": "docker-run: release",
+            "dependsOn": [
+                "docker-build: release"
+            ],
+            "dockerRun": {},
+            "netCore": {
+                "appProject": "${workspaceFolder}/WebEmpty.csproj"
+            }
+        }
+    ]
+}

Source/ConfigurationDebugViewEndpoint/ConfigurationDebugViewOptions.cs

@@ -0,0 +1,14 @@
+namespace ConfigurationDebugViewEndpoint
+{
+    /// <summary>
+    /// Contains options for the <see cref="ConfigurationDebugViewMiddleware"/>.
+    /// </summary>
+    public class ConfigurationDebugViewOptions
+    {
+        /// <summary>
+        /// Gets or sets a value that controls whether to use <see cref="ConfigurationDebugViewMiddleware"/>
+        /// exclusively on Development environment.
+        /// </summary>
+        public bool AllowDevelopmentOnly { get; set; }
+    }
+}

Source/ConfigurationDebugViewEndpoint/EndpointRouteBuilderExtensions.cs

@@ -3,6 +3,8 @@ namespace ConfigurationDebugViewEndpoint.Extensions
     using System;
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.Routing;
+    using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Hosting;
 
     /// <summary>
     /// Provides extension methods for <see cref="IEndpointRouteBuilder"/> to add routes.
@@ -14,24 +16,36 @@ public static class EndpointRouteBuilderExtensions
         /// </summary>
         /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/> to add endpoint to.</param>
         /// <param name="pattern">The URL pattern of the endpoint.</param>
+        /// <param name="optionsDelegate"></param>
         /// <returns>A route for the endpoint.</returns>
-        public static IEndpointConventionBuilder MapConfigurationDebugView(
+        public static IEndpointConventionBuilder? MapConfigurationDebugView(
             this IEndpointRouteBuilder endpoints,
-            string pattern = "config")
+            string pattern = "config",
+            Action<ConfigurationDebugViewOptions>? optionsDelegate = default)
         {
             if (endpoints == null)
             {
                 throw new ArgumentNullException(nameof(endpoints));
             }
 
-            return MapConfigurationDebugViewCore(endpoints, pattern);
+            var options = new ConfigurationDebugViewOptions();
+            optionsDelegate?.Invoke(options);
+
+            return MapConfigurationDebugViewCore(endpoints, pattern, options);
         }
 
-        private static IEndpointConventionBuilder MapConfigurationDebugViewCore(
+        private static IEndpointConventionBuilder? MapConfigurationDebugViewCore(
             IEndpointRouteBuilder endpoints,
-            string pattern)
+            string pattern, ConfigurationDebugViewOptions options)
         {
-            var pipeline = endpoints.CreateApplicationBuilder()
+            var environment = endpoints.ServiceProvider.GetRequiredService<IHostEnvironment>();
+            var builder = endpoints.CreateApplicationBuilder();
+
+            if (options.AllowDevelopmentOnly && !environment.IsDevelopment())
+            {
+                return null;
+            }
+            var pipeline = builder
                 .UseMiddleware<ConfigurationDebugViewMiddleware>()
                 .Build();
 

Tests/ConfigurationDebugViewEndpoint.Test/ConfigurationDebugViewMiddlewareTests.cs Tests/ConfigurationDebugViewEndpoint.Test/EndpointRouteBuilderExtensionsTests.cs

@@ -9,8 +9,9 @@ namespace ConfigurationDebugViewEndpoint.Test
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.Hosting;
     using System;
+    using ConfigurationDebugViewEndpoint.Extensions;
 
-    public class ConfigurationDebugViewMiddlewareTests
+    public class EndpointRouteBuilderExtensionsTests
     {
         [Fact]
         public async Task EmptyConfiguration()
@@ -51,5 +52,34 @@ public async Task NotEmptyConfiguration_ExpectedConfigurationReturned()
             Assert.Contains(settingKey, content);
             Assert.Contains(settingValue, content);
         }
+
+        [Theory]
+        [InlineData("Development", 200)]
+        [InlineData("Production", 404)]
+        public async Task WithAllowDevelopmentOnlyOptions_Development_ConfigurationReturned(
+            string environment,
+            int expectedStatusCode)
+        {
+            var pattern = "/config";
+            using var host = new HostBuilder().ConfigureWebHost(builder =>
+            {
+                builder.ConfigureServices(services => services.AddRouting());
+                builder.Configure(app =>
+                {
+                    app.UseRouting();
+                    app.UseEndpoints(endpoints =>
+                        endpoints.MapConfigurationDebugView(pattern, (options) => options.AllowDevelopmentOnly = true));
+                });
+                builder.UseTestServer()
+                    .UseEnvironment(environment);
+            })
+                .Build();
+
+            await host.StartAsync();
+            using var server = host.GetTestServer();
+            var response = await server.CreateClient().GetAsync($"http://example.com{pattern}");
+            Assert.Equal(expectedStatusCode, (int)response.StatusCode);
+        }
+
     }
 }