Adds support for URLs on relationships.

coldacid · Feb 25, 2020 · 450e31b · 450e31b
1 parent c4d6e0d
commit 450e31b
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 1 deletion.
diff --git a/Structurizr.Core.Tests/Model/RelationshipTests.cs b/Structurizr.Core.Tests/Model/RelationshipTests.cs
@@ -1,4 +1,5 @@
-using Xunit;
+using System;
+using Xunit;
 
 namespace Structurizr.Core.Tests
 {
@@ -82,6 +83,43 @@ public void test_Tags_IncludesTheInteractionStyleWhenSpecified()
             Assert.False(relationship.Tags.Contains(Tags.Synchronous));
             Assert.True(relationship.Tags.Contains(Tags.Asynchronous));
         }
+
+        [Fact]
+        public void Test_SetUrl_DoesNotThrowAnException_WhenANullUrlIsSpecified()
+        {
+            Relationship relationship = _softwareSystem1.Uses(_softwareSystem2, "Uses 1", "Technology");
+            relationship.Url = null;
+        }
+
+        [Fact]
+        public void Test_SetUrl_DoesNotThrowAnException_WhenAnEmptyUrlIsSpecified()
+        {
+            Relationship relationship = _softwareSystem1.Uses(_softwareSystem2, "Uses 1", "Technology");
+            relationship.Url = "";
+        }
+
+        [Fact]
+        public void Test_SetUrl_ThrowsAnException_WhenAnInvalidUrlIsSpecified()
+        {
+            try
+            {
+                Relationship relationship = _softwareSystem1.Uses(_softwareSystem2, "Uses 1", "Technology");
+                relationship.Url = "www.somedomain.com";
+                throw new TestFailedException();
+            }
+            catch (Exception e)
+            {
+                Assert.Equal("www.somedomain.com is not a valid URL.", e.Message);
+            }
+        }
+
+        [Fact]
+        public void Test_SetUrl_DoesNotThrowAnException_WhenAValidUrlIsSpecified()
+        {
+            Relationship relationship = _softwareSystem1.Uses(_softwareSystem2, "Uses 1", "Technology");
+            relationship.Url = "http://www.somedomain.com";
+            Assert.Equal("http://www.somedomain.com", relationship.Url);
+        }
 
     }
 }
diff --git a/Structurizr.Core/Model/Relationship.cs b/Structurizr.Core/Model/Relationship.cs
@@ -110,6 +110,35 @@ public InteractionStyle InteractionStyle
                 _interactionStyle = value;
             }
         }
+
+        private string _url;
+
+        /// <summary>
+        /// The URL where more information about this relationship can be found.
+        /// </summary>
+        [DataMember(Name = "url", EmitDefaultValue = false)]
+        public string Url
+        {
+            get
+            {
+                return _url;
+            }
+
+            set
+            {
+                if (value != null && value.Trim().Length > 0)
+                {
+                    if (Util.Url.IsUrl(value))
+                    { 
+                        this._url = value;
+                    }
+                    else
+                    {
+                        throw new ArgumentException(value + " is not a valid URL.");
+                    }
+                }
+            }
+        }
 
         internal Relationship()
         {

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,7 @@
 - Added A1 and A0 paper sizes.
 - Adds support for themes.
 - Adds support for tags on deployment nodes.
+- Adds support for URLs on relationships.
 
 ## 0.9.5 (24th December 2019)