Further test cleanup and fixup

Author: stevejgordon

tests/Tests.Core/Client/FixedResponseClient.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using System;
+using System.Net;
 using System.Text;
 using Elasticsearch.Net;
 using Nest;
@@ -16,10 +17,11 @@ public static IElasticClient Create(
 			int statusCode = 200,
 			Func<ConnectionSettings, ConnectionSettings> modifySettings = null,
 			string contentType = null,
-			Exception exception = null
+			Exception exception = null,
+			bool productCheckSucceeds = true
 		)
 		{
-			var settings = CreateConnectionSettings(response, statusCode, modifySettings, contentType, exception);
+			var settings = CreateConnectionSettings(response, statusCode, modifySettings, contentType, exception, productCheckSucceeds);
 			return new ElasticClient(settings);
 		}
 
@@ -28,7 +30,8 @@ public static ConnectionSettings CreateConnectionSettings(
 			int statusCode = 200,
 			Func<ConnectionSettings, ConnectionSettings> modifySettings = null,
 			string contentType = null,
-			Exception exception = null
+			Exception exception = null,
+			bool productCheckSucceeds = true
 		)
 		{
 			contentType ??= RequestData.DefaultJsonMimeType;
@@ -51,7 +54,12 @@ public static ConnectionSettings CreateConnectionSettings(
 				}
 			}
 
-			var connection = new InMemoryConnection(responseBytes, statusCode, exception, contentType);
+			var productCheckResponse = productCheckSucceeds ? InMemoryConnection.ValidProductCheckResponse() : new InMemoryHttpResponse
+			{
+				StatusCode = 500
+			};
+
+			var connection = new InMemoryConnection(responseBytes, statusCode, exception, contentType, productCheckResponse);
 			var connectionPool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));
 			var defaultSettings = new ConnectionSettings(connectionPool, connection)
 				.DefaultIndex("default-index");

tests/Tests/ClientConcepts/ConnectionPooling/Exceptions/UnexpectedExceptions.doc.cs

@@ -104,7 +104,7 @@ [U] public async Task WillFailOverKnowConnectionExceptionButNotUnexpected()
 		*
 		* Here, pinging nodes on first use is enabled and the node on port 9200 throws an exception on ping; when this happens,
 		* we still fallover to retry the ping on node on port 9201, where it succeeds.
-		* Following this, the client call on 9201 throws a hard exception that we are not able to recover from
+		* Following this, the client call on 9201 throws a hard exception that we are not able to recover from.
 		*/
 		[U] public async Task PingUnexceptedExceptionDoesFailOver()
 		{

tests/Tests/ClientConcepts/ConnectionPooling/Failover/FallingOver.doc.cs

@@ -15,7 +15,7 @@ public class FallingOver
 		/**[[fail-over]]
 		* === Fail over
 		* When using a connection pool with more than one node, a request will be retried if
-		* the call to a node throws an exception or returns a 502, 503 or 504 response
+		* the call to a node throws an exception or returns a 502, 503 or 504 response.
 		*/
 		[U]
 		public async Task ExceptionFallsOverToNextNode()
@@ -27,7 +27,7 @@ public async Task ExceptionFallsOverToNextNode()
 				.StaticConnectionPool()
 				.Settings(s => s.DisablePing())
 			);
-
+			
 			audit = await audit.TraceCall(
 				new ClientCall {
 					{ AuditEvent.BadResponse, 9200 },
@@ -39,7 +39,7 @@ public async Task ExceptionFallsOverToNextNode()
 		/**[[bad-gateway]]
 		*==== 502 Bad Gateway
 		*
-		* Will be treated as an error that requires retrying
+		* Will be treated as an error that requires retrying.
 		*/
 		[U]
 		public async Task Http502FallsOver()
@@ -63,7 +63,7 @@ public async Task Http502FallsOver()
 		/**[[service-unavailable]]
 		*==== 503 Service Unavailable
 		*
-		* Will be treated as an error that requires retrying
+		* Will be treated as an error that requires retrying.
 		*/
 		[U]
 		public async Task Http503FallsOver()
@@ -87,7 +87,7 @@ public async Task Http503FallsOver()
 		/**[[gateway-timeout]]
 		*==== 504 Gateway Timeout
 		*
-		* Will be treated as an error that requires retrying
+		* Will be treated as an error that requires retrying.
 		*/
 		[U]
 		public async Task Http504FallsOver()
@@ -112,7 +112,7 @@ public async Task Http504FallsOver()
 		* If a call returns a __valid__ HTTP status code other than 502 or 503, the request won't be retried.
 		*
 		* IMPORTANT: Different requests may have different status codes that are deemed __valid__. For example,
-		* a *404 Not Found* response is a __valid__ status code for an index exists request
+		* a *404 Not Found* response is a __valid__ status code for an index exists request.
 		*/
 		[U]
 		public async Task HttpTeapotDoesNotFallOver()

tests/Tests/ClientConcepts/ConnectionPooling/MaxRetries/RespectsMaxRetry.doc.cs

@@ -5,10 +5,8 @@
 using System;
 using System.Threading.Tasks;
 using Elastic.Elasticsearch.Xunit.XunitPlumbing;
-using Elasticsearch.Net;
 using Elasticsearch.Net.VirtualizedCluster;
 using Elasticsearch.Net.VirtualizedCluster.Audit;
-using Tests.Framework;
 using static Elasticsearch.Net.AuditEvent;
 
 namespace Tests.ClientConcepts.ConnectionPooling.MaxRetries

tests/Tests/ClientConcepts/ConnectionPooling/Pinging/FirstUsage.doc.cs

@@ -6,11 +6,9 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Elastic.Elasticsearch.Xunit.XunitPlumbing;
-using Elasticsearch.Net;
 using Elasticsearch.Net.VirtualizedCluster;
 using Elasticsearch.Net.VirtualizedCluster.Audit;
 using FluentAssertions;
-using Tests.Framework;
 using static Elasticsearch.Net.VirtualizedCluster.Rules.TimesHelper;
 using static Elasticsearch.Net.AuditEvent;
 

tests/Tests/ClientConcepts/ConnectionPooling/RequestOverrides/DisableSniffPingPerRequest.doc.cs

@@ -36,7 +36,7 @@ [U] public async Task DisableSniff()
 				.Settings(s => s.SniffOnStartup()) // <1> sniff on startup
 			);
 
-			/** Now We disable sniffing on the request so even though it's our first call,
+			/** Now we disable sniffing on the request so even though it's our first call,
 			 * we do not want to sniff on startup.
 			 *
 			 * Instead, the sniff on startup is deferred to the second call into the cluster that

tests/Tests/ClientConcepts/ConnectionPooling/RequestOverrides/RequestTimeoutsOverrides.doc.cs

@@ -17,14 +17,13 @@ public class RequestTimeoutsOverrides
 		/**[[request-timeout]]
 		* === Request timeouts
 		*
-		* While you can specify Request time out globally you can override this per request too
+		* While you can specify Request time out globally, you can override this per request too.
 		*/
 
 		[U]
 		public async Task RespectsRequestTimeoutOverride()
 		{
-
-			/** we set up a 10 node cluster with a global time out of 20 seconds.
+			/** We set up a 10 node cluster with a global time out of 20 seconds.
 			* Each call on a node takes 10 seconds. So we can only try this call on 2 nodes
 			* before the max request time out kills the client call.
 			*/
@@ -43,7 +42,7 @@ public async Task RespectsRequestTimeoutOverride()
 					{ MaxTimeoutReached }
 				},
 				/**
-				* On the second request we specify a request timeout override to 80 seconds
+				* On the second request we specify a request timeout override to 80 seconds.
 				* We should now see more nodes being tried.
 				*/
 				new ClientCall(r => r.RequestTimeout(TimeSpan.FromSeconds(80)))

tests/Tests/ClientConcepts/ConnectionPooling/RequestOverrides/RespectsMaxRetryOverrides.doc.cs

@@ -5,10 +5,8 @@
 using System;
 using System.Threading.Tasks;
 using Elastic.Elasticsearch.Xunit.XunitPlumbing;
-using Elasticsearch.Net;
 using Elasticsearch.Net.VirtualizedCluster;
 using Elasticsearch.Net.VirtualizedCluster.Audit;
-using Tests.Framework;
 using static Elasticsearch.Net.AuditEvent;
 
 namespace Tests.ClientConcepts.ConnectionPooling.RequestOverrides
@@ -90,7 +88,6 @@ public async Task DoesNotRetryOnSingleNodeConnectionPool()
 					{ BadResponse, 9200 }
 				}
 			);
-
 		}
 	}
 }

tests/Tests/ClientConcepts/Troubleshooting/LoggingWithOnRequestCompleted.doc.cs

@@ -59,7 +59,7 @@ public async Task OnRequestCompletedIsCalledWhenExceptionIsThrown()
 				500,
 				connectionSettings => connectionSettings
 					.ThrowExceptions() // <2> Always throw exceptions when a call results in an exception
-					.OnRequestCompleted(r => counter++)
+					.OnRequestCompleted(r => counter++), productCheckSucceeds: false
 			);
 
 			Assert.Throws<ElasticsearchClientException>(() => client.RootNodeInfo()); // <3> Assert an exception is thrown and the counter is incremented

tests/Tests/CodeStandards/Requests.doc.cs

@@ -42,7 +42,7 @@ public void BaseUriWithTrailingSlashIsRespected()
 		public void BaseUriWithRelativePathIsRespected()
 		{
 			var pool = new SingleNodeConnectionPool(new Uri("http://localhost:9200/elasticsearch"));
-			var settings = new ConnectionSettings(pool, new InMemoryConnection());
+			var settings = new ConnectionSettings(pool, new InMemoryConnection("elasticsearch"));
 			var client = new ElasticClient(settings);
 			var searchResponse = client.Search<Project>(s => s.AllIndices());
 
@@ -53,7 +53,7 @@ public void BaseUriWithRelativePathIsRespected()
 		public void BaseUriWithRelativePathAndTrailingSlashIsRespected()
 		{
 			var pool = new SingleNodeConnectionPool(new Uri("http://localhost:9200/elasticsearch/"));
-			var settings = new ConnectionSettings(pool, new InMemoryConnection());
+			var settings = new ConnectionSettings(pool, new InMemoryConnection("elasticsearch/"));
 			var client = new ElasticClient(settings);
 			var searchResponse = client.Search<Project>(s => s.AllIndices());
 

tests/Tests/MetaHeader/MetaHeaderHelperTests.cs

@@ -183,11 +183,13 @@ protected class SmallObject
 		{
 			public string Name { get; set; }
 		}
-
+		
 		protected class TestableInMemoryConnection : IConnection
 		{
 			internal static readonly byte[] EmptyBody = Encoding.UTF8.GetBytes("");
 
+			private readonly InMemoryHttpResponse _productCheckResponse = InMemoryConnection.ValidProductCheckResponse();
+
 			private readonly Action<RequestData> _perRequestAssertion;
 			private readonly List<(int, string)> _responses;
 			private int _requestCounter = -1;
@@ -202,8 +204,25 @@ public TestableInMemoryConnection(Action<RequestData> assertion, List<(int, stri
 
 			async Task<TResponse> IConnection.RequestAsync<TResponse>(RequestData requestData, CancellationToken cancellationToken)
 			{
-				Interlocked.Increment(ref _requestCounter);
+				if ("/".Equals(requestData.Uri.AbsolutePath, StringComparison.Ordinal) && requestData.Method == HttpMethod.GET)
+				{
+					// We don't add product checks to the request count
+
+					_productCheckResponse.Headers.TryGetValue("X-elastic-product", out var productNames);
+
+					requestData.MadeItToResponse = true;
+
+					await using var ms = requestData.MemoryStreamFactory.Create(_productCheckResponse.ResponseBytes);
+
+					await Task.Yield(); // avoids test deadlocks
+
+					return ResponseBuilder.ToResponse<TResponse>(
+						requestData, null, _productCheckResponse.StatusCode, null, ms,
+						RequestData.DefaultJsonMimeType, productNames?.FirstOrDefault());
+				}
 
+				Interlocked.Increment(ref _requestCounter);
+				
 				_perRequestAssertion(requestData);
 
 				await Task.Yield(); // avoids test deadlocks
@@ -219,12 +238,27 @@ async Task<TResponse> IConnection.RequestAsync<TResponse>(RequestData requestDat
 				var stream = !string.IsNullOrEmpty(response) ? requestData.MemoryStreamFactory.Create(Encoding.UTF8.GetBytes(response)) : requestData.MemoryStreamFactory.Create(EmptyBody);
 
 				return await ResponseBuilder
-					.ToResponseAsync<TResponse>(requestData, null, statusCode, null, stream, RequestData.DefaultJsonMimeType, cancellationToken)
+					.ToResponseAsync<TResponse>(requestData, null, statusCode, null, stream, RequestData.DefaultJsonMimeType, "Elasticsearch", cancellationToken)
 					.ConfigureAwait(false);
 			}
 
 			TResponse IConnection.Request<TResponse>(RequestData requestData)
 			{
+				if ("/".Equals(requestData.Uri.AbsolutePath, StringComparison.Ordinal) && requestData.Method == HttpMethod.GET)
+				{
+					// We don't add product checks to the request count
+
+					_productCheckResponse.Headers.TryGetValue("X-elastic-product", out var productNames);
+
+					requestData.MadeItToResponse = true;
+
+					using var ms = requestData.MemoryStreamFactory.Create(_productCheckResponse.ResponseBytes);
+
+					return ResponseBuilder.ToResponse<TResponse>(
+						requestData, null, _productCheckResponse.StatusCode, null, ms,
+						RequestData.DefaultJsonMimeType, productNames?.FirstOrDefault());
+				}
+
 				Interlocked.Increment(ref _requestCounter);
 
 				_perRequestAssertion(requestData);