Hack a way around some serialization related issues

The abstract class only wraps some common functionality on top of the IUpdateTask interface, a consumer can either derive from it or implement the interface himself. Binary serialization saves us a lot of work, but makes implementing a task more of an hassle than it should be, so we might move to a more transient way in the future
phillipp · Jul 3, 2012 · 9c499e8 · 9c499e8
1 parent ed2b72c
commit 9c499e8
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 61 deletions.
diff --git a/src/NAppUpdate.Framework/NAppUpdate.Framework.csproj b/src/NAppUpdate.Framework/NAppUpdate.Framework.csproj
@@ -92,6 +92,7 @@
     <Compile Include="Tasks\IUpdateTask.cs" />
     <Compile Include="Tasks\RegistryTask.cs" />
     <Compile Include="Tasks\UpdateTaskAliasAttribute.cs" />
+    <Compile Include="Tasks\UpdateTaskBase.cs" />
     <Compile Include="UpdateManager.cs" />
     <Compile Include="Utils\FileChecksum.cs" />
     <Compile Include="Utils\FileDownloader.cs" />

diff --git a/src/NAppUpdate.Framework/Tasks/FileUpdateTask.cs b/src/NAppUpdate.Framework/Tasks/FileUpdateTask.cs
@@ -1,19 +1,13 @@
 using System;
 using System.IO;
 using NAppUpdate.Framework.Common;
-using NAppUpdate.Framework.Conditions;
 
 namespace NAppUpdate.Framework.Tasks
 {
 	[Serializable]
     [UpdateTaskAlias("fileUpdate")]
-    public class FileUpdateTask : IUpdateTask
+    public class FileUpdateTask : UpdateTaskBase
     {
-        public FileUpdateTask()
-        {
-			ExecutionStatus = TaskExecutionStatus.Pending;
-        }
-
         [NauField("localPath", "The local path of the file to update", true)]
         public string LocalPath { get; set; }
 
@@ -30,26 +24,9 @@ public FileUpdateTask()
             , false)]
         public bool CanHotSwap { get; set; }
 
-        internal string tempFile;
-        private string destinationFile, backupFile;
+		private string destinationFile, backupFile, tempFile;
 
-        #region IUpdateTask Members
-
-        public string Description { get; set; }
-		public TaskExecutionStatus ExecutionStatus { get; set; }
-
-		[NonSerialized]
-		private BooleanCondition _updateConditions;
-		public BooleanCondition UpdateConditions
-		{
-			get { return _updateConditions ?? (_updateConditions = new BooleanCondition()); }
-			set { _updateConditions = value; }
-		}
-
-		[field:NonSerialized]
-    	public event ReportProgressDelegate OnProgress;
-
-    	public bool Prepare(Sources.IUpdateSource source)
+    	public override bool Prepare(Sources.IUpdateSource source)
         {
             if (string.IsNullOrEmpty(LocalPath))
                 return true; // Errorneous case, but there's nothing to prepare to...
@@ -66,7 +43,7 @@ public bool Prepare(Sources.IUpdateSource source)
             {
                 string tempFileLocal = Path.Combine(UpdateManager.Instance.Config.TempFolder, Guid.NewGuid().ToString());
                 if (!source.GetData(fileName, UpdateManager.Instance.BaseUrl, 
-					p => OnProgress(p),
+					OnProgress,
 					ref tempFileLocal))
                     return false;
 
@@ -87,7 +64,7 @@ public bool Prepare(Sources.IUpdateSource source)
 			return tempFile != null;
         }
 
-		public TaskExecutionStatus Execute(bool coldRun)
+		public override TaskExecutionStatus Execute(bool coldRun)
 		{
 			if (string.IsNullOrEmpty(LocalPath))
 				return TaskExecutionStatus.Successful;
@@ -141,7 +118,7 @@ public TaskExecutionStatus Execute(bool coldRun)
 			return TaskExecutionStatus.RequiresAppRestart;
 		}
 
-    	public bool Rollback()
+    	public override bool Rollback()
         {
             if (string.IsNullOrEmpty(destinationFile))
                 return true;
@@ -153,7 +130,5 @@ public bool Rollback()
 
             return true;
         }
-
-    	#endregion
     }
 }
diff --git a/src/NAppUpdate.Framework/Tasks/IUpdateTask.cs b/src/NAppUpdate.Framework/Tasks/IUpdateTask.cs
@@ -20,7 +20,7 @@ public interface IUpdateTask : INauFieldsHolder
     	string Description { get; set; }
         BooleanCondition UpdateConditions { get; set; }
 		TaskExecutionStatus ExecutionStatus { get; set; }
-		event ReportProgressDelegate OnProgress;
+		event ReportProgressDelegate ProgressDelegate;
 
         /// <summary>
         /// Do all work, especially if it is lengthy, required to prepare the update task, except from

diff --git a/src/NAppUpdate.Framework/Tasks/RegistryTask.cs b/src/NAppUpdate.Framework/Tasks/RegistryTask.cs
@@ -1,19 +1,13 @@
 using System;
 using NAppUpdate.Framework.Common;
 using Microsoft.Win32;
-using NAppUpdate.Framework.Conditions;
 
 namespace NAppUpdate.Framework.Tasks
 {
 	[Serializable]
     [UpdateTaskAlias("registryUpdate")]
-    public class RegistryTask : IUpdateTask
+	public class RegistryTask : UpdateTaskBase
     {
-        public RegistryTask()
-        {
-			ExecutionStatus = TaskExecutionStatus.Pending;
-        }
-
         [NauField("keyName", "The full path to the registry key", true)]
         public string KeyName { get; set; }
 
@@ -50,28 +44,13 @@ protected object ValueToSet
         }
         private object originalValue;
 
-        #region IUpdateTask Members
-
-        public string Description { get; set; }
-		public TaskExecutionStatus ExecutionStatus { get; set; }
-
-		[NonSerialized]
-		private BooleanCondition _updateConditions;
-		public BooleanCondition UpdateConditions
-		{
-			get { return _updateConditions ?? (_updateConditions = new BooleanCondition()); }
-			set { _updateConditions = value; }
-		}
-
-    	public event ReportProgressDelegate OnProgress;
-
-    	public bool Prepare(Sources.IUpdateSource source)
+    	public override bool Prepare(Sources.IUpdateSource source)
         {
             // No preparation required
             return true;
         }
 
-		public TaskExecutionStatus Execute(bool coldRun /* unused */)
+		public override TaskExecutionStatus Execute(bool coldRun /* unused */)
         {
             if (String.IsNullOrEmpty(KeyName) || String.IsNullOrEmpty(KeyValueName))
 				return ExecutionStatus = TaskExecutionStatus.Successful;
@@ -93,7 +72,7 @@ public TaskExecutionStatus Execute(bool coldRun /* unused */)
 			return ExecutionStatus = TaskExecutionStatus.Successful;
         }
 
-        public bool Rollback()
+        public override bool Rollback()
         {
             try
             {
@@ -102,7 +81,5 @@ public bool Rollback()
             catch { return false; }
             return true;
         }
-
-        #endregion
     }
 }
diff --git a/src/NAppUpdate.Framework/Tasks/UpdateTaskBase.cs b/src/NAppUpdate.Framework/Tasks/UpdateTaskBase.cs
@@ -0,0 +1,35 @@
+using System;
+using NAppUpdate.Framework.Common;
+using NAppUpdate.Framework.Conditions;
+using NAppUpdate.Framework.Sources;
+
+namespace NAppUpdate.Framework.Tasks
+{
+	[Serializable]
+	public abstract class UpdateTaskBase : IUpdateTask
+	{
+		public string Description { get; set; }
+		public TaskExecutionStatus ExecutionStatus { get; set; }
+
+		[NonSerialized]
+		private BooleanCondition _updateConditions;
+		public BooleanCondition UpdateConditions
+		{
+			get { return _updateConditions ?? (_updateConditions = new BooleanCondition()); }
+			set { _updateConditions = value; }
+		}
+
+		[field: NonSerialized]
+		public event ReportProgressDelegate ProgressDelegate;
+
+		public virtual void OnProgress(UpdateProgressInfo pi)
+		{
+			if (ProgressDelegate != null)
+				ProgressDelegate(pi);
+		}
+
+		public abstract bool Prepare(IUpdateSource source);
+		public abstract TaskExecutionStatus Execute(bool coldRun);
+		public abstract bool Rollback();
+	}
+}
diff --git a/src/NAppUpdate.Framework/UpdateManager.cs b/src/NAppUpdate.Framework/UpdateManager.cs
@@ -265,7 +265,7 @@ private bool PrepareUpdates(Action<bool> callback)
 						}
 
 						var t = task;
-						task.OnProgress += status => TaskProgressCallback(status, t);
+						task.ProgressDelegate += status => TaskProgressCallback(status, t);
 
 						if (!task.Prepare(UpdateSource))
 						{
@@ -416,7 +416,7 @@ public bool ApplyUpdates(bool relaunchApplication, bool updaterDoLogging, bool u
 					foreach (var task in UpdatesToApply)
 					{
 						IUpdateTask t = task;
-						task.OnProgress += status => TaskProgressCallback(status, t);
+						task.ProgressDelegate += status => TaskProgressCallback(status, t);
 
 						try
 						{

diff --git a/src/NAppUpdate.Tests/NAppUpdate.Tests.csproj b/src/NAppUpdate.Tests/NAppUpdate.Tests.csproj
@@ -76,6 +76,7 @@
     <Compile Include="FeedReaders\NauXmlFeedReaderTests.cs" />
     <Compile Include="Integration\FileDownloaderTests.cs" />
     <Compile Include="Integration\SimpleWebSourceTests.cs" />
+    <Compile Include="Tasks\BasicTaskTests.cs" />
     <Compile Include="UtilTests\PermissionsCheckTest.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="FeedReaders\AppcastReaderTests.cs" />

diff --git a/src/NAppUpdate.Tests/Tasks/BasicTaskTests.cs b/src/NAppUpdate.Tests/Tasks/BasicTaskTests.cs
@@ -0,0 +1,16 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using NAppUpdate.Framework.Tasks;
+
+namespace NAppUpdate.Tests.Tasks
+{
+	[TestClass]
+	public class BasicTaskTests
+	{
+		[TestMethod]
+		public void TestTaskDefaultCharacteristics()
+		{
+			var task = new FileUpdateTask(); // just a random task object
+			Assert.IsTrue(task.ExecutionStatus == TaskExecutionStatus.Pending);
+		}
+	}
+}