6.0 Script changes (#2951)

* 6.0 Script changes

- Groovy, JavaScript, and Python languages removed
The Groovy, JavaScript, and Python scripting languages were deprecated in elasticsearch 5.0 and have now been removed. Use painless instead.

- lang can no longer be specified when using a stored script as part of a requestedit
The lang variable can no longer be specified as part of a request that uses a stored script otherwise an error will occur. Note that a request using a stored script is different from a request that puts a stored script. The language of the script has already been stored as part of the cluster state and an id is sufficient to access all of the information necessary to execute a stored script.

- lang can no longer be used when putting, getting, or deleting a stored scriptedit
Stored scripts can no longer have the lang parameter specified as part of the url when performing PUT, GET, and DELETE actions on the _scripts/ path. All stored scripts must have a unique id as the namespace is only id now and no longer lang and id.

- Convert PutScriptApi to integration test

- Remove no longer supported languages from ScriptLang enum

Author: Stuart Cam

src/Nest/Modules/Scripting/IStoredScript.cs

@@ -1,33 +1,50 @@
-using System.Collections.Generic;
-using Elasticsearch.Net;
+using Elasticsearch.Net;
 using Newtonsoft.Json;
 
 namespace Nest
 {
+	/// <summary>
+	/// A Stored script
+	/// </summary>
 	[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
 	[JsonConverter(typeof(ReadAsTypeJsonConverter<StoredScript>))]
 	public interface IStoredScript
 	{
+		/// <summary>
+		/// The script language
+		/// </summary>
 		[JsonProperty("lang")]
 		string Lang { get; set; }
 
+		/// <summary>
+		/// The script source
+		/// </summary>
 		[JsonProperty("source")]
 		string Source { get; set; }
 	}
+
+	/// <inheritdoc />
 	public class StoredScript : IStoredScript
 	{
 		[JsonProperty("lang")]
 		string IStoredScript.Lang { get; set; }
+
 		[JsonProperty("source")]
 		string IStoredScript.Source { get; set; }
 
 		//used for deserialization
-		internal StoredScript() { }
+		internal StoredScript() {}
 
+		/// <summary>
+		/// Instantiates a new instance of <see cref="StoredScript"/>
+		/// </summary>
+		/// <param name="lang">Script language</param>
+		/// <param name="source">Script source</param>
 		protected StoredScript(string lang, string source)
 		{
-			((IStoredScript) this).Lang = lang;
-			((IStoredScript) this).Source = source;
+			IStoredScript self = this;
+			self.Lang = lang;
+			self.Source = source;
 		}
 	}
 
@@ -36,39 +53,28 @@ public class PainlessScript : StoredScript
 		private static readonly string Lang = ScriptLang.Painless.GetStringValue();
 		public PainlessScript(string source) : base(Lang, source) { }
 	}
-	public class GroovyScript : StoredScript
-	{
-		private static readonly string Lang = ScriptLang.Groovy.GetStringValue();
-		public GroovyScript(string source) : base(Lang, source) { }
-	}
-	public class JavaScriptScript : StoredScript
-	{
-		private static readonly string Lang = ScriptLang.JS.GetStringValue();
-		public JavaScriptScript(string source) : base(Lang, source) { }
-	}
-	public class PythonScript : StoredScript
-	{
-		private static readonly string Lang = ScriptLang.Python.GetStringValue();
-		public PythonScript(string source) : base(Lang, source) { }
-	}
+
 	public class LuceneExpressionScript : StoredScript
 	{
 		private static readonly string Lang = ScriptLang.Expression.GetStringValue();
 		public LuceneExpressionScript(string source) : base(Lang, source) { }
 	}
+
 	public class MustacheScript : StoredScript
 	{
 		private static readonly string Lang = ScriptLang.Mustache.GetStringValue();
-		public MustacheScript(string source) : base(Lang, source) { }
+	 	public MustacheScript(string source) : base(Lang, source) { }
 	}
 
 	public class StoredScriptDescriptor : DescriptorBase<StoredScriptDescriptor, IStoredScript>, IStoredScript
 	{
-		string IStoredScript.Lang { get; set; }
 		string IStoredScript.Source { get; set; }
+		string IStoredScript.Lang { get; set; }
+
+		public StoredScriptDescriptor Source(string source) => Assign(a => a.Source = source);
 
 		public StoredScriptDescriptor Lang(string lang) => Assign(a => a.Lang = lang);
 
-		public StoredScriptDescriptor Source(string source) => Assign(a => a.Source = source);
+		public StoredScriptDescriptor Lang(ScriptLang lang) => Assign(a => a.Lang = lang.GetStringValue());
 	}
 }

src/Nest/Modules/Scripting/PutScript/PutScriptRequest.cs

@@ -22,11 +22,19 @@ public partial class PutScriptDescriptor
 		public PutScriptDescriptor Script(Func<StoredScriptDescriptor, IStoredScript> selector) =>
 			Assign(a => a.Script = selector?.Invoke(new StoredScriptDescriptor()));
 
+		/// <summary>
+		/// A Painless language script
+		/// </summary>
 		public PutScriptDescriptor Painless(string source) => Assign(a => a.Script = new PainlessScript(source));
-		public PutScriptDescriptor Groovy(string source) => Assign(a => a.Script = new GroovyScript(source));
-		public PutScriptDescriptor JavaScript(string source) => Assign(a => a.Script = new JavaScriptScript(source));
-		public PutScriptDescriptor Python(string source) => Assign(a => a.Script = new PythonScript(source));
+
+		/// <summary>
+		/// A Lucene expression language script
+		/// </summary>
 		public PutScriptDescriptor LuceneExpression(string source) => Assign(a => a.Script = new LuceneExpressionScript(source));
+
+		/// <summary>
+		/// A Mustache template language script
+		/// </summary>
 		public PutScriptDescriptor Mustache(string source) => Assign(a => a.Script = new MustacheScript(source));
 	}
 }

src/Nest/Modules/Scripting/ScriptLang.cs

@@ -10,15 +10,6 @@ public enum ScriptLang
 		[EnumMember(Value = "painless")]
 		Painless,
 
-		[EnumMember(Value = "groovy")]
-		Groovy,
-
-		[EnumMember(Value = "js")]
-		JS,
-
-		[EnumMember(Value = "python")]
-		Python,
-
 		[EnumMember(Value = "expression")]
 		Expression,
 

src/Tests/Modules/Scripting/PutScript/PutScriptApiTests.cs

@@ -1,5 +1,6 @@
 using System;
 using Elasticsearch.Net;
+using FluentAssertions;
 using Nest;
 using Tests.Framework;
 using Tests.Framework.Integration;
@@ -9,13 +10,12 @@
 namespace Tests.Modules.Scripting.PutScript
 {
 	public class PutScriptApiTests
-		: ApiTestBase<ReadOnlyCluster, IPutScriptResponse, IPutScriptRequest, PutScriptDescriptor, PutScriptRequest>
+		: ApiIntegrationTestBase<ReadOnlyCluster, IPutScriptResponse, IPutScriptRequest, PutScriptDescriptor, PutScriptRequest>
 	{
 		public PutScriptApiTests(ReadOnlyCluster cluster, EndpointUsage usage) : base(cluster, usage) { }
 
 		private static readonly string _name = "scrpt1";
 
-
 		protected override LazyResponses ClientUsage() => Calls(
 			fluent: (client, f) => client.PutScript(_name, f),
 			fluentAsync: (client, f) => client.PutScriptAsync(_name, f),
@@ -25,12 +25,18 @@ protected override LazyResponses ClientUsage() => Calls(
 
 		protected override HttpMethod HttpMethod => HttpMethod.PUT;
 		protected override string UrlPath => $"/_scripts/{_name}";
+		protected override int ExpectStatusCode => 200;
+		protected override bool ExpectIsValid => true;
 
 		protected override bool SupportsDeserialization => false;
 
-		protected override object ExpectJson { get; } = new
+		protected override object ExpectJson => new
 		{
-			script = new { lang = "painless", source = "1+1" }
+			script = new
+			{
+				lang = "painless",
+				source = "1+1"
+			}
 		};
 
 		protected override PutScriptDescriptor NewDescriptor() => new PutScriptDescriptor(_name);
@@ -42,5 +48,11 @@ protected override LazyResponses ClientUsage() => Calls(
 		{
 			Script = new PainlessScript("1+1")
 		};
+
+		protected override void ExpectResponse(IPutScriptResponse response)
+		{
+			response.ShouldBeValid();
+			response.Acknowledged.Should().BeTrue();
+		}
 	}
 }