You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2020/06/30 21:58:55 UTC

[lucenenet] 08/09: Lucene.Net.TestFramework: Reuse inbuilt environment variable provider rather than our stock one, that is only meant as a logical default.

This is an automated email from the ASF dual-hosted git repository.

nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git

commit 5de2f4c39d5698727e6cc80a61bfbe1d8edaca1f
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Tue Jun 30 22:52:26 2020 +0700

    Lucene.Net.TestFramework: Reuse inbuilt environment variable provider rather than our stock one, that is only meant as a logical default.
---
 .../ConfigurationBuilderExtensions.cs              | 55 +++++++++++-----------
 .../Configuration/TestConfigurationFactory.cs      |  2 +-
 2 files changed, 28 insertions(+), 29 deletions(-)

diff --git a/src/Lucene.Net.TestFramework/Support/Configuration/ConfigurationBuilderExtensions.cs b/src/Lucene.Net.TestFramework/Support/Configuration/ConfigurationBuilderExtensions.cs
index 53a0b54..a30fdd1 100644
--- a/src/Lucene.Net.TestFramework/Support/Configuration/ConfigurationBuilderExtensions.cs
+++ b/src/Lucene.Net.TestFramework/Support/Configuration/ConfigurationBuilderExtensions.cs
@@ -28,40 +28,35 @@ namespace Lucene.Net.Configuration
     /// </summary>
     public static class ConfigurationBuilderExtensions
     {
-
         /// <summary>
-        /// Helper Extension method to add a LuceneDefaultConfigurationSource
+        /// Helper Extension method to add a <see cref="TestParameterConfigurationSource"/>
+        /// Uses the <see cref="NUnit.Framework.TestContext.Parameters"/> to build provider.
         /// </summary>
-        /// <param name="configurationBuilder"></param>
-        /// <param name="prefix">A prefix used to filter the environment variables.</param>
-        /// <returns></returns>
+        /// <param name="builder">This <see cref="IConfigurationBuilder"/>.</param>
+        /// <returns>This <see cref="IConfigurationBuilder"/>.</returns>
         [CLSCompliant(false)]
-        public static IConfigurationBuilder AddLuceneDefaultSettings(this IConfigurationBuilder configurationBuilder, string prefix)
+        public static IConfigurationBuilder AddNUnitTestRunSettings(this IConfigurationBuilder builder)
         {
-            return configurationBuilder.Add(new LuceneDefaultConfigurationSource() { Prefix = prefix });
-        }
-        /// <summary>
-        /// Helper Extension method to add a TestParameterConfigurationSource
-        /// Uses the NUnit.Framework.TestContext.Parameters to build provider
-        /// </summary>
-        /// <param name="configurationBuilder"></param>
-        /// <returns></returns>
-        [CLSCompliant(false)]
-        public static IConfigurationBuilder AddNUnitTestRunSettings(this IConfigurationBuilder configurationBuilder)
-        {
-            return configurationBuilder.Add(new TestParameterConfigurationSource() { TestParameters = NUnit.Framework.TestContext.Parameters });
+            if (builder == null)
+                throw new ArgumentNullException(nameof(builder));
+
+            return builder.Add(new TestParameterConfigurationSource() { TestParameters = NUnit.Framework.TestContext.Parameters });
         }
 
         /// <summary>
-        /// Scans from currentPath to the root directory looking for fileName configuration settings. This loads a Json Configuration provider in ascending hierarchy.
+        /// Scans from <paramref name="currentPath"/> to the root directory looking for <paramref name="fileName"/> configuration settings.
+        /// This loads a Json Configuration provider in ascending hierarchy.
         /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="currentPath">The current path to start in</param>
-        /// <param name="fileName">The filename to be searched for</param>
-        /// <returns></returns>
+        /// <param name="builder">This <see cref="IConfigurationBuilder"/>.</param>
+        /// <param name="currentPath">The current path to start in.</param>
+        /// <param name="fileName">The filename to be searched for.</param>
+        /// <returns>This <see cref="IConfigurationBuilder"/>.</returns>
         [CLSCompliant(false)]
         public static IConfigurationBuilder AddJsonFilesFromRootDirectoryTo(this IConfigurationBuilder builder, string currentPath, string fileName)
         {
+            if (builder == null)
+                throw new ArgumentNullException(nameof(builder));
+
             Stack<string> locations = ScanConfigurationFiles(currentPath, fileName);
 
             while (locations.Count != 0)
@@ -72,15 +67,19 @@ namespace Lucene.Net.Configuration
         }
 
         /// <summary>
-        /// Scans from currentPath to the root directory looking for fileName configuration settings. This loads a XML Configuration provider in ascending hierarchy.
+        /// Scans from <paramref name="currentPath"/> to the root directory looking for <paramref name="fileName"/> configuration settings.
+        /// This loads a XML Configuration provider in ascending hierarchy.
         /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="currentPath">The current path to start in</param>
-        /// <param name="fileName">The filename to be searched for</param>
-        /// <returns></returns>
+        /// <param name="builder">This <see cref="IConfigurationBuilder"/>.</param>
+        /// <param name="currentPath">The current path to start in.</param>
+        /// <param name="fileName">The filename to be searched for.</param>
+        /// <returns>This <see cref="IConfigurationBuilder"/>.</returns>
         [CLSCompliant(false)]
         public static IConfigurationBuilder AddXmlFilesFromRootDirectoryTo(this IConfigurationBuilder builder, string currentPath, string fileName)
         {
+            if (builder == null)
+                throw new ArgumentNullException(nameof(builder));
+
             Stack<string> locations = ScanConfigurationFiles(currentPath, fileName);
 
             while (locations.Count != 0)
diff --git a/src/Lucene.Net.TestFramework/Support/Configuration/TestConfigurationFactory.cs b/src/Lucene.Net.TestFramework/Support/Configuration/TestConfigurationFactory.cs
index 2f8a7cb..eec42bd 100644
--- a/src/Lucene.Net.TestFramework/Support/Configuration/TestConfigurationFactory.cs
+++ b/src/Lucene.Net.TestFramework/Support/Configuration/TestConfigurationFactory.cs
@@ -56,7 +56,7 @@ namespace Lucene.Net.Configuration
             return configurationCache.GetOrAdd(testDirectory, (key) =>
             {
                 return new ConfigurationBuilder()
-                    .AddLuceneDefaultSettings(EnvironmentVariablePrefix) // Use a custom prefix to only load Lucene.NET settings
+                    .AddEnvironmentVariables(EnvironmentVariablePrefix) // Use a custom prefix to only load Lucene.NET settings
                     .AddJsonFilesFromRootDirectoryTo(currentPath: key, JsonTestSettingsFileName)
 #if TESTFRAMEWORK_NUNIT
                     .AddNUnitTestRunSettings()