Consistent file string comparison across Windows and Linux (#4948) (#4949)

This commit fixes a difference in the default string comparison
on .NET core across Windows and Linux which was causing the
Stale docs github action to fail on CI because generated documentation
was ordering asciidoc includes and list items in a different order.

This fix sets a specific culture to use and uses ordinal string
comparison.

Co-authored-by: Russ Cam <russ.cam@elastic.co>

Author: github-actions[bot]

docs/aggregations.asciidoc

@@ -64,12 +64,12 @@ The values are typically extracted from the fields of the document (using the fi
 
 * <<sum-aggregation-usage,Sum Aggregation Usage>>
 
+* <<t-test-aggregation-usage,T Test Aggregation Usage>>
+
 * <<top-hits-aggregation-usage,Top Hits Aggregation Usage>>
 
 * <<top-metrics-aggregation-usage,Top Metrics Aggregation Usage>>
 
-* <<t-test-aggregation-usage,T Test Aggregation Usage>>
-
 * <<value-count-aggregation-usage,Value Count Aggregation Usage>>
 
 * <<weighted-average-aggregation-usage,Weighted Average Aggregation Usage>>
@@ -108,12 +108,12 @@ include::aggregations/metric/string-stats/string-stats-aggregation-usage.asciido
 
 include::aggregations/metric/sum/sum-aggregation-usage.asciidoc[]
 
+include::aggregations/metric/t-test/t-test-aggregation-usage.asciidoc[]
+
 include::aggregations/metric/top-hits/top-hits-aggregation-usage.asciidoc[]
 
 include::aggregations/metric/top-metrics/top-metrics-aggregation-usage.asciidoc[]
 
-include::aggregations/metric/t-test/t-test-aggregation-usage.asciidoc[]
-
 include::aggregations/metric/value-count/value-count-aggregation-usage.asciidoc[]
 
 include::aggregations/metric/weighted-average/weighted-average-aggregation-usage.asciidoc[]

docs/query-dsl.asciidoc

@@ -49,13 +49,13 @@ NEST exposes all of the full text queries available in Elasticsearch
 
 * <<intervals-usage,Intervals Usage>>
 
-* <<match-usage,Match Usage>>
-
 * <<match-bool-prefix-usage,Match Bool Prefix Usage>>
 
+* <<match-phrase-prefix-usage,Match Phrase Prefix Usage>>
+
 * <<match-phrase-usage,Match Phrase Usage>>
 
-* <<match-phrase-prefix-usage,Match Phrase Prefix Usage>>
+* <<match-usage,Match Usage>>
 
 * <<multi-match-usage,Multi Match Usage>>
 
@@ -71,13 +71,13 @@ include::query-dsl/full-text/common-terms/common-terms-usage.asciidoc[]
 
 include::query-dsl/full-text/intervals/intervals-usage.asciidoc[]
 
-include::query-dsl/full-text/match/match-usage.asciidoc[]
-
 include::query-dsl/full-text/match-bool-prefix/match-bool-prefix-usage.asciidoc[]
 
+include::query-dsl/full-text/match-phrase-prefix/match-phrase-prefix-usage.asciidoc[]
+
 include::query-dsl/full-text/match-phrase/match-phrase-usage.asciidoc[]
 
-include::query-dsl/full-text/match-phrase-prefix/match-phrase-prefix-usage.asciidoc[]
+include::query-dsl/full-text/match/match-usage.asciidoc[]
 
 include::query-dsl/full-text/multi-match/multi-match-usage.asciidoc[]
 
@@ -122,14 +122,14 @@ NEST exposes all of the term queries available in Elasticsearch
 
 * <<term-query-usage,Term Query Usage>>
 
+* <<terms-set-query-usage,Terms Set Query Usage>>
+
 * <<terms-list-query-usage,Terms List Query Usage>>
 
 * <<terms-lookup-query-usage,Terms Lookup Query Usage>>
 
 * <<terms-query-usage,Terms Query Usage>>
 
-* <<terms-set-query-usage,Terms Set Query Usage>>
-
 * <<wildcard-query-usage,Wildcard Query Usage>>
 
 See the Elasticsearch documentation on {ref_current}/term-level-queries.html[Term level queries] for more details.
@@ -160,14 +160,14 @@ include::query-dsl/term-level/regexp/regexp-query-usage.asciidoc[]
 
 include::query-dsl/term-level/term/term-query-usage.asciidoc[]
 
+include::query-dsl/term-level/terms-set/terms-set-query-usage.asciidoc[]
+
 include::query-dsl/term-level/terms/terms-list-query-usage.asciidoc[]
 
 include::query-dsl/term-level/terms/terms-lookup-query-usage.asciidoc[]
 
 include::query-dsl/term-level/terms/terms-query-usage.asciidoc[]
 
-include::query-dsl/term-level/terms-set/terms-set-query-usage.asciidoc[]
-
 include::query-dsl/term-level/wildcard/wildcard-query-usage.asciidoc[]
 
 [[compound-queries]]
@@ -283,10 +283,10 @@ Specialized types of queries that do not fit into other groups
 
 * <<rank-feature-query-usage,Rank Feature Query Usage>>
 
-* <<script-query-usage,Script Query Usage>>
-
 * <<script-score-query-usage,Script Score Query Usage>>
 
+* <<script-query-usage,Script Query Usage>>
+
 * <<shape-query-usage,Shape Query Usage>>
 
 See the Elasticsearch documentation on {ref_current}/specialized-queries.html[Specialized queries] for more details.
@@ -305,10 +305,10 @@ include::query-dsl/specialized/pinned/pinned-query-usage.asciidoc[]
 
 include::query-dsl/specialized/rank-feature/rank-feature-query-usage.asciidoc[]
 
-include::query-dsl/specialized/script/script-query-usage.asciidoc[]
-
 include::query-dsl/specialized/script-score/script-score-query-usage.asciidoc[]
 
+include::query-dsl/specialized/script/script-query-usage.asciidoc[]
+
 include::query-dsl/specialized/shape/shape-query-usage.asciidoc[]
 
 [[span-queries]]

src/DocGenerator/AsciiDoc/RawAsciidocVisitor.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text.RegularExpressions;
@@ -53,50 +54,38 @@ public override void VisitAttributeEntry(AttributeEntry attributeEntry)
 			{
 				var thisFileUri = new Uri(_destination.FullName);
 				var directories = attributeEntry.Value.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
-
 				var counter = 1;
 
-				foreach (var directory in directories.OrderBy(s=>s))
+				foreach (var file in DirectoryFiles(directories))
 				{
-					var files = Directory.EnumerateFiles(
-						Path.Combine(Program.TmpOutputDirPath, directory), "*.asciidoc", SearchOption.AllDirectories);
-					 foreach (var file in files.OrderBy(s=>s))
-					{
-						var fileInfo = new FileInfo(file);
-						var referencedFileUri = new Uri(fileInfo.FullName);
-						var relativePath = thisFileUri.MakeRelativeUri(referencedFileUri);
-						var include = new Include(relativePath.OriginalString);
+					var fileInfo = new FileInfo(file);
+					var referencedFileUri = new Uri(fileInfo.FullName);
+					var relativePath = thisFileUri.MakeRelativeUri(referencedFileUri);
+					var include = new Include(relativePath.OriginalString);
 
-						if (attributeEntry.Parent != null)
-						{
-							attributeEntry.Parent.Insert(attributeEntry.Parent.IndexOf(attributeEntry) + counter, include);
-							++counter;
-						}
-						else
-							_document.Add(include);
+					if (attributeEntry.Parent != null)
+					{
+						attributeEntry.Parent.Insert(attributeEntry.Parent.IndexOf(attributeEntry) + counter, include);
+						++counter;
 					}
+					else
+						_document.Add(include);
 				}
 			}
 			else if (attributeEntry.Name == "anchor-list")
 			{
 				var directories = attributeEntry.Value.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
-
 				var list = new UnorderedList();
 
-				foreach (var directory in directories.OrderBy(s=>s))
+				foreach (var file in DirectoryFiles(directories))
 				{
-					var files = Directory.EnumerateFiles(
-						Path.Combine(Program.TmpOutputDirPath, directory), "*.asciidoc", SearchOption.AllDirectories);
-					 foreach (var file in files.OrderBy(s=>s))
-					{
-						var fileInfo = new FileInfo(file);
-						var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(fileInfo.Name);
+					var fileInfo = new FileInfo(file);
+					var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(fileInfo.Name);
 
-						list.Items.Add(new UnorderedListItem
-						{
-							new Paragraph(new InternalAnchor(fileNameWithoutExtension, fileNameWithoutExtension.LowercaseHyphenToPascal()))
-						});
-					}
+					list.Items.Add(new UnorderedListItem
+					{
+						new Paragraph(new InternalAnchor(fileNameWithoutExtension, fileNameWithoutExtension.LowercaseHyphenToPascal()))
+					});
 				}
 
 				if (attributeEntry.Parent != null)
@@ -107,5 +96,11 @@ public override void VisitAttributeEntry(AttributeEntry attributeEntry)
 
 			base.VisitAttributeEntry(attributeEntry);
 		}
+
+		private static IEnumerable<string> DirectoryFiles(string[] directories) =>
+			directories
+				.SelectMany(directory =>
+					Directory.EnumerateFiles(Path.Combine(Program.TmpOutputDirPath, directory), "*.asciidoc", SearchOption.AllDirectories))
+				.OrderBy(f => f, StringComparer.Ordinal);
 	}
 }

src/DocGenerator/Program.cs

@@ -3,7 +3,8 @@
 // See the LICENSE file in the project root for more information
 
 using System;
-using System.IO;
+ using System.Globalization;
+ using System.IO;
 using System.Linq;
 using CommandLine;
 using Newtonsoft.Json.Linq;
@@ -14,6 +15,7 @@ public static class Program
 	{
 		static Program()
 		{
+			CultureInfo.DefaultThreadCurrentCulture = new CultureInfo("en-us");
 			var root = new DirectoryInfo(Directory.GetCurrentDirectory());
 
 			do

src/DocGenerator/StringExtensions.cs

@@ -224,7 +224,8 @@ public static bool TryGetJsonForExpressionSyntax(this string anonymousTypeString
 		{
 			json = null;
 
-			foreach (var substitution in Substitutions) anonymousTypeString = anonymousTypeString.Replace(substitution.Key, substitution.Value);
+			foreach (var substitution in Substitutions)
+				anonymousTypeString = anonymousTypeString.Replace(substitution.Key, substitution.Value);
 
 			var text =
 				$@"

src/DocGenerator/SyntaxNodeExtensions.cs

@@ -39,7 +39,7 @@ public static bool ShouldBeConvertedToJson(this SyntaxNode node) =>
 		/// </summary>
 		public static bool ShouldBeConvertedToJson(this SyntaxNode node, SyntaxTriviaList leadingTrivia)
 		{
-			if (leadingTrivia == default(SyntaxTriviaList))
+			if (leadingTrivia == default)
 				return false;
 
 			var singleLineCommentIndex = leadingTrivia.IndexOf(SyntaxKind.SingleLineCommentTrivia);
@@ -77,7 +77,10 @@ public static bool TryGetJsonForSyntaxNode(this SyntaxNode node, out string json
 
 			// find the first anonymous object or new object expression
 			var syntax = node.DescendantNodes()
-				.FirstOrDefault(n => n is AnonymousObjectCreationExpressionSyntax || n is ObjectCreationExpressionSyntax || n is LiteralExpressionSyntax);
+				.FirstOrDefault(n =>
+					n is AnonymousObjectCreationExpressionSyntax ||
+					n is ObjectCreationExpressionSyntax ||
+					n is LiteralExpressionSyntax);
 
 			return syntax != null && syntax.ToFullString().TryGetJsonForExpressionSyntax(out json);
 		}
@@ -107,7 +110,7 @@ public static SyntaxNode WithLeadingEndOfLineTrivia(this SyntaxNode node)
 		public static string ToFullStringWithoutPragmaWarningDirectiveTrivia(this SyntaxNode node)
 		{
 			var pragma = node.DescendantTrivia(s => true, true).Where(t => t.IsKind(SyntaxKind.PragmaWarningDirectiveTrivia));
-			return node.ReplaceTrivia(pragma, (s, r) => default(SyntaxTrivia)).ToFullString();
+			return node.ReplaceTrivia(pragma, (s, r) => default).ToFullString();
 		}
 	}
 }