Merge branch 'main' into 39-data-api-builder-dab

FBoucher · FBoucher · commit bca3ff9de4be · 2024-10-02T13:40:26.000-04:00
diff --git a/.github/workflows/SignClientFileList.txt b/.github/workflows/SignClientFileList.txt
@@ -0,0 +1 @@
+**/Aspire.CommunityToolkit.*
diff --git a/.github/workflows/dotnet-main.yml b/.github/workflows/dotnet-main.yml
@@ -125,7 +125,7 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     environment:
-      name: nuget
+      name: nuget-beta
     steps:
       - name: Download package
         uses: actions/download-artifact@v4
diff --git a/.github/workflows/dotnet-release.yml b/.github/workflows/dotnet-release.yml
@@ -9,6 +9,9 @@ on:
       - "examples/**"
       - "tests/**"
 
+env:
+  DEFAULT_DOTNET_VERSION: "8.0.x"
+
 jobs:
   build:
     strategy:
@@ -29,7 +32,7 @@ jobs:
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: |
-            8.0.x
+            ${{ env.DEFAULT_DOTNET_VERSION }}
             9.0.x
       - uses: actions/setup-java@v4
         name: Set up Java
@@ -138,30 +141,77 @@ jobs:
           files: |
             ./*.nupkg
 
-  publish-nuget:
+  sign:
     needs: release
+    runs-on: windows-latest
+    permissions:
+      id-token: write # Required for requesting the JWT
+
+    steps:
+      - name: Install .NET SDK v${{ env.DEFAULT_DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ env.DEFAULT_DOTNET_VERSION }}
+
+      - name: Download Package List
+        uses: actions/download-artifact@v4
+        with:
+          name: nuget-packages
+          path: ./
+
+      - name: Install Signing Tool
+        run: dotnet tool install --tool-path ./tools sign --version 0.9.1-beta.23356.1
+
+      - name: Sign Packages
+        run: >
+          ./tools/sign code azure-key-vault
+          **/*.nupkg
+          --base-directory "${{ github.workspace }}/packages"
+          --file-list "${{ github.workspace }}/SignClientFileList.txt"
+          --timestamp-url "http://timestamp.digicert.com"
+          --publisher-name ".NET Foundation"
+          --description ".NET Aspire Community Toolkit"
+          --description-url "https://github.com/CommunityToolkit/Aspire"
+          --azure-key-vault-url "${{ secrets.SIGN_KEY_VAULT_URL }}"
+          --azure-key-vault-client-id ${{ secrets.SIGN_CLIENT_ID }}
+          --azure-key-vault-client-secret "${{ secrets.SIGN_CLIENT_SECRET }}"
+          --azure-key-vault-tenant-id ${{ secrets.SIGN_TENANT_ID }}
+          --azure-key-vault-certificate "${{ secrets.SIGN_CERTIFICATE }}"
+          --verbosity Information
+
+      - name: Upload Signed Packages as Artifacts (for release)
+        uses: actions/upload-artifact@v4
+        with:
+          name: signed-nuget-packages
+          if-no-files-found: error
+          path: |
+            ${{ github.workspace }}/packages/**/*.nupkg
+
+  publish-nuget:
+    needs: sign
     runs-on: ubuntu-latest
     environment:
-      name: nuget
+      name: nuget-stable
     steps:
       - name: Download package
         uses: actions/download-artifact@v4
         with:
-          name: nuget-packages
+          name: signed-nuget-packages
 
       - name: Publish to NuGet
         run: dotnet nuget push ./*.nupkg --source "https://api.nuget.org/v3/index.json" --api-key ${{ secrets.NUGET_API_KEY }}
 
   publish-github-packages:
-    needs: release
+    needs: sign
     runs-on: ubuntu-latest
     environment:
       name: github-packages
     steps:
       - name: Download package
         uses: actions/download-artifact@v4
         with:
-          name: nuget-packages
+          name: signed-nuget-packages
 
       - name: Publish to GitHub packages
         run: dotnet nuget push ./*.nupkg --source "https://nuget.pkg.github.com/communitytoolkit/index.json" --api-key ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -38,3 +38,13 @@ Anyone can create a Pull Request by forking the .NET Aspire Community Toolkit Re
 ## 💙 Thank You
 
 **Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the .NET Aspire Community Toolkit.**
+
+## Code of Conduct
+
+Please see our [Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
+
+As should be clear by now: we assume everyone tries to do their best, everyone should be treated with respect and equally.
+
+In the unfortunate event that doesn't happen, please feel free to report it to any of the team members or reach out to [Gerald](mailto:gerald.versluis@microsoft.com) directly.
+
+We will take appropriate actions and measures if necessary.
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,7 @@
-MIT License
+The MIT License (MIT)
+Copyright (c) .NET Foundation and Contributors
+All Rights Reserved
 
-Copyright (c) 2024 Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[<img src="https://raw.githubusercontent.com/dotnet-foundation/swag/master/logo/dotnetfoundation_v4.svg" alt=".NET Foundation" width=100>](https://dotnetfoundation.org)
+
 # .NET Aspire Community Toolkit
 
 [![CI](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml) | [![main branch](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml) | [![Latest Release](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml)
@@ -37,6 +39,14 @@ Check out our [Contributing guide](./CONTRIBUTING.md) to learn more about contri
 
 Made with [contrib.rocks](https://contrib.rocks).
 
+## Code of Conduct
+
+As a part of the .NET Foundation, we have adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). Please familiarize yourself with that before participating with this repository. Thanks!
+
+## .NET Foundation
+
+This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
+
 [swa-integration-docs]: https://communitytoolkit.github.io/aspire/integrations/hosting-azure-static-web-apps
 [swa-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps
 [swa-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/
@@ -57,4 +67,3 @@ Made with [contrib.rocks](https://contrib.rocks).
 [ollama-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Ollama/
 [ollama-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Ollama?label=nuget%20(preview)
 [ollama-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Ollama/absoluteLatest
-
diff --git a/examples/ollama/Aspire.CommunityToolkit.Hosting.Ollama.AppHost/Program.cs b/examples/ollama/Aspire.CommunityToolkit.Hosting.Ollama.AppHost/Program.cs
@@ -2,7 +2,8 @@
 
 var ollama = builder.AddOllama("ollama", port: null)
     .AddModel("phi3")
-    .WithDefaultModel("phi3");
+    .WithDefaultModel("phi3")
+    .WithOpenWebUI();
 
 builder.AddProject<Projects.Aspire_CommunityToolkit_Hosting_Ollama_Web>("webfrontend")
     .WithExternalHttpEndpoints()
diff --git a/src/Aspire.CommunityToolkit.Hosting.Ollama/Aspire.CommunityToolkit.Hosting.Ollama.csproj b/src/Aspire.CommunityToolkit.Hosting.Ollama/Aspire.CommunityToolkit.Hosting.Ollama.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="OllamaSharp"/>
+    <PackageReference Include="OllamaSharp" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaContainerImageTags.cs b/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaContainerImageTags.cs
@@ -5,4 +5,8 @@ internal static class OllamaContainerImageTags
     public const string Registry = "docker.io";
     public const string Image = "ollama/ollama";
     public const string Tag = "0.3.11";
+
+    public const string OpenWebUIRegistry = "ghcr.io";
+    public const string OpenWebUIImage = "open-webui/open-webui";
+    public const string OpenWebUITag = "0.3.30";
 }
diff --git a/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaResource.cs b/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaResource.cs
@@ -10,13 +10,13 @@
 /// <param name="modelName">The LLM to download on initial startup.</param>
 public class OllamaResource(string name) : ContainerResource(name), IResourceWithConnectionString
 {
-    internal const string OllamaEndpointName = "ollama";
+    internal const string OllamaEndpointName = "http";
 
     private readonly List<string> _models = [];
 
     private string? _defaultModel = null;
 
-    private EndpointReference? _endpointReference;
+    private EndpointReference? _primaryEndpointReference;
 
     /// <summary>
     /// Adds a model to the list of models to download on initial startup.
@@ -31,14 +31,14 @@ public class OllamaResource(string name) : ContainerResource(name), IResourceWit
     /// <summary>
     /// Gets the endpoint for the Ollama server.
     /// </summary>
-    public EndpointReference Endpoint => _endpointReference ??= new(this, OllamaEndpointName);
+    public EndpointReference PrimaryEndpoint => _primaryEndpointReference ??= new(this, OllamaEndpointName);
 
     /// <summary>
     /// Gets the connection string expression for the Ollama server.
     /// </summary>
     public ReferenceExpression ConnectionStringExpression =>
       ReferenceExpression.Create(
-        $"http://{Endpoint.Property(EndpointProperty.Host)}:{Endpoint.Property(EndpointProperty.Port)}"
+        $"{PrimaryEndpoint.Property(EndpointProperty.Scheme)}://{PrimaryEndpoint.Property(EndpointProperty.Host)}:{PrimaryEndpoint.Property(EndpointProperty.Port)}"
       );
 
     /// <summary>
@@ -47,7 +47,7 @@ public class OllamaResource(string name) : ContainerResource(name), IResourceWit
     /// <param name="modelName">The name of the model</param>
     public void AddModel(string modelName)
     {
-        ArgumentNullException.ThrowIfNullOrEmpty(modelName, nameof(modelName));
+        ArgumentException.ThrowIfNullOrEmpty(modelName, nameof(modelName));
         if (!_models.Contains(modelName))
         {
             _models.Add(modelName);
@@ -63,7 +63,7 @@ public void AddModel(string modelName)
     /// </remarks>
     public void SetDefaultModel(string modelName)
     {
-        ArgumentNullException.ThrowIfNullOrEmpty(modelName, nameof(modelName));
+        ArgumentException.ThrowIfNullOrEmpty(modelName, nameof(modelName));
         _defaultModel = modelName;
 
         if (!_models.Contains(modelName))
diff --git a/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaResourceBuilderExtensions.cs b/src/Aspire.CommunityToolkit.Hosting.Ollama/OllamaResourceBuilderExtensions.cs
@@ -92,4 +92,61 @@ public static IResourceBuilder<OllamaResource> WithDefaultModel(this IResourceBu
         builder.Resource.SetDefaultModel(modelName);
         return builder;
     }
+
+
+    /// <summary>
+    /// Adds an administration web UI Ollama to the application model using Attu. This version the package defaults to the main tag of the Open WebUI container image
+    /// </summary>
+    /// <example>
+    /// Use in application host with an Ollama resource
+    /// <code lang="csharp">
+    /// var builder = DistributedApplication.CreateBuilder(args);
+    ///
+    /// var ollama = builder.AddOllama("ollama")
+    ///   .WithOpenWebUI();
+    /// var api = builder.AddProject&lt;Projects.Api&gt;("api")
+    ///   .WithReference(ollama);
+    ///  
+    /// builder.Build().Run(); 
+    /// </code>
+    /// </example>
+    /// <param name="builder">The Ollama resource builder.</param>
+    /// <param name="configureContainer">Configuration callback for Open WebUI container resource.</param>
+    /// <param name="containerName">The name of the container (Optional).</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
+    /// <remarks>See https://openwebui.com for more information about Open WebUI</remarks>
+    public static IResourceBuilder<T> WithOpenWebUI<T>(this IResourceBuilder<T> builder, Action<IResourceBuilder<OpenWebUIResource>>? configureContainer = null, string? containerName = null) where T : OllamaResource
+    {
+        ArgumentNullException.ThrowIfNull(builder, nameof(builder));
+
+        if (builder.ApplicationBuilder.Resources.OfType<OpenWebUIResource>().SingleOrDefault() is { } existingOpenWebUIResource)
+        {
+            var builderForExistingResource = builder.ApplicationBuilder.CreateResourceBuilder(existingOpenWebUIResource);
+            configureContainer?.Invoke(builderForExistingResource);
+            return builder;
+        }
+
+        containerName ??= $"{builder.Resource.Name}-openwebui";
+
+        var openWebUI = new OpenWebUIResource(containerName);
+        var resourceBuilder = builder.ApplicationBuilder.AddResource(openWebUI)
+                                                        .WithImage(OllamaContainerImageTags.OpenWebUIImage, OllamaContainerImageTags.OpenWebUITag)
+                                                        .WithImageRegistry(OllamaContainerImageTags.OpenWebUIRegistry)
+                                                        .WithHttpEndpoint(targetPort: 8080, name: "http")
+                                                        .WithVolume("open-webui", "/app/backend/data")
+                                                        .WithEnvironment(context => ConfigureOpenWebUIContainer(context, builder.Resource))
+                                                        .ExcludeFromManifest();
+
+        configureContainer?.Invoke(resourceBuilder);
+
+        return builder;
+    }
+
+    private static void ConfigureOpenWebUIContainer(EnvironmentCallbackContext context, OllamaResource resource)
+    {
+        context.EnvironmentVariables.Add("ENABLE_SIGNUP", "false");
+        context.EnvironmentVariables.Add("ENABLE_COMMUNITY_SHARING", "false"); // by default don't enable sharing
+        context.EnvironmentVariables.Add("WEBUI_AUTH", "false"); // https://docs.openwebui.com/#quick-start-with-docker--recommended
+        context.EnvironmentVariables.Add("OLLAMA_BASE_URL", $"{resource.PrimaryEndpoint.Scheme}://{resource.PrimaryEndpoint.ContainerHost}:{resource.PrimaryEndpoint.Port}");
+    }
 }
diff --git a/src/Aspire.CommunityToolkit.Hosting.Ollama/OpenWebUIResource.cs b/src/Aspire.CommunityToolkit.Hosting.Ollama/OpenWebUIResource.cs
@@ -0,0 +1,23 @@
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// A resource that represents an Open WebUI resource
+/// </summary>
+public class OpenWebUIResource(string name) : ContainerResource(name), IResourceWithConnectionString
+{
+    internal const string PrimaryEndpointName = "http";
+
+    private EndpointReference? _primaryEndpoint;
+
+    /// <summary>
+    /// Gets the http endpoint for the Open WebUI resource.
+    /// </summary>
+    public EndpointReference PrimaryEndpoint => _primaryEndpoint ??= new(this, PrimaryEndpointName);
+
+    /// <summary>
+    /// Gets the connection string expression for the Open WebUI endpoint.
+    /// </summary>
+    public ReferenceExpression ConnectionStringExpression =>
+       ReferenceExpression.Create(
+            $"{PrimaryEndpoint.Property(EndpointProperty.Url)}");
+}
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -4,16 +4,17 @@
   <PropertyGroup>
     <IsPackable>true</IsPackable>
 
-    <Authors>Microsoft</Authors>
-    <Owners>Microsoft</Owners>
+    <Authors>Microsoft.Toolkit,dotnetfoundation,Community Toolkit</Authors>
+    <Company>.NET Foundation</Company>
+    <Copyright>(c) .NET Foundation and Contributors. All rights reserved.</Copyright>
     <NeutralLanguage>en</NeutralLanguage>
     <Product>Aspire.CommunityToolkit ($(NetVersion))</Product>
-    <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/CommunityToolkit/Aspire</PackageProjectUrl>
     <PackageIcon>nuget.png</PackageIcon>
     <RepositoryUrl>https://github.com/CommunityToolkit/Aspire</RepositoryUrl>
     <VersionPrefix>$(AspireVersion).0</VersionPrefix>
+    <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
 
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
diff --git a/tests/Aspire.CommunityToolkit.Hosting.Ollama.Tests/AddOllamaTests.cs b/tests/Aspire.CommunityToolkit.Hosting.Ollama.Tests/AddOllamaTests.cs
@@ -2,7 +2,7 @@
 
 namespace Aspire.CommunityToolkit.Hosting.Ollama.Tests;
 
-public class ResourceCreationTests
+public class AddOllamaTests
 {
     [Fact]
     public void VerifyDefaultModel()
@@ -145,4 +145,20 @@ public void DefaultModelCannotBeOmitted()
         Assert.Throws<ArgumentException>(() => ollama.WithDefaultModel(" "));
         Assert.Throws<ArgumentNullException>(() => ollama.WithDefaultModel(null!));
     }
+
+    [Fact]
+    public void OpenWebUIConfigured()
+    {
+        var builder = DistributedApplication.CreateBuilder();
+        _ = builder.AddOllama("ollama", port: null).WithOpenWebUI();
+
+        using var app = builder.Build();
+
+        var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
+
+        var resource = Assert.Single(appModel.Resources.OfType<OpenWebUIResource>());
+
+        Assert.Equal("ollama-openwebui", resource.Name);
+        Assert.Equal("http", resource.PrimaryEndpoint.EndpointName);
+    }
 }
diff --git a/tests/Aspire.CommunityToolkit.Hosting.Ollama.Tests/AppHostTests.cs b/tests/Aspire.CommunityToolkit.Hosting.Ollama.Tests/AppHostTests.cs
diff --git a/tests/Aspire.CommunityToolkit.Testing/AspireIntegrationTest.cs b/tests/Aspire.CommunityToolkit.Testing/AspireIntegrationTest.cs

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,8 @@ internal static class OllamaContainerImageTags`
`5`	`5`	`public const string Registry = "docker.io";`
`6`	`6`	`public const string Image = "ollama/ollama";`
`7`	`7`	`public const string Tag = "0.3.11";`
	`8`	`+`
	`9`	`+ public const string OpenWebUIRegistry = "ghcr.io";`
	`10`	`+ public const string OpenWebUIImage = "open-webui/open-webui";`
	`11`	`+ public const string OpenWebUITag = "0.3.30";`
`8`	`12`	`}`