Merge pull request #19 from ParticularLabs/load-from-uri

SzymonPobiega · web-flow · commit 9fb99eccb3ff · 2017-01-27T13:35:36.000+01:00
Allow uri configuration for routing file path
diff --git a/src/NServiceBus.FileBasedRouting.Tests/XmlRoutingFileAccessTests.cs b/src/NServiceBus.FileBasedRouting.Tests/XmlRoutingFileAccessTests.cs
@@ -10,7 +10,7 @@ public class XmlRoutingFileAccessTests
         [Test]
         public void Should_throw_when_file_not_found()
         {
-            var fileAccess = new XmlRoutingFileAccess("non-existing.file");
+            var fileAccess = new XmlRoutingFileAccess(new Uri("non-existing.file", UriKind.RelativeOrAbsolute));
 
             Assert.Throws<FileNotFoundException>(() => fileAccess.Read());
         }
@@ -19,7 +19,7 @@ public void Should_throw_when_file_not_found()
         public void Should_return_loaded_document()
         {
             var fileName = "hello-world.xml";
-            var fileAccess = new XmlRoutingFileAccess(fileName);
+            var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));
 
             File.WriteAllText(fileName, "<greeting>Hello World!</greeting>");
             try
@@ -38,7 +38,7 @@ public void Should_return_loaded_document()
         public void Should_load_valid_xml_content()
         {
             var fileName = "hello-world.html";
-            var fileAccess = new XmlRoutingFileAccess(fileName);
+            var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));
 
             File.WriteAllText(fileName, "<h1>Hello World!</h1>");
             try
@@ -57,7 +57,7 @@ public void Should_load_valid_xml_content()
         public void Should_throw_when_file_contains_no_xml_content()
         {
             var fileName = "hello-world.txt";
-            var fileAccess = new XmlRoutingFileAccess(fileName);
+            var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));
 
             File.WriteAllText(fileName, "Hello World!");
             try
diff --git a/src/NServiceBus.FileBasedRouting/FileBasedRoutingConfigExtensions.cs b/src/NServiceBus.FileBasedRouting/FileBasedRoutingConfigExtensions.cs
@@ -1,4 +1,5 @@
 ﻿using NServiceBus.Configuration.AdvanceExtensibility;
+using System;
 
 namespace NServiceBus.FileBasedRouting
 {
@@ -22,7 +23,17 @@ public static void UseFileBasedRouting(this RoutingSettings config)
         /// <param name="configurationFilePath">The path to the configuration file.</param>
         public static void UseFileBasedRouting(this RoutingSettings config, string configurationFilePath)
         {
-            config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFilePath);
+            config.UseFileBasedRouting(UriHelper.FilePathToUri(configurationFilePath));
+        }
+
+        /// <summary>
+        /// Enables routing configured with the routing configuration file under <paramref name="configurationFileUri"/>
+        /// </summary>
+        /// <param name="config">The configuration object.</param>
+        /// <param name="configurationFileUri">The <see cref="Uri"/> to the configuration file.</param>
+        public static void UseFileBasedRouting(this RoutingSettings config, Uri configurationFileUri)
+        {
+            config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFileUri);
             config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();
         }
     }
diff --git a/src/NServiceBus.FileBasedRouting/FileBasedRoutingFeature.cs b/src/NServiceBus.FileBasedRouting/FileBasedRoutingFeature.cs
@@ -5,23 +5,21 @@
 using NServiceBus.Features;
 using NServiceBus.Routing;
 using NServiceBus.Transport;
+using NServiceBus.Logging;
 
 namespace NServiceBus.FileBasedRouting
 {
-    using System.IO;
-    using Logging;
-
     class FileBasedRoutingFeature : Feature
     {
         static ILog log = LogManager.GetLogger<FileBasedRoutingFeature>();
 
-        public const string RoutingFilePathKey = "NServiceBus.FileBasedRouting.RoutingFilePath";
+        public const string RoutingFilePathKey = "NServiceBus.FileBasedRouting.RoutingFileUri";
 
         public FileBasedRoutingFeature()
         {
             Defaults(s=>
             {
-                s.SetDefault(RoutingFilePathKey, "endpoints.xml");
+                s.SetDefault(RoutingFilePathKey, UriHelper.FilePathToUri("endpoints.xml"));
                 s.SetDefault<UnicastSubscriberTable>(new UnicastSubscriberTable());
             });
         }
@@ -33,8 +31,8 @@ protected override void Setup(FeatureConfigurationContext context)
             var unicastRoutingTable = context.Settings.Get<UnicastRoutingTable>();
             var unicastSubscriberTable = context.Settings.Get<UnicastSubscriberTable>();
 
-            var routingFilePath = GetRoutingFilePath(context);
-            var routingFile = new XmlRoutingFileAccess(routingFilePath);
+            var routingFileUri = context.Settings.Get<Uri>(RoutingFilePathKey);
+            var routingFile = new XmlRoutingFileAccess(routingFileUri);
             var routingFileParser = new XmlRoutingFileParser();
 
             var nativeSends = transportInfrastructure.OutboundRoutingPolicy.Sends == OutboundRoutingType.Multicast;
@@ -61,12 +59,6 @@ protected override void Setup(FeatureConfigurationContext context)
             }
         }
 
-        static string GetRoutingFilePath(FeatureConfigurationContext context)
-        {
-            var configuredRoutingFilePath = context.Settings.Get<string>(RoutingFilePathKey);
-            return Path.IsPathRooted(configuredRoutingFilePath) ? configuredRoutingFilePath : Path.Combine(AppDomain.CurrentDomain.BaseDirectory, configuredRoutingFilePath);
-        }
-
         static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutingFileAccess routingFile, UnicastRoutingTable routingTable, UnicastSubscriberTable subscriberTable, bool nativeSends, bool nativePublishes)
         {
             var endpoints = routingFileParser.Parse(routingFile.Read());
@@ -81,7 +73,7 @@ static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutin
                 {
                     if (nativeSends)
                     {
-                        log.Warn($"Selected transport uses native command routing. Route for {commandType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FilePath} will be ignored.");
+                        log.Warn($"Selected transport uses native command routing. Route for {commandType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FileUri} will be ignored.");
                     }
                     commandRoutes.Add(new RouteTableEntry(commandType, route));
                 }
@@ -90,7 +82,7 @@ static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutin
                 {
                     if (nativePublishes)
                     {
-                        log.Warn($"Selected transport uses native event routing. Route for {eventType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FilePath} will be ignored.");
+                        log.Warn($"Selected transport uses native event routing. Route for {eventType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FileUri} will be ignored.");
                     }
                     eventRoutes.Add(new RouteTableEntry(eventType, route));
                 }
diff --git a/src/NServiceBus.FileBasedRouting/NServiceBus.FileBasedRouting.csproj b/src/NServiceBus.FileBasedRouting/NServiceBus.FileBasedRouting.csproj
@@ -47,6 +47,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="UriHelper.cs" />
     <Compile Include="XmlRoutingFileAccess.cs" />
     <Compile Include="UnicastRouteGroup.cs" />
     <Compile Include="EndpointRoutingConfiguration.cs" />
diff --git a/src/NServiceBus.FileBasedRouting/UriHelper.cs b/src/NServiceBus.FileBasedRouting/UriHelper.cs
@@ -0,0 +1,16 @@
+﻿namespace NServiceBus.FileBasedRouting
+{
+    using System;
+    using System.IO;
+
+    class UriHelper
+    {
+        public static Uri FilePathToUri(string filePath)
+        {
+            var absoluteFilePath = Path.IsPathRooted(filePath)
+                ? filePath
+                : Path.Combine(AppDomain.CurrentDomain.BaseDirectory, filePath);
+            return new Uri(absoluteFilePath, UriKind.Absolute);
+        }
+    }
+}
diff --git a/src/NServiceBus.FileBasedRouting/XmlRoutingFileAccess.cs b/src/NServiceBus.FileBasedRouting/XmlRoutingFileAccess.cs
@@ -1,27 +1,23 @@
 ﻿namespace NServiceBus.FileBasedRouting
 {
     using System;
-    using System.IO;
     using System.Xml;
     using System.Xml.Linq;
 
     class XmlRoutingFileAccess
     {
-        public string FilePath { get; }
+        public Uri FileUri { get; }
 
-        public XmlRoutingFileAccess(string filePath)
+        public XmlRoutingFileAccess(Uri fileUri)
         {
-            FilePath = filePath;
+            FileUri = fileUri;
         }
 
         public XDocument Read()
         {
             try
             {
-                using (var fileStream = File.OpenRead(FilePath))
-                {
-                    return XDocument.Load(fileStream);
-                }
+                return XDocument.Load(FileUri.ToString());
             }
             catch (XmlException e)
             {

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class XmlRoutingFileAccessTests`
`10`	`10`	`[Test]`
`11`	`11`	`public void Should_throw_when_file_not_found()`
`12`	`12`	`{`
`13`		`- var fileAccess = new XmlRoutingFileAccess("non-existing.file");`
	`13`	`+ var fileAccess = new XmlRoutingFileAccess(new Uri("non-existing.file", UriKind.RelativeOrAbsolute));`
`14`	`14`
`15`	`15`	`Assert.Throws<FileNotFoundException>(() => fileAccess.Read());`
`16`	`16`	`}`
`@@ -19,7 +19,7 @@ public void Should_throw_when_file_not_found()`
`19`	`19`	`public void Should_return_loaded_document()`
`20`	`20`	`{`
`21`	`21`	`var fileName = "hello-world.xml";`
`22`		`- var fileAccess = new XmlRoutingFileAccess(fileName);`
	`22`	`+ var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));`
`23`	`23`
`24`	`24`	`File.WriteAllText(fileName, "<greeting>Hello World!</greeting>");`
`25`	`25`	`try`
`@@ -38,7 +38,7 @@ public void Should_return_loaded_document()`
`38`	`38`	`public void Should_load_valid_xml_content()`
`39`	`39`	`{`
`40`	`40`	`var fileName = "hello-world.html";`
`41`		`- var fileAccess = new XmlRoutingFileAccess(fileName);`
	`41`	`+ var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));`
`42`	`42`
`43`	`43`	`File.WriteAllText(fileName, "<h1>Hello World!</h1>");`
`44`	`44`	`try`
`@@ -57,7 +57,7 @@ public void Should_load_valid_xml_content()`
`57`	`57`	`public void Should_throw_when_file_contains_no_xml_content()`
`58`	`58`	`{`
`59`	`59`	`var fileName = "hello-world.txt";`
`60`		`- var fileAccess = new XmlRoutingFileAccess(fileName);`
	`60`	`+ var fileAccess = new XmlRoutingFileAccess(new Uri(fileName, UriKind.RelativeOrAbsolute));`
`61`	`61`
`62`	`62`	`File.WriteAllText(fileName, "Hello World!");`
`63`	`63`	`try`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using NServiceBus.Configuration.AdvanceExtensibility;`
	`2`	`+using System;`
`2`	`3`
`3`	`4`	`namespace NServiceBus.FileBasedRouting`
`4`	`5`	`{`
`@@ -22,7 +23,17 @@ public static void UseFileBasedRouting(this RoutingSettings config)`
`22`	`23`	`/// <param name="configurationFilePath">The path to the configuration file.</param>`
`23`	`24`	`public static void UseFileBasedRouting(this RoutingSettings config, string configurationFilePath)`
`24`	`25`	`{`
`25`		`- config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFilePath);`
	`26`	`+ config.UseFileBasedRouting(UriHelper.FilePathToUri(configurationFilePath));`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ /// <summary>`
	`30`	`+ /// Enables routing configured with the routing configuration file under <paramref name="configurationFileUri"/>`
	`31`	`+ /// </summary>`
	`32`	`+ /// <param name="config">The configuration object.</param>`
	`33`	`+ /// <param name="configurationFileUri">The <see cref="Uri"/> to the configuration file.</param>`
	`34`	`+ public static void UseFileBasedRouting(this RoutingSettings config, Uri configurationFileUri)`
	`35`	`+ {`
	`36`	`+ config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFileUri);`
`26`	`37`	`config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();`
`27`	`38`	`}`
`28`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,23 +5,21 @@`
`5`	`5`	`using NServiceBus.Features;`
`6`	`6`	`using NServiceBus.Routing;`
`7`	`7`	`using NServiceBus.Transport;`
	`8`	`+using NServiceBus.Logging;`
`8`	`9`
`9`	`10`	`namespace NServiceBus.FileBasedRouting`
`10`	`11`	`{`
`11`		`- using System.IO;`
`12`		`- using Logging;`
`13`		`-`
`14`	`12`	`class FileBasedRoutingFeature : Feature`
`15`	`13`	`{`
`16`	`14`	`static ILog log = LogManager.GetLogger<FileBasedRoutingFeature>();`
`17`	`15`
`18`		`- public const string RoutingFilePathKey = "NServiceBus.FileBasedRouting.RoutingFilePath";`
	`16`	`+ public const string RoutingFilePathKey = "NServiceBus.FileBasedRouting.RoutingFileUri";`
`19`	`17`
`20`	`18`	`public FileBasedRoutingFeature()`
`21`	`19`	`{`
`22`	`20`	`Defaults(s=>`
`23`	`21`	`{`
`24`		`- s.SetDefault(RoutingFilePathKey, "endpoints.xml");`
	`22`	`+ s.SetDefault(RoutingFilePathKey, UriHelper.FilePathToUri("endpoints.xml"));`
`25`	`23`	`s.SetDefault<UnicastSubscriberTable>(new UnicastSubscriberTable());`
`26`	`24`	`});`
`27`	`25`	`}`
`@@ -33,8 +31,8 @@ protected override void Setup(FeatureConfigurationContext context)`
`33`	`31`	`var unicastRoutingTable = context.Settings.Get<UnicastRoutingTable>();`
`34`	`32`	`var unicastSubscriberTable = context.Settings.Get<UnicastSubscriberTable>();`
`35`	`33`
`36`		`- var routingFilePath = GetRoutingFilePath(context);`
`37`		`- var routingFile = new XmlRoutingFileAccess(routingFilePath);`
	`34`	`+ var routingFileUri = context.Settings.Get<Uri>(RoutingFilePathKey);`
	`35`	`+ var routingFile = new XmlRoutingFileAccess(routingFileUri);`
`38`	`36`	`var routingFileParser = new XmlRoutingFileParser();`
`39`	`37`
`40`	`38`	`var nativeSends = transportInfrastructure.OutboundRoutingPolicy.Sends == OutboundRoutingType.Multicast;`
`@@ -61,12 +59,6 @@ protected override void Setup(FeatureConfigurationContext context)`
`61`	`59`	`}`
`62`	`60`	`}`
`63`	`61`
`64`		`- static string GetRoutingFilePath(FeatureConfigurationContext context)`
`65`		`- {`
`66`		`- var configuredRoutingFilePath = context.Settings.Get<string>(RoutingFilePathKey);`
`67`		`- return Path.IsPathRooted(configuredRoutingFilePath) ? configuredRoutingFilePath : Path.Combine(AppDomain.CurrentDomain.BaseDirectory, configuredRoutingFilePath);`
`68`		`- }`
`69`		`-`
`70`	`62`	`static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutingFileAccess routingFile, UnicastRoutingTable routingTable, UnicastSubscriberTable subscriberTable, bool nativeSends, bool nativePublishes)`
`71`	`63`	`{`
`72`	`64`	`var endpoints = routingFileParser.Parse(routingFile.Read());`
`@@ -81,7 +73,7 @@ static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutin`
`81`	`73`	`{`
`82`	`74`	`if (nativeSends)`
`83`	`75`	`{`
`84`		`- log.Warn($"Selected transport uses native command routing. Route for {commandType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FilePath} will be ignored.");`
	`76`	`+ log.Warn($"Selected transport uses native command routing. Route for {commandType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FileUri} will be ignored.");`
`85`	`77`	`}`
`86`	`78`	`commandRoutes.Add(new RouteTableEntry(commandType, route));`
`87`	`79`	`}`
`@@ -90,7 +82,7 @@ static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutin`
`90`	`82`	`{`
`91`	`83`	`if (nativePublishes)`
`92`	`84`	`{`
`93`		`- log.Warn($"Selected transport uses native event routing. Route for {eventType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FilePath} will be ignored.");`
	`85`	`+ log.Warn($"Selected transport uses native event routing. Route for {eventType.FullName} to {endpoint.LogicalEndpointName} configured in {routingFile.FileUri} will be ignored.");`
`94`	`86`	`}`
`95`	`87`	`eventRoutes.Add(new RouteTableEntry(eventType, route));`
`96`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,27 +1,23 @@`
`1`	`1`	`namespace NServiceBus.FileBasedRouting`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`		`- using System.IO;`
`5`	`4`	`using System.Xml;`
`6`	`5`	`using System.Xml.Linq;`
`7`	`6`
`8`	`7`	`class XmlRoutingFileAccess`
`9`	`8`	`{`
`10`		`- public string FilePath { get; }`
	`9`	`+ public Uri FileUri { get; }`
`11`	`10`
`12`		`- public XmlRoutingFileAccess(string filePath)`
	`11`	`+ public XmlRoutingFileAccess(Uri fileUri)`
`13`	`12`	`{`
`14`		`- FilePath = filePath;`
	`13`	`+ FileUri = fileUri;`
`15`	`14`	`}`
`16`	`15`
`17`	`16`	`public XDocument Read()`
`18`	`17`	`{`
`19`	`18`	`try`
`20`	`19`	`{`
`21`		`- using (var fileStream = File.OpenRead(FilePath))`
`22`		`- {`
`23`		`- return XDocument.Load(fileStream);`
`24`		`- }`
	`20`	`+ return XDocument.Load(FileUri.ToString());`
`25`	`21`	`}`
`26`	`22`	`catch (XmlException e)`
`27`	`23`	`{`