Add support for ip_range datatype (Backport of #3202 to 6.x) (#3216)

Stuart Cam · web-flow · commit c729779b1484 · 2018-04-27T12:56:11.000+10:00
Add support for ip_range datatype (Backport of #3202 to 6.x) This commit adds support for the ip_range datatype. The existing IpRange type used for IpRangeAggregation renamed to IpRangeAggregationRange to allow for the introduction of an IpRange type whose name aligns with other range datatypes.
diff --git a/src/Nest/CommonOptions/Range/Ranges.cs b/src/Nest/CommonOptions/Range/Ranges.cs
@@ -73,4 +73,18 @@ public class LongRange
 		[JsonProperty("lt")]
 		public long? LessThan { get; set; }
 	}
+	public class IpAddressRange
+	{
+		[JsonProperty("gte")]
+		public string GreaterThanOrEqualTo { get; set; }
+
+		[JsonProperty("lte")]
+		public string LessThanOrEqualTo { get; set; }
+
+		[JsonProperty("gt")]
+		public string GreaterThan { get; set; }
+
+		[JsonProperty("lt")]
+		public string LessThan { get; set; }
+	}
 }
diff --git a/src/Nest/Mapping/DynamicTemplate/SingleMapping.cs b/src/Nest/Mapping/DynamicTemplate/SingleMapping.cs
@@ -73,6 +73,9 @@ public IProperty IntegerRange(Func<IntegerRangePropertyDescriptor<T>, IIntegerRa
 		public IProperty LongRange(Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector) =>
 			selector?.Invoke(new LongRangePropertyDescriptor<T>());
 
+		public IProperty IpRange(Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector) =>
+			selector?.Invoke(new IpRangePropertyDescriptor<T>());
+
 		public IProperty Join(Func<JoinPropertyDescriptor<T>, IJoinProperty> selector) =>
 			selector?.Invoke(new JoinPropertyDescriptor<T>());
 
@@ -239,6 +242,8 @@ public IProperty Scalar(Expression<Func<T, IntegerRange>> field, Func<IntegerRan
 			selector.InvokeOrDefault(new IntegerRangePropertyDescriptor<T>().Name(field));
 		public IProperty Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null) =>
 			selector.InvokeOrDefault(new FloatRangePropertyDescriptor<T>().Name(field));
+		public IProperty Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null) =>
+			selector.InvokeOrDefault(new IpRangePropertyDescriptor<T>().Name(field));
 #pragma warning restore CS3001 // Argument type is not CLS-compliant
 	}
 }
diff --git a/src/Nest/Mapping/Types/Core/Range/Ip/IpAddressRangeProperty.cs b/src/Nest/Mapping/Types/Core/Range/Ip/IpAddressRangeProperty.cs
@@ -0,0 +1,21 @@
+using System;
+using Elasticsearch.Net;
+using Newtonsoft.Json;
+
+namespace Nest
+{
+	[JsonObject(MemberSerialization.OptIn)]
+	public interface IIpRangeProperty : IRangeProperty { }
+
+	public class IpRangeProperty : RangePropertyBase, IIpRangeProperty
+	{
+		public IpRangeProperty() : base(RangeType.IpRange) { }
+	}
+
+	public class IpRangePropertyDescriptor<T>
+		: RangePropertyDescriptorBase<IpRangePropertyDescriptor<T>, IIpRangeProperty, T>, IIpRangeProperty
+		where T : class
+	{
+		public IpRangePropertyDescriptor() : base(RangeType.IpRange) { }
+	}
+}
diff --git a/src/Nest/Mapping/Types/Core/Range/Ip/IpRangeAttribute.cs b/src/Nest/Mapping/Types/Core/Range/Ip/IpRangeAttribute.cs
@@ -0,0 +1,10 @@
+﻿using System;
+using Elasticsearch.Net;
+
+namespace Nest
+{
+	public class IpRangeAttribute : RangePropertyAttributeBase, IIpRangeProperty
+	{
+		public IpRangeAttribute() : base(RangeType.IpRange) { }
+	}
+}
diff --git a/src/Nest/Mapping/Types/Core/Range/RangePropertyBase.cs b/src/Nest/Mapping/Types/Core/Range/RangePropertyBase.cs
@@ -49,11 +49,11 @@ public abstract class RangePropertyDescriptorBase<TDescriptor, TInterface, T>
 
 		protected RangePropertyDescriptorBase(RangeType type) : base(type.ToFieldType()) { }
 
-		/// <inheritdoc/>
+		/// <inheritdoc cref="IRangeProperty.Coerce"/>
 		public TDescriptor Coerce(bool? coerce = true) => Assign(a => a.Coerce = coerce);
-		/// <inheritdoc/>
+		/// <inheritdoc cref="IRangeProperty.Boost"/>
 		public TDescriptor Boost(double? boost) => Assign(a => a.Boost = boost);
-		/// <inheritdoc/>
+		/// <inheritdoc cref="IRangeProperty.Index"/>
 		public TDescriptor Index(bool? index = true) => Assign(a => a.Index = index);
 	}
 }
diff --git a/src/Nest/Mapping/Types/Core/Range/RangeType.cs b/src/Nest/Mapping/Types/Core/Range/RangeType.cs
@@ -32,7 +32,12 @@ public enum RangeType
 		/// A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.
 		/// </summary>
 		[EnumMember(Value = "date_range")]
-		DateRange
+		DateRange,
+		/// <summary>
+		/// A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.
+		/// </summary>
+		[EnumMember(Value = "ip_range")]
+		IpRange
 	}
 	internal static class RangeTypeExtensions
 	{
@@ -45,6 +50,7 @@ public static FieldType ToFieldType(this RangeType rangeType)
 				case RangeType.LongRange: return FieldType.LongRange;
 				case RangeType.DoubleRange: return FieldType.DoubleRange;
 				case RangeType.DateRange: return FieldType.DateRange;
+				case RangeType.IpRange: return FieldType.IpRange;
 				default:
 					throw new ArgumentOutOfRangeException(nameof(rangeType), rangeType, null);
 			}
diff --git a/src/Nest/Mapping/Types/FieldType.cs b/src/Nest/Mapping/Types/FieldType.cs
@@ -84,6 +84,8 @@ public enum FieldType
 		DoubleRange,
 		[EnumMember(Value = "date_range")]
 		DateRange,
+		[EnumMember(Value = "ip_range")]
+		IpRange,
 		[EnumMember(Value = "join")]
 		Join,
 	}
diff --git a/src/Nest/Mapping/Types/Properties-Scalar.cs b/src/Nest/Mapping/Types/Properties-Scalar.cs
@@ -100,6 +100,7 @@ public partial interface IPropertiesDescriptor<T, out TReturnType>
 		TReturnType Scalar(Expression<Func<T, LongRange>> field, Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector = null);
 		TReturnType Scalar(Expression<Func<T, IntegerRange>> field, Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector = null);
 		TReturnType Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null);
+		TReturnType Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null);
 #pragma warning restore CS3001 // Argument type is not CLS-compliant
 	}
 
@@ -269,6 +270,8 @@ public PropertiesDescriptor<T> Scalar(Expression<Func<T, IntegerRange>> field, F
 			SetProperty(selector.InvokeOrDefault(new IntegerRangePropertyDescriptor<T>().Name(field)));
 		public PropertiesDescriptor<T> Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null) =>
 			SetProperty(selector.InvokeOrDefault(new FloatRangePropertyDescriptor<T>().Name(field)));
+		public PropertiesDescriptor<T> Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null) =>
+			SetProperty(selector.InvokeOrDefault(new IpRangePropertyDescriptor<T>().Name(field)));
 
 #pragma warning restore CS3001 // Argument type is not CLS-compliant
 	}
diff --git a/src/Nest/Mapping/Types/Properties.cs b/src/Nest/Mapping/Types/Properties.cs
@@ -72,6 +72,7 @@ TReturnType Nested<TChild>(Func<NestedPropertyDescriptor<T, TChild>, INestedProp
 		TReturnType FloatRange(Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector);
 		TReturnType IntegerRange(Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector);
 		TReturnType LongRange(Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector);
+		TReturnType IpRange(Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector);
 		TReturnType Join(Func<JoinPropertyDescriptor<T>, IJoinProperty> selector);
 	}
 
@@ -127,6 +128,8 @@ public PropertiesDescriptor<T> Nested<TChild>(Func<NestedPropertyDescriptor<T, T
 
 		public PropertiesDescriptor<T> LongRange(Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector) => SetProperty(selector);
 
+		public PropertiesDescriptor<T> IpRange(Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector) => SetProperty(selector);
+
 		public PropertiesDescriptor<T> Join(Func<JoinPropertyDescriptor<T>, IJoinProperty> selector) => SetProperty(selector);
 
 		public PropertiesDescriptor<T> Custom(IProperty customType) => SetProperty(customType);
diff --git a/src/Nest/Mapping/Types/PropertiesJsonConverter.cs b/src/Nest/Mapping/Types/PropertiesJsonConverter.cs
@@ -54,14 +54,10 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
 			foreach (var p in o.Properties())
 			{
 				var name = p.Name;
-				var po = p.First as JObject;
-				if (po == null) continue;
-
-				var mapping = _elasticTypeConverter.ReadJson(po.CreateReader(), objectType, existingValue, serializer) as IProperty;
-				if (mapping == null) continue;
+				if (!(p.First is JObject po)) continue;
+				if (!(_elasticTypeConverter.ReadJson(po.CreateReader(), objectType, existingValue, serializer) is IProperty mapping)) continue;
 
 				mapping.Name = name;
-
 				r.Add(name, mapping);
 			}
 			return r;
diff --git a/src/Nest/Mapping/Types/PropertyJsonConverter.cs b/src/Nest/Mapping/Types/PropertyJsonConverter.cs
@@ -11,16 +11,11 @@ internal class PropertyJsonConverter : JsonConverter
 
 		public override bool CanConvert(Type objectType) => objectType == typeof(IProperty);
 
-		public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
-		{
+		public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) =>
 			throw new NotSupportedException();
-		}
 
-		private TProperty ReadProperty<TProperty>(JObject j, JsonSerializer s)
-			where TProperty : IProperty
-		{
-			return FromJson.ReadAs<TProperty>(j.CreateReader(), s);
-		}
+		private TProperty ReadProperty<TProperty>(JObject j, JsonSerializer s) where TProperty : IProperty =>
+			FromJson.ReadAs<TProperty>(j.CreateReader(), s);
 
 		public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
 		{
@@ -64,6 +59,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
 				case FieldType.FloatRange: return ReadProperty<FloatRangeProperty>(jObject, serializer);
 				case FieldType.IntegerRange: return ReadProperty<IntegerRangeProperty>(jObject, serializer);
 				case FieldType.LongRange: return ReadProperty<LongRangeProperty>(jObject, serializer);
+				case FieldType.IpRange: return ReadProperty<IpRangeProperty>(jObject, serializer);
 				case FieldType.Join: return ReadProperty<JoinProperty>(jObject, serializer);
 				case FieldType.None:
 					break;
diff --git a/src/Nest/Mapping/Visitor/PropertyWalker.cs b/src/Nest/Mapping/Visitor/PropertyWalker.cs
@@ -155,6 +155,9 @@ private static IProperty InferProperty(PropertyInfo propertyInfo)
 			if (type == typeof(LongRange))
 				return new LongRangeProperty();
 
+			if (type == typeof(IpAddressRange))
+				return new IpRangeProperty();
+
 			return new ObjectProperty();
 		}
 
diff --git a/src/Tests/Framework/MockData/Ranges.cs b/src/Tests/Framework/MockData/Ranges.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Net;
 using Bogus;
 using Nest;
 
@@ -11,6 +12,7 @@ public class Ranges
 		public FloatRange Floats { get; set; }
 		public IntegerRange Integers { get; set; }
 		public LongRange Longs { get; set; }
+		public IpAddressRange Ips { get; set; }
 
 		//for deserialization
 		public Ranges() { }
@@ -23,6 +25,7 @@ private Ranges(Faker faker)
 			SetFloats(faker, r);
 			SetIntegers(faker, r);
 			SetLongs(faker, r);
+			SetIps(faker, r);
 		}
 
 		private void SetDates(Faker faker, Func<bool> r)
@@ -70,6 +73,27 @@ private void SetLongs(Faker faker, Func<bool> r)
 			SwapAssign(r(), high, v => d.LessThan = v, v => d.LessThanOrEqualTo = v);
 			this.Longs = d;
 		}
+		private void SetIps(Faker faker, Func<bool> r)
+		{
+			var low = faker.Internet.Ip();
+			var high = faker.Internet.Ip();
+			var lowBytes = IPAddress.Parse(low).GetAddressBytes();
+			var highBytes = IPAddress.Parse(high).GetAddressBytes();
+			for (int i = 0; i < lowBytes.Length; i++)
+			{
+				if (lowBytes[i] > highBytes[i])
+				{
+					var s = low;
+					low = high;
+					high = s;
+					break;
+				}
+			}
+			var d = new IpAddressRange();
+			SwapAssign(r(), low, v => d.GreaterThan = v, v => d.GreaterThanOrEqualTo = v);
+			SwapAssign(r(), high, v => d.LessThan = v, v => d.LessThanOrEqualTo = v);
+			this.Ips = d;
+		}
 
 		private static void SwapAssign<T>(bool b, T value, Action<T> first, Action<T> second)
 		{
diff --git a/src/Tests/Indices/MappingManagement/PutMapping/PutMappingApiTest.cs b/src/Tests/Indices/MappingManagement/PutMapping/PutMappingApiTest.cs
@@ -111,7 +111,8 @@ protected override LazyResponses ClientUsage() => Calls(
 						doubles = new { type = "double_range" },
 						floats = new { type = "float_range" },
 						integers = new { type = "integer_range" },
-						longs = new { type = "long_range" }
+						longs = new { type = "long_range" },
+						ips = new { type = "ip_range" }
 					},
 					type = "object"
 				},
@@ -274,6 +275,7 @@ protected override LazyResponses ClientUsage() => Calls(
 							{p => p.Floats, new FloatRangeProperty()},
 							{p => p.Integers, new IntegerRangeProperty()},
 							{p => p.Longs, new LongRangeProperty()},
+							{p => p.Ips, new IpRangeProperty()},
 						}
 					}
 				},
diff --git a/src/Tests/Mapping/Types/Core/Range/IpRange/IpRangeAttributeTests.cs b/src/Tests/Mapping/Types/Core/Range/IpRange/IpRangeAttributeTests.cs
@@ -0,0 +1,26 @@
+﻿using Nest;
+using Tests.Framework;
+
+namespace Tests.Mapping.Types.Core.Range.IpRange
+{
+	public class IpRangeTest
+	{
+		[IpRange]
+		public Nest.IpAddressRange Range { get; set; }
+	}
+
+	[SkipVersion("<5.5.0", "ip range type is a new 5.5.0 feature")]
+	public class IpRangeAttributeTests : AttributeTestsBase<IpRangeTest>
+	{
+		protected override object ExpectJson => new
+		{
+			properties = new
+			{
+				range = new
+				{
+					type = "ip_range"
+				}
+			}
+		};
+	}
+}
diff --git a/src/Tests/Mapping/Types/Core/Range/IpRange/IpRangePropertyTests.cs b/src/Tests/Mapping/Types/Core/Range/IpRange/IpRangePropertyTests.cs
@@ -0,0 +1,73 @@
+﻿using System;
+using Nest;
+using Tests.Framework;
+using Tests.Framework.Integration;
+using Tests.Framework.ManagedElasticsearch.Clusters;
+using Tests.Framework.MockData;
+
+namespace Tests.Mapping.Types.Core.Range.IpRange
+{
+	[SkipVersion("<5.5.0", "ip range type is a new 5.5.0 feature")]
+	public class IpRangePropertyTests : PropertyTestsBase
+	{
+		public IpRangePropertyTests(WritableCluster cluster, EndpointUsage usage) : base(cluster, usage) { }
+
+		protected override object ExpectJson => new
+		{
+			properties = new
+			{
+				ranges = new
+				{
+					type = "object",
+					properties = new
+					{
+						ips = new
+						{
+							type = "ip_range",
+							store = true,
+							index = false,
+							boost = 1.5,
+							coerce = true
+						}
+					}
+				}
+			}
+		};
+
+		protected override Func<PropertiesDescriptor<Project>, IPromise<IProperties>> FluentProperties => f => f
+			.Object<Ranges>(m => m
+				.Name(p => p.Ranges)
+				.Properties(props => props
+					.IpRange(n => n
+						.Name(p => p.Ips)
+						.Store()
+						.Index(false)
+						.Boost(1.5)
+						.Coerce()
+					)
+				)
+			);
+
+
+		protected override IProperties InitializerProperties => new Properties
+		{
+			{
+				"ranges", new ObjectProperty
+				{
+					Properties = new Properties
+					{
+						{
+							"ips", new IpRangeProperty
+							{
+								Store = true,
+								Index = false,
+								Boost = 1.5,
+								Coerce = true
+							}
+						}
+					}
+				}
+			}
+		};
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -49,11 +49,11 @@ public abstract class RangePropertyDescriptorBase<TDescriptor, TInterface, T>`
`49`	`49`
`50`	`50`	`protected RangePropertyDescriptorBase(RangeType type) : base(type.ToFieldType()) { }`
`51`	`51`
`52`		`- /// <inheritdoc/>`
	`52`	`+ /// <inheritdoc cref="IRangeProperty.Coerce"/>`
`53`	`53`	`public TDescriptor Coerce(bool? coerce = true) => Assign(a => a.Coerce = coerce);`
`54`		`- /// <inheritdoc/>`
	`54`	`+ /// <inheritdoc cref="IRangeProperty.Boost"/>`
`55`	`55`	`public TDescriptor Boost(double? boost) => Assign(a => a.Boost = boost);`
`56`		`- /// <inheritdoc/>`
	`56`	`+ /// <inheritdoc cref="IRangeProperty.Index"/>`
`57`	`57`	`public TDescriptor Index(bool? index = true) => Assign(a => a.Index = index);`
`58`	`58`	`}`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,8 @@ public enum FieldType`
`84`	`84`	`DoubleRange,`
`85`	`85`	`[EnumMember(Value = "date_range")]`
`86`	`86`	`DateRange,`
	`87`	`+ [EnumMember(Value = "ip_range")]`
	`88`	`+ IpRange,`
`87`	`89`	`[EnumMember(Value = "join")]`
`88`	`90`	`Join,`
`89`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,7 @@ public partial interface IPropertiesDescriptor<T, out TReturnType>`
`100`	`100`	`TReturnType Scalar(Expression<Func<T, LongRange>> field, Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector = null);`
`101`	`101`	`TReturnType Scalar(Expression<Func<T, IntegerRange>> field, Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector = null);`
`102`	`102`	`TReturnType Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null);`
	`103`	`+ TReturnType Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null);`
`103`	`104`	`#pragma warning restore CS3001 // Argument type is not CLS-compliant`
`104`	`105`	`}`
`105`	`106`
`@@ -269,6 +270,8 @@ public PropertiesDescriptor<T> Scalar(Expression<Func<T, IntegerRange>> field, F`
`269`	`270`	`SetProperty(selector.InvokeOrDefault(new IntegerRangePropertyDescriptor<T>().Name(field)));`
`270`	`271`	`public PropertiesDescriptor<T> Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null) =>`
`271`	`272`	`SetProperty(selector.InvokeOrDefault(new FloatRangePropertyDescriptor<T>().Name(field)));`
	`273`	`+ public PropertiesDescriptor<T> Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null) =>`
	`274`	`+ SetProperty(selector.InvokeOrDefault(new IpRangePropertyDescriptor<T>().Name(field)));`
`272`	`275`
`273`	`276`	`#pragma warning restore CS3001 // Argument type is not CLS-compliant`
`274`	`277`	`}`