Merge pull request #37 from WeihanLi/dev

0.4.0

Author: WeihanLi

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+dotnet build
+
+## run all tasks
+# husky run

.husky/task-runner.json

@@ -0,0 +1,15 @@
+{
+   "tasks": [
+      {
+         "name": "dotnet-build",
+         "command": "dotnet",
+         "args": [ "build" ]
+      },
+      {
+         "name": "dotnet-format",
+         "command": "dotnet",
+         "args": [ "format", "--include", "${staged}" ],
+         "include": [ "**/*.cs", "**/*.vb" ]
+      }
+   ]
+}

Directory.Build.props

@@ -13,9 +13,6 @@
         <Authors>WeihanLi</Authors>
         <Copyright>Copyright 2021-$([System.DateTime]::Now.Year) (c) WeihanLi</Copyright>
     </PropertyGroup>
-    <ItemGroup>
-        <None Include="$(MSBuildThisFileDirectory)icon.png" Pack="true" Visible="false" PackagePath=""/>
-    </ItemGroup>
     <ItemGroup>
         <Using Include="WeihanLi.Common"/>
         <Using Include="WeihanLi.Common.Helpers"/>

build/version.props

@@ -1,8 +1,8 @@
 <Project>
   <PropertyGroup>
     <VersionMajor>0</VersionMajor>
-    <VersionMinor>3</VersionMinor>
-    <VersionPatch>4</VersionPatch>
+    <VersionMinor>4</VersionMinor>
+    <VersionPatch>0</VersionPatch>
     <VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
     <InformationalVersion>$(PackageVersion)</InformationalVersion>
   </PropertyGroup>

docs/ReleaseNotes.md

@@ -1,5 +1,12 @@
 # dotnet-httpie release notes
 
+## [0.4.0](https://nuget.org/packages/dotnet-httpie/0.4.0)
+
+- Add support for download file
+- Add support for response json schema validation
+- Add `RequestCacheMiddleware`
+- Add load test exporter
+
 ## [0.3.0](https://nuget.org/packages/dotnet-httpie/0.3.0)
 
 - Add support for load test

src/Directory.Build.props

@@ -8,4 +8,7 @@
         <PackageReleaseNotes>https://github.com/WeihanLi/dotnet-httpie/tree/main/docs/ReleaseNotes.md</PackageReleaseNotes>
         <ContinuousIntegrationBuild Condition="'$(TF_BUILD)' == 'true' or '$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild>
     </PropertyGroup>
+    <ItemGroup>
+        <None Include="$(MSBuildThisFileDirectory)../icon.png" Pack="true" Visible="false" PackagePath=""/>
+    </ItemGroup>
 </Project>

src/HTTPie/Abstractions/ILoadTestExporter.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Weihan Li. All rights reserved.
+// Licensed under the MIT license.
+
+using HTTPie.Models;
+
+namespace HTTPie.Abstractions;
+
+public interface ILoadTestExporter : IPlugin
+{
+    string Type { get; }
+
+    ValueTask Export(HttpContext context, HttpResponseModel[] responseList);
+}
+
+public interface ILoadTestExporterSelector : IPlugin
+{
+    ILoadTestExporter? Select();
+}

src/HTTPie/Abstractions/IOutputFormatter.cs

@@ -7,5 +7,5 @@ namespace HTTPie.Abstractions;
 
 public interface IOutputFormatter : IPlugin
 {
-    string GetOutput(HttpContext httpContext);
+    Task<string> GetOutput(HttpContext httpContext);
 }

src/HTTPie/HTTPie.csproj

@@ -15,6 +15,7 @@
         <Using Include="System.CommandLine.Parsing" />
     </ItemGroup>
     <ItemGroup>
+        <PackageReference Include="JsonSchema.Net" Version="2.2.1" />
         <PackageReference Include="MathNet.Numerics.Signed" Version="5.0.0-beta01" />
         <PackageReference Include="System.CommandLine" Version="2.0.0-beta3.22114.1" />
         <PackageReference Include="WeihanLi.Common" Version="1.0.50" />

src/HTTPie/Implement/JsonLoadTestExporter.cs

@@ -0,0 +1,38 @@
+// Copyright (c) Weihan Li. All rights reserved.
+// Licensed under the MIT license.
+
+using HTTPie.Abstractions;
+using HTTPie.Models;
+using System.Text.Json;
+
+namespace HTTPie.Implement;
+
+public sealed class JsonLoadTestExporter : ILoadTestExporter
+{
+    private static readonly Option<string> OutputJsonPathOption = new("--export-json-path", "Expected export json file path");
+
+    public ICollection<Option> SupportedOptions()
+    {
+        return new[] { OutputJsonPathOption };
+    }
+
+    public string Type => "Json";
+
+    public async ValueTask Export(HttpContext context, HttpResponseModel[] responseList)
+    {
+        var jsonPath = context.Request.ParseResult.GetValueForOption(OutputJsonPathOption);
+        if (string.IsNullOrEmpty(jsonPath))
+        {
+            return;
+        }
+        var result = new
+        {
+            context.Response.Elapsed,
+            context.Request,
+            ResponseList = responseList
+        };
+        await using var fs = File.Create(jsonPath);
+        await JsonSerializer.SerializeAsync(fs, result);
+        await fs.FlushAsync();
+    }
+}

src/HTTPie/Implement/LoadTestExporterSelector.cs

@@ -0,0 +1,33 @@
+// Copyright (c) Weihan Li. All rights reserved.
+// Licensed under the MIT license.
+
+using HTTPie.Abstractions;
+using HTTPie.Models;
+
+namespace HTTPie.Implement;
+
+public sealed class LoadTestExporterSelector : ILoadTestExporterSelector
+{
+    private readonly HttpContext _context;
+    private readonly Dictionary<string, ILoadTestExporter> _exporters;
+    private static readonly Option<string> ExporterTypeOption = new("--exporter-type", "Load test result exporter type");
+
+    public ICollection<Option> SupportedOptions()
+    {
+        return new[] { ExporterTypeOption };
+    }
+
+    public LoadTestExporterSelector(HttpContext context, IEnumerable<ILoadTestExporter> exporters)
+    {
+        _context = context;
+        _exporters = exporters.ToDictionary(x => x.Type, x => x, StringComparer.OrdinalIgnoreCase);
+        ExporterTypeOption.AddCompletions(_exporters.Keys.ToArray());
+    }
+
+    public ILoadTestExporter? Select()
+    {
+        var exporterType = _context.Request.ParseResult.GetValueForOption(ExporterTypeOption) ?? string.Empty;
+        _exporters.TryGetValue(exporterType, out var exporter);
+        return exporter;
+    }
+}

src/HTTPie/Implement/OutputFormatter.cs

@@ -5,9 +5,12 @@
 using HTTPie.Models;
 using HTTPie.Utilities;
 using MathNet.Numerics.Statistics;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Primitives;
 using System.Text;
 using System.Text.Json.Nodes;
+using WeihanLi.Common.Extensions;
 
 namespace HTTPie.Implement;
 
@@ -20,16 +23,25 @@ public enum PrettyOptions
     All = 3
 }
 
-public class OutputFormatter : IOutputFormatter
+public sealed class OutputFormatter : IOutputFormatter
 {
-    public static readonly Option<PrettyOptions> PrettyOption = new("--pretty", () => PrettyOptions.All, "pretty output");
+    private readonly IServiceProvider _serviceProvider;
+    private readonly ILogger<OutputFormatter> _logger;
+    private static readonly Option<PrettyOptions> PrettyOption = new("--pretty", () => PrettyOptions.All, "pretty output");
 
-    public static readonly Option QuietOption = new(new[] { "--quiet", "-q" }, "quiet mode, output nothing");
+    private static readonly Option QuietOption = new(new[] { "--quiet", "-q" }, "quiet mode, output nothing");
     public static readonly Option OfflineOption = new("--offline", "offline mode, would not send the request, just print request info");
-    public static readonly Option OutputHeadersOption = new(new[] { "-h", "--headers" }, "output response headers only");
-    public static readonly Option OutputBodyOption = new(new[] { "-b", "--body" }, "output response headers and response body only");
-    public static readonly Option OutputVerboseOption = new(new[] { "-v", "--verbose" }, "output request/response, response headers and response body");
-    public static readonly Option<string> OutputPrintModeOption = new(new[] { "-p", "--print" }, "print mode, output specific info,H:request headers,B:request body,h:response headers,b:response body");
+    private static readonly Option OutputHeadersOption = new(new[] { "-h", "--headers" }, "output response headers only");
+    private static readonly Option OutputBodyOption = new(new[] { "-b", "--body" }, "output response headers and response body only");
+    private static readonly Option OutputVerboseOption = new(new[] { "-v", "--verbose" }, "output request/response, response headers and response body");
+    private static readonly Option<string> OutputPrintModeOption = new(new[] { "-p", "--print" }, "print mode, output specific info,H:request headers,B:request body,h:response headers,b:response body");
+
+
+    public OutputFormatter(IServiceProvider serviceProvider, ILogger<OutputFormatter> logger)
+    {
+        _serviceProvider = serviceProvider;
+        _logger = logger;
+    }
 
     public ICollection<Option> SupportedOptions() => new HashSet<Option>()
         {
@@ -91,12 +103,12 @@ public static OutputFormat GetOutputFormat(HttpContext httpContext)
         return outputFormat;
     }
 
-    public string GetOutput(HttpContext httpContext)
+    public async Task<string> GetOutput(HttpContext httpContext)
     {
         var isLoadTest = httpContext.GetFlag(Constants.FlagNames.IsLoadTest);
         var outputFormat = GetOutputFormat(httpContext);
         return isLoadTest
-            ? GetLoadTestOutput(httpContext, outputFormat)
+            ? await GetLoadTestOutput(httpContext, outputFormat).ConfigureAwait(false)
             : GetCommonOutput(httpContext, outputFormat);
     }
 
@@ -135,7 +147,7 @@ private static string GetCommonOutput(HttpContext httpContext, OutputFormat outp
         return output.ToString();
     }
 
-    private static string GetLoadTestOutput(HttpContext httpContext, OutputFormat outputFormat)
+    private async Task<string> GetLoadTestOutput(HttpContext httpContext, OutputFormat outputFormat)
     {
         httpContext.TryGetProperty(Constants.ResponseListPropertyName,
             out HttpResponseModel[]? responseList);
@@ -164,6 +176,17 @@ private static string GetLoadTestOutput(HttpContext httpContext, OutputFormat ou
             P50 = SortedArrayStatistics.Quantile(durationInMs, 0.50),
         };
 
+        try
+        {
+            var exporter = _serviceProvider.GetService<ILoadTestExporter>();
+            if (exporter != null)
+                await exporter.Export(httpContext, responseList);
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "Export load test result failed");
+        }
+
         return $@"{GetCommonOutput(httpContext, outputFormat & OutputFormat.RequestInfo)}
 Total requests: {reportModel.TotalRequestCount}({reportModel.TotalElapsed} ms), successCount: {reportModel.SuccessRequestCount}({reportModel.SuccessRequestRate}%), failedCount: {reportModel.FailRequestCount}
 
@@ -218,3 +241,4 @@ private static string GetHeadersString(IDictionary<string, StringValues> headers
             $"{headers.Select(h => $"{h.Key}: {h.Value}").OrderBy(h => h).StringJoin(Environment.NewLine)}";
     }
 }
+

src/HTTPie/Implement/RequestExecutor.cs

@@ -8,11 +8,12 @@
 using System.Collections.Concurrent;
 using System.Diagnostics;
 using System.Net;
+using WeihanLi.Common.Extensions;
 using WeihanLi.Common.Http;
 
 namespace HTTPie.Implement;
 
-public partial class RequestExecutor : IRequestExecutor
+public sealed partial class RequestExecutor : IRequestExecutor
 {
     private readonly Func<HttpClientHandler, Task> _httpHandlerPipeline;
     private readonly ILogger _logger;
@@ -21,10 +22,10 @@ public partial class RequestExecutor : IRequestExecutor
     private readonly IResponseMapper _responseMapper;
     private readonly Func<HttpContext, Task> _responsePipeline;
 
-    public static readonly Option<double> TimeoutOption = new("--timeout", "Request timeout in seconds");
-    public static readonly Option<int> IterationOption = new(new[] { "-n", "--iteration" }, () => 1, "Request iteration");
-    public static readonly Option<int> VirtualUserOption = new(new[] { "--vu", "--vus", "--virtual-users" }, () => 1, "Virtual users");
-    public static readonly Option<string> DurationOption = new(new[] { "-d", "--duration" }, "Duration");
+    private static readonly Option<double> TimeoutOption = new("--timeout", "Request timeout in seconds");
+    private static readonly Option<int> IterationOption = new(new[] { "-n", "--iteration" }, () => 1, "Request iteration");
+    private static readonly Option<int> VirtualUserOption = new(new[] { "--vu", "--vus", "--virtual-users" }, () => 1, "Virtual users");
+    private static readonly Option<string> DurationOption = new(new[] { "--duration" }, "Request duration, 10s/1m ...");
 
     public Option[] SupportedOptions()
     {

src/HTTPie/Implement/RequestMapper.cs

@@ -9,7 +9,7 @@
 
 namespace HTTPie.Implement;
 
-public class RequestMapper : IRequestMapper
+public sealed class RequestMapper : IRequestMapper
 {
     public Task<HttpRequestMessage> ToRequestMessage(HttpContext httpContext)
     {

src/HTTPie/Implement/ResponseMapper.cs

@@ -7,32 +7,47 @@
 
 namespace HTTPie.Implement;
 
-public class ResponseMapper : IResponseMapper
+public sealed class ResponseMapper : IResponseMapper
 {
-    private readonly HttpContext _httpContext;
-
-    public ResponseMapper(HttpContext httpContext)
-    {
-        _httpContext = httpContext;
-    }
     public async Task<HttpResponseModel> ToResponseModel(HttpResponseMessage responseMessage)
     {
         var responseModel = new HttpResponseModel
         {
             HttpVersion = responseMessage.Version,
             StatusCode = responseMessage.StatusCode,
+            Headers = responseMessage.Headers
+                .Union(responseMessage.Content.Headers)
+                .ToDictionary(x => x.Key, x => new StringValues(x.Value.ToArray())),
+            Bytes = await responseMessage.Content.ReadAsByteArrayAsync(),
         };
-        var outputFormat = OutputFormatter.GetOutputFormat(_httpContext);
-        if (outputFormat.HasFlag(OutputFormat.ResponseHeaders))
+        if (IsTextResponse(responseMessage))
         {
-            responseModel.Headers = responseMessage.Headers
-              .Union(responseMessage.Content.Headers)
-              .ToDictionary(x => x.Key, x => new StringValues(x.Value.ToArray()));
+            try
+            {
+                responseModel.Body = responseModel.Bytes.GetString();
+            }
+            catch
+            {
+                // ignored
+            }
         }
-        if (outputFormat.HasFlag(OutputFormat.ResponseBody))
+        return responseModel;
+    }
+
+    private static bool IsTextResponse(HttpResponseMessage response)
+    {
+        if (response.Content.Headers.ContentType?.MediaType is null)
         {
-            responseModel.Body = await responseMessage.Content.ReadAsStringAsync();
+            return true;
         }
-        return responseModel;
+        var contentType = response.Content.Headers.ContentType;
+        var mediaType = contentType.MediaType;
+        var isTextContent = mediaType.StartsWith("text/", StringComparison.OrdinalIgnoreCase)
+            || mediaType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase)
+            || mediaType.StartsWith("application/xml", StringComparison.OrdinalIgnoreCase)
+            || mediaType.StartsWith("application/javascript", StringComparison.OrdinalIgnoreCase)
+            ;
+        return isTextContent;
     }
+
 }

src/HTTPie/Middleware/AuthorizationMiddleware.cs

@@ -8,10 +8,10 @@
 
 namespace HTTPie.Middleware;
 
-public class AuthorizationMiddleware : IRequestMiddleware
+public sealed class AuthorizationMiddleware : IRequestMiddleware
 {
-    public static readonly Option<string> AuthenticationTypeOption = new(new[] { "--auth-type", "-A" }, () => "Basic", "Authentication type");
-    public static readonly Option<string> AuthenticationValueOption = new(new[] { "--auth", "-a" }, "Authentication value");
+    private static readonly Option<string> AuthenticationTypeOption = new(new[] { "--auth-type", "-A" }, () => "Basic", "Authentication type");
+    private static readonly Option<string> AuthenticationValueOption = new(new[] { "--auth", "-a" }, "Authentication value");
 
     static AuthorizationMiddleware()
     {