Add ElasticsearchPlugin to determine plugin directory and validity for ES version

Simpler version of what exists in 5.x+.

Author: russcam

build/scripts/scripts.fsproj

@@ -61,7 +61,9 @@
   -->
   <Import Project="..\..\.paket\paket.targets" />
   <ItemGroup>
+    <None Include="Projects.fsx" />
     <None Include="Paths.fsx" />
+    <None Include="Tooling.fsx" />
     <None Include="Releasing.fsx" />
     <None Include="Versioning.fsx" />
     <None Include="Profiling.fsx" />

docs/client-concepts/connection-pooling/request-overrides/disable-sniff-ping-per-request.asciidoc

@@ -64,7 +64,9 @@ new ClientCall()
 );
 ----
 <1> disable sniffing
+
 <2> first call is a successful ping
+
 <3> sniff on startup call happens here, on the second call
 
 Now, let's disable pinging on the request 
@@ -87,6 +89,7 @@ audit = await audit.TraceCall(
 );
 ----
 <1> disable ping
+
 <2> No ping after sniffing
 
 Finally, let's demonstrate disabling both sniff and ping on the request 
@@ -108,5 +111,6 @@ audit = await audit.TraceCall(
 );
 ----
 <1> diable ping and sniff
+
 <2> no ping or sniff before the call
 

src/Tests/Framework/Integration/Process/ElasticsearchNode.cs

@@ -21,18 +21,18 @@ namespace Tests.Framework.Integration
 	public class ElasticsearchNode : IDisposable
 	{
 		private static readonly object _lock = new object();
-		// <installpath> <> <plugin folder prefix>
-		private readonly Dictionary<string, Func<string, string>> SupportedPlugins = new Dictionary<string, Func<string, string>>
-		{
-			{ "delete-by-query", _ => "delete-by-query" },
-			{ "cloud-azure", _ => "cloud-azure" },
-			{ "mapper-attachments", MapperAttachmentPlugin.GetVersion },
-			{ "mapper-murmur3", _ => "mapper-murmur3" },
-			{ "license", _ => "license" },
-			{ "graph", _ => "graph" },
-			{ "shield", _ => "shield" },
-			{ "watcher", _ => "watcher" },
+
+		private readonly ElasticsearchPlugin[] SupportedPlugins = {
+			new ElasticsearchPlugin("delete-by-query"),
+			new ElasticsearchPlugin("cloud-azure"),
+			new ElasticsearchPlugin("mapper-attachments", _ => true, MapperAttachmentPlugin.GetDirectory, MapperAttachmentPlugin.GetVersion),
+			new ElasticsearchPlugin("mapper-murmur3"),
+			new ElasticsearchPlugin("license"),
+			new ElasticsearchPlugin("graph", v => v >= new ElasticsearchVersionInfo("2.3.0")),
+			new ElasticsearchPlugin("shield"),
+			new ElasticsearchPlugin("watcher")
 		};
+
 		private string[] DefaultNodeSettings { get; }
 
 		private readonly bool _testAgainstAlreadyRunningElasticsearch;
@@ -50,10 +50,10 @@ public class ElasticsearchNode : IDisposable
 
 		public string TypeOfCluster { get; }
 		public bool Started { get; private set; }
-		public bool RunningIntegrations { get; private set; }
+		public bool RunningIntegrations { get; }
 		public string ClusterName { get; }
 		public string NodeName { get; }
-		public string RepositoryPath { get; private set; }
+		public string RepositoryPath { get; }
 		public ElasticsearchNodeInfo Info { get; private set; }
 		public int Port { get; private set; }
 
@@ -155,15 +155,14 @@ public ElasticsearchNode(
 
 		}
 
-		private object _lockGetClient = new object { };
+		private readonly object _lockGetClient = new object();
 		private IElasticClient _client;
 		public IElasticClient Client
 		{
 			get
 			{
 				if (!this.Started && TestClient.Configuration.RunIntegrationTests)
 				{
-
 					throw new Exception("can not request a client from an ElasticsearchNode if that node hasn't started yet");
 				}
 
@@ -174,6 +173,7 @@ public IElasticClient Client
 					if (this._client != null) return this._client;
 
 					var port = this.Started ? this.Port : 9200;
+					// ReSharper disable once PossibleMultipleWriteAccessInDoubleCheckLocking
 					this._client = TestClient.GetClient(ComposeSettings, port);
 					return this.Client;
 				}
@@ -247,9 +247,14 @@ private IObservable<ElasticsearchMessage> UseAlreadyRunningInstance(ManualResetE
 
 			var checkPlugins = client.CatPlugins();
 
-			var missingPlugins = SupportedPlugins.Keys.Except(checkPlugins.Records.Select(r => r.Component)).ToList();
+			var missingPlugins = SupportedPlugins
+				.Where(p => p.IsValid(this.VersionInfo))
+				.Select(p => p.Name)
+				.Except(checkPlugins.Records.Select(r => r.Component))
+				.ToList();
+
 			if (missingPlugins.Any())
-				throw new Exception($"Already running elasticsearch missed the following plugin(s): {string.Join(", ", missingPlugins)}.");
+				throw new Exception($"Already running elasticsearch missing the following plugin(s): {string.Join(", ", missingPlugins)}.");
 
 			this.Started = true;
 			this.Port = 9200;
@@ -397,10 +402,10 @@ private void InstallPlugins()
 			if (this.VersionInfo.ParsedVersion.Major >= 5) pluginCommand = "elasticsearch-plugin";
 
 			var pluginBat = Path.Combine(this.RoamingClusterFolder, "bin", pluginCommand) + ".bat";
-			foreach (var plugin in SupportedPlugins)
+			foreach (var plugin in SupportedPlugins.Where(p => p.IsValid(this.VersionInfo)))
 			{
-				var installPath = plugin.Key;
-				var command = plugin.Value(this.VersionInfo.Version);
+				var installPath = plugin.PluginDirectory(this.VersionInfo);
+				var command = plugin.PluginVersion(this.VersionInfo);
 				var pluginFolder = Path.Combine(this.RoamingClusterFolder, "plugins", installPath);
 
 				if (!Directory.Exists(this.RoamingClusterFolder)) continue;

src/Tests/Framework/Integration/Process/ElasticsearchPlugin.cs

@@ -0,0 +1,42 @@
+using System;
+
+namespace Tests.Framework.Integration
+{
+	public class ElasticsearchPlugin
+	{
+		private readonly string _name;
+		private readonly Func<ElasticsearchVersionInfo, bool> _valid;
+		private readonly Func<ElasticsearchVersionInfo, string> _pluginDirectory;
+		private readonly Func<ElasticsearchVersionInfo, string> _pluginVersion;
+
+		public ElasticsearchPlugin(string name) : this(name, null, null, null) {}
+
+		public ElasticsearchPlugin(string name, Func<ElasticsearchVersionInfo, bool> valid) : this(name, valid, null, null) {}
+
+		public ElasticsearchPlugin(
+			string name,
+			Func<ElasticsearchVersionInfo, bool> valid,
+			Func<ElasticsearchVersionInfo, string> pluginDirectory,
+			Func<ElasticsearchVersionInfo, string> pluginVersion)
+		{
+			if (name == null) throw new ArgumentNullException(nameof(name));
+
+			_name = name;
+			_valid = valid;
+			_pluginDirectory = pluginDirectory;
+			_pluginVersion = pluginVersion;
+		}
+
+		public string Name => _name;
+
+		public string PluginDirectory(ElasticsearchVersionInfo elasticsearchVersion) =>
+			_pluginDirectory?.Invoke(elasticsearchVersion) ?? _name;
+
+		public string PluginVersion(ElasticsearchVersionInfo elasticsearchVersion) =>
+			_pluginVersion?.Invoke(elasticsearchVersion) ?? _name;
+
+		public bool IsValid(ElasticsearchVersionInfo version) =>
+			_valid?.Invoke(version) ?? true;
+
+	}
+}

src/Tests/Framework/Integration/Process/ElasticsearchVersionInfo.cs

@@ -5,9 +5,9 @@
 
 namespace Tests.Framework.Integration
 {
-	public class ElasticsearchVersionInfo
+	public class ElasticsearchVersionInfo : SemVer.Version
 	{
-		public ElasticsearchVersionInfo(string version)
+		public ElasticsearchVersionInfo(string version) : base(version)
 		{
 			this.Version = version;
 
@@ -38,4 +38,4 @@ public ElasticsearchVersionInfo(string version)
 			? "https://oss.sonatype.org/content/repositories/snapshots/org/elasticsearch/distribution/zip/elasticsearch"
 			: "https://download.elasticsearch.org/elasticsearch/release/org/elasticsearch/distribution/zip/elasticsearch";
 	}
-}
+}

src/Tests/Framework/Integration/Process/MapperAttachmentPlugin.cs

@@ -25,16 +25,23 @@ public class MapperAttachmentPlugin
 			{"0.90", "elasticsearch/elasticsearch-mapper-attachments/1.9.0"}
 		};
 
-		public static string GetVersion(string elasticsearchVersion)
+		public static string GetVersion(ElasticsearchVersionInfo elasticsearchVersion)
 		{
 			string attachmentVersion;
-			if (!Versions.TryGetValue(elasticsearchVersion, out attachmentVersion))
+			if (!Versions.TryGetValue(elasticsearchVersion.Version, out attachmentVersion))
 			{
 				// assume latest version in elasticsearch repository
 				attachmentVersion = "mapper-attachments";
 			}
 
 			return attachmentVersion;
 		}
+
+		public static string GetDirectory(ElasticsearchVersionInfo elasticsearchVersion)
+		{
+			return elasticsearchVersion < new ElasticsearchVersionInfo("2.1.0")
+				? "elasticsearch-mapper-attachments"
+				: "mapper-attachments";
+		}
 	}
-}
+}

src/Tests/Tests.csproj

@@ -443,6 +443,7 @@
     <Compile Include=".\QueryDsl\Geo\Shape\MultiPoint\GeoMultiPointUsageTests.cs" />
     <Compile Include=".\QueryDsl\Geo\Shape\Point\GeoPointUsageTests.cs" />
     <Compile Include=".\QueryDsl\Geo\Shape\Polygon\GeoPolygonUsageTests.cs" />
+    <Compile Include="Framework\Integration\Process\ElasticsearchPlugin.cs" />
     <Compile Include="QueryDsl\Geo\Shape\GeoShapeQueryUsageTestsBase.cs" />
     <Compile Include=".\QueryDsl\Joining\HasChild\HasChildQueryUsageTests.cs" />
     <Compile Include=".\QueryDsl\Joining\HasParent\HasParentQueryUsageTests.cs" />