Skip to content

[release/9.1] Rename ASPIRECOSMOS001 to ASPIRECOSMOSDB001 #7691

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.

Sign up for GitHub

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

Merged
danmoseley merged 1 commit into from
Feb 19, 2025
+9 −8
Merged

[release/9.1] Rename ASPIRECOSMOS001 to ASPIRECOSMOSDB001 #7691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions playground/CosmosEndToEnd/CosmosEndToEnd.AppHost/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable ASPIRECOSMOSDB001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.

var builder = DistributedApplication.CreateBuilder(args);

#pragma warning disable ASPIRECOSMOS001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
var cosmos = builder.AddAzureCosmosDB("cosmos")
.RunAsPreviewEmulator(e => e.WithDataExplorer());
#pragma warning restore ASPIRECOSMOS001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.

var db = cosmos.AddCosmosDatabase("db");
db.AddContainer("entries", "/id");

Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static IResourceBuilder<AzureCosmosDBResource> RunAsEmulator(this IResour
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="CosmosDBEmulatorContainerImageTags.TagVNextPreview"/> tag of the <inheritdoc cref="CosmosDBEmulatorContainerImageTags.Registry"/>/<inheritdoc cref="CosmosDBEmulatorContainerImageTags.Image"/> container image.
/// </remarks>
[Experimental("ASPIRECOSMOS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
[Experimental("ASPIRECOSMOSDB001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
public static IResourceBuilder<AzureCosmosDBResource> RunAsPreviewEmulator(this IResourceBuilder<AzureCosmosDBResource> builder, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>? configureContainer = null)
=> builder.RunAsEmulator(configureContainer, useVNextPreview: true);

Expand Down Expand Up @@ -275,7 +275,7 @@ public static IResourceBuilder<AzureCosmosDBContainerResource> AddContainer(this
/// <remarks>
/// The Data Explorer is only available with <see cref="RunAsPreviewEmulator"/>.
/// </remarks>
[Experimental("ASPIRECOSMOS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
[Experimental("ASPIRECOSMOSDB001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
public static IResourceBuilder<AzureCosmosDBEmulatorResource> WithDataExplorer(this IResourceBuilder<AzureCosmosDBEmulatorResource> builder, int? port = null)
{
if (!builder.Resource.InnerResource.IsPreviewEmulator)
Expand Down
4 changes: 2 additions & 2 deletions tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBEmulatorFunctionalTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,9 @@ void WithVolume(IResourceBuilder<AzureCosmosDBEmulatorResource> emulator)
}

return usePreview
#pragma warning disable ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
#pragma warning disable ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
? builder.RunAsPreviewEmulator(WithVolume)
#pragma warning restore ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
#pragma warning restore ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
: builder.RunAsEmulator(WithVolume);
}
}
4 changes: 2 additions & 2 deletions tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public async Task AddAzureCosmosDBWithPartitionCountCanOverrideNumberOfPartition
[Fact]
public void AddAzureCosmosDBWithDataExplorer()
{
#pragma warning disable ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
#pragma warning disable ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
using var builder = TestDistributedApplicationBuilder.Create();

var cosmos = builder.AddAzureCosmosDB("cosmos");
Expand All @@ -85,7 +85,7 @@ public void AddAzureCosmosDBWithDataExplorer()
// WithDataExplorer doesn't work against the non-preview emulator
var cosmos2 = builder.AddAzureCosmosDB("cosmos2");
Assert.Throws<NotSupportedException>(() => cosmos2.RunAsEmulator(e => e.WithDataExplorer()));
#pragma warning restore ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
#pragma warning restore ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
}

[Fact]
Expand Down