Full support for jobs, asynch requests and job listings

Author: tonybaloney

Configuration/JobStoreConfiguration.cs

@@ -0,0 +1,22 @@
+using System.Configuration;
+
+namespace DynamicPowerShellApi.Configuration
+{
+	/// <summary>	A job store configuration. </summary>
+	/// <remarks>	Anthony, 6/1/2015. </remarks>
+	/// <seealso cref="T:System.Configuration.ConfigurationElement"/>
+	public class JobStoreConfiguration
+		: ConfigurationElement
+	{
+		/// <summary>	Gets the full pathname of the job directory. </summary>
+		/// <value>	The full pathname of the job file. </value>
+		[ConfigurationProperty("JobStorePath", IsRequired = true)]
+		public string JobStorePath
+		{
+			get
+			{
+				return (string)this["JobStorePath"];
+			}
+		}
+	}
+}

Configuration/WebAPIConfiguration.cs

@@ -67,5 +67,15 @@ public Authentication Authentication
 				return (Authentication)this["Authentication"];
 			}
 		}
+
+		/// <summary>	Gets the jobs configuration object. </summary>
+		[ConfigurationProperty("Jobs", IsRequired = true)]
+		public JobStoreConfiguration Jobs
+		{
+			get
+			{
+				return (JobStoreConfiguration)this["Jobs"];
+			}
+		}
 	}
 }

Constants.cs

@@ -7,5 +7,11 @@ public static class Constants
 		/// 	Full pathname of the status URL file. 
 		/// </summary>
 		public const string StatusUrlPath = "/api/server/status";
+
+		/// <summary>	Full pathname of the job list file. </summary>
+		public const string JobListPath = "/api/server/jobs";
+
+		/// <summary>	Full URI of the get job file. </summary>
+		public const string GetJobPath = "/api/server/job";
 	}
 }

Controllers/GenericController.cs

@@ -1,10 +1,16 @@
-using DynamicPowerShellApi.Logging;
+using System.IO;
+using System.Management.Automation;
+using System.Web.Http.Results;
+using DynamicPowerShellApi.Jobs;
+using DynamicPowerShellApi.Logging;
 using DynamicPowerShellApi.Model;
+using Newtonsoft.Json;
 
 namespace DynamicPowerShellApi.Controllers
 {
 	using Configuration;
 	using Exceptions;
+	using Microsoft.Owin;
 	using Newtonsoft.Json.Linq;
 	using System;
 	using System.Collections.Generic;
@@ -29,26 +35,35 @@ public class GenericController : ApiController
 		/// </summary>
 		private readonly ICrashLogger _crashLogger;
 
+		/// <summary>	The job list provider. </summary>
+		private readonly IJobListProvider _jobListProvider;
+
 		/// <summary>
 		/// Initialises a new instance of the <see cref="GenericController"/> class.
 		/// </summary>
 		public GenericController()
 		{
 		}
 
-		/// <summary>
-		/// Initialises a new instance of the <see cref="GenericController"/> class.
-		/// </summary>
-		/// <param name="powershellRunner">
-		/// The PowerShell runner.
-		/// </param>
-		/// <param name="crashLogger">
-		///		An implementation of a crash logger.
-		/// </param>
-		public GenericController(IRunner powershellRunner, ICrashLogger crashLogger)
+		/// <summary>	Initialises a new instance of the <see cref="GenericController"/> class. </summary>
+		/// <remarks>	Anthony, 6/1/2015. </remarks>
+		/// <exception cref="ArgumentNullException">	Thrown when one or more required arguments are
+		/// 											null. </exception>
+		/// <param name="powershellRunner">	The PowerShell runner. </param>
+		/// <param name="crashLogger">	   	An implementation of a crash logger. </param>
+		/// <param name="jobListProvider"> 	The job list provider. </param>
+		public GenericController(IRunner powershellRunner, ICrashLogger crashLogger, IJobListProvider jobListProvider)
 		{
+			if (jobListProvider == null)
+				throw new ArgumentNullException("jobListProvider");
+			if (crashLogger == null)
+				throw new ArgumentNullException("crashLogger");
+			if (powershellRunner == null)
+				throw new ArgumentNullException("powershellRunner");
+
 			_powershellRunner = powershellRunner;
 			_crashLogger = crashLogger;
+			_jobListProvider = jobListProvider;
 		}
 
 		/// <summary>
@@ -59,7 +74,40 @@ public GenericController(IRunner powershellRunner, ICrashLogger crashLogger)
 		[AllowAnonymous]
 		public HttpResponseMessage Status()
 		{
-			return new HttpResponseMessage { Content = new StringContent("OK") };
+			return new HttpResponseMessage {Content = new StringContent("OK")};
+		}
+
+		[Route("jobs")]
+		public dynamic AllJobStatus()
+		{
+			dynamic jobs = new
+			{
+				running = _jobListProvider.GetRunningJobs(),
+				completed = _jobListProvider.GetCompletedJobs()
+			};
+
+			return jobs;
+		}
+
+		/// <summary>	Gets a job. </summary>
+		/// <remarks>	Anthony, 6/1/2015. </remarks>
+		/// <exception cref="ArgumentOutOfRangeException">	Thrown when one or more arguments are outside
+		/// 												the required range. </exception>
+		/// <param name="jobId">	Identifier for the job. </param>
+		/// <returns>	The job. </returns>
+		[Route("job")]
+		public dynamic GetJob(string jobId)
+		{
+			Guid jobGuid;
+			if (!Guid.TryParse(jobId, out jobGuid))
+				throw new ArgumentOutOfRangeException("jobId is not a valid GUID");
+
+			using (TextReader reader = new StreamReader(
+				Path.Combine(WebApiConfiguration.Instance.Jobs.JobStorePath, jobId + ".json")))
+			{
+				dynamic d = JObject.Parse(reader.ReadToEnd());
+				return d;
+			}
 		}
 
 		/// <summary>
@@ -79,7 +127,7 @@ public HttpResponseMessage Status()
 		/// <exception cref="Exception">
 		/// </exception>
 		[AuthorizeIfEnabled]
-		public async Task<HttpResponseMessage> ProcessRequestAsync()
+		public async Task<HttpResponseMessage> ProcessRequestAsync(HttpRequestMessage request = null)
 		{
 			DynamicPowershellApiEvents
 				.Raise
@@ -168,13 +216,114 @@ public async Task<HttpResponseMessage> ProcessRequestAsync()
 			{
 				DynamicPowershellApiEvents.Raise.VerboseMessaging(String.Format("Started Executing the runner"));
 
-				PowershellReturn output =
-					await _powershellRunner.ExecuteAsync(method.PowerShellPath, method.Snapin, method.Module, query2.ToList(), asJob);
+				if (!asJob)
+				{
+					PowershellReturn output =
+						await _powershellRunner.ExecuteAsync(method.PowerShellPath, method.Snapin, method.Module, query2.ToList(), asJob);
+
+					JToken token = output.ActualPowerShellData.StartsWith("[")
+						? (JToken) JArray.Parse(output.ActualPowerShellData)
+						: JObject.Parse(output.ActualPowerShellData);
 
-				JToken token = output.ActualPowerShellData.StartsWith("[")
-					? (JToken) JArray.Parse(output.ActualPowerShellData)
-					: JObject.Parse(output.ActualPowerShellData);
-				return new HttpResponseMessage { Content = new JsonContent(token) };
+					return new HttpResponseMessage
+					{
+						Content = new JsonContent(token)
+					};
+				}
+				else // run as job.
+				{
+					Guid jobId = Guid.NewGuid();
+					string requestedHost = String.Empty;
+
+					if (Request.Properties.ContainsKey("MS_OwinContext"))
+						requestedHost = ((OwinContext)Request.Properties["MS_OwinContext"]).Request.RemoteIpAddress;
+
+					_jobListProvider.AddRequestedJob(jobId, requestedHost );
+
+					// Go off and run this job please sir.
+					var task = Task<bool>.Factory.StartNew(
+						() =>
+						{
+							try
+							{
+								Task<PowershellReturn> goTask =  
+								_powershellRunner.ExecuteAsync(
+										method.PowerShellPath,
+										method.Snapin,
+										method.Module,
+										query2.ToList(),
+										true);
+
+								goTask.Wait();
+								var output = goTask.Result;
+
+								JToken token = output.ActualPowerShellData.StartsWith("[")
+								? (JToken)JArray.Parse(output.ActualPowerShellData)
+								: JObject.Parse(output.ActualPowerShellData);
+
+								_jobListProvider.CompleteJob(jobId, output.PowerShellReturnedValidData, String.Empty);
+
+								string outputPath = Path.Combine(WebApiConfiguration.Instance.Jobs.JobStorePath, jobId + ".json");
+
+								using (TextWriter writer = File.CreateText(outputPath))
+								{
+									JsonSerializer serializer = new JsonSerializer
+									{
+										Formatting = Formatting.Indented // Make it readable for Ops sake!
+									};
+									serializer.Serialize(writer, token);
+								}
+
+								return true;
+							}
+							catch (PowerShellExecutionException poException)
+							{
+								CrashLogEntry entry = new CrashLogEntry
+								{
+									Exceptions = poException.Exceptions,
+									LogTime = poException.LogTime,
+									RequestAddress = requestedHost, 
+									RequestMethod = methodName,
+									RequestUrl = Request.RequestUri.ToString()
+								};
+								entry.SetActivityId(activityId);
+								string logFile = _crashLogger.SaveLog(entry);
+
+								DynamicPowershellApiEvents.Raise.InvalidPowerShellOutput(poException.Message + " logged to " + logFile);
+
+								ErrorResponse response =
+										new ErrorResponse
+										{
+											ActivityId = activityId,
+											LogFile = logFile,
+											Message = poException.Message
+										};
+
+								JToken token = new JObject(response);
+
+								_jobListProvider.CompleteJob(jobId, false, String.Empty);
+
+								string outputPath = Path.Combine(WebApiConfiguration.Instance.Jobs.JobStorePath, jobId + ".json");
+
+								using (TextWriter writer = File.CreateText(outputPath))
+								{
+									JsonSerializer serializer = new JsonSerializer
+									{
+										Formatting = Formatting.Indented // Make it readable for Ops sake!
+									};
+									serializer.Serialize(writer, token);
+								}
+								return true;
+							}
+						}
+					);
+					
+					// return the Job ID.
+					return new HttpResponseMessage
+					{
+						Content = new JsonContent(new JValue(jobId))
+					};
+				}
 			}
 			catch (PowerShellExecutionException poException)
 			{
@@ -191,7 +340,7 @@ public async Task<HttpResponseMessage> ProcessRequestAsync()
 
 				DynamicPowershellApiEvents.Raise.InvalidPowerShellOutput(poException.Message + " logged to " + logFile);
 
-				var response = Request.CreateResponse<ErrorResponse>(HttpStatusCode.InternalServerError, 
+				HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.InternalServerError, 
 						new ErrorResponse
 						{
 							ActivityId = activityId,
@@ -206,7 +355,7 @@ public async Task<HttpResponseMessage> ProcessRequestAsync()
 			{
 				CrashLogEntry entry = new CrashLogEntry
 				{
-					Exceptions = new List<PowerShellException>()
+					Exceptions = new List<PowerShellException>
 					{
 						new PowerShellException
 						{
@@ -226,7 +375,7 @@ public async Task<HttpResponseMessage> ProcessRequestAsync()
 
 				DynamicPowershellApiEvents.Raise.UnhandledException(ex.Message + " logged to " + logFile, ex.StackTrace ?? String.Empty);
 
-				var response = Request.CreateResponse<ErrorResponse>(HttpStatusCode.InternalServerError, 
+				HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.InternalServerError, 
 						new ErrorResponse
 						{
 							ActivityId = activityId,

DynamicPowerShellAPI.csproj

@@ -103,10 +103,16 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>packages\Microsoft.Diagnostics.Tracing.EventSource.Redist.1.0.26\lib\net40\Microsoft.Diagnostics.Tracing.EventSource.dll</HintPath>
     </Reference>
+    <Reference Include="Microsoft.Owin, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>packages\Microsoft.Owin.3.0.0\lib\net45\Microsoft.Owin.dll</HintPath>
+    </Reference>
     <Reference Include="Newtonsoft.Json">
       <HintPath>packages\Newtonsoft.Json.6.0.4\lib\net45\Newtonsoft.Json.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="Owin">
+      <HintPath>packages\Owin.1.0\lib\net40\Owin.dll</HintPath>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Configuration" />
     <Reference Include="System.Core" />
@@ -128,6 +134,7 @@
   <ItemGroup>
     <Compile Include="AuthorizeIfEnabledAttribute.cs" />
     <Compile Include="Configuration\Authentication.cs" />
+    <Compile Include="Configuration\JobStoreConfiguration.cs" />
     <Compile Include="Configuration\WebApiCollection.cs" />
     <Compile Include="Configuration\Parameter.cs" />
     <Compile Include="Configuration\ParameterCollection.cs" />
@@ -148,6 +155,8 @@
     <Compile Include="GenericActionSelector.cs" />
     <Compile Include="GenericControllerSelector.cs" />
     <Compile Include="IRunner.cs" />
+    <Compile Include="Jobs\IJobListProvider.cs" />
+    <Compile Include="Jobs\JobListProvider.cs" />
     <Compile Include="JsonContent.cs" />
     <Compile Include="Logging\CrashLog.cs" />
     <Compile Include="Logging\CrashLogger.cs" />

DynamicPowerShellApi.Host/App.config

@@ -4,6 +4,7 @@
 		<section name="WebApiConfiguration" type="DynamicPowerShellApi.Configuration.WebApiConfiguration, DynamicPowerShellApi" allowLocation="true" allowDefinition="Everywhere" />
 	</configSections>
 	<WebApiConfiguration HostAddress="http://localhost:9000">
+		<Jobs JobStorePath="c:\temp\" />
 		<Authentication Enabled="false" StoreName="My" StoreLocation="LocalMachine" Thumbprint="E6B6364C75ED8B6495A42D543AC728B4C2263082" Audience="http://aperture.identity/connectors" />
 		<Apis>
 			<WebApi Name="Example">

GenericActionSelector.cs

@@ -49,11 +49,22 @@ public GenericActionSelector(HttpConfiguration configuration)
 		/// </returns>
 		public HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
 		{
+			// if the user is requesting the server status..
 			if (controllerContext.Request.RequestUri.AbsolutePath == Constants.StatusUrlPath)
 				return new ReflectedHttpActionDescriptor(
 					new HttpControllerDescriptor(_currentConfiguration, "generic", typeof(GenericController)),
 					typeof(GenericController).GetMethod("Status"));
 
+			if (controllerContext.Request.RequestUri.AbsolutePath == Constants.JobListPath)
+				return new ReflectedHttpActionDescriptor(
+					new HttpControllerDescriptor(_currentConfiguration, "generic", typeof(GenericController)),
+					typeof(GenericController).GetMethod("AllJobStatus"));
+
+			if (controllerContext.Request.RequestUri.AbsolutePath == Constants.GetJobPath)
+				return new ReflectedHttpActionDescriptor(
+					new HttpControllerDescriptor(_currentConfiguration, "generic", typeof(GenericController)),
+					typeof(GenericController).GetMethod("GetJob"));
+
 			// Always give the same action
 			return ActionDescriptor;
 		}
@@ -69,9 +80,7 @@ public ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDesc
 		{
 			// Exercised only by ASP.NET Web API’s API explorer feature
 
-			List<HttpActionDescriptor> descriptors = new List<HttpActionDescriptor>();
-
-			descriptors.Add(ActionDescriptor);
+			List<HttpActionDescriptor> descriptors = new List<HttpActionDescriptor> { ActionDescriptor };
 
 			ILookup<string, HttpActionDescriptor> result = descriptors.ToLookup(
 				p => "generic",