Add support for ip_range datatype (Backport of #3202 to 5.x) (#3215)

Stuart Cam · web-flow · commit 37a34e0cb977 · 2018-04-27T12:55:12.000+10:00
Backport of #3202 to 5.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/Aggregations/Bucket/IpRange/IpRangeAggregation.cs b/src/Nest/Aggregations/Bucket/IpRange/IpRangeAggregation.cs
@@ -13,7 +13,7 @@ public interface IIpRangeAggregation : IBucketAggregation
 		[JsonProperty("field")]
 		Field Field { get; set; }
 
-		[JsonProperty(PropertyName = "ranges")]
+		[JsonProperty("ranges")]
 		IEnumerable<IIpRange> Ranges { get; set; }
 	}
 
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
@@ -83,6 +83,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>());
+
 #pragma warning disable CS3001 // Argument type is not CLS-compliant
 		public IProperty Scalar(Expression<Func<T, int>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null) =>
 			selector.InvokeOrDefault(new NumberPropertyDescriptor<T>().Name(field).Type(NumberType.Integer));
@@ -246,6 +249,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/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/Ip/IpRangeProperty.cs b/src/Nest/Mapping/Types/Core/Range/Ip/IpRangeProperty.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/RangePropertyBase.cs b/src/Nest/Mapping/Types/Core/Range/RangePropertyBase.cs
@@ -65,14 +65,14 @@ 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.IncludeInAll"/>
 		/// <remarks>Removed in 6.x</remarks>
 		public TDescriptor IncludeInAll(bool includeInAll = true) => Assign(a => a.IncludeInAll = includeInAll);
-		/// <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
@@ -91,5 +91,7 @@ public enum FieldType
 		DoubleRange,
 		[EnumMember(Value = "date_range")]
 		DateRange,
+		[EnumMember(Value = "ip_range")]
+		IpRange
 	}
 }
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
@@ -67,6 +67,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);
 	}
 
 	public partial class PropertiesDescriptor<T> : IsADictionaryDescriptorBase<PropertiesDescriptor<T>, IProperties, PropertyName, IProperty>, IPropertiesDescriptor<T, PropertiesDescriptor<T>>
@@ -128,6 +129,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> Custom(IProperty customType) => SetProperty(customType);
 
 		private PropertiesDescriptor<T> SetProperty<TDescriptor, TInterface>(Func<TDescriptor, TInterface> selector)
diff --git a/src/Nest/Mapping/Types/PropertyJsonConverter.cs b/src/Nest/Mapping/Types/PropertyJsonConverter.cs
@@ -85,6 +85,8 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
 					return jObject.ToObject<IntegerRangeProperty>();
 				case FieldType.LongRange:
 					return jObject.ToObject<LongRangeProperty>();
+				case FieldType.IpRange:
+					return jObject.ToObject<IpRangeProperty>();
 				case FieldType.None:
 					break;
 				default:
diff --git a/src/Nest/Mapping/Visitor/PropertyWalker.cs b/src/Nest/Mapping/Visitor/PropertyWalker.cs
@@ -157,6 +157,9 @@ private IProperty InferProperty(Type type)
 			if (type == typeof(LongRange))
 				return new LongRangeProperty();
 
+			if (type == typeof(IpAddressRange))
+				return new IpRangeProperty();
+
 			return new ObjectProperty();
 		}
 
diff --git a/src/Tests/Aggregations/Bucket/IpRange/IpRangeAggregationUsageTests.cs b/src/Tests/Aggregations/Bucket/IpRange/IpRangeAggregationUsageTests.cs
@@ -17,33 +17,30 @@ public IpRangeAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage) : ba
 
 		protected override object ExpectJson => new
 		{
-			aggs = new
-			{
+			aggs = new {
 				ip_ranges = new
 				{
 					ip_range = new
 					{
 						field = "leadDeveloper.iPAddress",
 						ranges = new object[]
 						{
-							new { to = "10.0.0.5" },
-							new { from = "10.0.0.5" }
+							new {to = "127.0.0.1"},
+							new {from = "127.0.0.1"}
 						}
 					}
-				}
+					}
 			}
 		};
 
 		protected override Func<SearchDescriptor<Project>, ISearchRequest> Fluent => s => s
-			.Aggregations(a => a
-				.IpRange("ip_ranges", ip => ip
-					.Field(p => p.LeadDeveloper.IPAddress)
-					.Ranges(
-						r => r.To("10.0.0.5"),
-						r => r.From("10.0.0.5")
-					)
+			.Aggregations(a => a.IpRange("ip_ranges", ip => ip
+				.Field(p => p.LeadDeveloper.IPAddress)
+				.Ranges(
+					r => r.To("127.0.0.1"),
+					r => r.From("127.0.0.1")
 				)
-			);
+			));
 
 		protected override SearchRequest<Project> Initializer =>
 			new SearchRequest<Project>
@@ -53,8 +50,8 @@ public IpRangeAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage) : ba
 					Field = Field((Project p) => p.LeadDeveloper.IPAddress),
 					Ranges = new List<Nest.IpRange>
 					{
-						new Nest.IpRange { To = "10.0.0.5" },
-						new Nest.IpRange { From = "10.0.0.5" }
+						new Nest.IpRange {To = "127.0.0.1"},
+						new Nest.IpRange {From = "127.0.0.1"}
 					}
 				}
 			};
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
@@ -176,6 +176,10 @@ protected override LazyResponses ClientUsage() => Calls(
 						},
 						longs = new {
 							type = "long_range"
+						},
+						ips = new
+						{
+							type = "ip_range"
 						}
 					},
 					type = "object"
@@ -315,6 +319,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

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public interface IIpRangeAggregation : IBucketAggregation`
`13`	`13`	`[JsonProperty("field")]`
`14`	`14`	`Field Field { get; set; }`
`15`	`15`
`16`		`- [JsonProperty(PropertyName = "ranges")]`
	`16`	`+ [JsonProperty("ranges")]`
`17`	`17`	`IEnumerable<IIpRange> Ranges { get; set; }`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -91,5 +91,7 @@ public enum FieldType`
`91`	`91`	`DoubleRange,`
`92`	`92`	`[EnumMember(Value = "date_range")]`
`93`	`93`	`DateRange,`
	`94`	`+ [EnumMember(Value = "ip_range")]`
	`95`	`+ IpRange`
`94`	`96`	`}`
`95`	`97`	`}`
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`	`}`