From 6a3441d109ec292312f4fe5516073678c510cdc3 Mon Sep 17 00:00:00 2001 From: yurvon-screamo <109030262+yurvon-screamo@users.noreply.github.com> Date: Mon, 8 Jul 2024 12:36:04 +0300 Subject: [PATCH 01/10] Check unit, fmt, build on ci (#211) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Dotnet format jobs * Dotnet format job - fix cmd * CI - build, test + fmt ci * CI - build, test + fmt ci * CI - build, test + fmt ci * CI - build, test + fmt ci * CI - build, test + fmt ci * fmt sln * fmt docs * CI: only main * Remove fmt tool * Add inner editorconfig on test * Add inner editorconfig on test --------- Co-authored-by: Юрий Турбин --- .github/dotnet/action.yaml | 10 ++++ .github/npm/action.yaml | 14 +++++ .github/workflows/ci.yaml | 54 ++++++++++--------- .github/workflows/release.yaml | 48 +++++------------ CONTRIBUTING.md | 3 +- Saunter.sln | 22 ++++++-- .../.editorconfig | 7 +++ test/Saunter.Tests/.editorconfig | 7 +++ .../ClassAttributesTests.cs | 22 ++++---- 9 files changed, 110 insertions(+), 77 deletions(-) create mode 100644 .github/dotnet/action.yaml create mode 100644 .github/npm/action.yaml create mode 100644 test/Saunter.Tests.MarkerTypeTests/.editorconfig create mode 100644 test/Saunter.Tests/.editorconfig diff --git a/.github/dotnet/action.yaml b/.github/dotnet/action.yaml new file mode 100644 index 00000000..47858e0c --- /dev/null +++ b/.github/dotnet/action.yaml @@ -0,0 +1,10 @@ +name: dotnet setup +description: "base dotnet setup for project" +runs: + using: composite + steps: + - name: setup + id: setup-dotnet + uses: actions/setup-dotnet@v1 + with: + dotnet-version: "6.0.x" diff --git a/.github/npm/action.yaml b/.github/npm/action.yaml new file mode 100644 index 00000000..a35897e2 --- /dev/null +++ b/.github/npm/action.yaml @@ -0,0 +1,14 @@ +name: npm setup +description: "base npm setup for project" +runs: + using: composite + steps: + - name: setup dotnet + uses: ./.github/dotnet + - uses: actions/setup-node@v3 + with: + node-version: "lts/*" + - name: Run NPM install + shell: sh + run: npm ci + working-directory: ./src/Saunter.UI diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index bf470245..b9ab2a66 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,7 +1,4 @@ -# Note: ci.yaml and release.yaml have some similar steps -# If updating dotnet-version, set in both. - -name: CI +name: ci on: push: @@ -10,30 +7,35 @@ on: pull_request: jobs: - build: + build: runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - - uses: actions/setup-node@v3 - with: - node-version: 'lts/*' # latest LTS version - - uses: actions/setup-dotnet@v2 - with: - dotnet-version: '6.0.x' # SDK Version to use; x will use the latest version of the channel + - uses: actions/checkout@v2 + - name: setup build + uses: ./.github/npm + - name: Run dotnet build + run: dotnet build --configuration Debug - - name: Run NPM install - run: npm ci - working-directory: ./src/Saunter.UI - - name: Run dotnet build - run: dotnet build --configuration Debug - - name: Run dotnet test - run: dotnet test --no-build + fmt: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: setup dotnet + uses: ./.github/dotnet + - name: dotnet format check + run: dotnet format --verify-no-changes *.sln + env: + PATH: ${{ github.env.PATH }}:/home/runner/.dotnet/tools - # Below steps run only on CI, not release - - uses: actions/upload-artifact@v2 - with: - name: saunter-bin - path: ./src/Saunter/bin + unit-test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: setup build + uses: ./.github/npm + - name: unit test + run: dotnet test ./test/Saunter.Tests/Saunter.Tests.csproj + # TODO: why there are 2 of them.... + - name: unit mark test + run: dotnet test ./test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 836b03d9..c1c33107 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,45 +1,23 @@ -# Note: ci.yaml and release.yaml have some similar steps -# If updating dotnet-version, set in both. - name: Release on: push: tags: - - 'v*.*.*' # e.g. v0.1.0 + - "v*.*.*" # e.g. v0.1.0 jobs: release: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - - uses: actions/setup-node@v3 - with: - node-version: 'lts/*' # latest LTS version - - uses: actions/setup-dotnet@v2 - with: - dotnet-version: '6.0.x' # SDK Version to use; x will use the latest version of the channel - - - name: Run NPM install - run: npm ci - working-directory: ./src/Saunter.UI - - name: Run dotnet build - run: dotnet build --configuration Debug - - name: Run dotnet test - run: dotnet test --no-build - - # Below steps are only on release, not CI. - - name: Set version - # Gets the numeric version from a tag (e.g. v1.2.3 -> 1.2.3) - run: echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV - - name: Create Nuget package - run: dotnet pack ./src/Saunter/Saunter.csproj --configuration Release -p:Version="$RELEASE_VERSION" --output ./build - - name: Push Nuget package to Nuget.org - env: - NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} - run: dotnet nuget push ./build/*.nupkg --api-key $NUGET_API_KEY --source "https://api.nuget.org/v3/index.json" - - + - uses: actions/checkout@v2 + - name: setup build + uses: ./.github/npm + - name: Set version + # Gets the numeric version from a tag (e.g. v1.2.3 -> 1.2.3) + run: echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV + - name: Create Nuget package + run: dotnet pack ./src/Saunter/Saunter.csproj --configuration Release -p:Version="$RELEASE_VERSION" --output ./build + - name: Push Nuget package to Nuget.org + env: + NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} + run: dotnet nuget push ./build/*.nupkg --api-key $NUGET_API_KEY --source "https://api.nuget.org/v3/index.json" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e35bd6fd..ce12592f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,11 +10,10 @@ Builds and releases managed with github actions. ### Build * Local builds are as simple as `dotnet build && dotnet test` -* CI builds on every push +* CI builds,fmt,unit on every push * [.github/workflows/ci.yaml](./.github/workflows/ci.yaml) * Build and tests MUST pass before merging to master - ### Release * Locally, packages can be created using `dotnet pack ./src/Saunter/Saunter.csproj` diff --git a/Saunter.sln b/Saunter.sln index 46277661..038ce2f3 100644 --- a/Saunter.sln +++ b/Saunter.sln @@ -15,19 +15,33 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{6A EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StreetlightsAPI", "examples\StreetlightsAPI\StreetlightsAPI.csproj", "{F188D4A7-BBCB-464F-A370-2BD84D18EA79}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{E0D34C77-924E-4F6B-9289-5A2F07D125A8}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E0D34C77-924E-4F6B-9289-5A2F07D125A8}" ProjectSection(SolutionItems) = preProject .editorconfig = .editorconfig CHANGELOG.md = CHANGELOG.md - .github\workflows\ci.yaml = .github\workflows\ci.yaml README.md = README.md - .github\workflows\release.yaml = .github\workflows\release.yaml EndProjectSection EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Saunter.IntegrationTests.ReverseProxy", "test\Saunter.IntegrationTests.ReverseProxy\Saunter.IntegrationTests.ReverseProxy.csproj", "{7CD09B89-130A-41AF-ADAE-2166C4ED695B}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Saunter.Tests.MarkerTypeTests", "test\Saunter.Tests.MarkerTypeTests\Saunter.Tests.MarkerTypeTests.csproj", "{02284473-6DE7-4EE0-8433-2AC295045549}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "actions", "actions", "{D8CB9C0D-9605-457B-979F-C8994B20A926}" + ProjectSection(SolutionItems) = preProject + .github\workflows\ci.yaml = .github\workflows\ci.yaml + .github\workflows\release.yaml = .github\workflows\release.yaml + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet", "dotnet", "{69459F9D-DA73-4E84-8BA7-4CE03E2B7664}" + ProjectSection(SolutionItems) = preProject + .github\dotnet\action.yaml = .github\dotnet\action.yaml + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "npm", "npm", "{E8FACA22-CFED-4710-89E4-D55F31BF96B3}" + ProjectSection(SolutionItems) = preProject + .github\npm\action.yaml = .github\npm\action.yaml + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -108,6 +122,8 @@ Global {F188D4A7-BBCB-464F-A370-2BD84D18EA79} = {6ABD4842-47AF-49A5-B057-0EBA64416789} {7CD09B89-130A-41AF-ADAE-2166C4ED695B} = {6491E321-2D02-44AB-9116-D722FE169595} {02284473-6DE7-4EE0-8433-2AC295045549} = {6491E321-2D02-44AB-9116-D722FE169595} + {69459F9D-DA73-4E84-8BA7-4CE03E2B7664} = {D8CB9C0D-9605-457B-979F-C8994B20A926} + {E8FACA22-CFED-4710-89E4-D55F31BF96B3} = {D8CB9C0D-9605-457B-979F-C8994B20A926} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {2F85D9DA-DBCF-4F13-8C42-5719F1469B2E} diff --git a/test/Saunter.Tests.MarkerTypeTests/.editorconfig b/test/Saunter.Tests.MarkerTypeTests/.editorconfig new file mode 100644 index 00000000..0f18a2dd --- /dev/null +++ b/test/Saunter.Tests.MarkerTypeTests/.editorconfig @@ -0,0 +1,7 @@ +# EditorConfig is awesome: https://EditorConfig.org + +root=false + +[*.{cs,vb}] + +dotnet_code_quality_unused_parameters = non_public diff --git a/test/Saunter.Tests/.editorconfig b/test/Saunter.Tests/.editorconfig new file mode 100644 index 00000000..0f18a2dd --- /dev/null +++ b/test/Saunter.Tests/.editorconfig @@ -0,0 +1,7 @@ +# EditorConfig is awesome: https://EditorConfig.org + +root=false + +[*.{cs,vb}] + +dotnet_code_quality_unused_parameters = non_public diff --git a/test/Saunter.Tests/Generation/DocumentGeneratorTests/ClassAttributesTests.cs b/test/Saunter.Tests/Generation/DocumentGeneratorTests/ClassAttributesTests.cs index 8fd8d2a3..c384d641 100644 --- a/test/Saunter.Tests/Generation/DocumentGeneratorTests/ClassAttributesTests.cs +++ b/test/Saunter.Tests/Generation/DocumentGeneratorTests/ClassAttributesTests.cs @@ -243,13 +243,13 @@ public interface IMyMessagePublisher public class TenantMessageConsumer { [Message(typeof(TenantCreated))] - public void SubscribeTenantCreatedEvent(Guid _, TenantCreated __) { } + public void SubscribeTenantCreatedEvent(Guid id, TenantCreated created) { } [Message(typeof(TenantUpdated))] - public void SubscribeTenantUpdatedEvent(Guid _, TenantUpdated __) { } + public void SubscribeTenantUpdatedEvent(Guid id, TenantUpdated updated) { } [Message(typeof(TenantRemoved))] - public void SubscribeTenantRemovedEvent(Guid _, TenantRemoved __) { } + public void SubscribeTenantRemovedEvent(Guid id, TenantRemoved removed) { } } [AsyncApi] @@ -273,13 +273,13 @@ public interface ITenantMessageConsumer public class TenantMessagePublisher { [Message(typeof(TenantCreated))] - public void PublishTenantCreatedEvent(Guid _, TenantCreated __) { } + public void PublishTenantCreatedEvent(Guid id, TenantCreated created) { } [Message(typeof(TenantUpdated))] - public void PublishTenantUpdatedEvent(Guid _, TenantUpdated __) { } + public void PublishTenantUpdatedEvent(Guid id, TenantUpdated updated) { } [Message(typeof(TenantRemoved))] - public void PublishTenantRemovedEvent(Guid _, TenantRemoved __) { } + public void PublishTenantRemovedEvent(Guid id, TenantRemoved removed) { } } [AsyncApi] @@ -305,7 +305,7 @@ public class TenantGenericMessagePublisher [Message(typeof(AnyTenantCreated))] [Message(typeof(AnyTenantUpdated))] [Message(typeof(AnyTenantRemoved))] - public void PublishTenantEvent(Guid _, TEvent __) + public void PublishTenantEvent(Guid id, TEvent @event) where TEvent : IEvent { } @@ -329,7 +329,7 @@ void PublishTenantEvent(Guid _, TEvent __) public class TenantSingleMessagePublisher { [Message(typeof(AnyTenantCreated))] - public void PublishTenantCreated(Guid _, AnyTenantCreated __) + public void PublishTenantCreated(Guid id, AnyTenantCreated created) { } } @@ -351,13 +351,13 @@ public interface ITenantSingleMessagePublisher public class OneTenantMessageConsumer { [Message(typeof(TenantCreated))] - public void SubscribeTenantCreatedEvent(Guid _, TenantCreated __) { } + public void SubscribeTenantCreatedEvent(Guid id, TenantCreated created) { } [Message(typeof(TenantUpdated))] - public void SubscribeTenantUpdatedEvent(Guid _, TenantUpdated __) { } + public void SubscribeTenantUpdatedEvent(Guid id, TenantUpdated updated) { } [Message(typeof(TenantRemoved))] - public void SubscribeTenantRemovedEvent(Guid _, TenantRemoved __) { } + public void SubscribeTenantRemovedEvent(Guid id, TenantRemoved removed) { } } [AsyncApi] From a746e4d0db912f915d11a4a82b84af60fac37858 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Tue, 9 Jul 2024 20:51:52 +0200 Subject: [PATCH 02/10] #196 Fixed formatting etc + some PR remarks --- .editorconfig | 2 - src/AsyncAPI.Saunter.Generator.Cli/Args.cs | 6 +- .../AsyncAPI.Saunter.Generator.Cli.csproj | 7 +- .../Commands/Tofile.cs | 6 +- .../Commands/TofileInternal.cs | 30 +-- .../Internal/DependencyResolver.cs | 6 +- .../SwashbuckleImport/HostFactoryResolver.cs | 5 +- src/AsyncAPI.Saunter.Generator.Cli/readme.md | 6 +- src/Saunter/AsyncApiOptions.cs | 14 +- .../AsyncApiServiceCollectionExtensions.cs | 10 +- .../DotnetCliToolTests.cs | 6 +- .../PackAndInstallLocalTests.cs | 6 +- .../InterfaceAttributeTests.cs | 214 +++++++++--------- .../AsyncApiTypesTests.cs | 1 - .../SchemaGeneration/SchemaGenerationTests.cs | 30 +-- 15 files changed, 160 insertions(+), 189 deletions(-) diff --git a/.editorconfig b/.editorconfig index 5209be73..20f2dfdc 100644 --- a/.editorconfig +++ b/.editorconfig @@ -144,8 +144,6 @@ dotnet_naming_symbols.all_members.applicable_kinds = * dotnet_naming_style.pascal_case_style.capitalization = pascal_case -file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the MIT license.\nSee the LICENSE file in the project root for more information. - # RS0016: Only enable if API files are present dotnet_public_api_analyzer.require_api_files = true diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Args.cs b/src/AsyncAPI.Saunter.Generator.Cli/Args.cs index cafc79b3..1100a58b 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/Args.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/Args.cs @@ -1,8 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -// ReSharper disable once CheckNamespace +// ReSharper disable once CheckNamespace public static partial class Program { internal const string StartupAssemblyArgument = "startupassembly"; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj b/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj index 472cc32e..0ece5488 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj +++ b/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj @@ -7,7 +7,7 @@ 12 AsyncAPI.Saunter.Generator.Cli - AsyncAPI Command Line Tools + AsyncAPI Command Line Tools: Dotnet tool to generate AsyncAPI spec file from dotnet startup assembly. AsyncAPI Initiative true AsyncAPI.Saunter.Generator.Cli @@ -23,7 +23,10 @@ false true snupkg - 1.0.1 + + + + true diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs b/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs index a447ce43..1c90a9b9 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs @@ -1,8 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System.Diagnostics; +using System.Diagnostics; using System.Reflection; using static Program; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs b/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs index 5889e5d2..b833d741 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs @@ -1,24 +1,18 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using LEGO.AsyncAPI.Readers; -using Microsoft.Extensions.Options; -using Saunter.Serialization; -using Saunter; +using System.Reflection; using System.Runtime.Loader; -using System.Reflection; +using AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; using LEGO.AsyncAPI; using LEGO.AsyncAPI.Models; -using Microsoft.Extensions.DependencyInjection; -using AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; -using Microsoft.AspNetCore.Hosting; +using LEGO.AsyncAPI.Readers; using Microsoft.AspNetCore; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; -using Saunter.AsyncApiSchema.v2; +using Microsoft.Extensions.Options; +using Saunter; +using Saunter.Serialization; using static Program; using AsyncApiDocument = Saunter.AsyncApiSchema.v2.AsyncApiDocument; -using System.IO; namespace AsyncApi.Saunter.Generator.Cli.Commands; @@ -35,13 +29,13 @@ internal static int Run(IDictionary namedArgs) var envVars = (namedArgs.TryGetValue(EnvOption, out var x) && !string.IsNullOrWhiteSpace(x)) ? x.Split(',').Select(x => x.Trim()) : Array.Empty(); foreach (var envVar in envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList())) { - if (envVar.Count == 2) + if (envVar.Count is 1 or 2) { - Environment.SetEnvironmentVariable(envVar[0], envVar[1], EnvironmentVariableTarget.Process); + Environment.SetEnvironmentVariable(envVar[0], envVar.ElementAtOrDefault(1), EnvironmentVariableTarget.Process); } else { - throw new ArgumentOutOfRangeException(EnvOption, namedArgs[EnvOption], "Environment variable should be in the format: env1=value1,env2=value2"); + throw new ArgumentOutOfRangeException(EnvOption, namedArgs[EnvOption], "Environment variable should be in the format: env1=value1,env2=value2,env3"); } } var serviceProvider = GetServiceProvider(startupAssembly); @@ -51,7 +45,7 @@ internal static int Run(IDictionary namedArgs) var asyncapiOptions = serviceProvider.GetService>().Value; var documentSerializer = serviceProvider.GetRequiredService(); - var documentNames = (namedArgs.TryGetValue(DocOption, out var doc) && !string.IsNullOrWhiteSpace(doc)) ? [doc] : asyncapiOptions.NamedApis.Keys; + var documentNames = (namedArgs.TryGetValue(DocOption, out var doc) && !string.IsNullOrWhiteSpace(doc)) ? [doc] : asyncapiOptions.NamedApis.Keys; var fileTemplate = (namedArgs.TryGetValue(FileNameOption, out var template) && !string.IsNullOrWhiteSpace(template)) ? template : "{document}_asyncapi.{extension}"; if (documentNames.Count == 0) { diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs b/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs index e6ef1bc3..d136cf1f 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs @@ -1,8 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System.Reflection; +using System.Reflection; namespace AsyncAPI.Saunter.Generator.Cli.Internal; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs index 29d3e96e..266e47f4 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs @@ -1,7 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Diagnostics; +using System.Diagnostics; using System.Reflection; namespace Microsoft.Extensions.Hosting; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/readme.md b/src/AsyncAPI.Saunter.Generator.Cli/readme.md index 8eb9a503..05c42764 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/readme.md +++ b/src/AsyncAPI.Saunter.Generator.Cli/readme.md @@ -5,14 +5,14 @@ A dotnet tool to generate AsyncAPI specification files based of a dotnet DLL (Th ``` dotnet asyncapi tofile --output [output-path] --format [json,yml,yaml] --doc [asyncapi-document-name] [startup-assembly] ``` -startup-assembly: the file path to the entrypoint dotnet DLL that hosts AsyncAPI document(s). +- _startup-assembly_: the file path to the entrypoint dotnet DLL that hosts AsyncAPI document(s). ## Tool options - _--doc_: The name of the AsyncAPI document as defined in the startup class by the ```.ConfigureNamedAsyncApi()```-method. If only ```.AddAsyncApiSchemaGeneration()``` is used, the document is unnamed and will always be exported. If not specified, all documents will be exported. - _--output_: relative path where the AsyncAPI will be output [defaults to stdout] - _--filename_: the template for the outputted file names. Default: "{document}_asyncapi.{extension}" -- _--format_: the output formats to generate, can be a combination of json, yml and/or yaml. File extension is appended to the output path. -- _--env_: define environment variable(s) for the application +- _--format_: the output formats to generate, can be a combination of json, yml and/or yaml. +- _--env_: define environment variable(s) for the application. Formatted as a comma separated list of _key=value_ pairs or just _key_ for flags, example: ```ASPNETCORE_ENVIRONMENT=AsyncAPI,CONNECT_TO_DATABASE=false,GENERATOR_FLAG```. ## Install the Generator.Cli dotnet Tool ``` diff --git a/src/Saunter/AsyncApiOptions.cs b/src/Saunter/AsyncApiOptions.cs index cc64cc55..cdd410fb 100644 --- a/src/Saunter/AsyncApiOptions.cs +++ b/src/Saunter/AsyncApiOptions.cs @@ -1,13 +1,13 @@ using System; using System.Collections.Concurrent; -using System.Collections.Generic; - +using System.Collections.Generic; + using Newtonsoft.Json; using Newtonsoft.Json.Serialization; - + using NJsonSchema; using NJsonSchema.NewtonsoftJson.Generation; - + using Saunter.AsyncApiSchema.v2; using Saunter.Generation.Filters; using Saunter.Generation.SchemaGeneration; @@ -90,10 +90,10 @@ public void AddOperationFilter() where T : IOperationFilter public class AsyncApiSchemaOptions : NewtonsoftJsonSchemaGeneratorSettings { - public AsyncApiSchemaOptions() + public AsyncApiSchemaOptions() { SchemaType = SchemaType.JsonSchema; // AsyncAPI uses json-schema, see https://github.com/tehmantra/saunter/pull/103#issuecomment-893267360 - TypeNameGenerator = new CamelCaseTypeNameGenerator(); + TypeNameGenerator = new CamelCaseTypeNameGenerator(); SerializerSettings = new JsonSerializerSettings() { ContractResolver = new CamelCasePropertyNamesContractResolver(), @@ -120,4 +120,4 @@ public class AsyncApiMiddlewareOptions /// public string UiTitle { get; set; } = "AsyncAPI"; } -} +} diff --git a/src/Saunter/AsyncApiServiceCollectionExtensions.cs b/src/Saunter/AsyncApiServiceCollectionExtensions.cs index 288001cb..cf2ac39c 100644 --- a/src/Saunter/AsyncApiServiceCollectionExtensions.cs +++ b/src/Saunter/AsyncApiServiceCollectionExtensions.cs @@ -1,8 +1,8 @@ -using System; - +using System; + using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.DependencyInjection.Extensions; - +using Microsoft.Extensions.DependencyInjection.Extensions; + using Saunter.AsyncApiSchema.v2; using Saunter.Generation; using Saunter.Serialization; @@ -57,4 +57,4 @@ public static IServiceCollection ConfigureNamedAsyncApi(this IServiceCollection return services; } } -} +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs index 97258c87..47746fc8 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs @@ -1,8 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System.Diagnostics; +using System.Diagnostics; using Shouldly; using Xunit.Abstractions; diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs index 79d9844d..2bf87baf 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs @@ -1,8 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System.Diagnostics; +using System.Diagnostics; using Shouldly; using Xunit.Abstractions; diff --git a/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs b/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs index a5183890..f520bd10 100644 --- a/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs +++ b/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs @@ -1,107 +1,107 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System; -using System.Reflection; -using Saunter.AsyncApiSchema.v2; -using Saunter.Attributes; -using Saunter.Generation; -using Shouldly; -using Xunit; -using System.Linq; - -namespace Saunter.Tests.Generation.DocumentGeneratorTests -{ - public class InterfaceAttributeTests - { - [Theory] - [InlineData(typeof(IServiceEvents))] - [InlineData(typeof(ServiceEventsFromInterface))] - [InlineData(typeof(ServiceEventsFromAnnotatedInterface))] // Check that annotations are not inherited from the interface - public void NonAnnotatedTypesTest(Type type) - { - // Arrange - var options = new AsyncApiOptions(); - var documentGenerator = new DocumentGenerator(); - - // Act - var document = documentGenerator.GenerateDocument(new[] { type.GetTypeInfo() }, options, options.AsyncApi, ActivatorServiceProvider.Instance); - - // Assert - document.ShouldNotBeNull(); - document.Channels.Count.ShouldBe(0); - } - - [Theory] - [InlineData(typeof(IAnnotatedServiceEvents), "interface")] - [InlineData(typeof(AnnotatedServiceEventsFromInterface), "class")] - [InlineData(typeof(AnnotatedServiceEventsFromAnnotatedInterface), "class")] // Check that the actual type's annotation takes precedence of the inherited interface - public void AnnotatedTypesTest(Type type, string source) - { - // Arrange - var options = new AsyncApiOptions(); - var documentGenerator = new DocumentGenerator(); - - // Act - var document = documentGenerator.GenerateDocument(new[] { type.GetTypeInfo() }, options, options.AsyncApi, ActivatorServiceProvider.Instance); - - // Assert - document.ShouldNotBeNull(); - document.Channels.Count.ShouldBe(1); - - var channel = document.Channels.First(); - channel.Key.ShouldBe($"{source}.event"); - channel.Value.Description.ShouldBeNull(); - - var publish = channel.Value.Publish; - publish.ShouldNotBeNull(); - publish.OperationId.ShouldBe("PublishEvent"); - publish.Description.ShouldBe($"({source}) Subscribe to domains events about a tenant."); - - var messageRef = publish.Message.ShouldBeOfType(); - messageRef.Id.ShouldBe("tenantEvent"); - } - - [AsyncApi] - private interface IAnnotatedServiceEvents - { - [Channel("interface.event")] - [PublishOperation(typeof(TenantEvent), Description = "(interface) Subscribe to domains events about a tenant.")] - void PublishEvent(TenantEvent evt); - } - - private interface IServiceEvents - { - void PublishEvent(TenantEvent evt); - } - - private class ServiceEventsFromInterface : IServiceEvents - { - public void PublishEvent(TenantEvent evt) { } - } - - private class ServiceEventsFromAnnotatedInterface : IAnnotatedServiceEvents - { - public void PublishEvent(TenantEvent evt) { } - } - - [AsyncApi] - private class AnnotatedServiceEventsFromInterface : IAnnotatedServiceEvents - { - [Channel("class.event")] - [PublishOperation(typeof(TenantEvent), Description = "(class) Subscribe to domains events about a tenant.")] - public void PublishEvent(TenantEvent evt) { } - } - - [AsyncApi] - private class AnnotatedServiceEventsFromAnnotatedInterface : IAnnotatedServiceEvents - { - [Channel("class.event")] - [PublishOperation(typeof(TenantEvent), Description = "(class) Subscribe to domains events about a tenant.")] - public void PublishEvent(TenantEvent evt) { } - } - - private class TenantEvent { } - } -} +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using System; +using System.Reflection; +using Saunter.AsyncApiSchema.v2; +using Saunter.Attributes; +using Saunter.Generation; +using Shouldly; +using Xunit; +using System.Linq; + +namespace Saunter.Tests.Generation.DocumentGeneratorTests +{ + public class InterfaceAttributeTests + { + [Theory] + [InlineData(typeof(IServiceEvents))] + [InlineData(typeof(ServiceEventsFromInterface))] + [InlineData(typeof(ServiceEventsFromAnnotatedInterface))] // Check that annotations are not inherited from the interface + public void NonAnnotatedTypesTest(Type type) + { + // Arrange + var options = new AsyncApiOptions(); + var documentGenerator = new DocumentGenerator(); + + // Act + var document = documentGenerator.GenerateDocument(new[] { type.GetTypeInfo() }, options, options.AsyncApi, ActivatorServiceProvider.Instance); + + // Assert + document.ShouldNotBeNull(); + document.Channels.Count.ShouldBe(0); + } + + [Theory] + [InlineData(typeof(IAnnotatedServiceEvents), "interface")] + [InlineData(typeof(AnnotatedServiceEventsFromInterface), "class")] + [InlineData(typeof(AnnotatedServiceEventsFromAnnotatedInterface), "class")] // Check that the actual type's annotation takes precedence of the inherited interface + public void AnnotatedTypesTest(Type type, string source) + { + // Arrange + var options = new AsyncApiOptions(); + var documentGenerator = new DocumentGenerator(); + + // Act + var document = documentGenerator.GenerateDocument(new[] { type.GetTypeInfo() }, options, options.AsyncApi, ActivatorServiceProvider.Instance); + + // Assert + document.ShouldNotBeNull(); + document.Channels.Count.ShouldBe(1); + + var channel = document.Channels.First(); + channel.Key.ShouldBe($"{source}.event"); + channel.Value.Description.ShouldBeNull(); + + var publish = channel.Value.Publish; + publish.ShouldNotBeNull(); + publish.OperationId.ShouldBe("PublishEvent"); + publish.Description.ShouldBe($"({source}) Subscribe to domains events about a tenant."); + + var messageRef = publish.Message.ShouldBeOfType(); + messageRef.Id.ShouldBe("tenantEvent"); + } + + [AsyncApi] + private interface IAnnotatedServiceEvents + { + [Channel("interface.event")] + [PublishOperation(typeof(TenantEvent), Description = "(interface) Subscribe to domains events about a tenant.")] + void PublishEvent(TenantEvent evt); + } + + private interface IServiceEvents + { + void PublishEvent(TenantEvent evt); + } + + private class ServiceEventsFromInterface : IServiceEvents + { + public void PublishEvent(TenantEvent evt) { } + } + + private class ServiceEventsFromAnnotatedInterface : IAnnotatedServiceEvents + { + public void PublishEvent(TenantEvent evt) { } + } + + [AsyncApi] + private class AnnotatedServiceEventsFromInterface : IAnnotatedServiceEvents + { + [Channel("class.event")] + [PublishOperation(typeof(TenantEvent), Description = "(class) Subscribe to domains events about a tenant.")] + public void PublishEvent(TenantEvent evt) { } + } + + [AsyncApi] + private class AnnotatedServiceEventsFromAnnotatedInterface : IAnnotatedServiceEvents + { + [Channel("class.event")] + [PublishOperation(typeof(TenantEvent), Description = "(class) Subscribe to domains events about a tenant.")] + public void PublishEvent(TenantEvent evt) { } + } + + private class TenantEvent { } + } +} diff --git a/test/Saunter.Tests/Generation/DocumentProviderTests/AsyncApiTypesTests.cs b/test/Saunter.Tests/Generation/DocumentProviderTests/AsyncApiTypesTests.cs index c3692640..c7806ae5 100644 --- a/test/Saunter.Tests/Generation/DocumentProviderTests/AsyncApiTypesTests.cs +++ b/test/Saunter.Tests/Generation/DocumentProviderTests/AsyncApiTypesTests.cs @@ -1,7 +1,6 @@ using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; using Saunter.AsyncApiSchema.v2; -using Saunter.Attributes; using Saunter.Tests.MarkerTypeTests; using Shouldly; using Xunit; diff --git a/test/Saunter.Tests/Generation/SchemaGeneration/SchemaGenerationTests.cs b/test/Saunter.Tests/Generation/SchemaGeneration/SchemaGenerationTests.cs index 41d11a8c..b836fa00 100644 --- a/test/Saunter.Tests/Generation/SchemaGeneration/SchemaGenerationTests.cs +++ b/test/Saunter.Tests/Generation/SchemaGeneration/SchemaGenerationTests.cs @@ -1,23 +1,23 @@ using System; using System.ComponentModel.DataAnnotations; using System.Linq; -using System.Runtime.Serialization; - +using System.Runtime.Serialization; + using Newtonsoft.Json; -using Newtonsoft.Json.Serialization; - +using Newtonsoft.Json.Serialization; + using NJsonSchema; using NJsonSchema.Generation; -using NJsonSchema.NewtonsoftJson.Converters; - +using NJsonSchema.NewtonsoftJson.Converters; + using Saunter.AsyncApiSchema.v2; using Saunter.Generation.SchemaGeneration; -using Saunter.Tests.Utils; - -using Shouldly; - -using Xunit; - +using Saunter.Tests.Utils; + +using Shouldly; + +using Xunit; + using JsonInheritanceAttribute = NJsonSchema.NewtonsoftJson.Converters.JsonInheritanceAttribute; namespace Saunter.Tests.Generation.SchemaGeneration @@ -97,8 +97,8 @@ public void GenerateSchema_GenerateSchemaFromClassWithDiscriminator_GeneratesSch var schema = _schemaGenerator.Generate(type, _schemaResolver); - schema.ShouldNotBeNull(); - + schema.ShouldNotBeNull(); + _schemaResolver.Schemas.ShouldNotBeNull(); var petSchema = _schemaResolver.Schemas.FirstOrDefault(s => s.Id == "pet"); petSchema.Discriminator.ShouldBe("petType"); @@ -242,4 +242,4 @@ public class Dog : Pet { public string PackSize { get; set; } } -} +} From 8e7a01fd65d7566b6eacdc54b7daaaf09ec59927 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Wed, 10 Jul 2024 00:13:28 +0200 Subject: [PATCH 03/10] #196 Tool rewrite to make its components testable, removed Swachbuckle copy/paste code --- src/AsyncAPI.Saunter.Generator.Cli/Args.cs | 10 - .../AsyncAPI.Saunter.Generator.Cli.csproj | 14 +- .../Commands/Tofile.cs | 42 --- .../Commands/TofileInternal.cs | 195 ----------- .../Internal/DependencyResolver.cs | 24 -- src/AsyncAPI.Saunter.Generator.Cli/Program.cs | 50 +-- .../SwashbuckleImport/CommandRunner.cs | 145 -------- .../SwashbuckleImport/HostFactoryResolver.cs | 322 ------------------ .../SwashbuckleImport/HostingApplication.cs | 118 ------- .../SwashbuckleImport/readme.md | 3 - .../ToFile/AsyncApiDocumentExtractor.cs | 67 ++++ .../ToFile/Environment.cs | 28 ++ .../ToFile/FileWriter.cs | 34 ++ .../ToFile/ServiceExtensions.cs | 15 + .../ToFile/ServiceProviderBuilder.cs | 20 ++ .../ToFile/ToFileCommand.cs | 77 +++++ .../AsyncApiSchema/v2/AsyncApiDocument.cs | 14 +- .../DotnetCliToolTests.cs | 32 +- .../InterfaceAttributeTests.cs | 8 +- 19 files changed, 290 insertions(+), 928 deletions(-) delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/Args.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/CommandRunner.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostingApplication.cs delete mode 100644 src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/readme.md create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Args.cs b/src/AsyncAPI.Saunter.Generator.Cli/Args.cs deleted file mode 100644 index 1100a58b..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/Args.cs +++ /dev/null @@ -1,10 +0,0 @@ -// ReSharper disable once CheckNamespace -public static partial class Program -{ - internal const string StartupAssemblyArgument = "startupassembly"; - internal const string DocOption = "--doc"; - internal const string FormatOption = "--format"; - internal const string FileNameOption = "--filename"; - internal const string OutputOption = "--output"; - internal const string EnvOption = "--env"; -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj b/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj index 0ece5488..e510838e 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj +++ b/src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj @@ -2,7 +2,7 @@ Exe - net6.0;net8.0 + net8.0 enable 12 AsyncAPI.Saunter.Generator.Cli @@ -11,6 +11,7 @@ AsyncAPI Initiative true AsyncAPI.Saunter.Generator.Cli + DotnetTool dotnet-asyncapi asyncapi;aspnetcore;openapi;documentation;amqp;generator;cli;tool readme.md @@ -34,10 +35,13 @@ - - - + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + @@ -45,7 +49,7 @@ - + diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs b/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs deleted file mode 100644 index 1c90a9b9..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/Commands/Tofile.cs +++ /dev/null @@ -1,42 +0,0 @@ -using System.Diagnostics; -using System.Reflection; -using static Program; - -namespace AsyncApi.Saunter.Generator.Cli.Commands; - -internal class Tofile -{ - internal static Func, int> Run(string[] args) => namedArgs => - { - if (!File.Exists(namedArgs[StartupAssemblyArgument])) - { - throw new FileNotFoundException(namedArgs[StartupAssemblyArgument]); - } - - var depsFile = namedArgs[StartupAssemblyArgument].Replace(".dll", ".deps.json"); - var runtimeConfig = namedArgs[StartupAssemblyArgument].Replace(".dll", ".runtimeconfig.json"); - var commandName = args[0]; - - var subProcessArguments = new string[args.Length - 1]; - if (subProcessArguments.Length > 0) - { - Array.Copy(args, 1, subProcessArguments, 0, subProcessArguments.Length); - } - - var assembly = typeof(Program).GetTypeInfo().Assembly; - var subProcessCommandLine = - $"exec --depsfile {EscapePath(depsFile)} " + - $"--runtimeconfig {EscapePath(runtimeConfig)} " + - $"{EscapePath(assembly.Location)} " + - $"_{commandName} {string.Join(" ", subProcessArguments.Select(EscapePath))}"; - - var subProcess = Process.Start("dotnet", subProcessCommandLine); - subProcess.WaitForExit(); - return subProcess.ExitCode; - }; - - private static string EscapePath(string path) - { - return (path.Contains(' ') || string.IsNullOrWhiteSpace(path)) ? "\"" + path + "\"" : path; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs b/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs deleted file mode 100644 index b833d741..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs +++ /dev/null @@ -1,195 +0,0 @@ -using System.Reflection; -using System.Runtime.Loader; -using AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; -using LEGO.AsyncAPI; -using LEGO.AsyncAPI.Models; -using LEGO.AsyncAPI.Readers; -using Microsoft.AspNetCore; -using Microsoft.AspNetCore.Hosting; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Hosting; -using Microsoft.Extensions.Options; -using Saunter; -using Saunter.Serialization; -using static Program; -using AsyncApiDocument = Saunter.AsyncApiSchema.v2.AsyncApiDocument; - -namespace AsyncApi.Saunter.Generator.Cli.Commands; - -internal class TofileInternal -{ - private const string defaultDocumentName = null; - - internal static int Run(IDictionary namedArgs) - { - // 1) Configure host with provided startupassembly - var startupAssembly = AssemblyLoadContext.Default.LoadFromAssemblyPath(Path.Combine(Directory.GetCurrentDirectory(), namedArgs[StartupAssemblyArgument])); - - // 2) Build a service container that's based on the startup assembly - var envVars = (namedArgs.TryGetValue(EnvOption, out var x) && !string.IsNullOrWhiteSpace(x)) ? x.Split(',').Select(x => x.Trim()) : Array.Empty(); - foreach (var envVar in envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList())) - { - if (envVar.Count is 1 or 2) - { - Environment.SetEnvironmentVariable(envVar[0], envVar.ElementAtOrDefault(1), EnvironmentVariableTarget.Process); - } - else - { - throw new ArgumentOutOfRangeException(EnvOption, namedArgs[EnvOption], "Environment variable should be in the format: env1=value1,env2=value2,env3"); - } - } - var serviceProvider = GetServiceProvider(startupAssembly); - - // 3) Retrieve AsyncAPI via configured provider - var documentProvider = serviceProvider.GetService(); - var asyncapiOptions = serviceProvider.GetService>().Value; - var documentSerializer = serviceProvider.GetRequiredService(); - - var documentNames = (namedArgs.TryGetValue(DocOption, out var doc) && !string.IsNullOrWhiteSpace(doc)) ? [doc] : asyncapiOptions.NamedApis.Keys; - var fileTemplate = (namedArgs.TryGetValue(FileNameOption, out var template) && !string.IsNullOrWhiteSpace(template)) ? template : "{document}_asyncapi.{extension}"; - if (documentNames.Count == 0) - { - if (asyncapiOptions.AssemblyMarkerTypes.Any()) - { - documentNames = [defaultDocumentName]; - } - else - { - throw new ArgumentOutOfRangeException(DocOption, $"No AsyncAPI documents found: {DocOption} = '{doc}'. Known document(s): {string.Join(", ", asyncapiOptions.NamedApis.Keys)}."); - } - } - - foreach (var documentName in documentNames) - { - AsyncApiDocument prototype; - if (documentName == defaultDocumentName) - { - prototype = asyncapiOptions.AsyncApi; - } - else if (!asyncapiOptions.NamedApis.TryGetValue(documentName, out prototype)) - { - throw new ArgumentOutOfRangeException(DocOption, documentName, $"Requested AsyncAPI document not found: '{documentName}'. Known document(s): {string.Join(", ", asyncapiOptions.NamedApis.Keys)}."); - } - - var schema = documentProvider.GetDocument(asyncapiOptions, prototype); - var asyncApiSchemaJson = documentSerializer.Serialize(schema); - var asyncApiDocument = new AsyncApiStringReader().Read(asyncApiSchemaJson, out var diagnostic); - if (diagnostic.Errors.Any()) - { - Console.Error.WriteLine($"AsyncAPI Schema '{documentName ?? "default"}' is not valid ({diagnostic.Errors.Count} Error(s), {diagnostic.Warnings.Count} Warning(s)):" + - $"{Environment.NewLine}{string.Join(Environment.NewLine, diagnostic.Errors.Select(x => $"- {x}"))}"); - } - - // 4) Serialize to specified output location or stdout - var outputPath = (namedArgs.TryGetValue(OutputOption, out var path) && !string.IsNullOrWhiteSpace(path)) ? Path.Combine(Directory.GetCurrentDirectory(), path) : null; - if (!string.IsNullOrEmpty(outputPath)) - { - Directory.CreateDirectory(outputPath); - } - - var exportJson = true; - var exportYml = false; - var exportYaml = false; - if (namedArgs.TryGetValue(FormatOption, out var format) && !string.IsNullOrWhiteSpace(format)) - { - var splitted = format.Split(',').Select(x => x.Trim()).ToList(); - exportJson = splitted.Any(x => x.Equals("json", StringComparison.OrdinalIgnoreCase)); - exportYml = splitted.Any(x => x.Equals("yml", StringComparison.OrdinalIgnoreCase)); - exportYaml = splitted.Any(x => x.Equals("yaml", StringComparison.OrdinalIgnoreCase)); - } - - if (exportJson) - { - WriteFile(AddFileExtension(outputPath, fileTemplate, documentName, "json"), stream => asyncApiDocument.SerializeAsJson(stream, AsyncApiVersion.AsyncApi2_0)); - } - - if (exportYml) - { - WriteFile(AddFileExtension(outputPath, fileTemplate, documentName, "yml"), stream => asyncApiDocument.SerializeAsYaml(stream, AsyncApiVersion.AsyncApi2_0)); - } - - if (exportYaml) - { - WriteFile(AddFileExtension(outputPath, fileTemplate, documentName, "yaml"), stream => asyncApiDocument.SerializeAsYaml(stream, AsyncApiVersion.AsyncApi2_0)); - } - } - - return 0; - } - - private static void WriteFile(string outputPath, Action writeAction) - { - using var stream = outputPath != null ? File.Create(outputPath) : Console.OpenStandardOutput(); - writeAction(stream); - - if (outputPath != null) - { - Console.WriteLine($"AsyncAPI {Path.GetExtension(outputPath)[1..]} successfully written to {outputPath}"); - } - } - - private static string AddFileExtension(string outputPath, string fileTemplate, string documentName, string extension) - { - if (outputPath == null) - { - return outputPath; - } - - return Path.Combine(outputPath, fileTemplate.Replace("{document}", documentName == defaultDocumentName ? "" : documentName).Replace("{extension}", extension).TrimStart('_')); - } - - private static IServiceProvider GetServiceProvider(Assembly startupAssembly) - { - if (TryGetCustomHost(startupAssembly, "AsyncAPIHostFactory", "CreateHost", out IHost host)) - { - return host.Services; - } - - if (TryGetCustomHost(startupAssembly, "AsyncAPIWebHostFactory", "CreateWebHost", out IWebHost webHost)) - { - return webHost.Services; - } - - try - { - return WebHost.CreateDefaultBuilder().UseStartup(startupAssembly.GetName().Name).Build().Services; - } - catch - { - var serviceProvider = HostingApplication.GetServiceProvider(startupAssembly); - - if (serviceProvider != null) - { - return serviceProvider; - } - - throw; - } - } - - private static bool TryGetCustomHost(Assembly startupAssembly, string factoryClassName, string factoryMethodName, out THost host) - { - // Scan the assembly for any types that match the provided naming convention - var factoryTypes = startupAssembly.DefinedTypes.Where(t => t.Name == factoryClassName).ToList(); - - if (factoryTypes.Count == 0) - { - host = default; - return false; - } - else if (factoryTypes.Count > 1) - { - throw new InvalidOperationException($"Multiple {factoryClassName} classes detected"); - } - - var factoryMethod = factoryTypes.Single().GetMethod(factoryMethodName, BindingFlags.Public | BindingFlags.Static); - - if (factoryMethod == null || factoryMethod.ReturnType != typeof(THost)) - { - throw new InvalidOperationException($"{factoryClassName} class detected but does not contain a public static method called {factoryMethodName} with return type {typeof(THost).Name}"); - } - - host = (THost)factoryMethod.Invoke(null, null); - return true; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs b/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs deleted file mode 100644 index d136cf1f..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/Internal/DependencyResolver.cs +++ /dev/null @@ -1,24 +0,0 @@ -using System.Reflection; - -namespace AsyncAPI.Saunter.Generator.Cli.Internal; - -internal static class DependencyResolver -{ - public static void Init() - { - var basePath = Path.GetDirectoryName(typeof(Program).GetTypeInfo().Assembly.Location); - AppDomain.CurrentDomain.AssemblyResolve += (sender, args) => - { - var requestedAssembly = new AssemblyName(args.Name); - var fullPath = Path.Combine(basePath, $"{requestedAssembly.Name}.dll"); - if (File.Exists(fullPath)) - { - var assembly = Assembly.LoadFile(fullPath); - return assembly; - } - - Console.WriteLine($"Could not resolve assembly: {args.Name}, requested by {args.RequestingAssembly?.FullName}"); - return default; - }; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/Program.cs b/src/AsyncAPI.Saunter.Generator.Cli/Program.cs index b9facd2b..3502ea7d 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/Program.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/Program.cs @@ -1,39 +1,17 @@ -using AsyncApi.Saunter.Generator.Cli.Commands; -using AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; -using AsyncAPI.Saunter.Generator.Cli.Internal; +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using ConsoleAppFramework; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; -DependencyResolver.Init(); +var services = new ServiceCollection(); +services.AddLogging(builder => builder.AddSimpleConsole(x => x.SingleLine = true).SetMinimumLevel(LogLevel.Trace)); +services.AddToFileCommand(); -// Helper to simplify command line parsing etc. -var runner = new CommandRunner("dotnet asyncapi", "AsyncAPI Command Line Tools", Console.Out); +using var serviceProvider = services.BuildServiceProvider(); +var logger = serviceProvider.GetRequiredService>(); +ConsoleApp.LogError = msg => logger.LogError(msg); +ConsoleApp.ServiceProvider = serviceProvider; -// NOTE: The "dotnet asyncapi tofile" command does not serve the request directly. Instead, it invokes a corresponding -// command (called _tofile) via "dotnet exec" so that the runtime configuration (*.runtimeconfig & *.deps.json) of the -// provided startupassembly can be used instead of the tool's. This is neccessary to successfully load the -// startupassembly and it's transitive dependencies. See https://github.com/dotnet/coreclr/issues/13277 for more. - -// > dotnet asyncapi tofile ... -runner.SubCommand("tofile", "retrieves AsyncAPI from a startup assembly, and writes to file ", c => -{ - c.Argument(StartupAssemblyArgument, "relative path to the application's startup assembly"); - c.Option(DocOption, "name(s) of the AsyncAPI documents you want to retrieve, as configured in your startup class [defaults to all documents]"); - c.Option(OutputOption, "relative path where the AsyncAPI will be output [defaults to stdout]"); - c.Option(FileNameOption, "defines the file name template, {document} and {extension} template variables can be used [defaults to \"{document}_asyncapi.{extension}\"]"); - c.Option(FormatOption, "exports AsyncAPI in json and/or yml format [defaults to json]"); - c.Option(EnvOption, "define environment variable(s) for the application during generation of the AsyncAPI files [defaults to empty, can be used to define for example ASPNETCORE_ENVIRONMENT]"); - c.OnRun(Tofile.Run(args)); -}); - -// > dotnet asyncapi _tofile ... (* should only be invoked via "dotnet exec") -runner.SubCommand("_tofile", "", c => -{ - c.Argument(StartupAssemblyArgument, ""); - c.Option(DocOption, ""); - c.Option(OutputOption, ""); - c.Option(FileNameOption, ""); - c.Option(FormatOption, ""); - c.Option(EnvOption, ""); - c.OnRun(TofileInternal.Run); -}); - -return runner.Run(args); +var app = ConsoleApp.Create(); +app.Add(); +app.Run(args); diff --git a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/CommandRunner.cs b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/CommandRunner.cs deleted file mode 100644 index c3c8eca0..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/CommandRunner.cs +++ /dev/null @@ -1,145 +0,0 @@ -namespace AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; - -internal class CommandRunner -{ - private readonly Dictionary _argumentDescriptors; - private readonly Dictionary _optionDescriptors; - private Func, int> _runFunc; - private readonly List _subRunners; - private readonly TextWriter _output; - - public CommandRunner(string commandName, string commandDescription, TextWriter output) - { - CommandName = commandName; - CommandDescription = commandDescription; - _argumentDescriptors = []; - _optionDescriptors = []; - _runFunc = (_) => 1; // no-op - _subRunners = []; - _output = output; - } - - public string CommandName { get; private set; } - - public string CommandDescription { get; private set; } - - public void Argument(string name, string description) - { - _argumentDescriptors.Add(name, description); - } - - public void Option(string name, string description, bool isFlag = false) - { - if (!name.StartsWith("--")) throw new ArgumentException("name of option must begin with --"); - _optionDescriptors.Add(name, new OptionDescriptor { Description = description, IsFlag = isFlag }); - } - - public void OnRun(Func, int> runFunc) - { - _runFunc = runFunc; - } - - public void SubCommand(string name, string description, Action configAction) - { - var runner = new CommandRunner($"{CommandName} {name}", description, _output); - configAction(runner); - _subRunners.Add(runner); - } - - public int Run(IEnumerable args) - { - if (args.Any()) - { - var subRunner = _subRunners.FirstOrDefault(r => r.CommandName.Split(' ').Last() == args.First()); - if (subRunner != null) return subRunner.Run(args.Skip(1)); - } - - if (_subRunners.Any() || !TryParseArgs(args, out IDictionary namedArgs)) - { - PrintUsage(); - return 1; - } - - return _runFunc(namedArgs); - } - - private bool TryParseArgs(IEnumerable args, out IDictionary namedArgs) - { - namedArgs = new Dictionary(); - var argsQueue = new Queue(args); - - // Process options first - while (argsQueue.Any() && argsQueue.Peek().StartsWith("--")) - { - // Ensure it's a known option - var name = argsQueue.Dequeue(); - if (!_optionDescriptors.TryGetValue(name, out OptionDescriptor optionDescriptor)) - return false; - - // If it's not a flag, ensure it's followed by a corresponding value - if (!optionDescriptor.IsFlag && (!argsQueue.Any() || argsQueue.Peek().StartsWith("--"))) - return false; - - namedArgs.Add(name, (!optionDescriptor.IsFlag ? argsQueue.Dequeue() : null)); - } - - // Process required args - ensure corresponding values are provided - foreach (var name in _argumentDescriptors.Keys) - { - if (!argsQueue.Any() || argsQueue.Peek().StartsWith("--")) return false; - namedArgs.Add(name, argsQueue.Dequeue()); - } - - return argsQueue.Count() == 0; - } - - private void PrintUsage() - { - if (_subRunners.Any()) - { - // List sub commands - _output.WriteLine(CommandDescription); - _output.WriteLine("Commands:"); - foreach (var runner in _subRunners) - { - var shortName = runner.CommandName.Split(' ').Last(); - if (shortName.StartsWith("_")) continue; // convention to hide commands - _output.WriteLine($" {shortName}: {runner.CommandDescription}"); - } - _output.WriteLine(); - } - else - { - // Usage for this command - var optionsPart = _optionDescriptors.Any() ? "[options] " : ""; - var argParts = _argumentDescriptors.Keys.Select(name => $"[{name}]"); - _output.WriteLine($"Usage: {CommandName} {optionsPart}{string.Join(" ", argParts)}"); - _output.WriteLine(); - - // Arguments - foreach (var entry in _argumentDescriptors) - { - _output.WriteLine($"{entry.Key}:"); - _output.WriteLine($" {entry.Value}"); - _output.WriteLine(); - } - - // Options - if (_optionDescriptors.Any()) - { - _output.WriteLine("options:"); - foreach (var entry in _optionDescriptors) - { - _output.WriteLine($" {entry.Key}: {entry.Value.Description}"); - } - _output.WriteLine(); - } - } - } - - private struct OptionDescriptor - { - public string Description; - public bool IsFlag; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs deleted file mode 100644 index 266e47f4..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostFactoryResolver.cs +++ /dev/null @@ -1,322 +0,0 @@ -using System.Diagnostics; -using System.Reflection; - -namespace Microsoft.Extensions.Hosting; - -internal sealed class HostFactoryResolver -{ - private const BindingFlags DeclaredOnlyLookup = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static | BindingFlags.DeclaredOnly; - - public const string BuildWebHost = nameof(BuildWebHost); - public const string CreateWebHostBuilder = nameof(CreateWebHostBuilder); - public const string CreateHostBuilder = nameof(CreateHostBuilder); - - // The amount of time we wait for the diagnostic source events to fire - private static readonly TimeSpan s_defaultWaitTimeout = Debugger.IsAttached ? Timeout.InfiniteTimeSpan : TimeSpan.FromSeconds(30); - - public static Func ResolveWebHostFactory(Assembly assembly) - { - return ResolveFactory(assembly, BuildWebHost); - } - - public static Func ResolveWebHostBuilderFactory(Assembly assembly) - { - return ResolveFactory(assembly, CreateWebHostBuilder); - } - - public static Func ResolveHostBuilderFactory(Assembly assembly) - { - return ResolveFactory(assembly, CreateHostBuilder); - } - - // This helpers encapsulates all of the complex logic required to: - // 1. Execute the entry point of the specified assembly in a different thread. - // 2. Wait for the diagnostic source events to fire - // 3. Give the caller a chance to execute logic to mutate the IHostBuilder - // 4. Resolve the instance of the applications's IHost - // 5. Allow the caller to determine if the entry point has completed - public static Func ResolveHostFactory(Assembly assembly, - TimeSpan? waitTimeout = null, - bool stopApplication = true, - Action configureHostBuilder = null, - Action entrypointCompleted = null) - { - if (assembly.EntryPoint is null) - { - return null; - } - - try - { - // Attempt to load hosting and check the version to make sure the events - // even have a chance of firing (they were added in .NET >= 6) - var hostingAssembly = Assembly.Load("Microsoft.Extensions.Hosting"); - if (hostingAssembly.GetName().Version is Version version && version.Major < 6) - { - return null; - } - - // We're using a version >= 6 so the events can fire. If they don't fire - // then it's because the application isn't using the hosting APIs - } - catch - { - // There was an error loading the extensions assembly, return null. - return null; - } - - return args => new HostingListener(args, assembly.EntryPoint, waitTimeout ?? s_defaultWaitTimeout, stopApplication, configureHostBuilder, entrypointCompleted).CreateHost(); - } - - private static Func ResolveFactory(Assembly assembly, string name) - { - var programType = assembly?.EntryPoint?.DeclaringType; - if (programType == null) - { - return null; - } - - var factory = programType.GetMethod(name, DeclaredOnlyLookup); - if (!IsFactory(factory)) - { - return null; - } - - return args => (T)factory.Invoke(null, [args]); - } - - // TReturn Factory(string[] args); - private static bool IsFactory(MethodInfo factory) - { - return factory != null - && typeof(TReturn).IsAssignableFrom(factory.ReturnType) - && factory.GetParameters().Length == 1 - && typeof(string[]).Equals(factory.GetParameters()[0].ParameterType); - } - - // Used by EF tooling without any Hosting references. Looses some return type safety checks. - public static Func ResolveServiceProviderFactory(Assembly assembly, TimeSpan? waitTimeout = null) - { - // Prefer the older patterns by default for back compat. - var webHostFactory = ResolveWebHostFactory(assembly); - if (webHostFactory != null) - { - return args => - { - var webHost = webHostFactory(args); - return GetServiceProvider(webHost); - }; - } - - var webHostBuilderFactory = ResolveWebHostBuilderFactory(assembly); - if (webHostBuilderFactory != null) - { - return args => - { - var webHostBuilder = webHostBuilderFactory(args); - var webHost = Build(webHostBuilder); - return GetServiceProvider(webHost); - }; - } - - var hostBuilderFactory = ResolveHostBuilderFactory(assembly); - if (hostBuilderFactory != null) - { - return args => - { - var hostBuilder = hostBuilderFactory(args); - var host = Build(hostBuilder); - return GetServiceProvider(host); - }; - } - - var hostFactory = ResolveHostFactory(assembly, waitTimeout: waitTimeout); - if (hostFactory != null) - { - return args => - { - var host = hostFactory(args); - return GetServiceProvider(host); - }; - } - - return null; - } - - private static object Build(object builder) - { - var buildMethod = builder.GetType().GetMethod("Build"); - return buildMethod?.Invoke(builder, []); - } - - private static IServiceProvider GetServiceProvider(object host) - { - if (host == null) - { - return null; - } - var hostType = host.GetType(); - var servicesProperty = hostType.GetProperty("Services", DeclaredOnlyLookup); - return (IServiceProvider)servicesProperty?.GetValue(host); - } - - private sealed class HostingListener : IObserver, IObserver> - { - private readonly string[] _args; - private readonly MethodInfo _entryPoint; - private readonly TimeSpan _waitTimeout; - private readonly bool _stopApplication; - - private readonly TaskCompletionSource _hostTcs = new(); - private IDisposable _disposable; - private readonly Action _configure; - private readonly Action _entrypointCompleted; - private static readonly AsyncLocal _currentListener = new(); - - public HostingListener( - string[] args, - MethodInfo entryPoint, - TimeSpan waitTimeout, - bool stopApplication, - Action configure, - Action entrypointCompleted) - { - _args = args; - _entryPoint = entryPoint; - _waitTimeout = waitTimeout; - _stopApplication = stopApplication; - _configure = configure; - _entrypointCompleted = entrypointCompleted; - } - - public object CreateHost() - { - using var subscription = DiagnosticListener.AllListeners.Subscribe(this); - - // Kick off the entry point on a new thread so we don't block the current one - // in case we need to timeout the execution - var thread = new Thread(() => - { - Exception exception = null; - - try - { - // Set the async local to the instance of the HostingListener so we can filter events that - // aren't scoped to this execution of the entry point. - _currentListener.Value = this; - - var parameters = _entryPoint.GetParameters(); - if (parameters.Length == 0) - { - _entryPoint.Invoke(null, []); - } - else - { - _entryPoint.Invoke(null, [_args]); - } - - // Try to set an exception if the entry point returns gracefully, this will force - // build to throw - _hostTcs.TrySetException(new InvalidOperationException("Unable to build IHost")); - } - catch (TargetInvocationException tie) when (tie.InnerException is StopTheHostException) - { - // The host was stopped by our own logic - } - catch (TargetInvocationException tie) - { - exception = tie.InnerException ?? tie; - - // Another exception happened, propagate that to the caller - _hostTcs.TrySetException(exception); - } - catch (Exception ex) - { - exception = ex; - - // Another exception happened, propagate that to the caller - _hostTcs.TrySetException(ex); - } - finally - { - // Signal that the entry point is completed - _entrypointCompleted?.Invoke(exception); - } - }) - { - // Make sure this doesn't hang the process - IsBackground = true - }; - - // Start the thread - thread.Start(); - - try - { - // Wait before throwing an exception - if (!_hostTcs.Task.Wait(_waitTimeout)) - { - throw new InvalidOperationException("Unable to build IHost"); - } - } - catch (AggregateException) when (_hostTcs.Task.IsCompleted) - { - // Lets this propagate out of the call to GetAwaiter().GetResult() - } - - Debug.Assert(_hostTcs.Task.IsCompleted); - - return _hostTcs.Task.GetAwaiter().GetResult(); - } - - public void OnCompleted() - { - _disposable?.Dispose(); - } - - public void OnError(Exception error) - { - } - - public void OnNext(DiagnosticListener value) - { - if (_currentListener.Value != this) - { - // Ignore events that aren't for this listener - return; - } - - if (value.Name == "Microsoft.Extensions.Hosting") - { - _disposable = value.Subscribe(this); - } - } - - public void OnNext(KeyValuePair value) - { - if (_currentListener.Value != this) - { - // Ignore events that aren't for this listener - return; - } - - if (value.Key == "HostBuilding") - { - _configure?.Invoke(value.Value); - } - - if (value.Key == "HostBuilt") - { - _hostTcs.TrySetResult(value.Value); - - if (_stopApplication) - { - // Stop the host from running further - throw new StopTheHostException(); - } - } - } - - private sealed class StopTheHostException : Exception; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostingApplication.cs b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostingApplication.cs deleted file mode 100644 index e4635aff..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/HostingApplication.cs +++ /dev/null @@ -1,118 +0,0 @@ -using System.Reflection; -using Microsoft.AspNetCore.Hosting.Server; -using Microsoft.AspNetCore.Http.Features; -#if NETCOREAPP3_0_OR_GREATER -using Microsoft.Extensions.DependencyInjection; -#endif -using Microsoft.Extensions.Hosting; - -namespace AsyncApi.Saunter.Generator.Cli.SwashbuckleImport; - -// Represents an application that uses Microsoft.Extensions.Hosting and supports -// the various entry point flavors. The final model *does not* have an explicit CreateHost entry point and thus inverts the typical flow where the -// execute Main and we wait for events to fire in order to access the appropriate state. -// This is what allows top level statements to work, but getting the IServiceProvider is slightly more complex. -internal class HostingApplication -{ - internal static IServiceProvider GetServiceProvider(Assembly assembly) - { -#if NETCOREAPP2_1 - return null; -#else - // We're disabling the default server and the console host lifetime. This will disable: - // 1. Listening on ports - // 2. Logging to the console from the default host. - // This is essentially what the test server does in order to get access to the application's - // IServicerProvider *and* middleware pipeline. - void ConfigureHostBuilder(object hostBuilder) - { - ((IHostBuilder)hostBuilder).ConfigureServices((context, services) => - { - services.AddSingleton(); - services.AddSingleton(); - - for (var i = services.Count - 1; i >= 0; i--) - { - // exclude all implementations of IHostedService - // except Microsoft.AspNetCore.Hosting.GenericWebHostService because that one will build/configure - // the WebApplication/Middleware pipeline in the case of the GenericWebHostBuilder. - var registration = services[i]; - if (registration.ServiceType == typeof(IHostedService) - && registration.ImplementationType is not { FullName: "Microsoft.AspNetCore.Hosting.GenericWebHostService" }) - { - services.RemoveAt(i); - } - } - }); - } - - var waitForStartTcs = new TaskCompletionSource(); - - void OnEntryPointExit(Exception exception) - { - // If the entry point exited, we'll try to complete the wait - if (exception != null) - { - waitForStartTcs.TrySetException(exception); - } - else - { - waitForStartTcs.TrySetResult(null); - } - } - - // If all of the existing techniques fail, then try to resolve the ResolveHostFactory - var factory = HostFactoryResolver.ResolveHostFactory(assembly, - stopApplication: false, - configureHostBuilder: ConfigureHostBuilder, - entrypointCompleted: OnEntryPointExit); - - // We're unable to resolve the factory. This could mean the application wasn't referencing the right - // version of hosting. - if (factory == null) - { - return null; - } - - try - { - // Get the IServiceProvider from the host - var assemblyName = assembly.GetName()?.FullName ?? string.Empty; - // We set the application name in the hosting environment to the startup assembly - // to avoid falling back to the entry assembly (dotnet-swagger) when configuring our - // application. - var services = ((IHost)factory([$"--{HostDefaults.ApplicationKey}={assemblyName}"])).Services; - - // Wait for the application to start so that we know it's fully configured. This is important because - // we need the middleware pipeline to be configured before we access the ISwaggerProvider in - // in the IServiceProvider - var applicationLifetime = services.GetRequiredService(); - - using var registration = applicationLifetime.ApplicationStarted.Register(() => waitForStartTcs.TrySetResult(null)); - waitForStartTcs.Task.Wait(); - - return services; - } - catch (InvalidOperationException) - { - // We're unable to resolve the host, swallow the exception and return null - } - - return null; -#endif - } - - private class NoopHostLifetime : IHostLifetime - { - public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask; - public Task WaitForStartAsync(CancellationToken cancellationToken) => Task.CompletedTask; - } - - private class NoopServer : IServer - { - public IFeatureCollection Features { get; } = new FeatureCollection(); - public void Dispose() { } - public Task StartAsync(IHttpApplication application, CancellationToken cancellationToken) => Task.CompletedTask; - public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask; - } -} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/readme.md b/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/readme.md deleted file mode 100644 index babea97b..00000000 --- a/src/AsyncAPI.Saunter.Generator.Cli/SwashbuckleImport/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -This code is taken from [Swashbuckle.AspNetCore.Cli](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/master/src/Swashbuckle.AspNetCore.Cli) - -Since Swashbuckle.AspNetCore.Cli is delivered as a tool, code cannot be reference through Nuget. \ No newline at end of file diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs new file mode 100644 index 00000000..9f070ddf --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs @@ -0,0 +1,67 @@ +using LEGO.AsyncAPI.Models; +using LEGO.AsyncAPI.Readers; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Options; +using Saunter.Serialization; +using Saunter; +using Microsoft.Extensions.Logging; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal class AsyncApiDocumentExtractor(ILogger logger) +{ + private IEnumerable GetDocumentNames(string[] requestedDocuments, AsyncApiOptions asyncApiOptions) + { + var documentNames = requestedDocuments ?? asyncApiOptions.NamedApis.Keys; + if (documentNames.Count == 0) + { + if (asyncApiOptions.AssemblyMarkerTypes.Any()) + { + documentNames = [null]; // null marks the default, unnamed, document + } + else + { + logger.LogCritical($"AsyncAPI documents found. Known named document(s): {string.Join(", ", asyncApiOptions.NamedApis.Keys)}."); + } + } + return documentNames; + } + + public IEnumerable<(string name, AsyncApiDocument document)> GetAsyncApiDocument(IServiceProvider serviceProvider, string[] requestedDocuments) + { + var documentProvider = serviceProvider.GetService(); + var asyncApiOptions = serviceProvider.GetService>().Value; + var documentSerializer = serviceProvider.GetRequiredService(); + + foreach (var documentName in GetDocumentNames(requestedDocuments, asyncApiOptions)) + { + if (documentName == null || !asyncApiOptions.NamedApis.TryGetValue(documentName, out var prototype)) + { + prototype = asyncApiOptions.AsyncApi; + } + + var schema = documentProvider.GetDocument(asyncApiOptions, prototype); + var asyncApiSchemaJson = documentSerializer.Serialize(schema); + var asyncApiDocument = new AsyncApiStringReader().Read(asyncApiSchemaJson, out var diagnostic); + if (diagnostic.Errors.Any()) + { + logger.LogError($"AsyncAPI Schema '{documentName ?? "default"}' is not valid ({diagnostic.Errors.Count} Error(s))"); + foreach (var error in diagnostic.Errors) + { + logger.LogError($"- {error}"); + } + } + if (diagnostic.Warnings.Any()) + { + logger.LogWarning($"AsyncAPI Schema '{documentName ?? "default"}' has {diagnostic.Warnings.Count} Warning(s):"); + foreach (var warning in diagnostic.Warnings) + { + logger.LogWarning($"- {warning}"); + } + } + + yield return (documentName, asyncApiDocument); + } + } +} + diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs new file mode 100644 index 00000000..040637a4 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs @@ -0,0 +1,28 @@ +using Microsoft.Extensions.Logging; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal class EnvironmentBuilder(ILogger logger) +{ + public void SetEnvironmentVariables(string env) + { + var envVars = !string.IsNullOrWhiteSpace(env) ? env.Split(',').Select(x => x.Trim()) : Array.Empty(); + foreach (var envVar in envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList())) + { + if (envVar.Count is 1) + { + Environment.SetEnvironmentVariable(envVar[0], null, EnvironmentVariableTarget.Process); + logger.LogDebug($"Set environment flag: {envVar[0]}"); + } + if (envVar.Count is 2) + { + Environment.SetEnvironmentVariable(envVar[0], envVar.ElementAtOrDefault(1), EnvironmentVariableTarget.Process); + logger.LogDebug($"Set environment variable: {envVar[0]} = {envVar[1]}"); + } + else + { + logger.LogCritical("Environment variables should be in the format: env1=value1,env2=value2,env3"); + } + } + } +} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs new file mode 100644 index 00000000..62e1bc43 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs @@ -0,0 +1,34 @@ +using Microsoft.Extensions.Logging; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal class FileWriter(ILogger logger) +{ + public void Write(string outputPath, string fileTemplate, string documentName, string format, Action streamWriter) + { + var fullFileName = AddFileExtension(outputPath, fileTemplate, documentName, format); + this.WriteFile(fullFileName, streamWriter); + } + + private void WriteFile(string outputPath, Action writeAction) + { + using var stream = outputPath != null ? File.Create(outputPath) : Console.OpenStandardOutput(); + writeAction(stream); + + if (outputPath != null) + { + logger.LogInformation($"AsyncAPI {Path.GetExtension(outputPath)[1..]} successfully written to {outputPath}"); + } + } + + private static string AddFileExtension(string outputPath, string fileTemplate, string documentName, string extension) + { + if (outputPath == null) + { + return outputPath; + } + + return Path.GetFullPath(Path.Combine(outputPath, fileTemplate.Replace("{document}", documentName ?? "") + .Replace("{extension}", extension).TrimStart('_'))); + } +} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs new file mode 100644 index 00000000..041e496e --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs @@ -0,0 +1,15 @@ +using Microsoft.Extensions.DependencyInjection; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal static class ServiceExtensions +{ + public static IServiceCollection AddToFileCommand(this IServiceCollection services) + { + services.AddTransient(); + services.AddTransient(); + services.AddTransient(); + services.AddTransient(); + return services; + } +} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs new file mode 100644 index 00000000..6a2907a5 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs @@ -0,0 +1,20 @@ +using System.Reflection; +using Microsoft.Extensions.Logging; +using System.Runtime.Loader; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal class ServiceProviderBuilder(ILogger logger) +{ + public IServiceProvider BuildServiceProvider(string startupAssembly) + { + var fullPath = Path.GetFullPath(Path.Combine(Directory.GetCurrentDirectory(), startupAssembly)); + logger.LogInformation($"Loading startup assembly: {fullPath}"); + var assembly = AssemblyLoadContext.Default.LoadFromAssemblyPath(fullPath); + var nswagCommandsAssembly = Assembly.LoadFrom("NSwag.Commands.dll"); + var nswagServiceProvider = nswagCommandsAssembly.GetType("NSwag.Commands.ServiceProviderResolver"); + var serviceProvider = (IServiceProvider)nswagServiceProvider.InvokeMember("GetServiceProvider", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Static, null, null, [assembly]); + return serviceProvider; + } +} + diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs new file mode 100644 index 00000000..5a5172b9 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs @@ -0,0 +1,77 @@ +using ConsoleAppFramework; +using LEGO.AsyncAPI; +using LEGO.AsyncAPI.Models; +using Microsoft.Extensions.Logging; + +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal class ToFileCommand(ILogger logger, EnvironmentBuilder environment, ServiceProviderBuilder builder, AsyncApiDocumentExtractor docExtractor, FileWriter fileWriter) +{ + private const string DEFAULT_FILENAME = "{document}_asyncapi.{extension}"; + + /// + /// Retrieves AsyncAPI spec from a startup assembly and writes to file. + /// + /// relative path to the application's startup assembly + /// -o,relative path where the AsyncAPI will be output [defaults to stdout] + /// -d,name(s) of the AsyncAPI documents you want to retrieve, as configured in your startup class [defaults to all documents] + /// exports AsyncAPI in json and/or yml format [defaults to json] + /// defines the file name template, {document} and {extension} template variables can be used [defaults to "{document}_asyncapi.{extension}\"] + /// define environment variable(s) for the application. Formatted as a comma separated list of key=value pairs or just key for flags + [Command("tofile")] + public int ToFile([Argument] string startupassembly, string output = "./", string doc = null, string format = "json", string filename = DEFAULT_FILENAME, string env = "") + { + if (!File.Exists(startupassembly)) + { + throw new FileNotFoundException(startupassembly); + } + + // Prepare environment + environment.SetEnvironmentVariables(env); + + // Get service provider from startup assembly + var serviceProvider = builder.BuildServiceProvider(startupassembly); + + // Retrieve AsyncAPI via service provider + var documents = docExtractor.GetAsyncApiDocument(serviceProvider, !string.IsNullOrWhiteSpace(doc) ? doc.Split(',', StringSplitOptions.RemoveEmptyEntries) : null); + foreach (var (documentName, asyncApiDocument) in documents) + { + // Serialize to specified output location or stdout + var outputPath = !string.IsNullOrWhiteSpace(output) ? Path.Combine(Directory.GetCurrentDirectory(), output) : null; + if (!string.IsNullOrEmpty(outputPath)) + { + Directory.CreateDirectory(outputPath); + } + + var exportJson = true; + var exportYml = false; + var exportYaml = false; + if (!string.IsNullOrWhiteSpace(format)) + { + var splitted = format.Split(',').Select(x => x.Trim()).ToList(); + exportJson = splitted.Any(x => x.Equals("json", StringComparison.OrdinalIgnoreCase)); + exportYml = splitted.Any(x => x.Equals("yml", StringComparison.OrdinalIgnoreCase)); + exportYaml = splitted.Any(x => x.Equals("yaml", StringComparison.OrdinalIgnoreCase)); + } + logger.LogDebug($"Format: exportJson={exportJson}, exportYml={exportYml}, exportYaml={exportYaml}."); + + var fileTemplate = !string.IsNullOrWhiteSpace(filename) ? filename : DEFAULT_FILENAME; + if (exportJson) + { + fileWriter.Write(outputPath, fileTemplate, documentName, "json", stream => asyncApiDocument.SerializeAsJson(stream, AsyncApiVersion.AsyncApi2_0)); + } + + if (exportYml) + { + fileWriter.Write(outputPath, fileTemplate, documentName, "yml", stream => asyncApiDocument.SerializeAsYaml(stream, AsyncApiVersion.AsyncApi2_0)); + } + + if (exportYaml) + { + fileWriter.Write(outputPath, fileTemplate, documentName, "yaml", stream => asyncApiDocument.SerializeAsYaml(stream, AsyncApiVersion.AsyncApi2_0)); + } + } + + return 1; + } +} diff --git a/src/Saunter/AsyncApiSchema/v2/AsyncApiDocument.cs b/src/Saunter/AsyncApiSchema/v2/AsyncApiDocument.cs index ed38829a..a5604b64 100644 --- a/src/Saunter/AsyncApiSchema/v2/AsyncApiDocument.cs +++ b/src/Saunter/AsyncApiSchema/v2/AsyncApiDocument.cs @@ -1,9 +1,9 @@ using System; using System.Collections.Generic; -using System.Linq; - -using Newtonsoft.Json; - +using System.Linq; + +using Newtonsoft.Json; + using NJsonSchema.NewtonsoftJson.Converters; namespace Saunter.AsyncApiSchema.v2 @@ -15,8 +15,8 @@ public class AsyncApiDocument : ICloneable /// Specifies the AsyncAPI Specification version being used. /// [JsonProperty("asyncapi", NullValueHandling = NullValueHandling.Ignore)] - public string AsyncApi { get; } = "2.4.0"; - + public string AsyncApi { get; } = "2.4.0"; + /// /// Identifier of the application the AsyncAPI document is defining. /// @@ -105,4 +105,4 @@ object ICloneable.Clone() return Clone(); } } -} +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs index 47746fc8..8d9e12d3 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs @@ -6,11 +6,11 @@ namespace AsyncAPI.Saunter.Generator.Cli.Tests; public class DotnetCliToolTests(ITestOutputHelper output) { - private string RunTool(string args, int expectedExitCode = 0) + private string RunTool(string args, int expectedExitCode = 1) { var process = Process.Start(new ProcessStartInfo("dotnet") { - Arguments = $"../../../../../src/AsyncAPI.Saunter.Generator.Cli/bin/Debug/net6.0/AsyncAPI.Saunter.Generator.Cli.dll tofile {args}", + Arguments = $"../../../../../src/AsyncAPI.Saunter.Generator.Cli/bin/Debug/net8.0/AsyncAPI.Saunter.Generator.Cli.dll tofile {args}", RedirectStandardOutput = true, RedirectStandardError = true, }); @@ -28,20 +28,22 @@ private string RunTool(string args, int expectedExitCode = 0) [Fact] public void DefaultCallPrintsCommandInfo() { - var stdOut = RunTool("", 1); + var stdOut = RunTool("", 0).Trim(); stdOut.ShouldBe(""" - Usage: dotnet asyncapi tofile [options] [startupassembly] - - startupassembly: - relative path to the application's startup assembly - - options: - --doc: name(s) of the AsyncAPI documents you want to retrieve, as configured in your startup class [defaults to all documents] - --output: relative path where the AsyncAPI will be output [defaults to stdout] - --filename: defines the file name template, {document} and {extension} template variables can be used [defaults to "{document}_asyncapi.{extension}"] - --format: exports AsyncAPI in json and/or yml format [defaults to json] - --env: define environment variable(s) for the application during generation of the AsyncAPI files [defaults to empty, can be used to define for example ASPNETCORE_ENVIRONMENT] + Usage: tofile [arguments...] [options...] [-h|--help] [--version] + + Retrieves AsyncAPI spec from a startup assembly and writes to file. + + Arguments: + [0] relative path to the application's startup assembly + + Options: + -o|--output relative path where the AsyncAPI will be output [defaults to stdout] (Default: "./") + -d|--doc name(s) of the AsyncAPI documents you want to retrieve as configured in your startup class [defaults to all documents] (Default: null) + --format exports AsyncAPI in json and/or yml format [defaults to json] (Default: "json") + --filename defines the file name template, {document} and {extension} template variables can be used [defaults to "{document}_asyncapi.{extension}\"] (Default: "{document}_asyncapi.{extension}") + --env define environment variable(s) for the application. Formatted as a comma separated list of key=value pairs or just key for flags (Default: "") """, StringCompareShould.IgnoreLineEndings); } @@ -50,7 +52,7 @@ public void StreetlightsAPIExportSpecTest() { var path = Directory.GetCurrentDirectory(); output.WriteLine($"Output path: {path}"); - var stdOut = RunTool($"--output {path} --format json,yml,yaml ../../../../../examples/StreetlightsAPI/bin/Debug/net6.0/StreetlightsAPI.dll"); + var stdOut = RunTool($"../../../../../examples/StreetlightsAPI/bin/Debug/net8.0/StreetlightsAPI.dll --output {path} --format json,yml,yaml"); stdOut.ShouldNotBeEmpty(); stdOut.ShouldContain($"AsyncAPI yaml successfully written to {Path.Combine(path, "asyncapi.yaml")}"); diff --git a/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs b/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs index f520bd10..030dbfd4 100644 --- a/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs +++ b/test/Saunter.Tests/Generation/DocumentGeneratorTests/InterfaceAttributeTests.cs @@ -1,15 +1,11 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. -// See the LICENSE file in the project root for more information. - -using System; +using System; +using System.Linq; using System.Reflection; using Saunter.AsyncApiSchema.v2; using Saunter.Attributes; using Saunter.Generation; using Shouldly; using Xunit; -using System.Linq; namespace Saunter.Tests.Generation.DocumentGeneratorTests { From 240c9ed18be84682b67a18d7778adb284a5b4324 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Wed, 10 Jul 2024 00:24:46 +0200 Subject: [PATCH 04/10] #196 formatting --- .../ToFile/AsyncApiDocumentExtractor.cs | 2 +- .../ToFile/ServiceProviderBuilder.cs | 2 +- src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs index 9f070ddf..aa9852bd 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs @@ -1,10 +1,10 @@ using LEGO.AsyncAPI.Models; using LEGO.AsyncAPI.Readers; using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Saunter.Serialization; using Saunter; -using Microsoft.Extensions.Logging; namespace AsyncAPI.Saunter.Generator.Cli.ToFile; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs index 6a2907a5..5c3c6a69 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs @@ -1,6 +1,6 @@ using System.Reflection; -using Microsoft.Extensions.Logging; using System.Runtime.Loader; +using Microsoft.Extensions.Logging; namespace AsyncAPI.Saunter.Generator.Cli.ToFile; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs index 5a5172b9..98bebc55 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs @@ -8,7 +8,7 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; internal class ToFileCommand(ILogger logger, EnvironmentBuilder environment, ServiceProviderBuilder builder, AsyncApiDocumentExtractor docExtractor, FileWriter fileWriter) { private const string DEFAULT_FILENAME = "{document}_asyncapi.{extension}"; - + /// /// Retrieves AsyncAPI spec from a startup assembly and writes to file. /// From 715a62db60d702b361c3a51518f9bed50e377c5f Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Wed, 10 Jul 2024 18:37:13 +0200 Subject: [PATCH 05/10] #196 add unitTests for tofile classes --- Directory.Build.props | 9 ++ Saunter.sln | 3 +- .../ToFile/AsyncApiDocumentExtractor.cs | 2 +- .../ToFile/Environment.cs | 14 +- .../ToFile/FileWriter.cs | 6 +- .../ToFile/ServiceExtensions.cs | 1 + .../ToFile/ServiceProviderBuilder.cs | 1 - .../ToFile/StreamProvider.cs | 11 ++ ...syncAPI.Saunter.Generator.Cli.Tests.csproj | 5 +- .../ToFile/AsyncApiDocumentExtractorTests.cs | 153 ++++++++++++++++++ .../ToFile/EnvironmentBuilderTests.cs | 95 +++++++++++ .../ToFile/FileWriterTests.cs | 108 +++++++++++++ .../ToFile/StreamProviderTests.cs | 37 +++++ test/Saunter.Tests/Saunter.Tests.csproj | 2 +- 14 files changed, 430 insertions(+), 17 deletions(-) create mode 100644 Directory.Build.props create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 00000000..2451c08c --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/Saunter.sln b/Saunter.sln index 10d433bd..85c435a4 100644 --- a/Saunter.sln +++ b/Saunter.sln @@ -20,6 +20,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E0D34C77-9 .editorconfig = .editorconfig .gitattributes = .gitattributes CHANGELOG.md = CHANGELOG.md + Directory.Build.props = Directory.Build.props README.md = README.md EndProjectSection EndProject @@ -45,7 +46,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "npm", "npm", "{E8FACA22-CFE EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AsyncAPI.Saunter.Generator.Cli", "src\AsyncAPI.Saunter.Generator.Cli\AsyncAPI.Saunter.Generator.Cli.csproj", "{6C102D4D-3DA4-4763-B75E-C15E33E7E94A}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncAPI.Saunter.Generator.Cli.Tests", "test\AsyncAPI.Saunter.Generator.Cli.Tests\AsyncAPI.Saunter.Generator.Cli.Tests.csproj", "{18AD0249-0436-4A26-9972-B97BA6905A54}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AsyncAPI.Saunter.Generator.Cli.Tests", "test\AsyncAPI.Saunter.Generator.Cli.Tests\AsyncAPI.Saunter.Generator.Cli.Tests.csproj", "{18AD0249-0436-4A26-9972-B97BA6905A54}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs index aa9852bd..7cb45ca8 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs @@ -3,8 +3,8 @@ using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; -using Saunter.Serialization; using Saunter; +using Saunter.Serialization; namespace AsyncAPI.Saunter.Generator.Cli.ToFile; diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs index 040637a4..bb69a731 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs @@ -7,21 +7,17 @@ internal class EnvironmentBuilder(ILogger logger) public void SetEnvironmentVariables(string env) { var envVars = !string.IsNullOrWhiteSpace(env) ? env.Split(',').Select(x => x.Trim()) : Array.Empty(); - foreach (var envVar in envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList())) + var keyValues = envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList()); + foreach (var envVar in keyValues) { - if (envVar.Count is 1) + if (envVar.Count == 2 && !string.IsNullOrWhiteSpace(envVar[0])) { - Environment.SetEnvironmentVariable(envVar[0], null, EnvironmentVariableTarget.Process); - logger.LogDebug($"Set environment flag: {envVar[0]}"); - } - if (envVar.Count is 2) - { - Environment.SetEnvironmentVariable(envVar[0], envVar.ElementAtOrDefault(1), EnvironmentVariableTarget.Process); + Environment.SetEnvironmentVariable(envVar[0], envVar[1], EnvironmentVariableTarget.Process); logger.LogDebug($"Set environment variable: {envVar[0]} = {envVar[1]}"); } else { - logger.LogCritical("Environment variables should be in the format: env1=value1,env2=value2,env3"); + logger.LogCritical("Environment variables should be in the format: env1=value1,env2=value2"); } } } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs index 62e1bc43..02e67b8f 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs @@ -2,7 +2,7 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class FileWriter(ILogger logger) +internal class FileWriter(IStreamProvider streamProvider, ILogger logger) { public void Write(string outputPath, string fileTemplate, string documentName, string format, Action streamWriter) { @@ -12,12 +12,12 @@ public void Write(string outputPath, string fileTemplate, string documentName, s private void WriteFile(string outputPath, Action writeAction) { - using var stream = outputPath != null ? File.Create(outputPath) : Console.OpenStandardOutput(); + using var stream = streamProvider.GetStreamFor(outputPath); writeAction(stream); if (outputPath != null) { - logger.LogInformation($"AsyncAPI {Path.GetExtension(outputPath)[1..]} successfully written to {outputPath}"); + logger.LogInformation($"AsyncAPI {Path.GetExtension(outputPath).TrimStart('.')} successfully written to {outputPath}"); } } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs index 041e496e..f10b7bbe 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs @@ -9,6 +9,7 @@ public static IServiceCollection AddToFileCommand(this IServiceCollection servic services.AddTransient(); services.AddTransient(); services.AddTransient(); + services.AddTransient(); services.AddTransient(); return services; } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs index 5c3c6a69..c5001d5e 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs @@ -17,4 +17,3 @@ public IServiceProvider BuildServiceProvider(string startupAssembly) return serviceProvider; } } - diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs new file mode 100644 index 00000000..23e49a20 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs @@ -0,0 +1,11 @@ +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal interface IStreamProvider +{ + Stream GetStreamFor(string path); +} + +internal class StreamProvider : IStreamProvider +{ + public Stream GetStreamFor(string path) => path != null ? File.Create(path) : Console.OpenStandardOutput(); +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj index 355fdd59..954ce53e 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj @@ -1,4 +1,4 @@ - + net8.0 @@ -9,11 +9,14 @@ + + + diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs new file mode 100644 index 00000000..0dd165c6 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs @@ -0,0 +1,153 @@ +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using NSubstitute; +using NSubstitute.Community.Logging; +using Saunter; +using Saunter.AsyncApiSchema.v2; +using Saunter.Serialization; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class AsyncApiDocumentExtractorTests +{ + private readonly AsyncApiDocumentExtractor _extractor; + private readonly ILogger _logger; + private readonly IServiceProvider _serviceProvider; + private readonly IAsyncApiDocumentProvider _documentProvider; + private readonly IOptions _asyncApiOptions; + private readonly IAsyncApiDocumentSerializer _documentSerializer; + + public AsyncApiDocumentExtractorTests(ITestOutputHelper output) + { + var services = new ServiceCollection(); + this._documentProvider = Substitute.For(); + this._asyncApiOptions = Substitute.For>(); + var options = new AsyncApiOptions(); + this._asyncApiOptions.Value.Returns(options); + this._documentSerializer = Substitute.For(); + services.AddSingleton(this._documentProvider); + services.AddSingleton(this._asyncApiOptions); + services.AddSingleton(this._documentSerializer); + this._serviceProvider = services.BuildServiceProvider(); + + this._logger = Substitute.For>(); + this._extractor = new AsyncApiDocumentExtractor(this._logger); + } + + [Fact] + public void GetAsyncApiDocument_Null_NoMarkerAssemblies() + { + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(1).CallToLog(LogLevel.Critical); + } + + [Fact] + public void GetAsyncApiDocument_Default_WithMarkerAssembly() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBeNull(); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } + + [Fact] + public void GetAsyncApiDocument_1NamedDocument() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._asyncApiOptions.Value.NamedApis["service 1"] = doc; + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBe("service 1"); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } + + [Fact] + public void GetAsyncApiDocument_2NamedDocument() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc1 = new AsyncApiDocument { Id = "1" }; + var doc2 = new AsyncApiDocument { Id = "2" }; + this._asyncApiOptions.Value.NamedApis["service 1"] = doc1; + this._asyncApiOptions.Value.NamedApis["service 2"] = doc2; + this._documentProvider.GetDocument(Arg.Any(), Arg.Is(doc1)).Returns(doc1); + this._documentProvider.GetDocument(Arg.Any(), Arg.Is(doc2)).Returns(doc2); + this._documentSerializer.Serialize(doc1).Returns(""" + asyncapi: 2.6.0 + info: + title: Streetlights API 1 + """); + this._documentSerializer.Serialize(doc2).Returns(""" + asyncapi: 2.6.0 + info: + title: Streetlights API 2 + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).OrderBy(x => x.name).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(2); + documents[0].name.ShouldBe("service 1"); + documents[0].document.Info.Title.ShouldBe("Streetlights API 1"); + documents[1].name.ShouldBe("service 2"); + documents[1].document.Info.Title.ShouldBe("Streetlights API 2"); + } + + [Fact] + public void GetAsyncApiDocument_LogErrors() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + channels: + publish/light/measured: + servers: + - webapi + publish: + operationId: MeasureLight + summary: Inform about environmental lighting conditions for a particular streetlight. + tags: + - name: Light + message: + $ref: '#/components/messages/lightMeasuredEvent' + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + this._logger.Received(3).CallToLog(LogLevel.Error); + this._logger.Received(0).CallToLog(LogLevel.Warning); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBeNull(); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs new file mode 100644 index 00000000..812033a3 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs @@ -0,0 +1,95 @@ +using System.Collections; +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.Logging; +using NSubstitute; +using NSubstitute.Community.Logging; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class EnvironmentBuilderTests : IDisposable +{ + private readonly IDictionary _variablesBefore = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process); + private readonly EnvironmentBuilder _environment; + private readonly ILogger _logger; + + public EnvironmentBuilderTests() + { + this._logger = Substitute.For>(); + this._environment = new EnvironmentBuilder(this._logger); + } + + private Dictionary GetAddedEnvironmentVariables() + { + var after = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process); + return after.Cast().ExceptBy(this._variablesBefore.Keys.Cast(), x => x.Key).ToDictionary(x => x.Key.ToString(), x => x.Value?.ToString()); + } + + public void Dispose() + { + foreach (var variable in this.GetAddedEnvironmentVariables()) + { + Environment.SetEnvironmentVariable(variable.Key, null, EnvironmentVariableTarget.Process); + } + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + public void EmptyEnvStringProvided(string env) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.ReceivedCalls().Count().ShouldBe(0); + this.GetAddedEnvironmentVariables().ShouldBeEmpty(); + } + + [Theory] + [InlineData("env1=val1", 1)] + [InlineData("a=b,b=c", 2)] + public void ValidEnvStringProvided(string env, int expectedSets) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.Received(expectedSets).CallToLog(LogLevel.Debug); + this.GetAddedEnvironmentVariables().ShouldNotBeEmpty(); + } + + [Theory] + [InlineData(",", 2)] + [InlineData(",,,,", 5)] + [InlineData("=a", 1)] + [InlineData("b", 1)] + [InlineData("=", 1)] + [InlineData("====", 1)] + public void InvalidEnvStringProvided(string env, int expectedSets) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.Received(expectedSets).CallToLog(LogLevel.Critical); + this.GetAddedEnvironmentVariables().ShouldBeEmpty(); + } + + [Fact] + public void ValidateEnvValues() + { + this._environment.SetEnvironmentVariables("ENV=1,,Test=two"); + + Environment.GetEnvironmentVariable("ENV").ShouldBe("1"); + Environment.GetEnvironmentVariable("Test").ShouldBe("two"); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + [InlineData(" ")] + public void EmptyValueDeletesEnvValue(string value) + { + this._environment.SetEnvironmentVariables($"ENV=1,,ENV={value}"); + + Environment.GetEnvironmentVariable("ENV").ShouldBe(null); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs new file mode 100644 index 00000000..04ba400d --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs @@ -0,0 +1,108 @@ +using System.Linq; +using System.Text; +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.Logging; +using NSubstitute; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class FileWriterTests +{ + private readonly Action _testContextWriter = stream => stream.Write(Encoding.Default.GetBytes("ananas")); + + private readonly FileWriter _writer; + private readonly IStreamProvider _streamProvider; + private readonly ILogger _logger; + private readonly MemoryStream _stream = new(); + + public FileWriterTests(ITestOutputHelper output) + { + this._logger = Substitute.For>(); + this._streamProvider = Substitute.For(); + this._streamProvider.GetStreamFor(default).ReturnsForAnyArgs(x => + { + output.WriteLine($"GetStreamFor({x.Args()[0]})"); + return this._stream; + }); + this._writer = new FileWriter(this._streamProvider, this._logger); + } + + [Fact] + public void CheckStreamContents() + { + this._writer.Write("/", "", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/")); + Encoding.Default.GetString(this._stream.GetBuffer().Take(6).ToArray()).ShouldBe("ananas"); + } + + [Fact] + public void CheckName_NoVariablesInTemplate() + { + this._writer.Write("/some/path", "fixed_name", "doc", "json", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/some/path/fixed_name")); + } + + [Theory] + [InlineData("./")] + [InlineData("/")] + [InlineData("/test/")] + [InlineData("/test/1/2/3/4/")] + public void CheckOutputPath_BaseOutputPath_Absolute(string path) + { + this._writer.Write(path, "document.something", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"{path}document.something")); + } + + [Theory] + [InlineData(".")] + [InlineData("")] + [InlineData("asyncApi/")] + [InlineData("service-1/")] + [InlineData("service 1/")] + [InlineData("service 1/spec")] + public void CheckOutputPath_BaseOutputPath_Relative(string path) + { + this._writer.Write(path, "document.something", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath(Path.Combine(Directory.GetCurrentDirectory(), path, "document.something"))); + } + + [Theory] + [InlineData("json")] + [InlineData("yml")] + [InlineData("txt")] + public void CheckOutputPath_FormatTemplate(string format) + { + this._writer.Write("/some/path", "{extension}_name.{extension}", "doc", format, _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"/some/path/{format}_name.{format}")); + } + + [Theory] + [InlineData("")] + [InlineData(null)] + public void CheckOutputPath_FormatTemplate_trimmed(string format) + { + this._writer.Write("/some/path", "{extension}_name.{extension}", "doc", format, _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/some/path/name.")); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("asyncApi")] + [InlineData("service-1")] + [InlineData("service 1")] + public void CheckOutputPath_DocumentNameTemplate(string documentName) + { + this._writer.Write("/some/path", "{document}.something", documentName, "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"/some/path/{documentName}.something")); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs new file mode 100644 index 00000000..a340b6d4 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs @@ -0,0 +1,37 @@ +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Shouldly; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class StreamProviderTests +{ + private readonly IStreamProvider _streamProvider = new StreamProvider(); + + [Fact] + public void NullPathIsStdOut() + { + using var stream = this._streamProvider.GetStreamFor(null); + + stream.ShouldNotBeNull(); + Assert.False(stream is FileStream); + } + + [Fact] + public void StringPathIsFileStream() + { + var path = Path.GetFullPath("./test"); + File.Delete(path); + try + { + using var stream = this._streamProvider.GetStreamFor(path); + + stream.ShouldNotBeNull(); + Assert.True(stream is FileStream); + File.Exists(path); + } + finally + { + File.Delete(path); + } + } +} diff --git a/test/Saunter.Tests/Saunter.Tests.csproj b/test/Saunter.Tests/Saunter.Tests.csproj index 8f47b9f1..4c8fc01d 100644 --- a/test/Saunter.Tests/Saunter.Tests.csproj +++ b/test/Saunter.Tests/Saunter.Tests.csproj @@ -17,7 +17,7 @@ - + From e1818508e223ab6e97ede284e740ef5376647231 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Wed, 10 Jul 2024 18:37:13 +0200 Subject: [PATCH 06/10] #196 add unitTests for tofile --- .gitignore | 1 + Directory.Build.props | 9 + Saunter.sln | 3 +- .../ToFile/AsyncApiDocumentExtractor.cs | 9 +- .../ToFile/Environment.cs | 21 +- .../ToFile/FileWriter.cs | 11 +- .../ToFile/ServiceExtensions.cs | 9 +- .../ToFile/ServiceProviderBuilder.cs | 8 +- .../ToFile/StreamProvider.cs | 19 ++ .../ToFile/ToFileCommand.cs | 8 +- ...syncAPI.Saunter.Generator.Cli.Tests.csproj | 12 +- .../E2ETests.cs | 59 +++++ ...netCliToolTests.cs => IntegrationTests.cs} | 33 +-- .../PackAndInstallLocalTests.cs | 52 ----- .../ToFile/AsyncApiDocumentExtractorTests.cs | 152 +++++++++++++ .../ToFile/EnvironmentBuilderTests.cs | 94 ++++++++ .../ToFile/FileWriterTests.cs | 107 +++++++++ .../ToFile/StreamProviderTests.cs | 37 ++++ .../ToFile/ToFileCommandTests.cs | 205 ++++++++++++++++++ test/Saunter.Tests/Saunter.Tests.csproj | 6 +- 20 files changed, 754 insertions(+), 101 deletions(-) create mode 100644 Directory.Build.props create mode 100644 src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/E2ETests.cs rename test/AsyncAPI.Saunter.Generator.Cli.Tests/{DotnetCliToolTests.cs => IntegrationTests.cs} (92%) delete mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs create mode 100644 test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs diff --git a/.gitignore b/.gitignore index 758b4e30..dd3e6915 100644 --- a/.gitignore +++ b/.gitignore @@ -206,6 +206,7 @@ PublishScripts/ # NuGet v3's project.json files produces more ignorable files *.nuget.props *.nuget.targets +dotnet-tools.json # Microsoft Azure Build Output csx/ diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 00000000..2451c08c --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/Saunter.sln b/Saunter.sln index 10d433bd..85c435a4 100644 --- a/Saunter.sln +++ b/Saunter.sln @@ -20,6 +20,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E0D34C77-9 .editorconfig = .editorconfig .gitattributes = .gitattributes CHANGELOG.md = CHANGELOG.md + Directory.Build.props = Directory.Build.props README.md = README.md EndProjectSection EndProject @@ -45,7 +46,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "npm", "npm", "{E8FACA22-CFE EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AsyncAPI.Saunter.Generator.Cli", "src\AsyncAPI.Saunter.Generator.Cli\AsyncAPI.Saunter.Generator.Cli.csproj", "{6C102D4D-3DA4-4763-B75E-C15E33E7E94A}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncAPI.Saunter.Generator.Cli.Tests", "test\AsyncAPI.Saunter.Generator.Cli.Tests\AsyncAPI.Saunter.Generator.Cli.Tests.csproj", "{18AD0249-0436-4A26-9972-B97BA6905A54}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AsyncAPI.Saunter.Generator.Cli.Tests", "test\AsyncAPI.Saunter.Generator.Cli.Tests\AsyncAPI.Saunter.Generator.Cli.Tests.csproj", "{18AD0249-0436-4A26-9972-B97BA6905A54}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs index aa9852bd..6a1709fb 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/AsyncApiDocumentExtractor.cs @@ -3,12 +3,17 @@ using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; -using Saunter.Serialization; using Saunter; +using Saunter.Serialization; namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class AsyncApiDocumentExtractor(ILogger logger) +internal interface IAsyncApiDocumentExtractor +{ + IEnumerable<(string name, AsyncApiDocument document)> GetAsyncApiDocument(IServiceProvider serviceProvider, string[] requestedDocuments); +} + +internal class AsyncApiDocumentExtractor(ILogger logger) : IAsyncApiDocumentExtractor { private IEnumerable GetDocumentNames(string[] requestedDocuments, AsyncApiOptions asyncApiOptions) { diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs index 040637a4..2ae66e79 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/Environment.cs @@ -2,26 +2,27 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class EnvironmentBuilder(ILogger logger) +internal interface IEnvironmentBuilder +{ + void SetEnvironmentVariables(string env); +} + +internal class EnvironmentBuilder(ILogger logger) : IEnvironmentBuilder { public void SetEnvironmentVariables(string env) { var envVars = !string.IsNullOrWhiteSpace(env) ? env.Split(',').Select(x => x.Trim()) : Array.Empty(); - foreach (var envVar in envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList())) + var keyValues = envVars.Select(x => x.Split('=').Select(x => x.Trim()).ToList()); + foreach (var envVar in keyValues) { - if (envVar.Count is 1) - { - Environment.SetEnvironmentVariable(envVar[0], null, EnvironmentVariableTarget.Process); - logger.LogDebug($"Set environment flag: {envVar[0]}"); - } - if (envVar.Count is 2) + if (envVar.Count == 2 && !string.IsNullOrWhiteSpace(envVar[0])) { - Environment.SetEnvironmentVariable(envVar[0], envVar.ElementAtOrDefault(1), EnvironmentVariableTarget.Process); + Environment.SetEnvironmentVariable(envVar[0], envVar[1], EnvironmentVariableTarget.Process); logger.LogDebug($"Set environment variable: {envVar[0]} = {envVar[1]}"); } else { - logger.LogCritical("Environment variables should be in the format: env1=value1,env2=value2,env3"); + logger.LogCritical("Environment variables should be in the format: env1=value1,env2=value2"); } } } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs index 62e1bc43..d58060ea 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/FileWriter.cs @@ -2,7 +2,12 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class FileWriter(ILogger logger) +internal interface IFileWriter +{ + void Write(string outputPath, string fileTemplate, string documentName, string format, Action streamWriter); +} + +internal class FileWriter(IStreamProvider streamProvider, ILogger logger) : IFileWriter { public void Write(string outputPath, string fileTemplate, string documentName, string format, Action streamWriter) { @@ -12,12 +17,12 @@ public void Write(string outputPath, string fileTemplate, string documentName, s private void WriteFile(string outputPath, Action writeAction) { - using var stream = outputPath != null ? File.Create(outputPath) : Console.OpenStandardOutput(); + using var stream = streamProvider.GetStreamFor(outputPath); writeAction(stream); if (outputPath != null) { - logger.LogInformation($"AsyncAPI {Path.GetExtension(outputPath)[1..]} successfully written to {outputPath}"); + logger.LogInformation($"AsyncAPI {Path.GetExtension(outputPath).TrimStart('.')} successfully written to {outputPath}"); } } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs index 041e496e..33201f1e 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceExtensions.cs @@ -6,10 +6,11 @@ internal static class ServiceExtensions { public static IServiceCollection AddToFileCommand(this IServiceCollection services) { - services.AddTransient(); - services.AddTransient(); - services.AddTransient(); - services.AddTransient(); + services.AddTransient(); + services.AddTransient(); + services.AddTransient(); + services.AddTransient(); + services.AddTransient(); return services; } } diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs index 5c3c6a69..69bde4f2 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ServiceProviderBuilder.cs @@ -4,7 +4,12 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class ServiceProviderBuilder(ILogger logger) +internal interface IServiceProviderBuilder +{ + IServiceProvider BuildServiceProvider(string startupAssembly); +} + +internal class ServiceProviderBuilder(ILogger logger) : IServiceProviderBuilder { public IServiceProvider BuildServiceProvider(string startupAssembly) { @@ -17,4 +22,3 @@ public IServiceProvider BuildServiceProvider(string startupAssembly) return serviceProvider; } } - diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs new file mode 100644 index 00000000..8af5dbd4 --- /dev/null +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/StreamProvider.cs @@ -0,0 +1,19 @@ +namespace AsyncAPI.Saunter.Generator.Cli.ToFile; + +internal interface IStreamProvider +{ + Stream GetStreamFor(string path); +} + +internal class StreamProvider : IStreamProvider +{ + public Stream GetStreamFor(string path) + { + if (!string.IsNullOrEmpty(path)) + { + Directory.CreateDirectory(Path.GetDirectoryName(path)); + } + + return path != null ? File.Create(path) : Console.OpenStandardOutput(); + } +} diff --git a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs index 98bebc55..0a62c43d 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs +++ b/src/AsyncAPI.Saunter.Generator.Cli/ToFile/ToFileCommand.cs @@ -5,7 +5,7 @@ namespace AsyncAPI.Saunter.Generator.Cli.ToFile; -internal class ToFileCommand(ILogger logger, EnvironmentBuilder environment, ServiceProviderBuilder builder, AsyncApiDocumentExtractor docExtractor, FileWriter fileWriter) +internal class ToFileCommand(ILogger logger, IEnvironmentBuilder environment, IServiceProviderBuilder builder, IAsyncApiDocumentExtractor docExtractor, IFileWriter fileWriter) { private const string DEFAULT_FILENAME = "{document}_asyncapi.{extension}"; @@ -37,11 +37,7 @@ public int ToFile([Argument] string startupassembly, string output = "./", strin foreach (var (documentName, asyncApiDocument) in documents) { // Serialize to specified output location or stdout - var outputPath = !string.IsNullOrWhiteSpace(output) ? Path.Combine(Directory.GetCurrentDirectory(), output) : null; - if (!string.IsNullOrEmpty(outputPath)) - { - Directory.CreateDirectory(outputPath); - } + var outputPath = !string.IsNullOrWhiteSpace(output) ? Path.GetFullPath(Path.Combine(Directory.GetCurrentDirectory(), output)) : null; var exportJson = true; var exportYml = false; diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj index 355fdd59..6b89cdbe 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj @@ -1,4 +1,4 @@ - + net8.0 @@ -9,11 +9,17 @@ + - - + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/E2ETests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/E2ETests.cs new file mode 100644 index 00000000..0134ce62 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/E2ETests.cs @@ -0,0 +1,59 @@ +using System.Diagnostics; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests; + +public class E2ETests(ITestOutputHelper output) +{ + private string Run(string file, string args, string workingDirectory, int expectedExitCode = 0) + { + var process = Process.Start(new ProcessStartInfo(file) + { + Arguments = args, + WorkingDirectory = workingDirectory, + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + }); + process.WaitForExit(TimeSpan.FromSeconds(20)); + var stdOut = process.StandardOutput.ReadToEnd().Trim(); + var stdError = process.StandardError.ReadToEnd().Trim(); + output.WriteLine($"### Output of \"{file} {args}\""); + output.WriteLine(stdOut); + output.WriteLine(stdError); + + process.ExitCode.ShouldBe(expectedExitCode); + return stdOut; + } + + [Fact(Skip = "Manual verification only")] + public void Pack_Install_Run_Uninstall_Test() + { + var workingDirectory = "../../../../../src/AsyncAPI.Saunter.Generator.Cli"; + var stdOut = this.Run("dotnet", "pack", workingDirectory); + stdOut.ShouldContain("Successfully created package"); + + // use --force flag to ensure the test starts clean every run + stdOut = this.Run("dotnet", "new tool-manifest --force", workingDirectory); + stdOut.ShouldContain("The template \"Dotnet local tool manifest file\" was created successfully"); + + stdOut = this.Run("dotnet", "tool install --local --add-source ./bin/Release AsyncAPI.Saunter.Generator.Cli", workingDirectory); + stdOut = stdOut.Replace("Skipping NuGet package signature verification.", "").Trim(); + stdOut.ShouldContain("You can invoke the tool from this directory using the following commands: 'dotnet tool run dotnet-asyncapi"); + stdOut.ShouldContain("was successfully installed."); + + stdOut = this.Run("dotnet", "tool list --local asyncapi.saunter.generator.cli", workingDirectory); + stdOut.ShouldContain("dotnet-asyncapi"); + + stdOut = this.Run("dotnet", "tool run dotnet-asyncapi", workingDirectory, 1); + stdOut.ShouldContain("tofile: retrieves AsyncAPI from a startup assembly, and writes to file"); + + stdOut = this.Run("dotnet", "tool uninstall --local asyncapi.saunter.generator.cli", workingDirectory); + stdOut.ShouldContain(" was successfully uninstalled"); + stdOut.ShouldContain("removed from manifest file"); + + stdOut = this.Run("dotnet", "tool list --local asyncapi.saunter.generator.cli", workingDirectory, 1); + stdOut.ShouldNotContain("dotnet-asyncapi"); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs similarity index 92% rename from test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs rename to test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs index 8d9e12d3..105916d2 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs @@ -1,26 +1,29 @@ -using System.Diagnostics; -using Shouldly; +using Shouldly; using Xunit.Abstractions; namespace AsyncAPI.Saunter.Generator.Cli.Tests; -public class DotnetCliToolTests(ITestOutputHelper output) +public class IntegrationTests(ITestOutputHelper output) { private string RunTool(string args, int expectedExitCode = 1) { - var process = Process.Start(new ProcessStartInfo("dotnet") - { - Arguments = $"../../../../../src/AsyncAPI.Saunter.Generator.Cli/bin/Debug/net8.0/AsyncAPI.Saunter.Generator.Cli.dll tofile {args}", - RedirectStandardOutput = true, - RedirectStandardError = true, - }); - process.WaitForExit(); - var stdOut = process.StandardOutput.ReadToEnd().Trim(); - var stdError = process.StandardError.ReadToEnd().Trim(); + using var outWriter = new StringWriter(); + using var errorWriter = new StringWriter(); + Console.SetOut(outWriter); + Console.SetError(errorWriter); + + var entryPoint = typeof(Program).Assembly.EntryPoint!; + entryPoint.Invoke(null, new object[] { args.Split(' ') }); + + var stdOut = outWriter.ToString(); + var stdError = errorWriter.ToString(); + output.WriteLine($"RUN: {args}"); + output.WriteLine("### STD OUT"); output.WriteLine(stdOut); + output.WriteLine("### STD ERROR"); output.WriteLine(stdError); - process.ExitCode.ShouldBe(expectedExitCode); + Environment.ExitCode.ShouldBe(expectedExitCode); //stdError.ShouldBeEmpty(); LEGO lib doesn't like id: "id is not a valid property at #/components/schemas/lightMeasuredEvent"" return stdOut; } @@ -28,7 +31,7 @@ private string RunTool(string args, int expectedExitCode = 1) [Fact] public void DefaultCallPrintsCommandInfo() { - var stdOut = RunTool("", 0).Trim(); + var stdOut = RunTool("tofile", 0).Trim(); stdOut.ShouldBe(""" Usage: tofile [arguments...] [options...] [-h|--help] [--version] @@ -52,7 +55,7 @@ public void StreetlightsAPIExportSpecTest() { var path = Directory.GetCurrentDirectory(); output.WriteLine($"Output path: {path}"); - var stdOut = RunTool($"../../../../../examples/StreetlightsAPI/bin/Debug/net8.0/StreetlightsAPI.dll --output {path} --format json,yml,yaml"); + var stdOut = RunTool($"tofile ../../../../../examples/StreetlightsAPI/bin/Debug/net8.0/StreetlightsAPI.dll --output {path} --format json,yml,yaml"); stdOut.ShouldNotBeEmpty(); stdOut.ShouldContain($"AsyncAPI yaml successfully written to {Path.Combine(path, "asyncapi.yaml")}"); diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs deleted file mode 100644 index 2bf87baf..00000000 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs +++ /dev/null @@ -1,52 +0,0 @@ -using System.Diagnostics; -using Shouldly; -using Xunit.Abstractions; - -namespace AsyncAPI.Saunter.Generator.Cli.Tests; - -public class PackAndInstallLocalTests(ITestOutputHelper output) -{ - private string Run(string file, string args, string workingDirectory, int expectedExitCode = 0) - { - var process = Process.Start(new ProcessStartInfo(file) - { - Arguments = args, - WorkingDirectory = workingDirectory, - RedirectStandardOutput = true, - RedirectStandardError = true, - UseShellExecute = false, - }); - process.WaitForExit(TimeSpan.FromSeconds(20)); - var stdOut = process.StandardOutput.ReadToEnd().Trim(); - var stdError = process.StandardError.ReadToEnd().Trim(); - output.WriteLine($"### Output of \"{file} {args}\""); - output.WriteLine(stdOut); - output.WriteLine(stdError); - - process.ExitCode.ShouldBe(expectedExitCode); - return stdOut; - } - - [Fact] - public void Pack_Install_Run_Uninstall_Test() - { - var stdOut = this.Run("dotnet", "pack", "../../../../../src/AsyncAPI.Saunter.Generator.Cli"); - stdOut.ShouldContain("Successfully created package"); - - stdOut = this.Run("dotnet", "tool install --global --add-source ./bin/Release AsyncAPI.Saunter.Generator.Cli", "../../../../../src/AsyncAPI.Saunter.Generator.Cli"); - stdOut.ShouldBeOneOf("You can invoke the tool using the following command: dotnet-asyncapi\r\nTool 'asyncapi.saunter.generator.cli' (version '1.0.1') was successfully installed.", - "Tool 'asyncapi.saunter.generator.cli' was reinstalled with the stable version (version '1.0.1')."); - - stdOut = this.Run("dotnet", "tool list -g asyncapi.saunter.generator.cli", ""); - stdOut.ShouldContain("dotnet-asyncapi"); - - stdOut = this.Run("dotnet", "asyncapi", "", 1); - stdOut.ShouldContain("tofile: retrieves AsyncAPI from a startup assembly, and writes to file"); - - stdOut = this.Run("dotnet", "tool uninstall -g asyncapi.saunter.generator.cli", ""); - stdOut.ShouldContain(" was successfully uninstalled."); - - stdOut = this.Run("dotnet", "tool list -g asyncapi.saunter.generator.cli", "", 1); - stdOut.ShouldNotContain("dotnet-asyncapi"); - } -} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs new file mode 100644 index 00000000..bf091832 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/AsyncApiDocumentExtractorTests.cs @@ -0,0 +1,152 @@ +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using NSubstitute; +using NSubstitute.Community.Logging; +using Saunter; +using Saunter.AsyncApiSchema.v2; +using Saunter.Serialization; +using Shouldly; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class AsyncApiDocumentExtractorTests +{ + private readonly AsyncApiDocumentExtractor _extractor; + private readonly ILogger _logger; + private readonly IServiceProvider _serviceProvider; + private readonly IAsyncApiDocumentProvider _documentProvider; + private readonly IOptions _asyncApiOptions; + private readonly IAsyncApiDocumentSerializer _documentSerializer; + + public AsyncApiDocumentExtractorTests() + { + var services = new ServiceCollection(); + this._documentProvider = Substitute.For(); + this._asyncApiOptions = Substitute.For>(); + var options = new AsyncApiOptions(); + this._asyncApiOptions.Value.Returns(options); + this._documentSerializer = Substitute.For(); + services.AddSingleton(this._documentProvider); + services.AddSingleton(this._asyncApiOptions); + services.AddSingleton(this._documentSerializer); + this._serviceProvider = services.BuildServiceProvider(); + + this._logger = Substitute.For>(); + this._extractor = new AsyncApiDocumentExtractor(this._logger); + } + + [Fact] + public void GetAsyncApiDocument_Null_NoMarkerAssemblies() + { + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(1).CallToLog(LogLevel.Critical); + } + + [Fact] + public void GetAsyncApiDocument_Default_WithMarkerAssembly() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBeNull(); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } + + [Fact] + public void GetAsyncApiDocument_1NamedDocument() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._asyncApiOptions.Value.NamedApis["service 1"] = doc; + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBe("service 1"); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } + + [Fact] + public void GetAsyncApiDocument_2NamedDocument() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc1 = new AsyncApiDocument { Id = "1" }; + var doc2 = new AsyncApiDocument { Id = "2" }; + this._asyncApiOptions.Value.NamedApis["service 1"] = doc1; + this._asyncApiOptions.Value.NamedApis["service 2"] = doc2; + this._documentProvider.GetDocument(Arg.Any(), Arg.Is(doc1)).Returns(doc1); + this._documentProvider.GetDocument(Arg.Any(), Arg.Is(doc2)).Returns(doc2); + this._documentSerializer.Serialize(doc1).Returns(""" + asyncapi: 2.6.0 + info: + title: Streetlights API 1 + """); + this._documentSerializer.Serialize(doc2).Returns(""" + asyncapi: 2.6.0 + info: + title: Streetlights API 2 + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).OrderBy(x => x.name).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + documents.Count.ShouldBe(2); + documents[0].name.ShouldBe("service 1"); + documents[0].document.Info.Title.ShouldBe("Streetlights API 1"); + documents[1].name.ShouldBe("service 2"); + documents[1].document.Info.Title.ShouldBe("Streetlights API 2"); + } + + [Fact] + public void GetAsyncApiDocument_LogErrors() + { + this._asyncApiOptions.Value.AssemblyMarkerTypes = [typeof(AsyncApiDocumentExtractorTests)]; + var doc = new AsyncApiDocument(); + this._documentProvider.GetDocument(default, default).ReturnsForAnyArgs(doc); + this._documentSerializer.Serialize(doc).ReturnsForAnyArgs(""" + asyncapi: 2.6.0 + info: + title: Streetlights API + channels: + publish/light/measured: + servers: + - webapi + publish: + operationId: MeasureLight + summary: Inform about environmental lighting conditions for a particular streetlight. + tags: + - name: Light + message: + $ref: '#/components/messages/lightMeasuredEvent' + """); + + var documents = this._extractor.GetAsyncApiDocument(this._serviceProvider, null).ToList(); + + this._logger.Received(0).CallToLog(LogLevel.Critical); + this._logger.Received(3).CallToLog(LogLevel.Error); + this._logger.Received(0).CallToLog(LogLevel.Warning); + documents.Count.ShouldBe(1); + documents[0].name.ShouldBeNull(); + documents[0].document.Info.Title.ShouldBe("Streetlights API"); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs new file mode 100644 index 00000000..de26811d --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/EnvironmentBuilderTests.cs @@ -0,0 +1,94 @@ +using System.Collections; +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.Logging; +using NSubstitute; +using NSubstitute.Community.Logging; +using Shouldly; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class EnvironmentBuilderTests : IDisposable +{ + private readonly IDictionary _variablesBefore = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process); + private readonly EnvironmentBuilder _environment; + private readonly ILogger _logger; + + public EnvironmentBuilderTests() + { + this._logger = Substitute.For>(); + this._environment = new EnvironmentBuilder(this._logger); + } + + private Dictionary GetAddedEnvironmentVariables() + { + var after = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process); + return after.Cast().ExceptBy(this._variablesBefore.Keys.Cast(), x => x.Key).ToDictionary(x => x.Key.ToString(), x => x.Value?.ToString()); + } + + public void Dispose() + { + foreach (var variable in this.GetAddedEnvironmentVariables()) + { + Environment.SetEnvironmentVariable(variable.Key, null, EnvironmentVariableTarget.Process); + } + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + public void EmptyEnvStringProvided(string env) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.ReceivedCalls().Count().ShouldBe(0); + this.GetAddedEnvironmentVariables().ShouldBeEmpty(); + } + + [Theory] + [InlineData("env1=val1", 1)] + [InlineData("a=b,b=c", 2)] + public void ValidEnvStringProvided(string env, int expectedSets) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.Received(expectedSets).CallToLog(LogLevel.Debug); + this.GetAddedEnvironmentVariables().ShouldNotBeEmpty(); + } + + [Theory] + [InlineData(",", 2)] + [InlineData(",,,,", 5)] + [InlineData("=a", 1)] + [InlineData("b", 1)] + [InlineData("=", 1)] + [InlineData("====", 1)] + public void InvalidEnvStringProvided(string env, int expectedSets) + { + this._environment.SetEnvironmentVariables(env); + + this._logger.Received(expectedSets).CallToLog(LogLevel.Critical); + this.GetAddedEnvironmentVariables().ShouldBeEmpty(); + } + + [Fact] + public void ValidateEnvValues() + { + this._environment.SetEnvironmentVariables("ENV=1,,Test=two"); + + Environment.GetEnvironmentVariable("ENV").ShouldBe("1"); + Environment.GetEnvironmentVariable("Test").ShouldBe("two"); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + [InlineData(" ")] + public void EmptyValueDeletesEnvValue(string value) + { + this._environment.SetEnvironmentVariables($"ENV=1,,ENV={value}"); + + Environment.GetEnvironmentVariable("ENV").ShouldBe(null); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs new file mode 100644 index 00000000..129959b0 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/FileWriterTests.cs @@ -0,0 +1,107 @@ +using System.Text; +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Microsoft.Extensions.Logging; +using NSubstitute; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class FileWriterTests +{ + private readonly Action _testContextWriter = stream => stream.Write(Encoding.Default.GetBytes("ananas")); + + private readonly FileWriter _writer; + private readonly IStreamProvider _streamProvider; + private readonly ILogger _logger; + private readonly MemoryStream _stream = new(); + + public FileWriterTests(ITestOutputHelper output) + { + this._logger = Substitute.For>(); + this._streamProvider = Substitute.For(); + this._streamProvider.GetStreamFor(default).ReturnsForAnyArgs(x => + { + output.WriteLine($"GetStreamFor({x.Args()[0]})"); + return this._stream; + }); + this._writer = new FileWriter(this._streamProvider, this._logger); + } + + [Fact] + public void CheckStreamContents() + { + this._writer.Write("/", "", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/")); + Encoding.Default.GetString(this._stream.GetBuffer().Take(6).ToArray()).ShouldBe("ananas"); + } + + [Fact] + public void CheckName_NoVariablesInTemplate() + { + this._writer.Write("/some/path", "fixed_name", "doc", "json", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/some/path/fixed_name")); + } + + [Theory] + [InlineData("./")] + [InlineData("/")] + [InlineData("/test/")] + [InlineData("/test/1/2/3/4/")] + public void CheckOutputPath_BaseOutputPath_Absolute(string path) + { + this._writer.Write(path, "document.something", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"{path}document.something")); + } + + [Theory] + [InlineData(".")] + [InlineData("")] + [InlineData("asyncApi/")] + [InlineData("service-1/")] + [InlineData("service 1/")] + [InlineData("service 1/spec")] + public void CheckOutputPath_BaseOutputPath_Relative(string path) + { + this._writer.Write(path, "document.something", "", "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath(Path.Combine(Directory.GetCurrentDirectory(), path, "document.something"))); + } + + [Theory] + [InlineData("json")] + [InlineData("yml")] + [InlineData("txt")] + public void CheckOutputPath_FormatTemplate(string format) + { + this._writer.Write("/some/path", "{extension}_name.{extension}", "doc", format, _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"/some/path/{format}_name.{format}")); + } + + [Theory] + [InlineData("")] + [InlineData(null)] + public void CheckOutputPath_FormatTemplate_trimmed(string format) + { + this._writer.Write("/some/path", "{extension}_name.{extension}", "doc", format, _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath("/some/path/name.")); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("asyncApi")] + [InlineData("service-1")] + [InlineData("service 1")] + public void CheckOutputPath_DocumentNameTemplate(string documentName) + { + this._writer.Write("/some/path", "{document}.something", documentName, "", _testContextWriter); + + this._streamProvider.Received(1).GetStreamFor(Path.GetFullPath($"/some/path/{documentName}.something")); + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs new file mode 100644 index 00000000..a340b6d4 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/StreamProviderTests.cs @@ -0,0 +1,37 @@ +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using Shouldly; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class StreamProviderTests +{ + private readonly IStreamProvider _streamProvider = new StreamProvider(); + + [Fact] + public void NullPathIsStdOut() + { + using var stream = this._streamProvider.GetStreamFor(null); + + stream.ShouldNotBeNull(); + Assert.False(stream is FileStream); + } + + [Fact] + public void StringPathIsFileStream() + { + var path = Path.GetFullPath("./test"); + File.Delete(path); + try + { + using var stream = this._streamProvider.GetStreamFor(path); + + stream.ShouldNotBeNull(); + Assert.True(stream is FileStream); + File.Exists(path); + } + finally + { + File.Delete(path); + } + } +} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs new file mode 100644 index 00000000..d879cc41 --- /dev/null +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs @@ -0,0 +1,205 @@ +using AsyncAPI.Saunter.Generator.Cli.ToFile; +using LEGO.AsyncAPI.Models; +using Microsoft.Extensions.Logging; +using NSubstitute; +using Shouldly; +using Xunit.Abstractions; + +namespace AsyncAPI.Saunter.Generator.Cli.Tests.ToFile; + +public class ToFileCommandTests +{ + private readonly ToFileCommand _command; + private readonly IEnvironmentBuilder _environment; + private readonly IServiceProviderBuilder _builder; + private readonly IAsyncApiDocumentExtractor _docExtractor; + private readonly IFileWriter _fileWriter; + private readonly ILogger _logger; + private readonly ITestOutputHelper _output; + + public ToFileCommandTests(ITestOutputHelper output) + { + this._output = output; + this._logger = Substitute.For>(); + this._environment = Substitute.For(); + this._builder = Substitute.For(); + this._docExtractor = Substitute.For(); + this._fileWriter = Substitute.For(); + this._command = new ToFileCommand(this._logger, _environment, _builder, _docExtractor, _fileWriter); + } + + [Fact] + public void StartupAssembly_FileNotFoundException() + { + Assert.Throws(() => this._command.ToFile("")); + } + + [Fact] + public void SetEnvironmentVariables() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + + this._command.ToFile(me, env: "env=value"); + + this._environment.Received(1).SetEnvironmentVariables("env=value"); + } + + [Fact] + public void BuildServiceProvider() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + + this._command.ToFile(me); + + this._builder.Received(1).BuildServiceProvider(me); + } + + [Fact] + public void GetAsyncApiDocument_DefaultDocParam() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + var sp = Substitute.For(); + this._builder.BuildServiceProvider(default).ReturnsForAnyArgs(sp); + + this._command.ToFile(me); + + this._docExtractor.Received(1).GetAsyncApiDocument(sp, null); + } + + [Fact] + public void GetAsyncApiDocument_DocParam() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + var sp = Substitute.For(); + this._builder.BuildServiceProvider(default).ReturnsForAnyArgs(sp); + + this._command.ToFile(me, doc: "a"); + + this._docExtractor.Received(1).GetAsyncApiDocument(sp, Arg.Is(x => x.SequenceEqual(new[] { "a" }))); ; + } + + [Fact] + public void GetAsyncApiDocument_DocParamMultiple() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + var sp = Substitute.For(); + this._builder.BuildServiceProvider(default).ReturnsForAnyArgs(sp); + + this._command.ToFile(me, doc: "a,b, c ,,"); + + this._docExtractor.Received(1).GetAsyncApiDocument(sp, Arg.Is(x => x.SequenceEqual(new[] { "a", "b", " c " }))); + } + + [Fact] + public void WriteFile_DefaultParams() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } } )]); + + this._command.ToFile(me); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(1); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, "json", Arg.Any>()); + } + + [Theory] + [InlineData("json")] + [InlineData("yml")] + [InlineData("yaml")] + public void WriteFile_FormatParam(string format) + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, format: format); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(1); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, format, Arg.Any>()); + } + + [Theory] + [InlineData("")] + [InlineData(" ")] + [InlineData(null)] + public void WriteFile_EmptyFormatParamVariants_FallbackToJson(string format) + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, format: format); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(1); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, "json", Arg.Any>()); + } + + [Theory] + [InlineData("a")] + [InlineData("json1")] + [InlineData(".json")] + public void WriteFile_InvalidFormatParam_FallbackToJson(string format) + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, format: format); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(0); + } + + [Fact] + public void WriteFile_FormatParamMultiple() + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, format: " json , yaml,yml ,,a, "); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(3); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, "json", Arg.Any>()); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, "yml", Arg.Any>()); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), "{document}_asyncapi.{extension}", null, "yaml", Arg.Any>()); + } + + [Theory] + [InlineData("doc")] + [InlineData("{document}")] + [InlineData("{extension}")] + [InlineData("{document}.{extension}")] + public void WriteFile_FileTemplateParam(string template) + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, filename: template); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(1); + this._fileWriter.Received(1).Write(Path.GetFullPath("./"), template, null, "json", Arg.Any>()); + } + + [Theory] + [InlineData("./")] + [InlineData("/")] + [InlineData("a/")] + [InlineData("/a/b")] + public void WriteFile_OutputPathParam(string path) + { + var me = typeof(ToFileCommandTests).Assembly.Location; + this._output.WriteLine($"Assembly: {me}"); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); + + this._command.ToFile(me, output: path); + + this._fileWriter.ReceivedCalls().Count().ShouldBe(1); + this._fileWriter.Received(1).Write(Path.GetFullPath(path), "{document}_asyncapi.{extension}", null, "json", Arg.Any>()); + } +} diff --git a/test/Saunter.Tests/Saunter.Tests.csproj b/test/Saunter.Tests/Saunter.Tests.csproj index 8f47b9f1..98b03563 100644 --- a/test/Saunter.Tests/Saunter.Tests.csproj +++ b/test/Saunter.Tests/Saunter.Tests.csproj @@ -17,11 +17,11 @@ - + - - + + all runtime; build; native; contentfiles; analyzers; buildtransitive From 183a4e8276d205a3d890c8f9a3014ca0170b990c Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Thu, 11 Jul 2024 22:53:43 +0200 Subject: [PATCH 07/10] #196 formatting --- src/AsyncAPI.Saunter.Generator.Cli/readme.md | 9 ++++++--- .../ToFile/ToFileCommandTests.cs | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/AsyncAPI.Saunter.Generator.Cli/readme.md b/src/AsyncAPI.Saunter.Generator.Cli/readme.md index 05c42764..b5ee1273 100644 --- a/src/AsyncAPI.Saunter.Generator.Cli/readme.md +++ b/src/AsyncAPI.Saunter.Generator.Cli/readme.md @@ -3,7 +3,7 @@ A dotnet tool to generate AsyncAPI specification files based of a dotnet DLL (Th ## Tool usage ``` -dotnet asyncapi tofile --output [output-path] --format [json,yml,yaml] --doc [asyncapi-document-name] [startup-assembly] +dotnet asyncapi tofile [startup-assembly] --output [output-path] --format [json,yml,yaml] --doc [asyncapi-document-name] ``` - _startup-assembly_: the file path to the entrypoint dotnet DLL that hosts AsyncAPI document(s). @@ -12,7 +12,7 @@ dotnet asyncapi tofile --output [output-path] --format [json,yml,yaml] --doc [as - _--output_: relative path where the AsyncAPI will be output [defaults to stdout] - _--filename_: the template for the outputted file names. Default: "{document}_asyncapi.{extension}" - _--format_: the output formats to generate, can be a combination of json, yml and/or yaml. -- _--env_: define environment variable(s) for the application. Formatted as a comma separated list of _key=value_ pairs or just _key_ for flags, example: ```ASPNETCORE_ENVIRONMENT=AsyncAPI,CONNECT_TO_DATABASE=false,GENERATOR_FLAG```. +- _--env_: define environment variable(s) for the application. Formatted as a comma separated list of _key=value_ pairs, example: ```ASPNETCORE_ENVIRONMENT=AsyncAPI,CONNECT_TO_DATABASE=false```. ## Install the Generator.Cli dotnet Tool ``` @@ -21,4 +21,7 @@ dotnet tool install --global AsyncAPI.Saunter.Generator.Cli After installing the tool globally, it is available using commands: ```dotnet asyncapi``` or ```dotnet-asyncapi``` Want to learn more about .NET tools? Or want to install it local using a manifest? -[Check out this Microsoft page on how to manage .NET tools](https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools) \ No newline at end of file +[Check out this Microsoft page on how to manage .NET tools](https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools) + +## Internals +How does the tool work internally? It tries to exact an ```IServiceProvider``` from the provided _startup-assembly_ and exports AsyncApiDocument(s) as registered in the services provider. \ No newline at end of file diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs index d879cc41..44e3c1f3 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/ToFile/ToFileCommandTests.cs @@ -99,7 +99,7 @@ public void WriteFile_DefaultParams() { var me = typeof(ToFileCommandTests).Assembly.Location; this._output.WriteLine($"Assembly: {me}"); - this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } } )]); + this._docExtractor.GetAsyncApiDocument(default, default).ReturnsForAnyArgs([(null, new AsyncApiDocument { Info = new AsyncApiInfo { Title = "a" } })]); this._command.ToFile(me); From 8d2fd4969a34a4c15b1bb0be21592e362d5e0931 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Thu, 11 Jul 2024 23:00:38 +0200 Subject: [PATCH 08/10] #196 ALL tests should run --- .github/workflows/ci.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index b9ab2a66..ec47f69c 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -35,7 +35,4 @@ jobs: - name: setup build uses: ./.github/npm - name: unit test - run: dotnet test ./test/Saunter.Tests/Saunter.Tests.csproj - # TODO: why there are 2 of them.... - - name: unit mark test - run: dotnet test ./test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj + run: dotnet test --configuration Debug From a9d544ac7672f8942586555f8856c9ae1eee00ea Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Thu, 11 Jul 2024 23:03:34 +0200 Subject: [PATCH 09/10] #196 Tests use streetlights DLL in integegration tests, add dependency --- .../AsyncAPI.Saunter.Generator.Cli.Tests.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj index 6b89cdbe..6704dac9 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj @@ -23,6 +23,7 @@ + From 72dc74205694a29a384ed6532d4041e323a9caa2 Mon Sep 17 00:00:00 2001 From: Senn Geerts Date: Thu, 11 Jul 2024 23:13:02 +0200 Subject: [PATCH 10/10] #196 release also the CLI tool --- .github/workflows/release.yaml | 2 +- test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs | 2 +- .../Saunter.Tests.MarkerTypeTests.csproj | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index c1c33107..452effd8 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -16,7 +16,7 @@ jobs: # Gets the numeric version from a tag (e.g. v1.2.3 -> 1.2.3) run: echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV - name: Create Nuget package - run: dotnet pack ./src/Saunter/Saunter.csproj --configuration Release -p:Version="$RELEASE_VERSION" --output ./build + run: dotnet pack --configuration Release -p:Version="$RELEASE_VERSION" --output ./build - name: Push Nuget package to Nuget.org env: NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} diff --git a/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs b/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs index 105916d2..e7751ac3 100644 --- a/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs +++ b/test/AsyncAPI.Saunter.Generator.Cli.Tests/IntegrationTests.cs @@ -55,7 +55,7 @@ public void StreetlightsAPIExportSpecTest() { var path = Directory.GetCurrentDirectory(); output.WriteLine($"Output path: {path}"); - var stdOut = RunTool($"tofile ../../../../../examples/StreetlightsAPI/bin/Debug/net8.0/StreetlightsAPI.dll --output {path} --format json,yml,yaml"); + var stdOut = RunTool($"tofile ../../../../../examples/StreetlightsAPI/bin/Debug/net6.0/StreetlightsAPI.dll --output {path} --format json,yml,yaml"); stdOut.ShouldNotBeEmpty(); stdOut.ShouldContain($"AsyncAPI yaml successfully written to {Path.Combine(path, "asyncapi.yaml")}"); diff --git a/test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj b/test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj index 014abc3c..bd04796d 100644 --- a/test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj +++ b/test/Saunter.Tests.MarkerTypeTests/Saunter.Tests.MarkerTypeTests.csproj @@ -4,6 +4,7 @@ net6.0 enable enable + false