Use TestContainer Cloud on CI for windows tests that can not host the…

… requested images (#2139) * Reenable profiler tests on windows * reenable other docker tests that were previously disabled on windows * ci: try to setup testcontainers cloud Signed-off-by: Adrien Mannocci <adrien.mannocci@elastic.co> * fix: use correct import for docker facts Signed-off-by: Adrien Mannocci <adrien.mannocci@elastic.co> * ensure test container cloud is setup for regular tests run too * increase logging of SqlClientListenerTests --------- Signed-off-by: Adrien Mannocci <adrien.mannocci@elastic.co> Co-authored-by: Adrien Mannocci <adrien.mannocci@elastic.co>
elastic · Nov 21, 2023 · 2c5c299 · 2c5c299
1 parent 29490f2
commit 2c5c299
Show file tree

Hide file tree

Showing 13 changed files with 79 additions and 78 deletions.
diff --git a/.github/workflows/test-windows.yml b/.github/workflows/test-windows.yml
@@ -40,6 +40,11 @@ jobs:
       - name: Build
         run: dotnet build -c Release --verbosity minimal
 
+      - name: Setup Testcontainers Cloud Client
+        uses: atomicjar/testcontainers-cloud-setup-action@v1
+        with:
+          token: ${{ secrets.TC_CLOUD_TOKEN }}
+
       - name: 'Tests: Unit'
         uses: ./.github/workflows/test
         with:
@@ -57,7 +62,7 @@ jobs:
 
       - name: Build agent-zip
         run: ./build.bat agent-zip
-
+        
       - name: 'Tests: StartupHooks'
         uses: ./.github/workflows/test
         with:
@@ -67,7 +72,7 @@ jobs:
   profiler-tests:
     runs-on: windows-2022
     # Disable profiler tests for now
-    if: ${{ false }} 
+    # if: ${{ false }} 
     steps:
       - uses: actions/checkout@v4
       - name: Bootstrap Action Workspace
@@ -78,6 +83,11 @@ jobs:
       - name: Build profiler
         run: ./build.bat profiler-zip
 
+      - name: Setup Testcontainers Cloud Client
+        uses: atomicjar/testcontainers-cloud-setup-action@v1
+        with:
+          token: ${{ secrets.TC_CLOUD_TOKEN }}
+
       - name: 'Tests: Profiler'
         uses: ./.github/workflows/test
         with:

diff --git a/test/Elastic.Apm.Tests.Utilities/Docker/DockerFactAttribute.cs b/test/Elastic.Apm.Tests.Utilities/Docker/DockerFactAttribute.cs
@@ -20,12 +20,6 @@ static DockerFactAttribute()
 		{
 			try
 			{
-				if (TestEnvironment.IsCi && TestEnvironment.IsWindows)
-				{
-					_skip = "not running tests that require docker in CI on Windows";
-					return;
-				}
-
 				var result = Proc.Start(new StartArguments("docker", "--version"));
 				if (result.ExitCode != 0)
 					_skip = "docker not installed";

diff --git a/test/Elastic.Apm.Tests.Utilities/Docker/DockerTheoryAttribute.cs b/test/Elastic.Apm.Tests.Utilities/Docker/DockerTheoryAttribute.cs
@@ -20,12 +20,6 @@ static DockerTheoryAttribute()
 		{
 			try
 			{
-				if (TestEnvironment.IsCi && TestEnvironment.IsWindows)
-				{
-					_skip = "not running tests that require docker in CI on Windows";
-					return;
-				}
-
 				var result = Proc.Start(new StartArguments("docker", "--version"));
 				if (result.ExitCode != 0)
 					_skip = "docker not installed";

diff --git a/test/Elastic.Apm.Tests.Utilities/XUnit/DisabledOnWindowsFact.cs b/test/Elastic.Apm.Tests.Utilities/XUnit/DisabledOnWindowsFact.cs
@@ -18,17 +18,6 @@ public DisabledOnWindowsFact()
 	}
 }
 
-public sealed class DisabledOnFullFrameworkFact : FactAttribute
-{
-	public DisabledOnFullFrameworkFact()
-	{
-#if NETFRAMEWORK
-
-		Skip = "This test is disabled on .NET Full Framework";
-#endif
-	}
-}
-
 public sealed class DisabledOnNet462FrameworkFact : FactAttribute
 {
 	public DisabledOnNet462FrameworkFact()
@@ -39,36 +28,5 @@ public DisabledOnNet462FrameworkFact()
 	}
 }
 
-/// <summary>
-/// May be applied to tests which depend on Linux Docker images which will not be
-/// available when running on Windows images from GitHub actions.
-/// </summary>
-public sealed class DisabledOnWindowsGitHubActionsDockerFact : DockerFactAttribute
-{
-	public DisabledOnWindowsGitHubActionsDockerFact()
-	{
-		if (TestEnvironment.IsGitHubActions && TestEnvironment.IsWindows)
-			Skip = "This test is disabled on Windows when running under GitHub Actions.";
-	}
-}
-
-public sealed class DisabledOnWindowsTheory : TheoryAttribute
-{
-	public DisabledOnWindowsTheory()
-	{
-		if (TestEnvironment.IsWindows)
-			Skip = "This test is disabled on Windows.";
-	}
-}
-
-public sealed class DisabledOnFullFrameworkTheory : TheoryAttribute
-{
-	public DisabledOnFullFrameworkTheory()
-	{
-#if NETFRAMEWORK
-		Skip = "This test is disabled on .NET Full Framework";
-#endif
-	}
-}
 
 #pragma warning restore IDE0021 // Use expression body for constructor
diff --git a/test/Elastic.Apm.Tests.Utilities/XUnit/DisabledOnWindowsTheory.cs b/test/Elastic.Apm.Tests.Utilities/XUnit/DisabledOnWindowsTheory.cs
@@ -0,0 +1,17 @@
+// Licensed to Elasticsearch B.V under
+// one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using Xunit;
+
+namespace Elastic.Apm.Tests.Utilities.XUnit;
+
+public sealed class DisabledOnWindowsTheory : TheoryAttribute
+{
+	public DisabledOnWindowsTheory()
+	{
+		if (TestEnvironment.IsWindows)
+			Skip = "This test is disabled on Windows.";
+	}
+}
diff --git a/test/instrumentations/Elastic.Apm.Elasticsearch.Tests/ElasticsearchTests.cs b/test/instrumentations/Elastic.Apm.Elasticsearch.Tests/ElasticsearchTests.cs
@@ -9,6 +9,7 @@
 using Elastic.Apm.Api;
 using Elastic.Apm.DiagnosticSource;
 using Elastic.Apm.Tests.Utilities;
+using Elastic.Apm.Tests.Utilities.Docker;
 using Elastic.Apm.Tests.Utilities.XUnit;
 using Elasticsearch.Net;
 using FluentAssertions;
@@ -28,7 +29,7 @@ public ElasticsearchTests(ElasticsearchFixture fixture)
 			_client = new ElasticLowLevelClient(settings);
 		}
 
-		[DisabledOnWindowsGitHubActionsDockerFact]
+		[DockerFact]
 		public async Task Elasticsearch_Span_Should_Align_With_Spec()
 		{
 			var payloadSender = new MockPayloadSender();
@@ -86,7 +87,7 @@ private static void AssertSpan(ISpan span)
 			span.Context.Destination.Port.Should().BeGreaterThan(0).And.BeLessThan(65536);
 		}
 
-		[DisabledOnWindowsGitHubActionsDockerFact]
+		[DockerFact]
 		public async Task Elasticsearch_Span_Does_Not_Have_Http_Child_Span()
 		{
 			var payloadSender = new MockPayloadSender();

diff --git a/test/instrumentations/Elastic.Apm.MongoDb.Tests/MongoApmTests.cs b/test/instrumentations/Elastic.Apm.MongoDb.Tests/MongoApmTests.cs
@@ -10,6 +10,7 @@
 using Elastic.Apm.Api;
 using Elastic.Apm.MongoDb.Tests.Fixture;
 using Elastic.Apm.Tests.Utilities;
+using Elastic.Apm.Tests.Utilities.Docker;
 using Elastic.Apm.Tests.Utilities.XUnit;
 using FluentAssertions;
 using MongoDB.Bson;
@@ -64,7 +65,7 @@ public Task DisposeAsync(IMongoCollection<BsonDocument> collection) =>
 
 		private readonly MockPayloadSender _payloadSender;
 
-		[DisabledOnWindowsFact]
+		[DockerFact]
 		public async Task ApmAgent_ShouldCorrectlyCaptureSpan()
 		{
 			// Arrange
@@ -101,7 +102,7 @@ public async Task ApmAgent_ShouldCorrectlyCaptureSpan()
 			});
 		}
 
-		[DisabledOnWindowsFact]
+		[DockerFact]
 		public async Task ApmAgent_ShouldCorrectlyCaptureSpanAndError_WhenMongoCommandFailed()
 		{
 			// Arrange

diff --git a/test/instrumentations/Elastic.Apm.SqlClient.Tests/EfCoreWithMsSqlTests.cs b/test/instrumentations/Elastic.Apm.SqlClient.Tests/EfCoreWithMsSqlTests.cs
@@ -8,6 +8,7 @@
 using Elastic.Apm.EntityFrameworkCore;
 using Elastic.Apm.Instrumentations.SqlClient;
 using Elastic.Apm.Tests.Utilities;
+using Elastic.Apm.Tests.Utilities.Docker;
 using Elastic.Apm.Tests.Utilities.XUnit;
 using FluentAssertions;
 using Microsoft.EntityFrameworkCore;
@@ -43,7 +44,7 @@ public EfCoreWithMsSqlTests(ITestOutputHelper testOutputHelper, SqlServerFixture
 		/// Executes a db query within a transaction while both SqlClient and EFCore capturing is active.
 		/// Makes sure that the db call is only captured once - so only 1 of them captures the call, the other one ignores it.
 		/// </summary>
-		[DisabledOnWindowsFact]
+		[DockerFact]
 		public void BothEfCoreAndSqlClientCapturingActive()
 		{
 			var dbContextOptionsBuilder = new DbContextOptionsBuilder<TestDbContext>();

diff --git a/test/instrumentations/Elastic.Apm.SqlClient.Tests/Elastic.Apm.SqlClient.Tests.csproj b/test/instrumentations/Elastic.Apm.SqlClient.Tests/Elastic.Apm.SqlClient.Tests.csproj
@@ -22,4 +22,8 @@
     <ProjectReference Include="$(SolutionRoot)\test\Elastic.Apm.Tests.Utilities\Elastic.Apm.Tests.Utilities.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Content Include="..\..\xunit.runner.json" Link="xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup>
+
 </Project>
diff --git a/test/instrumentations/Elastic.Apm.SqlClient.Tests/SqlClientListenerTests.cs b/test/instrumentations/Elastic.Apm.SqlClient.Tests/SqlClientListenerTests.cs
@@ -11,6 +11,7 @@
 using Elastic.Apm.Api;
 using Elastic.Apm.Instrumentations.SqlClient;
 using Elastic.Apm.Tests.Utilities;
+using Elastic.Apm.Tests.Utilities.Docker;
 using Elastic.Apm.Tests.Utilities.XUnit;
 using FluentAssertions;
 using Xunit;
@@ -38,9 +39,10 @@ public SqlClientListenerTests(ITestOutputHelper testOutputHelper, SqlServerFixtu
 
 			_testOutputHelper = testOutputHelper;
 
-			_payloadSender = new MockPayloadSender();
+			var logger = new LineWriterToLoggerAdaptor(new XunitOutputToLineWriterAdaptor(_testOutputHelper));
+			_payloadSender = new MockPayloadSender(logger);
 			_apmAgent = new ApmAgent(new TestAgentComponents(
-				new LineWriterToLoggerAdaptor(new XunitOutputToLineWriterAdaptor(_testOutputHelper)),
+				logger,
 				payloadSender: _payloadSender));
 			_subscription = _apmAgent.Subscribe(new SqlClientDiagnosticSubscriber());
 		}
@@ -63,7 +65,7 @@ public static IEnumerable<object[]> Connections
 			}
 		}
 
-		[DisabledOnWindowsTheory]
+		[DockerTheory]
 		[MemberData(nameof(Connections))]
 		public async Task SqlClientDiagnosticListener_ShouldCaptureSpan(string providerName, Func<string, DbConnection> connectionCreator)
 		{
@@ -117,7 +119,7 @@ await _apmAgent.Tracer.CaptureTransaction("transaction", "type", async _ =>
 			span.Context.Service.Target.Name.Should().Be(span.Context.Db.Instance);
 		}
 
-		[DisabledOnWindowsTheory]
+		[DockerTheory]
 		[MemberData(nameof(Connections))]
 		public async Task SqlClientDiagnosticListener_ShouldCaptureErrorFromSystemSqlClient(string providerName,
 			Func<string, DbConnection> connectionCreator
@@ -181,7 +183,7 @@ await _apmAgent.Tracer.CaptureTransaction("transaction", "type", async _ =>
 			span.Context.Service.Target.Name.Should().Be(span.Context.Db.Instance);
 		}
 
-		[DisabledOnWindowsTheory]
+		[DockerTheory]
 		[MemberData(nameof(Connections))]
 		public async Task SqlClientDiagnosticListener_ShouldNotUseCumulativeDurations(string providerName, Func<string, DbConnection> connectionCreator)
 		{

diff --git a/test/instrumentations/Elastic.Apm.SqlClient.Tests/SqlServerFixture.cs b/test/instrumentations/Elastic.Apm.SqlClient.Tests/SqlServerFixture.cs
@@ -6,18 +6,35 @@
 using System.Threading.Tasks;
 using Testcontainers.MsSql;
 using Xunit;
+using Xunit.Abstractions;
+using Xunit.Sdk;
 
 namespace Elastic.Apm.SqlClient.Tests
 {
 	// ReSharper disable once ClassNeverInstantiated.Global - it's used as a generic parameter
 	public sealed class SqlServerFixture : IAsyncLifetime
 	{
-		private readonly MsSqlContainer _container = new MsSqlBuilder().Build();
+		private readonly MsSqlContainer _container;
+		private readonly IMessageSink _sink;
 
 		public string ConnectionString => _container.GetConnectionString();
 
-		public Task InitializeAsync() => _container.StartAsync();
+		public SqlServerFixture(IMessageSink sink)
+		{
+			_sink = sink;
+			_container = new MsSqlBuilder()
+				.Build();
+		}
 
-		public Task DisposeAsync() => _container.DisposeAsync().AsTask();
+		public async Task InitializeAsync()
+		{
+			await _container.StartAsync();
+			var (stdOut, stdErr) = await _container.GetLogsAsync();
+
+			_sink.OnMessage(new DiagnosticMessage(stdOut));
+			_sink.OnMessage(new DiagnosticMessage(stdErr));
+		}
+
+		public async Task DisposeAsync() => await _container.DisposeAsync();
 	}
 }
diff --git a/test/instrumentations/Elastic.Apm.StackExchange.Redis.Tests/ProfilingSessionTests.cs b/test/instrumentations/Elastic.Apm.StackExchange.Redis.Tests/ProfilingSessionTests.cs
@@ -8,16 +8,17 @@
 using System.Threading.Tasks;
 using Elastic.Apm.Api;
 using Elastic.Apm.Tests.Utilities;
-using Elastic.Apm.Tests.Utilities.XUnit;
+using Elastic.Apm.Tests.Utilities.Docker;
 using FluentAssertions;
 using StackExchange.Redis;
 using Testcontainers.Redis;
+using Xunit;
 
 namespace Elastic.Apm.StackExchange.Redis.Tests
 {
 	public class ProfilingSessionTests
 	{
-		[DisabledOnWindowsGitHubActionsDockerFact]
+		[DockerFact]
 		public async Task Capture_Redis_Commands_On_Transaction()
 		{
 			await using var container = new RedisBuilder().Build();
@@ -75,7 +76,7 @@ await agent.Tracer.CaptureTransaction("Set and Get String", ApiConstants.TypeDb,
 			await container.StopAsync();
 		}
 
-		[DisabledOnWindowsGitHubActionsDockerFact]
+		[DockerFact]
 		public async Task Capture_Redis_Commands_On_Span()
 		{
 			await using var container = new RedisBuilder().Build();

diff --git a/test/instrumentations/Elastic.Clients.Elasticsearch.Tests/ElasticsearchTests.cs b/test/instrumentations/Elastic.Clients.Elasticsearch.Tests/ElasticsearchTests.cs
@@ -11,7 +11,7 @@
 using Elastic.Apm.DiagnosticSource;
 using Elastic.Apm.Elasticsearch;
 using Elastic.Apm.Tests.Utilities;
-using Elastic.Apm.Tests.Utilities.XUnit;
+using Elastic.Apm.Tests.Utilities.Docker;
 using FluentAssertions;
 using Xunit;
 using Xunit.Abstractions;
@@ -32,7 +32,7 @@ public ElasticsearchTests(ITestOutputHelper testOutputHelper, ElasticsearchTestF
 		_client = _esClientListenerFixture.Client ?? throw new Exception("ElasticsearchClient is `null`");
 	}
 
-	[DisabledOnWindowsGitHubActionsDockerFact]
+	[DockerFact]
 	public async Task IndexDataTest()
 	{
 		var (payloadSender, apmAgent) = SetUpAgent();
@@ -56,7 +56,8 @@ public async Task IndexDataTest()
 		elasticsearchSpan.Otel.Attributes.Should().Contain(new KeyValuePair<string, object>("net.peer.name", _esClientListenerFixture.Container.Hostname));
 	}
 
-	[DisabledOnWindowsGitHubActionsDockerFact]
+
+	[DockerFact]
 	public async Task GetDocumentTest()
 	{
 		// make sure data is present
@@ -83,7 +84,7 @@ public async Task GetDocumentTest()
 		elasticsearchSpan.Otel.Attributes.Should().Contain(new KeyValuePair<string, object>("net.peer.name", _esClientListenerFixture.Container.Hostname));
 	}
 
-	[DisabledOnWindowsGitHubActionsDockerFact]
+	[DockerFact]
 	public async Task SearchDocumentTest()
 	{
 		// make sure data is present
@@ -110,7 +111,7 @@ public async Task SearchDocumentTest()
 		elasticsearchSpan.Otel.Attributes.Should().Contain(new KeyValuePair<string, object>("net.peer.name", _esClientListenerFixture.Container.Hostname));
 	}
 
-	[DisabledOnWindowsGitHubActionsDockerFact]
+	[DockerFact]
 	public async Task UpdateDocumentTest()
 	{
 		// make sure data is present
@@ -147,7 +148,7 @@ await apmAgent.Tracer.CaptureTransaction("Test", "Foo", async () =>
 		elasticsearchSpan.Otel.Attributes.Should().Contain(new KeyValuePair<string, object>("net.peer.name", _esClientListenerFixture.Container.Hostname));
 	}
 
-	[DisabledOnWindowsGitHubActionsDockerFact]
+	[DockerFact]
 	public async Task DeleteDocumentTest()
 	{
 		// make sure data is present