-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#197 Produce AsyncAPI documents at build time (AsyncAPI.Saunter.Generator.Build) #219
Draft
smoerijf
wants to merge
75
commits into
asyncapi:main
Choose a base branch
from
smoerijf:#197-more-logging
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
75 commits
Select commit
Hold shift + click to select a range
6318f80
#196 Publish a global dotnet tool
2162d72
#196 Publish a global dotnet tool -- Api/API casing fix
55895a2
#196 .NET8
6ba3409
#196 .NET6
74c9cff
#196 I'd like .NET8 more, request both for ci
cc5d952
#196 I'd like .NET8 more, request both for ci?
569a30a
#196 Fixed resolving, added support for multiple asyncAPI documents, …
0419101
#196 Test for dotnet cli tool, added support for default asyncapi doc…
b29a1ab
#196 Pack_Install_Run_Uninstall Test
12593dc
#196 Pack_Install_Run_Uninstall fix casing in test, add meta data to …
93dc17e
#196 fix accident
e701660
#196 fix warnings, fix permission
d9b558c
#196 unix needs a shebang
f0af6d1
#196 sourcelink properties
a379a3e
#197 Produce AsyncAPI documents at build time
02ffbcd
#197 Produce AsyncAPI documents at build time
1ebb77c
#196 renamed tool to make up a more logical name, fixed empty paramet…
ba1e856
#196 fix readme error
88c5caf
Merge remote-tracking branch 'remotes/smoerijf/#196-Publish-a-global-…
a2813e2
#197 Produce AsyncAPI documents at build time - test + setup with loc…
a42ab3f
#197 local nuget source folder should exist
d3f0472
#197 update readme's
e10112b
#197 set streetlights example to depend on the Generator.Build projec…
4741f56
#197 undo streetlights example order, use 2 step build approach
195dc14
#197 use better path to the dotnet dll in tools and hopefully fix the…
8583f08
#197 need more logging
2f2c172
#197 need more logging - dir logs
0c033f1
#197 slashes?
31bacc6
#197 idk
fbbf601
Merge branch '#197-more-logging' of https://github.com/smoerijf/saunt…
6cc92e3
#197 try by installing local tool
df5636e
#197 bump net version
829d5a5
#197 install dotnet in .nuget iso the csproj root
49fb31f
#197 use 999.* for local nuget package buils to use in tests and exam…
f110afe
#197 readme style
1b7087a
#197 pin .Cli version to beta in .Build
90dcff1
Merge remote-tracking branch 'remotes/origin/main' into #196-Publish-…
a746e4d
#196 Fixed formatting etc + some PR remarks
8e7a01f
#196 Tool rewrite to make its components testable, removed Swachbuckl…
240c9ed
#196 formatting
715a62d
#196 add unitTests for tofile classes
e181850
#196 add unitTests for tofile
ab5b375
#196-Publish-a-global-dotnet-tool
183a4e8
#196 formatting
8d2fd49
#196 ALL tests should run
a9d544a
#196 Tests use streetlights DLL in integegration tests, add dependency
72dc742
#196 release also the CLI tool
2c6e2d9
#197 formatting
5823431
Merge remote-tracking branch 'remotes/smoerijf/#196-Publish-a-global-…
38ac1eb
#197 .build nuget package
6099e65
#197 fix test
e804aaf
Merge branch '#197-more-logging' of https://github.com/smoerijf/saunt…
1bb7d30
#196 fix wrong ci.yml merge
0babe05
#196 2 phase build: first src, then the others
9ee1100
#196 fix formatting
7c5095a
#196 test after build
d30c503
#196 test needs build
e739072
#196 trying...
ba95b28
#196 seperate job is inpossible, giving up on it
a9cc0de
#197 wording
e16fcf1
#197 common.props
7b22ce0
#196 Add example project with top level statement, because that faile…
ba8dd8e
#196 Ignore expected warning (ASP0014 needs #173)
3d6c0ea
#196 formatting and readme wording
8a4f5c6
#196 ExitCode test problems
07b4273
#196 ExitCode test problems -- the issue is a missing reference
e846dd9
#196 GetStreamFor logging
fc7cccd
#196 GetStreamFor try recreate directory?
4f1064e
#196 GetStreamFor try recreate directory??
74260a8
#196 permission issue?
e937716
Merge branch '#196-Publish-a-global-dotnet-tool' into #197-more-logging
a2cee95
#197 cleanup csproj
b043a77
#197 cleanup csproj
5fe8c6e
#196 cleanup csproj
68e06ca
Merge remote-tracking branch 'remotes/smoerijf/#196-Publish-a-global-…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * text eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,4 +7,6 @@ runs: | |
| id: setup-dotnet | ||
| uses: actions/setup-dotnet@v1 | ||
| with: | ||
| dotnet-version: "6.0.x" | ||
| dotnet-version: | | ||
| 6.0.x | ||
| 8.0.x | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <Project> | ||
| <ItemGroup> | ||
| <!-- Make it possible for NSubstitube to make substitues of internal classes --> | ||
| <InternalsVisibleTo Include="DynamicProxyGenAssembly2" /> | ||
|
|
||
| <!-- Make project internals visible to their respective .Tests project --> | ||
| <InternalsVisibleTo Include="$(AssemblyName).Tests" /> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| specs/ | ||
| streetlights.json | ||
| streetlights.yml | ||
| streetlights.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| using System.Linq; | ||
| using Microsoft.AspNetCore.Builder; | ||
| using Microsoft.AspNetCore.Http; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.Hosting; | ||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.Extensions.Options; | ||
| using NLog; | ||
| using NLog.Web; | ||
| using Saunter; | ||
| using Saunter.AsyncApiSchema.v2; | ||
| using StreetlightsAPI; | ||
|
|
||
| LogManager.Setup().LoadConfigurationFromAppSettings(); | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
| builder.Logging.AddSimpleConsole(console => console.SingleLine = true); | ||
| builder.Host.UseNLog(); | ||
|
|
||
| // Add Saunter to the application services. | ||
| builder.Services.AddAsyncApiSchemaGeneration(options => | ||
| { | ||
| options.AssemblyMarkerTypes = [typeof(StreetlightMessageBus)]; | ||
|
|
||
| options.Middleware.UiTitle = "Streetlights API"; | ||
|
|
||
| options.AsyncApi = new AsyncApiDocument | ||
| { | ||
| Info = new Info("Streetlights API", "1.0.0") | ||
| { | ||
| Description = "The Smartylighting Streetlights API allows you to remotely manage the city lights.", | ||
| License = new License("Apache 2.0") | ||
| { | ||
| Url = "https://www.apache.org/licenses/LICENSE-2.0" | ||
| } | ||
| }, | ||
| Servers = | ||
| { | ||
| ["mosquitto"] = new Server("test.mosquitto.org", "mqtt"), | ||
| ["webapi"] = new Server("localhost:5000", "http"), | ||
| }, | ||
| }; | ||
| }); | ||
|
|
||
| builder.Services.AddScoped<IStreetlightMessageBus, StreetlightMessageBus>(); | ||
| builder.Services.AddControllers(); | ||
|
|
||
| var app = builder.Build(); | ||
|
|
||
| app.UseDeveloperExceptionPage(); | ||
|
|
||
| app.UseRouting(); | ||
| app.UseCors(configure => configure.AllowAnyOrigin().AllowAnyMethod()); | ||
|
|
||
| // to be fixed with issue #173 | ||
| #pragma warning disable ASP0014 // Suggest using top level route registrations instead of UseEndpoints | ||
| app.UseEndpoints(endpoints => | ||
| { | ||
| endpoints.MapAsyncApiDocuments(); | ||
| endpoints.MapAsyncApiUi(); | ||
|
|
||
| endpoints.MapControllers(); | ||
| }); | ||
| #pragma warning restore ASP0014 // Suggest using top level route registrations instead of UseEndpoints | ||
|
|
||
| await app.StartAsync(); | ||
|
|
||
| // Print the AsyncAPI doc location | ||
| var logger = app.Services.GetService<ILoggerFactory>().CreateLogger<Program>(); | ||
| var options = app.Services.GetService<IOptions<AsyncApiOptions>>(); | ||
| var addresses = app.Urls; | ||
| logger.LogInformation("AsyncAPI doc available at: {URL}", $"{addresses.FirstOrDefault()}{options.Value.Middleware.Route}"); | ||
| logger.LogInformation("AsyncAPI UI available at: {URL}", $"{addresses.FirstOrDefault()}{options.Value.Middleware.UiBaseRoute}"); | ||
|
|
||
| // Redirect base url to AsyncAPI UI | ||
| app.Map("/", () => Results.Redirect("index.html")); | ||
| app.Map("/index.html", () => Results.Redirect(options.Value.Middleware.UiBaseRoute)); | ||
|
|
||
| await app.WaitForShutdownAsync(); |
63 changes: 63 additions & 0 deletions
63
examples/StreetlightsAPI.TopLevelStatement/StreetlightsAPI.TopLevelStatement.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
|
|
||
| <PropertyGroup> | ||
| <!-- This project is targeting .NET8 intentionally (The 'old school' Startup-class project is .NET6), to prove that | ||
| the AsyncAPI.Saunter.Generator.Cli tool can generate specs for projects targetting .NET6 and .NET8. --> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <IsPackable>false</IsPackable> | ||
|
|
||
| <!-- Example settings for "AsyncAPI.Saunter.Generator.Build", they are all option though --> | ||
| <AsyncAPIGenerateDocumentsOnBuild>true</AsyncAPIGenerateDocumentsOnBuild> | ||
| <AsyncAPIDocumentFormats>json,yml</AsyncAPIDocumentFormats> | ||
| <AsyncAPIDocumentFilename>streetlights.{extension}</AsyncAPIDocumentFilename> | ||
| <AsyncAPIDocumentOutputPath>specs</AsyncAPIDocumentOutputPath> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup Condition=" '$(Configuration)' == 'Debug' "> | ||
| <DocumentationFile>bin\Debug\StreetlightsAPI.TopLevelStatement.xml</DocumentationFile> | ||
| <NoWarn>1701;1702;1591</NoWarn> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup Condition=" '$(Configuration)' == 'Release' "> | ||
| <DocumentationFile>bin\Release\StreetlightsAPI.TopLevelStatement.xml</DocumentationFile> | ||
| <NoWarn>1701;1702;1591</NoWarn> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- Get the latest local build nuget package from source code, from the local nuget packages source as configured in nuget.config | ||
| 999.* are the 'special' version number for local builds --> | ||
| <ItemGroup Condition=" '$(Configuration)' == 'Debug' "> | ||
| <PackageReference Include="AsyncAPI.Saunter.Generator.Build" Version="999.*"> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
|
|
||
| <!-- For release: use a real published nuget package --> | ||
| <ItemGroup Condition=" '$(Configuration)' == 'Release' "> | ||
| <PackageReference Include="AsyncAPI.Saunter.Generator.Build" Version="*-*"> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\Saunter\Saunter.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Folder Include="specs\" /> | ||
|
|
||
| <Compile Include="../StreetlightsAPI/API.cs" /> | ||
| <Compile Include="../StreetlightsAPI/Messaging.cs" /> | ||
|
|
||
| <None Include="../StreetlightsAPI/nlog.config"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </None> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="NLog" Version="5.3.2" /> | ||
| <PackageReference Include="NLog.Web.AspNetCore" Version="5.3.11" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
19 changes: 19 additions & 0 deletions
19
examples/StreetlightsAPI.TopLevelStatement/appsettings.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft": "Warning", | ||
| "Microsoft.Hosting.Lifetime": "Information" | ||
| } | ||
| }, | ||
|
|
||
| "AllowedHosts": "*", | ||
|
|
||
| "Kestrel": { | ||
| "EndPoints": { | ||
| "Http": { | ||
| "Url": "http://localhost:5001" | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed separate unittest step because it causes a lot duplicate work: