Adds support for the location option (#7)

cake-contrib · Jan 16, 2018 · 0d16203 · 0d16203
1 parent 0e84a47
commit 0d16203
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 0 deletions.
diff --git a/src/Cake.Curl.Tests/CurlDownloadFileTests.cs b/src/Cake.Curl.Tests/CurlDownloadFileTests.cs
@@ -277,6 +277,38 @@ public void Should_Set_The_Request_Command_In_Quotes_And_Upper_Case_As_Argument(
                 // Then
                 Assert.Contains("--request \"COMMAND\"", result.Args);
             }
+
+            [Fact]
+            public void Should_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlDownloadFileFixture
+                {
+                    Settings = { FollowRedirects = true }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Contains("--location", result.Args);
+            }
+
+            [Fact]
+            public void Should_Not_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlDownloadFileFixture
+                {
+                    Settings = { FollowRedirects = false }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.DoesNotContain("--location", result.Args);
+            }
         }
     }
 }
diff --git a/src/Cake.Curl.Tests/CurlDownloadMultipleFilesTests.cs b/src/Cake.Curl.Tests/CurlDownloadMultipleFilesTests.cs
@@ -309,6 +309,38 @@ public void Should_Set_The_Request_Command_In_Quotes_And_Upper_Case_As_Argument(
                 // Then
                 Assert.Contains("--request \"COMMAND\"", result.Args);
             }
+
+            [Fact]
+            public void Should_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlDownloadMultipleFilesFixture
+                {
+                    Settings = { FollowRedirects = true }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Contains("--location", result.Args);
+            }
+
+            [Fact]
+            public void Should_Not_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlDownloadFileFixture
+                {
+                    Settings = { FollowRedirects = false }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.DoesNotContain("--location", result.Args);
+            }
         }
     }
 }
diff --git a/src/Cake.Curl.Tests/CurlUploadFileTests.cs b/src/Cake.Curl.Tests/CurlUploadFileTests.cs
@@ -285,6 +285,38 @@ public void Should_Set_The_Request_Command_In_Quotes_And_Upper_Case_As_Argument(
                 // Then
                 Assert.Contains("--request \"COMMAND\"", result.Args);
             }
+
+            [Fact]
+            public void Should_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlUploadFileFixture
+                {
+                    Settings = { FollowRedirects = true }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Contains("--location", result.Args);
+            }
+
+            [Fact]
+            public void Should_Not_Set_The_Location_Option_As_Argument()
+            {
+                // Given
+                var fixture = new CurlDownloadFileFixture
+                {
+                    Settings = { FollowRedirects = false }
+                };
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.DoesNotContain("--location", result.Args);
+            }
         }
     }
 }
diff --git a/src/Cake.Curl/ArgumentsExtensions.cs b/src/Cake.Curl/ArgumentsExtensions.cs
@@ -42,6 +42,11 @@ internal static void AppendSettings(
                     "--request",
                     settings.RequestCommand.ToUpperInvariant());
             }
+
+            if (settings.FollowRedirects)
+            {
+                arguments.Append("--location");
+            }
         }
     }
 }
diff --git a/src/Cake.Curl/CurlSettings.cs b/src/Cake.Curl/CurlSettings.cs
@@ -62,5 +62,21 @@ public class CurlSettings : ToolSettings
         /// is a far better choice.
         /// </remarks>
         public string RequestCommand { get; set; }
+
+        /// <summary>
+        /// Gets or sets a flag telling curl to follow HTTP redirects.
+        /// </summary>
+        /// <remarks>
+        /// If the remote service responds with a 3xx status code and this flag
+        /// is set to <see langword="true"/>, curl will redo the request
+        /// to the URL found in the <code>Location</code> response header.
+        /// Note that if the remote service responded with a <code>301</code> (<em>Moved Permanently</em>),
+        /// <code>302</code> (<em>Found</em>) or <code>303</code> (<em>See Other</em>) status code,
+        /// curl will redo the request using the <code>GET</code> method, even if the original request
+        /// was using another method (like for example <code>PUT</code> or <code>POST</code>).
+        /// For all other 3xx status codes, curl will redo the request using the same method
+        /// as the one specified in the original request.
+        /// </remarks>
+        public bool FollowRedirects { get; set; }
     }
 }