Skip to content
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

Jump to bottom

Add test that verifies the default credentials work #725

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Add test that verifies the default credentials work #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
905b13e
Add test that verifies the default credentials work
danielmarbach Jun 26, 2024
16ec9ab
Rename the endpoint
danielmarbach Jun 26, 2024
77aee89
More debugging information
danielmarbach Jun 26, 2024
3742300
Try default database and container
danielmarbach Jun 26, 2024
ca8bc92
Add ignore for emulator, align and add proper done condition
danielmarbach Jun 26, 2024
304d156
Newline removal
danielmarbach Jun 26, 2024
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
1 change: 1 addition & 0 deletions ...box.AcceptanceTests/NServiceBus.Persistence.CosmosDB.LogicalOutbox.AcceptanceTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Azure.Identity" Version="1.12.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" />
<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.38.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
Expand Down
13 changes: 7 additions & 6 deletions src/NServiceBus.Persistence.CosmosDB.LogicalOutbox.AcceptanceTests/SetupFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ public class SetupFixture
[OneTimeSetUp]
public async Task OneTimeSetUp()
{
var connectionStringEnvironmentVariableName = "CosmosDBPersistence_ConnectionString";
var connectionString = GetEnvironmentVariable(connectionStringEnvironmentVariableName,
fallbackEmulatorConnectionString: "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==");
var connectionString = GetConnectionStringOrFallback();

ContainerName = $"{DateTime.UtcNow.Ticks}_{Path.GetFileNameWithoutExtension(Path.GetTempFileName())}";

Expand Down Expand Up @@ -51,14 +49,17 @@ public async Task OneTimeTearDown()
CosmosDbClient.Dispose();
}

static string GetEnvironmentVariable(string variable, string fallbackEmulatorConnectionString)
public static string GetConnectionStringOrFallback(string environmentVariableName = "CosmosDBPersistence_ConnectionString", string fallbackEmulatorConnectionString = EmulatorConnectionString)
{
var candidate = Environment.GetEnvironmentVariable(variable, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(variable) : candidate;
var candidate = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(environmentVariableName) : candidate;

return string.IsNullOrEmpty(environmentVariableConnectionString) ? fallbackEmulatorConnectionString : environmentVariableConnectionString;
}

public static bool IsRunningWithEmulator => GetConnectionStringOrFallback() == EmulatorConnectionString;

const string EmulatorConnectionString = "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
public const string DatabaseName = "CosmosDBPersistence";
public const string PartitionPathKey = "/deep/down";
public static string ContainerName;
Expand Down
1 change: 1 addition & 0 deletions ...ptanceTests/NServiceBus.Persistence.CosmosDB.NonTransactionalSagas.AcceptanceTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Azure.Identity" Version="1.12.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" />
<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.38.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
Expand Down
13 changes: 7 additions & 6 deletions src/NServiceBus.Persistence.CosmosDB.NonTransactionalSagas.AcceptanceTests/SetupFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ public class SetupFixture
[OneTimeSetUp]
public async Task OneTimeSetUp()
{
var connectionStringEnvironmentVariableName = "CosmosDBPersistence_ConnectionString";
var connectionString = GetEnvironmentVariable(connectionStringEnvironmentVariableName,
fallbackEmulatorConnectionString: "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==");
var connectionString = GetConnectionStringOrFallback();

ContainerName = $"{DateTime.UtcNow.Ticks}_{Path.GetFileNameWithoutExtension(Path.GetTempFileName())}";

Expand Down Expand Up @@ -51,14 +49,17 @@ public async Task OneTimeTearDown()
CosmosDbClient.Dispose();
}

static string GetEnvironmentVariable(string variable, string fallbackEmulatorConnectionString)
public static string GetConnectionStringOrFallback(string environmentVariableName = "CosmosDBPersistence_ConnectionString", string fallbackEmulatorConnectionString = EmulatorConnectionString)
{
var candidate = Environment.GetEnvironmentVariable(variable, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(variable) : candidate;
var candidate = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(environmentVariableName) : candidate;

return string.IsNullOrEmpty(environmentVariableConnectionString) ? fallbackEmulatorConnectionString : environmentVariableConnectionString;
}

public static bool IsRunningWithEmulator => GetConnectionStringOrFallback() == EmulatorConnectionString;

const string EmulatorConnectionString = "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
public const string DatabaseName = "CosmosDBPersistence";
public const string PartitionPathKey = "/id";
public static string ContainerName;
Expand Down
1 change: 1 addition & 0 deletions ...k.AcceptanceTests/NServiceBus.Persistence.CosmosDB.PessimisticLock.AcceptanceTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Azure.Identity" Version="1.12.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" />
<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.38.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
Expand Down
13 changes: 7 additions & 6 deletions src/NServiceBus.Persistence.CosmosDB.PessimisticLock.AcceptanceTests/SetupFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ public class SetupFixture
[OneTimeSetUp]
public async Task OneTimeSetUp()
{
var connectionStringEnvironmentVariableName = "CosmosDBPersistence_ConnectionString";
var connectionString = GetEnvironmentVariable(connectionStringEnvironmentVariableName,
fallbackEmulatorConnectionString: "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==");
var connectionString = GetConnectionStringOrFallback();

ContainerName = $"{DateTime.UtcNow.Ticks}_{Path.GetFileNameWithoutExtension(Path.GetTempFileName())}";

Expand Down Expand Up @@ -51,14 +49,17 @@ public async Task OneTimeTearDown()
CosmosDbClient.Dispose();
}

static string GetEnvironmentVariable(string variable, string fallbackEmulatorConnectionString)
public static string GetConnectionStringOrFallback(string environmentVariableName = "CosmosDBPersistence_ConnectionString", string fallbackEmulatorConnectionString = EmulatorConnectionString)
{
var candidate = Environment.GetEnvironmentVariable(variable, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(variable) : candidate;
var candidate = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(environmentVariableName) : candidate;

return string.IsNullOrEmpty(environmentVariableConnectionString) ? fallbackEmulatorConnectionString : environmentVariableConnectionString;
}

public static bool IsRunningWithEmulator => GetConnectionStringOrFallback() == EmulatorConnectionString;

const string EmulatorConnectionString = "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
danielmarbach marked this conversation as resolved.
Show resolved Hide resolved
public const string DatabaseName = "CosmosDBPersistence";
public const string PartitionPathKey = "/id";
public static string ContainerName;
Expand Down
1 change: 1 addition & 0 deletions ...ox.AcceptanceTests/NServiceBus.Persistence.CosmosDB.PhysicalOutbox.AcceptanceTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Azure.Identity" Version="1.12.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" />
<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.38.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
Expand Down
13 changes: 7 additions & 6 deletions src/NServiceBus.Persistence.CosmosDB.PhysicalOutbox.AcceptanceTests/SetupFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ public class SetupFixture
[OneTimeSetUp]
public async Task OneTimeSetUp()
{
var connectionStringEnvironmentVariableName = "CosmosDBPersistence_ConnectionString";
var connectionString = GetEnvironmentVariable(connectionStringEnvironmentVariableName,
fallbackEmulatorConnectionString: "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==");
var connectionString = GetConnectionStringOrFallback();

ContainerName = $"{DateTime.UtcNow.Ticks}_{Path.GetFileNameWithoutExtension(Path.GetTempFileName())}";

Expand Down Expand Up @@ -51,14 +49,17 @@ public async Task OneTimeTearDown()
CosmosDbClient.Dispose();
}

static string GetEnvironmentVariable(string variable, string fallbackEmulatorConnectionString)
public static string GetConnectionStringOrFallback(string environmentVariableName = "CosmosDBPersistence_ConnectionString", string fallbackEmulatorConnectionString = EmulatorConnectionString)
{
var candidate = Environment.GetEnvironmentVariable(variable, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(variable) : candidate;
var candidate = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(environmentVariableName) : candidate;

return string.IsNullOrEmpty(environmentVariableConnectionString) ? fallbackEmulatorConnectionString : environmentVariableConnectionString;
}

public static bool IsRunningWithEmulator => GetConnectionStringOrFallback() == EmulatorConnectionString;

const string EmulatorConnectionString = "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
public const string DatabaseName = "CosmosDBPersistence";
public const string PartitionPathKey = "/deep/down";
public static string ContainerName;
Expand Down
11 changes: 7 additions & 4 deletions src/NServiceBus.Persistence.CosmosDB.TransactionalSession.AcceptanceTests/SetupFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ public class SetupFixture
[OneTimeSetUp]
public async Task OneTimeSetUp()
{
var connectionString = GetEnvironmentVariable("CosmosDBPersistence_ConnectionString",
fallbackEmulatorConnectionString: "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==");
var connectionString = GetConnectionStringOrFallback();

ContainerName = $"{DateTime.UtcNow.Ticks}_{Path.GetFileNameWithoutExtension(Path.GetTempFileName())}";

Expand Down Expand Up @@ -51,13 +50,17 @@ public async Task OneTimeTearDown()
CosmosDbClient.Dispose();
}

static string GetEnvironmentVariable(string variable, string fallbackEmulatorConnectionString)
public static string GetConnectionStringOrFallback(string environmentVariableName = "CosmosDBPersistence_ConnectionString", string fallbackEmulatorConnectionString = EmulatorConnectionString)
{
var environmentVariableConnectionString = Environment.GetEnvironmentVariable(variable);
var candidate = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.User);
var environmentVariableConnectionString = string.IsNullOrWhiteSpace(candidate) ? Environment.GetEnvironmentVariable(environmentVariableName) : candidate;

return string.IsNullOrEmpty(environmentVariableConnectionString) ? fallbackEmulatorConnectionString : environmentVariableConnectionString;
}

public static bool IsRunningWithEmulator => GetConnectionStringOrFallback() == EmulatorConnectionString;

const string EmulatorConnectionString = "AccountEndpoint = https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
public const string DatabaseName = "CosmosDBPersistence";
public const string PartitionPathKey = $"/{PartitionPropertyName}";
public const string PartitionPropertyName = "somekey";
Expand Down
88 changes: 88 additions & 0 deletions src/SharedAcceptanceTests.All/When_default_credentials_used.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
namespace NServiceBus.AcceptanceTests
{
using System;
using System.Data.Common;
using System.Threading.Tasks;
using AcceptanceTesting;
using Azure.Identity;
using EndpointTemplates;
using Microsoft.Azure.Cosmos;
using NUnit.Framework;

public class When_default_credentials_used : NServiceBusAcceptanceTest
{
[Test]
public async Task Should_work()
{
if (SetupFixture.IsRunningWithEmulator)
{
Assert.Ignore("This test uses DefaultAzureCredential which is not supported with the emulator.");
}

var context = await Scenario.Define<Context>()
.WithEndpoint<EndpointUsingDefaultCredentials>(b => b.When(session => session.SendLocal(new StartSaga1
{
DataId = Guid.NewGuid()
})))
.Done(c => c.SagaReceivedMessage)
.Run();

Assert.True(context.SagaReceivedMessage);
}

public class Context : ScenarioContext
{
public bool SagaReceivedMessage { get; set; }
}

public class EndpointUsingDefaultCredentials : EndpointConfigurationBuilder
{
public EndpointUsingDefaultCredentials() =>
EndpointSetup<DefaultServer>(config =>
{
var builder = new DbConnectionStringBuilder
{
ConnectionString = SetupFixture.GetConnectionStringOrFallback()
};
builder.TryGetValue("AccountEndpoint", out var accountEndpoint);

var cosmosClient = new CosmosClient($"{accountEndpoint}", new DefaultAzureCredential(), new CosmosClientOptions());

var persistence = config.UsePersistence<CosmosPersistence>();
persistence.DisableContainerCreation();
persistence.CosmosClient(cosmosClient);
// with RBAC data plane operations are not supported, so we are using the existing database and container
persistence.DatabaseName(Environment.GetEnvironmentVariable("CosmosDBPersistence_ConnectionString_DatabaseName"));
persistence.DefaultContainer(Environment.GetEnvironmentVariable("CosmosDBPersistence_ConnectionString_ContainerOrTableName"), "/id");
});

public class JustASaga : Saga<JustASagaData>, IAmStartedByMessages<StartSaga1>
{
public JustASaga(Context testContext) => this.testContext = testContext;

public Task Handle(StartSaga1 message, IMessageHandlerContext context)
{
Data.DataId = message.DataId;
testContext.SagaReceivedMessage = true;
MarkAsComplete();
return Task.CompletedTask;
}

protected override void ConfigureHowToFindSaga(SagaPropertyMapper<JustASagaData> mapper)
=> mapper.ConfigureMapping<StartSaga1>(m => m.DataId).ToSaga(s => s.DataId);

readonly Context testContext;
}

public class JustASagaData : ContainSagaData
{
public virtual Guid DataId { get; set; }
}
}

public class StartSaga1 : ICommand
{
public Guid DataId { get; set; }
}
}
}