Add some scheduling helper methods and update docs

Author: ethanhann

docs-src/scheduling.md

@@ -2,6 +2,62 @@
 
 [Commands](commands) can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
 
+## Scheduling a Command
+
+A job schedule is created by adding a class to your plugin assembly that implements the **InEngine.Core.Jobs** interface.
+
+```csharp
+
+using System;
+using Quartz;
+
+namespace MyCommandPlugin
+{
+    public class Jobs : IJobs
+    {
+        public void Schedule(IScheduler scheduler)
+        {
+            // Schedule some jobs
+        }
+    }
+}
+```
+
+This class is automatically discovered by the InEngine.NET scheduler.
+It will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.
+
+```csharp
+using System;
+using Quartz;
+using InEngine.Core.Queue.Commands;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace InEngine.Core.Queue
+{
+    public class Jobs : IJobs
+    {
+        public void Schedule(IScheduler scheduler)
+        {
+            var myCommand = new MyCommand();
+            
+            // Generate a schedulable job with the command
+            var job = myCommand.MakeTriggerBuilder().Build();
+            
+            // Generate a trigger for the job, and set its schedule to every 10 seconds.
+            var trigger = myCommand.MakeTriggerBuilder().Build()
+                .StartNow()
+                .WithSimpleSchedule(x => x.WithIntervalInSeconds(10).RepeatForever())
+                .Build();
+                
+            // Register the job and trigger with the scheduler
+            scheduler.ScheduleJob(job, trigger);
+        }
+    }
+}
+
+```
+
 ## Running the Scheduler
 
 ### Manually from the CLI

docs/index.html

@@ -146,5 +146,5 @@ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
 
 <!--
 MkDocs version : 0.16.3
-Build Date UTC : 2017-11-21 12:28:19
+Build Date UTC : 2017-11-21 14:06:37
 -->

docs/mkdocs/search_index.json

@@ -62,14 +62,19 @@
         }, 
         {
             "location": "/scheduling/", 
-            "text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent \nrelease\n.\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \nInEngineScheduler.exe\n from the command line.\n\n\nInEngineScheduler.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono InEngineScheduler.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*", 
+            "text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent \nrelease\n.\n\n\nScheduling a Command\n\n\nA job schedule is created by adding a class to your plugin assembly that implements the \nInEngine.Core.Jobs\n interface.\n\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n    public class Jobs : IJobs\n    {\n        public void Schedule(IScheduler scheduler)\n        {\n            // Schedule some jobs\n        }\n    }\n}\n\n\n\n\nThis class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.\n\n\nusing System;\nusing Quartz;\nusing InEngine.Core.Queue.Commands;\nusing System.Collections.Generic;\nusing System.Linq;\n\nnamespace InEngine.Core.Queue\n{\n    public class Jobs : IJobs\n    {\n        public void Schedule(IScheduler scheduler)\n        {\n            var myCommand = new MyCommand();\n\n            // Generate a schedulable job with the command\n            var job = myCommand.MakeTriggerBuilder().Build();\n\n            // Generate a trigger for the job, and set its schedule to every 10 seconds.\n            var trigger = myCommand.MakeTriggerBuilder().Build()\n                .StartNow()\n                .WithSimpleSchedule(x =\n x.WithIntervalInSeconds(10).RepeatForever())\n                .Build();\n\n            // Register the job and trigger with the scheduler\n            scheduler.ScheduleJob(job, trigger);\n        }\n    }\n}\n\n\n\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \nInEngineScheduler.exe\n from the command line.\n\n\nInEngineScheduler.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono InEngineScheduler.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*", 
             "title": "Scheduling"
         }, 
         {
             "location": "/scheduling/#scheduling", 
             "text": "Commands  can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent  release .", 
             "title": "Scheduling"
         }, 
+        {
+            "location": "/scheduling/#scheduling-a-command", 
+            "text": "A job schedule is created by adding a class to your plugin assembly that implements the  InEngine.Core.Jobs  interface.  \nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n    public class Jobs : IJobs\n    {\n        public void Schedule(IScheduler scheduler)\n        {\n            // Schedule some jobs\n        }\n    }\n}  This class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.  using System;\nusing Quartz;\nusing InEngine.Core.Queue.Commands;\nusing System.Collections.Generic;\nusing System.Linq;\n\nnamespace InEngine.Core.Queue\n{\n    public class Jobs : IJobs\n    {\n        public void Schedule(IScheduler scheduler)\n        {\n            var myCommand = new MyCommand();\n\n            // Generate a schedulable job with the command\n            var job = myCommand.MakeTriggerBuilder().Build();\n\n            // Generate a trigger for the job, and set its schedule to every 10 seconds.\n            var trigger = myCommand.MakeTriggerBuilder().Build()\n                .StartNow()\n                .WithSimpleSchedule(x =  x.WithIntervalInSeconds(10).RepeatForever())\n                .Build();\n\n            // Register the job and trigger with the scheduler\n            scheduler.ScheduleJob(job, trigger);\n        }\n    }\n}", 
+            "title": "Scheduling a Command"
+        }, 
         {
             "location": "/scheduling/#running-the-scheduler", 
             "text": "", 

docs/scheduling/index.html

@@ -98,13 +98,65 @@
                 <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
     <ul class="nav bs-sidenav">
         <li class="main active"><a href="#scheduling">Scheduling</a></li>
+            <li><a href="#scheduling-a-command">Scheduling a Command</a></li>
             <li><a href="#running-the-scheduler">Running the Scheduler</a></li>
     </ul>
 </div></div>
                 <div class="col-md-9" role="main">
 
 <h1 id="scheduling">Scheduling</h1>
 <p><a href="../commands">Commands</a> can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent <a href="https://github.com/InEngine-NET/InEngine.NET/releases">release</a>.</p>
+<h2 id="scheduling-a-command">Scheduling a Command</h2>
+<p>A job schedule is created by adding a class to your plugin assembly that implements the <strong>InEngine.Core.Jobs</strong> interface.</p>
+<pre><code class="csharp">
+using System;
+using Quartz;
+
+namespace MyCommandPlugin
+{
+    public class Jobs : IJobs
+    {
+        public void Schedule(IScheduler scheduler)
+        {
+            // Schedule some jobs
+        }
+    }
+}
+</code></pre>
+
+<p>This class is automatically discovered by the InEngine.NET scheduler.
+It will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.</p>
+<pre><code class="csharp">using System;
+using Quartz;
+using InEngine.Core.Queue.Commands;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace InEngine.Core.Queue
+{
+    public class Jobs : IJobs
+    {
+        public void Schedule(IScheduler scheduler)
+        {
+            var myCommand = new MyCommand();
+
+            // Generate a schedulable job with the command
+            var job = myCommand.MakeTriggerBuilder().Build();
+
+            // Generate a trigger for the job, and set its schedule to every 10 seconds.
+            var trigger = myCommand.MakeTriggerBuilder().Build()
+                .StartNow()
+                .WithSimpleSchedule(x =&gt; x.WithIntervalInSeconds(10).RepeatForever())
+                .Build();
+
+            // Register the job and trigger with the scheduler
+            scheduler.ScheduleJob(job, trigger);
+        }
+    }
+}
+
+</code></pre>
+
 <h2 id="running-the-scheduler">Running the Scheduler</h2>
 <h3 id="manually-from-the-cli">Manually from the CLI</h3>
 <p>Running the scheduler from the CommandLine is useful for debugging or local development. Simply run <em>InEngineScheduler.exe</em> from the command line.</p>

src/InEngine.Core/AbstractCommand.cs

@@ -1,4 +1,5 @@
-using Konsole;
+using System;
+using Konsole;
 using NLog;
 using Quartz;
 
@@ -19,27 +20,34 @@ public string Name
                 Logger = LogManager.GetLogger(_name);
             }
         }
+        public string SchedulerGroup { get; set; }
+        public string ScheduleId { get; set; }
 
         protected AbstractCommand()
         {
+            ScheduleId = Guid.NewGuid().ToString();
             Name = GetType().FullName;
+            SchedulerGroup = GetType().AssemblyQualifiedName;
         }
 
         public virtual CommandResult Run()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
+        #region ProgressBar
         public void SetProgressBarMaxTicks(int maxTicks)
         {
             ProgressBar = new ProgressBar(maxTicks);
         }
 
         public void UpdateProgress(int tick)
         {
-            ProgressBar.Refresh(tick, Name);   
+            ProgressBar.Refresh(tick, Name);
         }
+        #endregion
 
+        #region Scheduling
         public void Execute(IJobExecutionContext context)
         {
             JobExecutionContext = context;
@@ -51,7 +59,22 @@ public T GetJobContextData<T>(string key)
             if (JobExecutionContext == null || JobExecutionContext.MergedJobDataMap == null)
                 return default(T);
             var objectVal = JobExecutionContext.MergedJobDataMap.Get(key);
-            return  objectVal == null ? default(T) : (T)objectVal;
+            return objectVal == null ? default(T) : (T)objectVal;
         }
+
+        public JobBuilder MakeJobBuilder()
+        {
+            return JobBuilder
+                .Create(GetType())
+                .WithIdentity($"{Name}:job:{ScheduleId}", SchedulerGroup);
+        }
+
+        public TriggerBuilder MakeTriggerBuilder()
+        {
+            return TriggerBuilder
+                .Create()
+                .WithIdentity($"{Name}:trigger:{ScheduleId}", SchedulerGroup);
+        }
+        #endregion
     }
 }

src/InEngine.Core/Queue/Jobs.cs

@@ -10,36 +10,50 @@ public class Jobs : IJobs
     {
         public void Schedule(IScheduler scheduler)
         {
-            var consume = new Consume();
-            foreach (var index in Enumerable.Range(0, 8).ToList()) 
-            {
-                var primaryQueueConsumer = JobBuilder
-                    .Create<Consume>()
-                    .WithIdentity(consume.Name + index, "primaryQueueConsumer")
-                    .Build();
+            ScheduleQueueConsumerJobs(scheduler);
+            ScheduleQueueConsumerJobs(scheduler, true);
+            //foreach (var index in Enumerable.Range(0, 8).ToList()) 
+            //{
+            //    var consume = new Consume();
+            //    consume.Name = consume.Name + index; 
+            //    var primaryQueueConsumer = consume.MakeJobBuilder().Build();
+            //    var secondaryQueueConsumer = consume.MakeJobBuilder().Build();
+            //    secondaryQueueConsumer.JobDataMap.Add("useSecondaryQueue", true);
 
-                var secondaryQueueConsumer = JobBuilder
-                    .Create<Consume>()
-                    .WithIdentity(consume.Name + index, "secondaryQueueConsumer")
-                    .Build();
-                secondaryQueueConsumer.JobDataMap.Add("useSecondaryQueue", true);
+            //    var primaryTrigger = consume
+            //        .MakeTriggerBuilder()
+            //        .StartNow()
+            //        .WithSimpleSchedule(x => x.WithIntervalInSeconds(1).RepeatForever())
+            //        .Build();
 
-                var primaryTrigger = TriggerBuilder
-                    .Create()
-                    .WithIdentity($"{consume.Name}-primary-{index}", "queue")
-                    .StartNow()
-                    .WithSimpleSchedule(x => x.WithIntervalInSeconds(1).RepeatForever())
-                    .Build();
+            //    var secondaryTrigger = consume
+            //        .MakeTriggerBuilder()
+            //        .StartNow()
+            //        .WithSimpleSchedule(x => x.WithIntervalInSeconds(1).RepeatForever())
+            //        .Build();
+
+            //    scheduler.ScheduleJob(primaryQueueConsumer, primaryTrigger);
+            //    scheduler.ScheduleJob(secondaryQueueConsumer, secondaryTrigger);
+            //}
+        }
+
+        private void ScheduleQueueConsumerJobs(IScheduler scheduler, bool useSecondaryQueue = false)
+        {
+            foreach (var index in Enumerable.Range(0, 8).ToList())
+            {
+                var consume = new Consume() {
+                    ScheduleId = $"{(useSecondaryQueue ? "secondary" : "primary")}:{index.ToString()}"
+                };
+                var job = consume.MakeJobBuilder().Build();
+                job.JobDataMap.Add("useSecondaryQueue", useSecondaryQueue);
 
-                var secondaryTrigger = TriggerBuilder
-                    .Create()
-                    .WithIdentity($"{consume.Name}-secondary-{index}", "queue")
+                var trigger = consume
+                    .MakeTriggerBuilder()
                     .StartNow()
                     .WithSimpleSchedule(x => x.WithIntervalInSeconds(1).RepeatForever())
                     .Build();
 
-                scheduler.ScheduleJob(primaryQueueConsumer, primaryTrigger);
-                scheduler.ScheduleJob(secondaryQueueConsumer, secondaryTrigger);
+                scheduler.ScheduleJob(job, trigger);
             }
         }
     }

src/InEngineCli/ArgumentInterpreter.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Linq;
-using System.Reflection;
 using CommandLine;
 using InEngine.Core;
 using InEngine.Core.Exceptions;