Skip to content

Commit 6821c63

Browse files
Odonnoaaronpowell
Odonno
and
aaronpowell
authored
k6 hosting integration (#600)
* feat: create k6 hosting integration * docs: create example project for k6 hosting integration * docs: add k6 description in readme file * test: add tests for k6 hosting integration * feat: add method `WithK6OtlpEnvironment` --------- Co-authored-by: Aaron Powell <[email protected]>
1 parent 5a3c19b commit 6821c63

File tree

23 files changed

+773
-1
lines changed

23 files changed

+773
-1
lines changed

‎.github/workflows/tests.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ jobs:
3232
Hosting.GoFeatureFlag.Tests,
3333
Hosting.Golang.Tests,
3434
Hosting.Java.Tests,
35+
Hosting.k6.Tests,
3536
Hosting.LavinMQ.Tests,
3637
Hosting.MailPit.Tests,
3738
Hosting.Meilisearch.Tests,

‎CommunityToolkit.Aspire.sln‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,18 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hos
361361
EndProject
362362
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.Azure.Dapr.AppHost", "examples\dapr\CommunityToolkit.Aspire.Hosting.Azure.Dapr.AppHost\CommunityToolkit.Aspire.Hosting.Azure.Dapr.AppHost.csproj", "{39A6C03B-52AB-45F4-8D01-C3A1E5095765}"
363363
EndProject
364+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.k6", "src\CommunityToolkit.Aspire.Hosting.k6\CommunityToolkit.Aspire.Hosting.k6.csproj", "{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531}"
365+
EndProject
366+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "k6", "k6", "{612ECA40-80B7-4365-9A6A-C35A6BE30FED}"
367+
EndProject
368+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.k6.AppHost", "examples\k6\CommunityToolkit.Aspire.Hosting.k6.AppHost\CommunityToolkit.Aspire.Hosting.k6.AppHost.csproj", "{744F01AD-B28E-4B25-B6BA-42821157CA72}"
369+
EndProject
370+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.k6.ServiceDefaults", "examples\k6\CommunityToolkit.Aspire.Hosting.k6.ServiceDefaults\CommunityToolkit.Aspire.Hosting.k6.ServiceDefaults.csproj", "{15BBCE34-82A2-489C-A65B-5BAEA299F07E}"
371+
EndProject
372+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.k6.ApiService", "examples\k6\CommunityToolkit.Aspire.Hosting.k6.ApiService\CommunityToolkit.Aspire.Hosting.k6.ApiService.csproj", "{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A}"
373+
EndProject
374+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.k6.Tests", "tests\CommunityToolkit.Aspire.Hosting.k6.Tests\CommunityToolkit.Aspire.Hosting.k6.Tests.csproj", "{CCFE3593-49A7-4F03-A329-687490CD0143}"
375+
EndProject
364376
Global
365377
GlobalSection(SolutionConfigurationPlatforms) = preSolution
366378
Debug|Any CPU = Debug|Any CPU
@@ -947,6 +959,26 @@ Global
947959
{39A6C03B-52AB-45F4-8D01-C3A1E5095765}.Debug|Any CPU.Build.0 = Debug|Any CPU
948960
{39A6C03B-52AB-45F4-8D01-C3A1E5095765}.Release|Any CPU.ActiveCfg = Release|Any CPU
949961
{39A6C03B-52AB-45F4-8D01-C3A1E5095765}.Release|Any CPU.Build.0 = Release|Any CPU
962+
{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
963+
{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531}.Debug|Any CPU.Build.0 = Debug|Any CPU
964+
{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531}.Release|Any CPU.ActiveCfg = Release|Any CPU
965+
{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531}.Release|Any CPU.Build.0 = Release|Any CPU
966+
{744F01AD-B28E-4B25-B6BA-42821157CA72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
967+
{744F01AD-B28E-4B25-B6BA-42821157CA72}.Debug|Any CPU.Build.0 = Debug|Any CPU
968+
{744F01AD-B28E-4B25-B6BA-42821157CA72}.Release|Any CPU.ActiveCfg = Release|Any CPU
969+
{744F01AD-B28E-4B25-B6BA-42821157CA72}.Release|Any CPU.Build.0 = Release|Any CPU
970+
{15BBCE34-82A2-489C-A65B-5BAEA299F07E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
971+
{15BBCE34-82A2-489C-A65B-5BAEA299F07E}.Debug|Any CPU.Build.0 = Debug|Any CPU
972+
{15BBCE34-82A2-489C-A65B-5BAEA299F07E}.Release|Any CPU.ActiveCfg = Release|Any CPU
973+
{15BBCE34-82A2-489C-A65B-5BAEA299F07E}.Release|Any CPU.Build.0 = Release|Any CPU
974+
{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
975+
{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A}.Debug|Any CPU.Build.0 = Debug|Any CPU
976+
{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A}.Release|Any CPU.ActiveCfg = Release|Any CPU
977+
{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A}.Release|Any CPU.Build.0 = Release|Any CPU
978+
{CCFE3593-49A7-4F03-A329-687490CD0143}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
979+
{CCFE3593-49A7-4F03-A329-687490CD0143}.Debug|Any CPU.Build.0 = Debug|Any CPU
980+
{CCFE3593-49A7-4F03-A329-687490CD0143}.Release|Any CPU.ActiveCfg = Release|Any CPU
981+
{CCFE3593-49A7-4F03-A329-687490CD0143}.Release|Any CPU.Build.0 = Release|Any CPU
950982
EndGlobalSection
951983
GlobalSection(SolutionProperties) = preSolution
952984
HideSolutionNode = FALSE
@@ -1128,6 +1160,12 @@ Global
11281160
{92D490BC-B953-45DC-8F9D-A992B2AEF96A} = {41ACF613-EE5A-5900-F4D1-9FB713A32BE8}
11291161
{27144ED2-9F74-4A86-AABA-38CD061D8984} = {41ACF613-EE5A-5900-F4D1-9FB713A32BE8}
11301162
{39A6C03B-52AB-45F4-8D01-C3A1E5095765} = {E3C2B4B7-B3B0-4E7F-A975-A6C7FD926792}
1163+
{C72E4CF1-EDEF-4AA8-A116-DAD99A86B531} = {414151D4-7009-4E78-A5C6-D99EBD1E67D1}
1164+
{612ECA40-80B7-4365-9A6A-C35A6BE30FED} = {8519CC01-1370-47C8-AD94-B0F326B1563F}
1165+
{744F01AD-B28E-4B25-B6BA-42821157CA72} = {612ECA40-80B7-4365-9A6A-C35A6BE30FED}
1166+
{15BBCE34-82A2-489C-A65B-5BAEA299F07E} = {612ECA40-80B7-4365-9A6A-C35A6BE30FED}
1167+
{9DB0C7B2-31D3-481C-9C0C-EEAEC9B2AA6A} = {612ECA40-80B7-4365-9A6A-C35A6BE30FED}
1168+
{CCFE3593-49A7-4F03-A329-687490CD0143} = {899F0713-7FC6-4750-BAFC-AC650B35B453}
11311169
EndGlobalSection
11321170
GlobalSection(ExtensibilityGlobals) = postSolution
11331171
SolutionGuid = {08B1D4B8-D2C5-4A64-BB8B-E1A2B29525F0}

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This repository contains the source code for the .NET Aspire Community Toolkit,
1919
| - **Learn More**: [`Hosting.Java`][java-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Java][java-shields]][java-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Java][java-shields-preview]][java-nuget-preview] | An integration for running Java code in .NET Aspire either using the local JDK or using a container. |
2020
| - **Learn More**: [`Hosting.NodeJS.Extensions`][nodejs-ext-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.NodeJS.Extensions][nodejs-ext-shields]][nodejs-ext-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.NodeJS.Extensions][nodejs-ext-shields-preview]][nodejs-ext-nuget-preview] | An integration that contains some additional extensions for running Node.js applications |
2121
| - **Learn More**: [`Hosting.Ollama`][ollama-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Ollama][ollama-shields]][ollama-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Ollama][ollama-shields-preview]][ollama-nuget-preview] | An Aspire hosting integration leveraging the [Ollama](https://ollama.com) container with support for downloading a model on startup. |
22-
| - **Learn More**: [`OllamaSharp`][ollama-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields]][ollamasharp-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields-preview]][ollama-nuget-preview] | An Aspire client integration for the [OllamaSharp](https://github.com/awaescher/OllamaSharp) package. |
22+
| - **Learn More**: [`OllamaSharp`][ollama-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields]][ollamasharp-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields-preview]][ollamasharp-nuget-preview] | An Aspire client integration for the [OllamaSharp](https://github.com/awaescher/OllamaSharp) package. |
2323
| - **Learn More**: [`Hosting.Meilisearch`][meilisearch-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Meilisearch][meilisearch-shields]][meilisearch-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Meilisearch][meilisearch-shields-preview]][meilisearch-nuget-preview] | An Aspire hosting integration leveraging the [Meilisearch](https://meilisearch.com) container. |
2424
| - **Learn More**: [`Meilisearch`][meilisearch-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Meilisearch][meilisearch-client-shields]][meilisearch-client-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Meilisearch][meilisearch-client-shields-preview]][meilisearch-client-nuget-preview] | An Aspire client integration for the [Meilisearch](https://github.com/meilisearch/meilisearch-dotnet) package. |
2525
| - **Learn More**: [`Hosting.Azure.DataApiBuilder`][dab-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder][dab-shields]][dab-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder][dab-shields-preview]][dab-nuget-preview] | A hosting integration for the [Azure Data API builder](https://learn.microsoft.com/en-us/azure/data-api-builder/overview). |
@@ -46,6 +46,7 @@ This repository contains the source code for the .NET Aspire Community Toolkit,
4646
| - **Learn More**: [`Hosting.SqlServer.Extensions`][sqlserver-ext-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.SqlServer.Extensions][sqlserver-ext-shields]][sqlserver-ext-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.SqlServer.Extensions][sqlserver-ext-shields-preview]][sqlserver-ext-nuget-preview] | An integration that contains some additional extensions for hosting SqlServer container. |
4747
| - **Learn More**: [`Hosting.LavinMQ`][lavinmq-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.LavinMQ][lavinmq-shields]][lavinmq-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.LavinMQ][lavinmq-shields-preview]][lavinmq-nuget-preview] | An Aspire hosting integration for [LavinMQ](https://www.lavinmq.com). |
4848
| - **Learn More**: [`Hosting.MailPit`][mailpit-ext-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.MailPit][mailpit-ext-shields]][mailpit-ext-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.MailPit][mailpit-ext-shields-preview]][mailpit-ext-nuget-preview] | An Aspire integration leveraging the [MailPit](https://mailpit.axllent.org/) container. |
49+
| - **Learn More**: [`Hosting.k6`][k6-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.k6][k6-shields]][k6-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.k6][k6-shields-preview]][k6-nuget-preview] | An Aspire integration leveraging the [Grafana k6](https://k6.io/) container. |
4950

5051
## 🙌 Getting Started
5152

@@ -240,3 +241,8 @@ This project is supported by the [.NET Foundation](https://dotnetfoundation.org)
240241
[mailpit-ext-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.MailPit/
241242
[mailpit-ext-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.MailPit?label=nuget%20(preview)
242243
[mailpit-ext-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.MailPit/absoluteLatest
244+
[k6-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-k6
245+
[k6-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.k6
246+
[k6-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.k6/
247+
[k6-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.k6?label=nuget%20(preview)
248+
[k6-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.k6/absoluteLatest

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.ApiService/CommunityToolkit.Aspire.Hosting.k6.ApiService.csproj‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<Project Sdk="Microsoft.NET.Sdk.Web">
2+
3+
<PropertyGroup>
4+
<Nullable>enable</Nullable>
5+
<ImplicitUsings>enable</ImplicitUsings>
6+
</PropertyGroup>
7+
8+
<ItemGroup>
9+
<ProjectReference Include="..\CommunityToolkit.Aspire.Hosting.k6.ServiceDefaults\CommunityToolkit.Aspire.Hosting.k6.ServiceDefaults.csproj" />
10+
</ItemGroup>
11+
12+
</Project>

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.ApiService/Program.cs‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
var builder = WebApplication.CreateBuilder(args);
2+
3+
builder.AddServiceDefaults();
4+
5+
var app = builder.Build();
6+
7+
app.UseOutputCache();
8+
9+
app.MapDefaultEndpoints();
10+
11+
string[] summaries =
12+
[
13+
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
14+
];
15+
16+
var helloWorldFn = static () => "Hello World!";
17+
var weathersFn = () =>
18+
Enumerable.Range(0, 6).Select(index =>
19+
new WeatherForecast(
20+
DateTime.Now.AddDays(index),
21+
Random.Shared.Next(-20, 55),
22+
summaries[Random.Shared.Next(summaries.Length)]
23+
)
24+
);
25+
26+
app.MapGet("/hello", helloWorldFn);
27+
app.MapGet("/api/weather", weathersFn);
28+
29+
var cachedGroup = app
30+
.MapGroup("")
31+
.CacheOutput(o => o.Cache());
32+
33+
cachedGroup.MapGet("/hello/cached", () => helloWorldFn);
34+
cachedGroup.MapGet("/api/weather/cached", weathersFn);
35+
36+
app.Run();
37+
38+
record WeatherForecast(DateTime Date, int TemperatureC, string Summary)
39+
{
40+
public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
41+
}

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.ApiService/Properties/launchSettings.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"$schema": "https://json.schemastore.org/launchsettings.json",
3+
"profiles": {
4+
"http": {
5+
"commandName": "Project",
6+
"dotnetRunMessages": true,
7+
"launchBrowser": false,
8+
"applicationUrl": "http://localhost:5048",
9+
"environmentVariables": {
10+
"ASPNETCORE_ENVIRONMENT": "Development"
11+
}
12+
},
13+
"https": {
14+
"commandName": "Project",
15+
"dotnetRunMessages": true,
16+
"launchBrowser": false,
17+
"applicationUrl": "https://localhost:7213;http://localhost:5048",
18+
"environmentVariables": {
19+
"ASPNETCORE_ENVIRONMENT": "Development"
20+
}
21+
}
22+
}
23+
}

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.ApiService/appsettings.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"Logging": {
3+
"LogLevel": {
4+
"Default": "Information",
5+
"Microsoft.AspNetCore": "Warning"
6+
}
7+
},
8+
"AllowedHosts": "*"
9+
}

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.AppHost/CommunityToolkit.Aspire.Hosting.k6.AppHost.csproj‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<Sdk Name="Aspire.AppHost.Sdk" Version="$(AspireAppHostSdkVersion)"/>
3+
4+
<PropertyGroup>
5+
<OutputType>Exe</OutputType>
6+
<ImplicitUsings>enable</ImplicitUsings>
7+
<Nullable>enable</Nullable>
8+
<IsAspireHost>true</IsAspireHost>
9+
<UserSecretsId>bdd580db-20ba-4a95-95a1-a8b4dbe0521d</UserSecretsId>
10+
</PropertyGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="Aspire.Hosting.AppHost" />
14+
</ItemGroup>
15+
16+
<ItemGroup>
17+
<ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.k6\CommunityToolkit.Aspire.Hosting.k6.csproj" IsAspireProjectResource="false" />
18+
<ProjectReference Include="..\CommunityToolkit.Aspire.Hosting.k6.ApiService\CommunityToolkit.Aspire.Hosting.k6.ApiService.csproj" />
19+
</ItemGroup>
20+
21+
</Project>

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.AppHost/Program.cs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
using Projects;
2+
3+
var builder = DistributedApplication.CreateBuilder(args);
4+
5+
var apiservice = builder
6+
.AddProject<CommunityToolkit_Aspire_Hosting_k6_ApiService>("apiservice")
7+
.WithHttpHealthCheck("/health");
8+
9+
var k6 = builder.AddK6("k6")
10+
.WithBindMount("scripts", "/scripts", true)
11+
.WithScript("/scripts/main.js")
12+
.WithReference(apiservice)
13+
.WaitFor(apiservice);
14+
15+
builder.Build().Run();

‎examples/k6/CommunityToolkit.Aspire.Hosting.k6.AppHost/Properties/launchSettings.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"$schema": "https://json.schemastore.org/launchsettings.json",
3+
"profiles": {
4+
"https": {
5+
"commandName": "Project",
6+
"dotnetRunMessages": true,
7+
"launchBrowser": true,
8+
"applicationUrl": "https://localhost:17137;http://localhost:15219",
9+
"environmentVariables": {
10+
"ASPNETCORE_ENVIRONMENT": "Development",
11+
"DOTNET_ENVIRONMENT": "Development",
12+
"DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21037",
13+
"DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22238"
14+
}
15+
},
16+
"http": {
17+
"commandName": "Project",
18+
"dotnetRunMessages": true,
19+
"launchBrowser": true,
20+
"applicationUrl": "http://localhost:15219",
21+
"environmentVariables": {
22+
"ASPNETCORE_ENVIRONMENT": "Development",
23+
"DOTNET_ENVIRONMENT": "Development",
24+
"DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19071",
25+
"DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20061"
26+
}
27+
}
28+
}
29+
}

0 commit comments

Comments
 (0)