Merge pull request #38 from tokejepsen/master

Event Script plugin

Custom/events/EventScript/EventScript.param

@@ -0,0 +1,9 @@
+[State]
+Type=Enum
+Items=Global Enabled;Opt-In;Disabled
+Category=Options
+CategoryOrder=0
+CategoryIndex=0
+Label=State
+Default=Disabled
+Description=How this event plug-in should respond to events. If Global, all jobs and slaves will trigger the events for this plugin. If Opt-In, jobs and slaves can choose to trigger the events for this plugin. If Disabled, no events are triggered for this plugin.

Custom/events/EventScript/EventScript.py

@@ -0,0 +1,187 @@
+import sys
+import os
+import traceback
+
+import Deadline.Events
+
+
+def GetDeadlineEventListener():
+    return EventScriptListener()
+
+
+def CleanupDeadlineEventListener(eventListener):
+    eventListener.Cleanup()
+
+
+class EventScriptListener(Deadline.Events.DeadlineEventListener):
+
+    def __init__(self):
+        self.OnJobSubmittedCallback += self.OnJobSubmitted
+        self.OnJobStartedCallback += self.OnJobStarted
+        self.OnJobFinishedCallback += self.OnJobFinished
+        self.OnJobRequeuedCallback += self.OnJobRequeued
+        self.OnJobFailedCallback += self.OnJobFailed
+        self.OnJobSuspendedCallback += self.OnJobSuspended
+        self.OnJobResumedCallback += self.OnJobResumed
+        self.OnJobPendedCallback += self.OnJobPended
+        self.OnJobReleasedCallback += self.OnJobReleased
+        self.OnJobDeletedCallback += self.OnJobDeleted
+        self.OnJobErrorCallback += self.OnJobError
+        self.OnJobPurgedCallback += self.OnJobPurged
+
+        self.OnHouseCleaningCallback += self.OnHouseCleaning
+        self.OnRepositoryRepairCallback += self.OnRepositoryRepair
+
+        self.OnSlaveStartedCallback += self.OnSlaveStarted
+        self.OnSlaveStoppedCallback += self.OnSlaveStopped
+        self.OnSlaveIdleCallback += self.OnSlaveIdle
+        self.OnSlaveRenderingCallback += self.OnSlaveRendering
+        self.OnSlaveStartingJobCallback += self.OnSlaveStartingJob
+        self.OnSlaveStalledCallback += self.OnSlaveStalled
+
+        self.OnIdleShutdownCallback += self.OnIdleShutdown
+        self.OnMachineStartupCallback += self.OnMachineStartup
+        self.OnThermalShutdownCallback += self.OnThermalShutdown
+        self.OnMachineRestartCallback += self.OnMachineRestart
+
+    def Cleanup(self):
+        del self.OnJobSubmittedCallback
+        del self.OnJobStartedCallback
+        del self.OnJobFinishedCallback
+        del self.OnJobRequeuedCallback
+        del self.OnJobFailedCallback
+        del self.OnJobSuspendedCallback
+        del self.OnJobResumedCallback
+        del self.OnJobPendedCallback
+        del self.OnJobReleasedCallback
+        del self.OnJobDeletedCallback
+        del self.OnJobErrorCallback
+        del self.OnJobPurgedCallback
+
+        del self.OnHouseCleaningCallback
+        del self.OnRepositoryRepairCallback
+
+        del self.OnSlaveStartedCallback
+        del self.OnSlaveStoppedCallback
+        del self.OnSlaveIdleCallback
+        del self.OnSlaveRenderingCallback
+        del self.OnSlaveStartingJobCallback
+        del self.OnSlaveStalledCallback
+
+        del self.OnIdleShutdownCallback
+        del self.OnMachineStartupCallback
+        del self.OnThermalShutdownCallback
+        del self.OnMachineRestartCallback
+
+    def run_script(self, *args):
+
+        try:
+            job = args[1]
+            script = job.GetJobExtraInfoKeyValueWithDefault("EventScript", "")
+
+            # Make arguments available to script with sys.argv
+            sys.argv = args
+
+            # Add script directory to sys.path
+            sys.path.append(os.path.dirname(script))
+
+            # Execute script
+            execfile(script)
+        except:
+            print(traceback.format_exc())
+
+    def OnJobSubmitted(self, job):
+
+        self.run_script("OnJobSubmitted", job)
+
+    def OnJobStarted(self, job):
+
+        self.run_script("OnJobStarted", job)
+
+    def OnJobFinished(self, job):
+
+        self.run_script("OnJobFinished", job)
+
+    def OnJobRequeued(self, job):
+
+        self.run_script("OnJobRequeued", job)
+
+    def OnJobFailed(self, job):
+
+        self.run_script("OnJobFailed", job)
+
+    def OnJobSuspended(self, job):
+
+        self.run_script("OnJobSuspended", job)
+
+    def OnJobResumed(self, job):
+
+        self.run_script("OnJobResumed", job)
+
+    def OnJobPended(self, job):
+
+        self.run_script("OnJobPended", job)
+
+    def OnJobReleased(self, job):
+
+        self.run_script("OnJobReleased", job)
+
+    def OnJobDeleted(self, job):
+
+        self.run_script("OnJobDeleted", job)
+
+    def OnJobError(self, job, task, report):
+
+        self.run_script("OnJobError", job, task, report)
+
+    def OnJobPurged(self, job):
+
+        self.run_script("OnJobPurged", job)
+
+    def OnHouseCleaning(self):
+
+        self.run_script("OnHouseCleaning")
+
+    def OnRepositoryRepair(self, job):
+
+        self.run_script("OnRepositoryRepair", job)
+
+    def OnSlaveStarted(self, job):
+
+        self.run_script("OnSlaveStarted", job)
+
+    def OnSlaveStopped(self, job):
+
+        self.run_script("OnSlaveStopped", job)
+
+    def OnSlaveIdle(self, job):
+
+        self.run_script("OnSlaveIdle", job)
+
+    def OnSlaveRendering(self, slaveName, job):
+
+        self.run_script("OnSlaveRendering", job, slaveName)
+
+    def OnSlaveStartingJob(self, slaveName, job):
+
+        self.run_script("OnSlaveStartingJob", job, slaveName)
+
+    def OnSlaveStalled(self, slaveName, job):
+
+        self.run_script("OnSlaveStalled", job, slaveName)
+
+    def OnIdleShutdown(self, job):
+
+        self.run_script("OnIdleShutdown", job)
+
+    def OnMachineStartup(self, job):
+
+        self.run_script("OnMachineStartup", job)
+
+    def OnThermalShutdown(self, job):
+
+        self.run_script("OnThermalShutdown", job)
+
+    def OnMachineRestart(self, job):
+
+        self.run_script("OnMachineRestart", job)

Custom/events/EventScript/README.md

@@ -0,0 +1,35 @@
+# EventScript.py
+
+An event plugin that executes an external script.
+
+The plugin gets the path to the external script from the jobs extra info, specifically if "EventScript" is specified as a key/value member.
+
+```
+ExtraInfoKeyValue1=EventScript=path/to/script.py
+```
+
+The event plugin also adds the direcotory of the script to ```sys.path```, so relative imports can be used.
+
+The arguments passed that is normally passed to an event plugin are stored in ```sys.argv```. These arguments vary in length depending the event, but as a minimum will always have the name of the event and the job object.
+
+Example of an external script printing all the arguments available.
+```python
+import sys
+
+
+def main():
+
+    event_name = sys.argv[0]
+    print("Event Name: {0}".format(event_name))
+
+    job = sys.argv[1]
+    print("Job Object: {0}".format(job))
+
+    print("Other arguments: {0}".format(sys.argv[1:]))
+
+main()
+```
+
+Since event plugin execute the script in the same process, you import any Deadline related modules.
+
+Lastly if anything fails a stracktrace will be printed and available in the job reports.