Adding a task that allows deleting files from an HTTP web server

pvandervelde · pvandervelde · commit 5626fd21fe49 · 2017-07-13T09:03:38.000+12:00
references #312
diff --git a/src/nbuildkit/actions/shared.errorcodes.props b/src/nbuildkit/actions/shared.errorcodes.props
@@ -179,7 +179,7 @@
         <NBuildKitErrorCodeCopyToHttpNoFiles>NBK1527</NBuildKitErrorCodeCopyToHttpNoFiles>
 
         <NBuildKitErrorIdDeleteFromHttpUrlMissing>NBuildKit.WebDelete.UrlMissing</NBuildKitErrorIdDeleteFromHttpUrlMissing>
-        <NBuildKitErrorCodeCopyToHttpUrlMissing>NBK1528</NBuildKitErrorCodeDeleteFromHttpUrlMissing>
+        <NBuildKitErrorCodeDeleteFromHttpUrlMissing>NBK1528</NBuildKitErrorCodeDeleteFromHttpUrlMissing>
 
         <NBuildKitErrorIdDeleteFromHttpUrlInvalid>NBuildKit.WebDelete.UrlInvalid</NBuildKitErrorIdDeleteFromHttpUrlInvalid>
         <NBuildKitErrorCodeDeleteFromHttpUrlInvalid>NBK1529</NBuildKitErrorCodeDeleteFromHttpUrlInvalid>
diff --git a/src/nbuildkit/tasks/Test.Unit.MsBuild.Tasks/Web/WebDeleteTest.cs b/src/nbuildkit/tasks/Test.Unit.MsBuild.Tasks/Web/WebDeleteTest.cs
@@ -28,18 +28,17 @@ public sealed class WebDeleteTest : TaskTest
         [Test]
         public void Execute()
         {
-            var fileToUpload = Assembly.GetExecutingAssembly().LocalFilePath();
+            var fileToDelete = Assembly.GetExecutingAssembly().LocalFilePath();
 
             var targetUri = "http://www.example.com/mypath";
 
             var webClient = new Mock<IInternalWebClient>();
             {
-                webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))
-                    .Callback<Uri, string, string>(
-                        (uri, method, path) =>
+                webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))
+                    .Callback<Uri>(
+                        (uri) =>
                         {
-                            Assert.AreEqual(new Uri(targetUri + "/" + Path.GetFileName(path)), uri);
-                            Assert.AreEqual(fileToUpload, path);
+                            Assert.AreEqual(new Uri(targetUri + "/" + Path.GetFileName(fileToDelete)), uri);
                         })
                     .Returns(new byte[0])
                     .Verifiable();
@@ -51,26 +50,26 @@ public void Execute()
 
             var task = new WebDelete(builder);
             task.BuildEngine = BuildEngine.Object;
-            task.Items = new ITaskItem[] { new TaskItem(fileToUpload) };
+            task.Items = new ITaskItem[] { new TaskItem(fileToDelete) };
             task.Source = new TaskItem(targetUri);
             task.UseDefaultCredentials = false;
 
             var result = task.Execute();
             Assert.IsTrue(result, "Expected the task to finish successfully");
 
-            webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Once());
+            webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Once());
 
             VerifyNumberOfLogMessages(numberOfErrorMessages: 0, numberOfWarningMessages: 0, numberOfNormalMessages: 3);
         }
 
         [Test]
         public void ExecuteWithEmptyUrl()
         {
-            var fileToUpload = Assembly.GetExecutingAssembly().LocalFilePath();
+            var fileToDelete = Assembly.GetExecutingAssembly().LocalFilePath();
 
             var webClient = new Mock<IInternalWebClient>();
             {
-                webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))
+                webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))
                     .Verifiable();
             }
 
@@ -80,14 +79,14 @@ public void ExecuteWithEmptyUrl()
 
             var task = new WebDelete(builder);
             task.BuildEngine = BuildEngine.Object;
-            task.Items = new ITaskItem[] { new TaskItem(fileToUpload) };
+            task.Items = new ITaskItem[] { new TaskItem(fileToDelete) };
             task.Source = new TaskItem(string.Empty);
             task.UseDefaultCredentials = false;
 
             var result = task.Execute();
             Assert.IsFalse(result, "Expected the task to not finish successfully");
 
-            webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());
+            webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());
 
             VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);
         }
@@ -99,7 +98,7 @@ public void ExecuteWithInvalidUrl()
 
             var webClient = new Mock<IInternalWebClient>();
             {
-                webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))
+                webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))
                     .Verifiable();
             }
 
@@ -116,7 +115,7 @@ public void ExecuteWithInvalidUrl()
             var result = task.Execute();
             Assert.IsFalse(result, "Expected the task to not finish successfully");
 
-            webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());
+            webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());
 
             VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);
         }
@@ -126,7 +125,7 @@ public void ExecuteWithoutItems()
         {
             var webClient = new Mock<IInternalWebClient>();
             {
-                webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))
+                webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))
                     .Verifiable();
             }
 
@@ -143,7 +142,7 @@ public void ExecuteWithoutItems()
             var result = task.Execute();
             Assert.IsFalse(result, "Expected the task to not finish successfully");
 
-            webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());
+            webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());
 
             VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);
         }
@@ -155,7 +154,7 @@ public void ExecuteWithoutUrl()
 
             var webClient = new Mock<IInternalWebClient>();
             {
-                webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))
+                webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))
                     .Verifiable();
             }
 
@@ -171,7 +170,7 @@ public void ExecuteWithoutUrl()
             var result = task.Execute();
             Assert.IsFalse(result, "Expected the task to not finish successfully");
 
-            webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());
+            webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());
 
             VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);
         }
diff --git a/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/IInternalWebClient.cs b/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/IInternalWebClient.cs
@@ -27,6 +27,13 @@ public interface IInternalWebClient : IDisposable
         /// <param name="fileName">The name of the local file that is to receive the data.</param>
         void DownloadFile(Uri address, string fileName);
 
+        /// <summary>
+        /// Deletes the specific file from the remote file server.
+        /// </summary>
+        /// <param name="address">The URI of the resource that should be removed. For example http://localhost/samplefile.txt</param>
+        /// <returns>The response of the server.</returns>
+        byte[] DeleteFile(Uri address);
+
         /// <summary>
         /// Uploads the specified local file to a resource with the specified URI.
         /// </summary>
diff --git a/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/InternalWebClient.cs b/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/InternalWebClient.cs
@@ -22,6 +22,16 @@ public InternalWebClient(bool forUploads = false)
             _forUploads = forUploads;
         }
 
+        /// <summary>
+        /// Deletes the specific file from the remote file server.
+        /// </summary>
+        /// <param name="address">The URI of the resource that should be removed. For example http://localhost/samplefile.txt</param>
+        /// <returns>The response of the server.</returns>
+        public byte[] DeleteFile(Uri address)
+        {
+            return UploadData(address, "DELETE", new byte[0]);
+        }
+
         protected override WebRequest GetWebRequest(Uri uri)
         {
             var webRequest = base.GetWebRequest(uri);
diff --git a/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/WebDelete.cs b/src/nbuildkit/tasks/nBuildKit.MsBuild.Tasks/Web/WebDelete.cs
@@ -161,7 +161,7 @@ public override bool Execute()
                             MessageImportance.Normal,
                             "Deleting from: {0}",
                             targetUri);
-                        var response = client.UploadFile(targetUri, "DELETE", itemPath);
+                        var response = client.DeleteFile(targetUri);
                         var responseText = System.Text.Encoding.ASCII.GetString(response);
                         Log.LogMessage(
                             MessageImportance.Normal,

Original file line number	Diff line number	Diff line change
`@@ -28,18 +28,17 @@ public sealed class WebDeleteTest : TaskTest`
`28`	`28`	`[Test]`
`29`	`29`	`public void Execute()`
`30`	`30`	`{`
`31`		`- var fileToUpload = Assembly.GetExecutingAssembly().LocalFilePath();`
	`31`	`+ var fileToDelete = Assembly.GetExecutingAssembly().LocalFilePath();`
`32`	`32`
`33`	`33`	`var targetUri = "http://www.example.com/mypath";`
`34`	`34`
`35`	`35`	`var webClient = new Mock<IInternalWebClient>();`
`36`	`36`	`{`
`37`		`- webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))`
`38`		`- .Callback<Uri, string, string>(`
`39`		`- (uri, method, path) =>`
	`37`	`+ webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))`
	`38`	`+ .Callback<Uri>(`
	`39`	`+ (uri) =>`
`40`	`40`	`{`
`41`		`- Assert.AreEqual(new Uri(targetUri + "/" + Path.GetFileName(path)), uri);`
`42`		`- Assert.AreEqual(fileToUpload, path);`
	`41`	`+ Assert.AreEqual(new Uri(targetUri + "/" + Path.GetFileName(fileToDelete)), uri);`
`43`	`42`	`})`
`44`	`43`	`.Returns(new byte[0])`
`45`	`44`	`.Verifiable();`
`@@ -51,26 +50,26 @@ public void Execute()`
`51`	`50`
`52`	`51`	`var task = new WebDelete(builder);`
`53`	`52`	`task.BuildEngine = BuildEngine.Object;`
`54`		`- task.Items = new ITaskItem[] { new TaskItem(fileToUpload) };`
	`53`	`+ task.Items = new ITaskItem[] { new TaskItem(fileToDelete) };`
`55`	`54`	`task.Source = new TaskItem(targetUri);`
`56`	`55`	`task.UseDefaultCredentials = false;`
`57`	`56`
`58`	`57`	`var result = task.Execute();`
`59`	`58`	`Assert.IsTrue(result, "Expected the task to finish successfully");`
`60`	`59`
`61`		`- webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Once());`
	`60`	`+ webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Once());`
`62`	`61`
`63`	`62`	`VerifyNumberOfLogMessages(numberOfErrorMessages: 0, numberOfWarningMessages: 0, numberOfNormalMessages: 3);`
`64`	`63`	`}`
`65`	`64`
`66`	`65`	`[Test]`
`67`	`66`	`public void ExecuteWithEmptyUrl()`
`68`	`67`	`{`
`69`		`- var fileToUpload = Assembly.GetExecutingAssembly().LocalFilePath();`
	`68`	`+ var fileToDelete = Assembly.GetExecutingAssembly().LocalFilePath();`
`70`	`69`
`71`	`70`	`var webClient = new Mock<IInternalWebClient>();`
`72`	`71`	`{`
`73`		`- webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))`
	`72`	`+ webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))`
`74`	`73`	`.Verifiable();`
`75`	`74`	`}`
`76`	`75`
`@@ -80,14 +79,14 @@ public void ExecuteWithEmptyUrl()`
`80`	`79`
`81`	`80`	`var task = new WebDelete(builder);`
`82`	`81`	`task.BuildEngine = BuildEngine.Object;`
`83`		`- task.Items = new ITaskItem[] { new TaskItem(fileToUpload) };`
	`82`	`+ task.Items = new ITaskItem[] { new TaskItem(fileToDelete) };`
`84`	`83`	`task.Source = new TaskItem(string.Empty);`
`85`	`84`	`task.UseDefaultCredentials = false;`
`86`	`85`
`87`	`86`	`var result = task.Execute();`
`88`	`87`	`Assert.IsFalse(result, "Expected the task to not finish successfully");`
`89`	`88`
`90`		`- webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());`
	`89`	`+ webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());`
`91`	`90`
`92`	`91`	`VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);`
`93`	`92`	`}`
`@@ -99,7 +98,7 @@ public void ExecuteWithInvalidUrl()`
`99`	`98`
`100`	`99`	`var webClient = new Mock<IInternalWebClient>();`
`101`	`100`	`{`
`102`		`- webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))`
	`101`	`+ webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))`
`103`	`102`	`.Verifiable();`
`104`	`103`	`}`
`105`	`104`
`@@ -116,7 +115,7 @@ public void ExecuteWithInvalidUrl()`
`116`	`115`	`var result = task.Execute();`
`117`	`116`	`Assert.IsFalse(result, "Expected the task to not finish successfully");`
`118`	`117`
`119`		`- webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());`
	`118`	`+ webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());`
`120`	`119`
`121`	`120`	`VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);`
`122`	`121`	`}`
`@@ -126,7 +125,7 @@ public void ExecuteWithoutItems()`
`126`	`125`	`{`
`127`	`126`	`var webClient = new Mock<IInternalWebClient>();`
`128`	`127`	`{`
`129`		`- webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))`
	`128`	`+ webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))`
`130`	`129`	`.Verifiable();`
`131`	`130`	`}`
`132`	`131`
`@@ -143,7 +142,7 @@ public void ExecuteWithoutItems()`
`143`	`142`	`var result = task.Execute();`
`144`	`143`	`Assert.IsFalse(result, "Expected the task to not finish successfully");`
`145`	`144`
`146`		`- webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());`
	`145`	`+ webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());`
`147`	`146`
`148`	`147`	`VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);`
`149`	`148`	`}`
`@@ -155,7 +154,7 @@ public void ExecuteWithoutUrl()`
`155`	`154`
`156`	`155`	`var webClient = new Mock<IInternalWebClient>();`
`157`	`156`	`{`
`158`		`- webClient.Setup(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()))`
	`157`	`+ webClient.Setup(w => w.DeleteFile(It.IsAny<Uri>()))`
`159`	`158`	`.Verifiable();`
`160`	`159`	`}`
`161`	`160`
`@@ -171,7 +170,7 @@ public void ExecuteWithoutUrl()`
`171`	`170`	`var result = task.Execute();`
`172`	`171`	`Assert.IsFalse(result, "Expected the task to not finish successfully");`
`173`	`172`
`174`		`- webClient.Verify(w => w.UploadFile(It.IsAny<Uri>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never());`
	`173`	`+ webClient.Verify(w => w.DeleteFile(It.IsAny<Uri>()), Times.Never());`
`175`	`174`
`176`	`175`	`VerifyNumberOfLogMessages(numberOfErrorMessages: 1, numberOfWarningMessages: 0, numberOfNormalMessages: 0);`
`177`	`176`	`}`