Merge branch 'fix/5.x-readonly-collections' into 5.x

russcam · russcam · commit 7f5988b0c8e6 · 2016-11-23T15:35:23.000+11:00
diff --git a/src/Elasticsearch.Net/Responses/ServerError.cs b/src/Elasticsearch.Net/Responses/ServerError.cs
@@ -82,7 +82,7 @@ public class Error : IRootCause
 		public string ResourceId { get; set; }
 		public string ResourceType { get; set; }
 		public string Type { get; set; }
-		public List<RootCause> RootCause { get; set; }
+		public IReadOnlyCollection<RootCause> RootCause { get; set; }
 		public CausedBy CausedBy { get; set; }
 
 		internal static Error Create(IDictionary<string, object> dict, IJsonSerializerStrategy strategy)
@@ -99,7 +99,7 @@ internal static Error Create(IDictionary<string, object> dict, IJsonSerializerSt
 
 			var os = rootCause as object[];
 			if (os == null) return error;
-			error.RootCause = os.Select(o => (RootCause)strategy.DeserializeObject(o, typeof(RootCause))).ToList();
+			error.RootCause = os.Select(o => (RootCause)strategy.DeserializeObject(o, typeof(RootCause))).ToList().AsReadOnly();
 			return error;
 		}
 
diff --git a/src/Elasticsearch.Net/Serialization/SimpleJson.cs b/src/Elasticsearch.Net/Serialization/SimpleJson.cs
@@ -32,7 +32,7 @@
 //#define SIMPLE_JSON_DATACONTRACT
 
 // NOTE: uncomment the following line to enable IReadOnlyCollection<T> and IReadOnlyList<T> support.
-//#define SIMPLE_JSON_READONLY_COLLECTIONS
+#define SIMPLE_JSON_READONLY_COLLECTIONS
 
 // NOTE: uncomment the following line to disable linq expressions/compiled lambda (better performance) instead of method.invoke().
 // define if you are using .net framework <= 3.0 or < WP7.5
@@ -81,12 +81,12 @@ namespace Elasticsearch.Net
 		class JsonArray : List<object>
 	{
 		/// <summary>
-		/// Initializes a new instance of the <see cref="JsonArray"/> class. 
+		/// Initializes a new instance of the <see cref="JsonArray"/> class.
 		/// </summary>
 		public JsonArray() { }
 
 		/// <summary>
-		/// Initializes a new instance of the <see cref="JsonArray"/> class. 
+		/// Initializes a new instance of the <see cref="JsonArray"/> class.
 		/// </summary>
 		/// <param name="capacity">The capacity of the json array.</param>
 		public JsonArray(int capacity) : base(capacity) { }
@@ -480,7 +480,7 @@ public override IEnumerable<string> GetDynamicMemberNames()
 	/// <summary>
 	/// This class encodes and decodes JSON strings.
 	/// Spec. details, see http://www.json.org/
-	/// 
+	///
 	/// JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList&lt;object>) and JsonObject(IDictionary&lt;string,object>).
 	/// All numbers are parsed to doubles.
 	/// </summary>
@@ -1176,7 +1176,7 @@ public static DataContractJsonSerializerStrategy DataContractJsonSerializerStrat
 
 #endif
 	}
-    
+
 	[GeneratedCode("simple-json", "1.0.0")]
 #if SIMPLE_JSON_INTERNAL
 	internal
@@ -1289,7 +1289,7 @@ public virtual object DeserializeObject(object value, Type type)
 
 			if (value == null)
 				return null;
-            
+
 			object obj = null;
 
 			if (str != null)
@@ -1327,7 +1327,7 @@ public virtual object DeserializeObject(object value, Type type)
 			}
 			else if (value is bool)
 				return value;
-            
+
 			bool valueIsLong = value is long;
 			bool valueIsDouble = value is double;
 			if ((valueIsLong && type == typeof(long)) || (valueIsDouble && type == typeof(double)))
@@ -2080,4 +2080,4 @@ System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
 // ReSharper restore LoopCanBeConvertedToQuery
 // ReSharper restore RedundantExplicitArrayCreation
 // ReSharper restore SuggestUseVarKeywordEvident
-}
+}
diff --git a/src/Nest/Cluster/ClusterReroute/ClusterRerouteState.cs b/src/Nest/Cluster/ClusterReroute/ClusterRerouteState.cs
@@ -17,7 +17,7 @@ public class ClusterRerouteState
 
 		[JsonProperty("nodes")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, NodeState>))]
-		public Dictionary<string, NodeState> Nodes { get; internal set; }
+		public IReadOnlyDictionary<string, NodeState> Nodes { get; internal set; }
 
 		[JsonProperty("routing_table")]
 		public RoutingTableState RoutingTable { get; internal set; }
diff --git a/src/Nest/Cluster/ClusterState/IndexRoutingTable.cs b/src/Nest/Cluster/ClusterState/IndexRoutingTable.cs
@@ -7,6 +7,6 @@ public class IndexRoutingTable
 	{
 		[JsonProperty("shards")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, List<RoutingShard>>))]
-		public Dictionary<string, List<RoutingShard>> Shards { get; internal set; }
+		public IReadOnlyDictionary<string, List<RoutingShard>> Shards { get; internal set; }
 	}
 }
diff --git a/src/Nest/Cluster/ClusterState/MetadataState.cs b/src/Nest/Cluster/ClusterState/MetadataState.cs
@@ -9,13 +9,13 @@ public class MetadataState
 	{
 		[JsonProperty("templates")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, TemplateMapping>))]
-		public IDictionary<string, TemplateMapping> Templates { get; internal set; }
+		public IReadOnlyDictionary<string, TemplateMapping> Templates { get; internal set; }
 
 		[JsonProperty("cluster_uuid")]
 		public string ClusterUUID { get; internal set; }
 
 		[JsonProperty("indices")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, MetadataIndexState>))]
-		public Dictionary<string, MetadataIndexState> Indices { get; internal set; }
+		public IReadOnlyDictionary<string, MetadataIndexState> Indices { get; internal set; }
 	}
 }
diff --git a/src/Nest/Cluster/ClusterState/RoutingNodesState.cs b/src/Nest/Cluster/ClusterState/RoutingNodesState.cs
@@ -8,9 +8,9 @@ namespace Nest
 	public class RoutingNodesState
 	{
 		[JsonProperty("unassigned")]
-		public List<RoutingShard> Unassigned { get; internal set; }
+		public IReadOnlyCollection<RoutingShard> Unassigned { get; internal set; }
 
 		[JsonProperty("nodes")]
-		public Dictionary<string, List<RoutingShard>> Nodes { get; internal set; }
+		public IReadOnlyDictionary<string, List<RoutingShard>> Nodes { get; internal set; }
 	}
-}
+}
diff --git a/src/Nest/Cluster/ClusterState/RoutingTableState.cs b/src/Nest/Cluster/ClusterState/RoutingTableState.cs
@@ -9,6 +9,6 @@ public class RoutingTableState
 	{
 		[JsonProperty("indices")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, IndexRoutingTable>))]
-		public Dictionary<string, IndexRoutingTable> Indices { get; internal set; }
+		public IReadOnlyDictionary<string, IndexRoutingTable> Indices { get; internal set; } = EmptyReadOnly<string, IndexRoutingTable>.Dictionary;
 	}
 }
diff --git a/src/Nest/Cluster/ClusterStats/ClusterNodesStats.cs b/src/Nest/Cluster/ClusterStats/ClusterNodesStats.cs
@@ -10,7 +10,7 @@ public class ClusterNodesStats
 		public ClusterNodeCount Count { get; internal set; }
 
 		[JsonProperty("versions")]
-		public List<string> Versions { get; internal set; }
+		public IReadOnlyCollection<string> Versions { get; internal set; }
 
 		[JsonProperty("os")]
 		public ClusterOperatingSystemStats OperatingSystem { get; internal set; }
@@ -25,7 +25,7 @@ public class ClusterNodesStats
 		public ClusterFileSystem FileSystem { get; internal set; }
 
 		[JsonProperty("plugins")]
-		public List<PluginStats> Plugins { get; internal set; }
+		public IReadOnlyCollection<PluginStats> Plugins { get; internal set; }
 	}
 
 	[JsonObject]
@@ -55,7 +55,7 @@ public class ClusterJvm
 		public long MaxUptimeInMilliseconds { get; internal set; }
 
 		[JsonProperty("versions")]
-		public List<ClusterJvmVersion> Versions { get; internal set; }
+		public IReadOnlyCollection<ClusterJvmVersion> Versions { get; internal set; }
 
 		[JsonProperty("mem")]
 		public ClusterJvmMemory Memory { get; internal set; }
@@ -139,7 +139,7 @@ public class ClusterOperatingSystemStats
 		public int AllocatedProcessors { get; internal set; }
 
 		[JsonProperty("names")]
-		public List<ClusterOperatingSystemName> Names { get; internal set; }
+		public IReadOnlyCollection<ClusterOperatingSystemName> Names { get; internal set; }
 	}
 
 	[JsonObject]
diff --git a/src/Nest/CommonOptions/Stats/IndexingStats.cs b/src/Nest/CommonOptions/Stats/IndexingStats.cs
@@ -44,6 +44,6 @@ public class IndexingStats
 
 		[JsonProperty("types")]
 		[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, IndexingStats>))]
-		public Dictionary<string, IndexingStats> Types { get; set; }
+		public IReadOnlyDictionary<string, IndexingStats> Types { get; set; }
 	}
 }
diff --git a/src/Nest/Modules/SnapshotAndRestore/Snapshot/Snapshot.cs b/src/Nest/Modules/SnapshotAndRestore/Snapshot/Snapshot.cs
@@ -11,46 +11,30 @@ public class Snapshot
 		public string Name { get; internal set;  }
 
 		[JsonProperty("indices")]
-		public IEnumerable<IndexName> Indices { get; internal set; }
+		public IReadOnlyCollection<IndexName> Indices { get; internal set; }
 
 		[JsonProperty("state")]
 		public string State { get; internal set; }
 
 		[JsonProperty("start_time")]
 		public DateTime StartTime { get; internal set;  }
-		
+
 		[JsonProperty("start_time_in_millis")]
 		public long StartTimeInMilliseconds { get; internal set;  }
-		
+
 		[JsonProperty("end_time")]
 		public DateTime EndTime { get; internal set;  }
-		
+
 		[JsonProperty("end_time_in_millis")]
 		public long EndTimeInMilliseconds { get; internal set;  }
-		
+
 		[JsonProperty("duration_in_millis")]
 		public long DurationInMilliseconds { get; internal set;  }
 
 		[JsonProperty("shards")]
 		public ShardsMetaData Shards { get; internal set; }
 
 		[JsonProperty("failures")]
-		public IEnumerable<SnapshotShardFailure> ShardFailures { get; internal set; }
-
-		/// <summary>
-		/// Contains the reason for each shard failure.
-		/// </summary>
-		/// For 2.0, remove this and rename ShardFailures => Failures
-		[JsonIgnore]
-		public IEnumerable<string> Failures
-		{
-			get
-			{
-				if (this.ShardFailures != null) 
-					return this.ShardFailures.Select(f => f.Reason);
-				return new List<string>();
-			}
-		}
-		
+		public IReadOnlyCollection<SnapshotShardFailure> Failures { get; internal set; }
 	}
-}
+}
diff --git a/src/Nest/XPack/License/PostLicense/LicenseAcknowledgement.cs b/src/Nest/XPack/License/PostLicense/LicenseAcknowledgement.cs
@@ -1,11 +1,13 @@
-﻿namespace Nest
+﻿using System.Collections.Generic;
+
+namespace Nest
 {
 	/// <summary>
 	/// If the license is valid but is older or has less capabilities this will list out the reasons why a resubmission with acknowledge=true is required
 	/// </summary>
 	public class LicenseAcknowledgement
 	{
 		public string Message { get; set; }
-		public string[] License { get; set; }
+		public IReadOnlyCollection<string> License { get; set; }
 	}
 }
diff --git a/src/Nest/XPack/Security/Authenticate/AuthenticateResponse.cs b/src/Nest/XPack/Security/Authenticate/AuthenticateResponse.cs
@@ -1,6 +1,4 @@
-﻿using System;
-using System.Collections.Generic;
-using System.IO;
+﻿using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace Nest
@@ -11,7 +9,7 @@ public interface IAuthenticateResponse : IResponse
 		string Username { get; }
 
 		[JsonProperty("roles")]
-		IEnumerable<string> Roles { get; }
+		IReadOnlyCollection<string> Roles { get; }
 
 		[JsonProperty("full_name")]
 		string FullName { get; }
@@ -28,13 +26,12 @@ public class AuthenticateResponse : ResponseBase, IAuthenticateResponse
 	{
 		public string Username { get; internal set; }
 
-		public IEnumerable<string> Roles { get; internal set;  }
+		public IReadOnlyCollection<string> Roles { get; internal set; } = EmptyReadOnly<string>.Collection;
 
 		public string FullName { get; internal set;  }
 
 		public string Email { get; internal set;  }
 
 		public IReadOnlyDictionary<string, object> Metadata { get; internal set; } = EmptyReadOnly<string, object>.Dictionary;
-
 	}
 }
diff --git a/src/Nest/XPack/Watcher/AcknowledgeWatch/AcknowledgeWatchResponse.cs b/src/Nest/XPack/Watcher/AcknowledgeWatch/AcknowledgeWatchResponse.cs
@@ -33,7 +33,7 @@ public class WatchStatus
 		public DateTimeOffset? LastMetCondition { get; set; }
 
 		[JsonProperty("actions")]
-		public Dictionary<string, ActionStatus> Actions { get; set; }
+		public IReadOnlyDictionary<string, ActionStatus> Actions { get; set; }
 	}
 
 	public class ActionStatus
diff --git a/src/Nest/XPack/Watcher/ActivateWatch/ActivateWatchResponse.cs b/src/Nest/XPack/Watcher/ActivateWatch/ActivateWatchResponse.cs
@@ -21,6 +21,6 @@ public class ActivationStatus
 		public ActivationState State { get; internal set; }
 
 		[JsonProperty("actions")]
-		public Dictionary<string, ActionStatus> Actions { get; set; }
+		public IReadOnlyDictionary<string, ActionStatus> Actions { get; set; }
 	}
 }
diff --git a/src/Nest/XPack/Watcher/ExecuteWatch/ExecuteWatchResponse.cs b/src/Nest/XPack/Watcher/ExecuteWatch/ExecuteWatchResponse.cs
@@ -49,7 +49,7 @@ public class WatchRecord
 		public Id WatchId { get; set; }
 
 		[JsonProperty("messages")]
-		public IEnumerable<string> Messages { get; set; }
+		public IReadOnlyCollection<string> Messages { get; set; }
 
 		[JsonProperty("state")]
 		public ActionExecutionState? State { get; set; }
@@ -64,7 +64,7 @@ public class WatchRecord
 		public InputContainer Input { get; set; }
 
 		[JsonProperty("metadata")]
-		public IDictionary<string, object> Metadata { get; set; }
+		public IReadOnlyDictionary<string, object> Metadata { get; set; }
 
 		[JsonProperty("result")]
 		public ExecutionResult Result { get; set; }
@@ -98,7 +98,7 @@ public class ExecutionResult
 		public ExecutionResultCondition Condition { get; set; }
 
 		[JsonProperty("actions")]
-		public List<ExecutionResultAction> Actions { get; set; }
+		public IReadOnlyCollection<ExecutionResultAction> Actions { get; set; }
 	}
 
 	[JsonObject]
@@ -111,7 +111,7 @@ public class ExecutionResultInput
 		public Status Status { get; set; }
 
 		[JsonProperty("payload")]
-		public Dictionary<string, object> Payload { get; set; }
+		public IReadOnlyDictionary<string, object> Payload { get; set; }
 	}
 
 	[JsonObject]
diff --git a/src/Nest/XPack/Watcher/Watch.cs b/src/Nest/XPack/Watcher/Watch.cs
@@ -7,7 +7,7 @@ namespace Nest
 	public class Watch
 	{
 		[JsonProperty("meta")]
-		public IDictionary<string, object> Meta { get; internal set; }
+		public IReadOnlyDictionary<string, object> Meta { get; internal set; }
 
 		[JsonProperty("input")]
 		public IInputContainer Input { get; internal set; }
diff --git a/src/Nest/XPack/Watcher/WatcherStats/WatcherStatsResponse.cs b/src/Nest/XPack/Watcher/WatcherStats/WatcherStatsResponse.cs
@@ -19,10 +19,10 @@ public interface IWatcherStatsResponse : IResponse
 		ExecutionThreadPool ExecutionThreadPool { get; }
 
 		[JsonProperty("current_watches")]
-		IEnumerable<WatchRecordStats> CurrentWatches { get; }
+		IReadOnlyCollection<WatchRecordStats> CurrentWatches { get; }
 
 		[JsonProperty("queued_watches")]
-		IEnumerable<WatchRecordQueuedStats> QueuedWatches { get; }
+		IReadOnlyCollection<WatchRecordQueuedStats> QueuedWatches { get; }
 
 		[JsonProperty("manually_stopped")]
 		bool ManuallyStopped { get; }
@@ -52,9 +52,9 @@ public class WatcherStatsResponse : ResponseBase, IWatcherStatsResponse
 
 		public ExecutionThreadPool ExecutionThreadPool { get; internal set; }
 
-		public IEnumerable<WatchRecordStats> CurrentWatches { get; internal set; }
+		public IReadOnlyCollection<WatchRecordStats> CurrentWatches { get; internal set; }
 
-		public IEnumerable<WatchRecordQueuedStats> QueuedWatches { get; internal set; }
+		public IReadOnlyCollection<WatchRecordQueuedStats> QueuedWatches { get; internal set; }
 
 		public bool ManuallyStopped { get; internal set; }
 	}
diff --git a/src/Tests/Cluster/ClusterState/ClusterStatsApiTests.cs b/src/Tests/Cluster/ClusterState/ClusterStatsApiTests.cs
@@ -40,7 +40,7 @@ protected override void ExpectResponse(IClusterStateResponse response)
 
 		private void Assert(IReadOnlyDictionary<string, NodeState> nodes, string master)
 		{
-			nodes.Should().NotBeEmpty().And.Contain(kv=>kv.Key == master);
+			nodes.Should().NotBeEmpty().And.ContainKey(master);
 			var node = nodes[master];
 			node.Name.Should().NotBeNullOrWhiteSpace();
 			node.TransportAddress.Should().NotBeNullOrWhiteSpace();
diff --git a/src/Tests/Cluster/TaskManagement/TasksCancel/TasksCancelApiTests.cs b/src/Tests/Cluster/TaskManagement/TasksCancel/TasksCancelApiTests.cs
@@ -71,7 +71,7 @@ protected override void ExpectResponse(ICancelTasksResponse response)
 			response.NodeFailures.Should().BeNullOrEmpty();
 			response.Nodes.Should().NotBeEmpty();
 			var tasks = response.Nodes.First().Value.Tasks;
-			tasks.Should().NotBeEmpty().And.Contain(kv=> kv.Key == this.TaskId);
+			tasks.Should().NotBeEmpty().And.ContainKey(this.TaskId);
 		}
 	}
 }
diff --git a/src/Tests/CodeStandards/Responses.doc.cs b/src/Tests/CodeStandards/Responses.doc.cs
diff --git a/src/Tests/Document/Multiple/MultiTermVectors/MultiTermVectorsApiTests.cs b/src/Tests/Document/Multiple/MultiTermVectors/MultiTermVectorsApiTests.cs
diff --git a/src/Tests/Framework/Extensions/ReadOnlyDictionaryAssertions.cs b/src/Tests/Framework/Extensions/ReadOnlyDictionaryAssertions.cs
diff --git a/src/Tests/Indices/IndexManagement/CreateIndex/CreateIndexApiTests.cs b/src/Tests/Indices/IndexManagement/CreateIndex/CreateIndexApiTests.cs
diff --git a/src/Tests/Indices/Monitoring/IndicesShardStores/IndicesShardStoresApiTests.cs b/src/Tests/Indices/Monitoring/IndicesShardStores/IndicesShardStoresApiTests.cs
diff --git a/src/Tests/Reproduce/GithubIssue2323.cs b/src/Tests/Reproduce/GithubIssue2323.cs
diff --git a/src/Tests/Tests.csproj b/src/Tests/Tests.csproj

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@ public class IndexRoutingTable`
`7`	`7`	`{`
`8`	`8`	`[JsonProperty("shards")]`
`9`	`9`	`[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, List<RoutingShard>>))]`
`10`		`- public Dictionary<string, List<RoutingShard>> Shards { get; internal set; }`
	`10`	`+ public IReadOnlyDictionary<string, List<RoutingShard>> Shards { get; internal set; }`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,13 @@ public class MetadataState`
`9`	`9`	`{`
`10`	`10`	`[JsonProperty("templates")]`
`11`	`11`	`[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, TemplateMapping>))]`
`12`		`- public IDictionary<string, TemplateMapping> Templates { get; internal set; }`
	`12`	`+ public IReadOnlyDictionary<string, TemplateMapping> Templates { get; internal set; }`
`13`	`13`
`14`	`14`	`[JsonProperty("cluster_uuid")]`
`15`	`15`	`public string ClusterUUID { get; internal set; }`
`16`	`16`
`17`	`17`	`[JsonProperty("indices")]`
`18`	`18`	`[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, MetadataIndexState>))]`
`19`		`- public Dictionary<string, MetadataIndexState> Indices { get; internal set; }`
	`19`	`+ public IReadOnlyDictionary<string, MetadataIndexState> Indices { get; internal set; }`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@ namespace Nest`
`8`	`8`	`public class RoutingNodesState`
`9`	`9`	`{`
`10`	`10`	`[JsonProperty("unassigned")]`
`11`		`- public List<RoutingShard> Unassigned { get; internal set; }`
	`11`	`+ public IReadOnlyCollection<RoutingShard> Unassigned { get; internal set; }`
`12`	`12`
`13`	`13`	`[JsonProperty("nodes")]`
`14`		`- public Dictionary<string, List<RoutingShard>> Nodes { get; internal set; }`
	`14`	`+ public IReadOnlyDictionary<string, List<RoutingShard>> Nodes { get; internal set; }`
`15`	`15`	`}`
`16`		`-}`
	`16`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ public class RoutingTableState`
`9`	`9`	`{`
`10`	`10`	`[JsonProperty("indices")]`
`11`	`11`	`[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, IndexRoutingTable>))]`
`12`		`- public Dictionary<string, IndexRoutingTable> Indices { get; internal set; }`
	`12`	`+ public IReadOnlyDictionary<string, IndexRoutingTable> Indices { get; internal set; } = EmptyReadOnly<string, IndexRoutingTable>.Dictionary;`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,6 @@ public class IndexingStats`
`44`	`44`
`45`	`45`	`[JsonProperty("types")]`
`46`	`46`	`[JsonConverter(typeof(VerbatimDictionaryKeysJsonConverter<string, IndexingStats>))]`
`47`		`- public Dictionary<string, IndexingStats> Types { get; set; }`
	`47`	`+ public IReadOnlyDictionary<string, IndexingStats> Types { get; set; }`
`48`	`48`	`}`
`49`	`49`	`}`