summaryrefslogtreecommitdiff
path: root/jobs/JobBase.py
blob: 29ca4439c9638c91a545a0f1b3753fdac715ad3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
#!/usr/bin/env python

import time
import random
import logging
import datetime

import smtplib

class JobFrequency:
    MINUTE = "minute"
    HOUR = "hour"
    DAY = "day"
    DAY_NOON = "day_noon"

class JobFailureNotificationFrequency:
    EVERYTIME = "every"
    EVERYFIVEMINUTES = "5min"
    EVERYTENMINUTES = "10min"
    EVERYHOUR = "hour"
    ONSTATECHANGE = "state_change"

class JobBase:
    def __init__(self, config):
        self.config = config

    """ Return a friendly name to identify this Job"""
    def getName(self):
        return str(self.__class__)

    """Return a non-friendly, guarenteed-unique name to identify this Job
       Needed to keep track of the job's run history. 
       Takes into account the contructor arguments to uniquely identify JobSpawner-jobs"""
    def getStateName(self):
        return self.getName()

    """Returns True if the job should execute this cron-run"""
    def shouldExecute(self, cronmode):
        frequency = self.executeEvery()
        if cronmode == frequency:
            return True
        return False

    """Returns True if the jobmanager should call 'onFailure' to alert the admin"""
    def shouldNotifyFailure(self, jobState):
        notifyFrequency = self.notifyOnFailureEvery()
        if notifyFrequency == JobFailureNotificationFrequency.EVERYTIME:
            return True
        elif notifyFrequency == JobFailureNotificationFrequency.EVERYFIVEMINUTES:
            now = time.time()
            lastNotify = jobState.LastNotifyTime
            if now - lastNotify > datetime.timedelta(minutes=4, seconds=30):
                return True
            return False
        elif notifyFrequency == JobFailureNotificationFrequency.EVERYTENMINUTES:
            now = time.time()
            lastNotify = jobState.LastNotifyTime
            if now - lastNotify > datetime.timedelta(minutes=9, seconds=15):
                return True
            return False
        elif notifyFrequency == JobFailureNotificationFrequency.EVERYHOUR:
            now = time.time()
            lastNotify = jobState.LastNotifyTime
            if now - lastNotify > datetime.timedelta(minutes=59, seconds=0):
                return True
            return False
        elif notifyFrequency == JobFailureNotificationFrequency.ONSTATECHANGE:
            #Only notify if the last JobState was a Success
            return jobState.CurrentStateSuccess
        return True

    """Helper method to send email"""
    def sendEmail(self, subject, body, to=""):
        return sendEmail(self.config, subject, body, to)


    """OVERRIDE ME
        Returns a JobFrequency indicating how often the job should be run."""
    def executeEvery(self):
        pass

    """OVERRIDE ME
        Returns a JobFailureNotificationFrequency indicating how often a failure 
        notification email should be sent"""
    def notifyOnFailureEvery(self):
        pass

    """OVERRIDE ME
       Executes the job's actions, and returns true to indicate the job succeeded."""
    def execute(self):
        pass

    """OVERRIDE ME
       Notify the admin the job failed. Returns True if the email could be 
       successfully sent.
       Example: return self.sendEmail(self.subject, self.body, self.notificationAddress)"""
    def onFailure(self):
        pass

    """OVERRIDE ME
       Notify the admin the job succeeded (when it was previously failing). Only used for
       JobFailureNotificationFrequency.ONSTATECHANGE

       Returns True if the email could be successfully sent.
       Example: return self.sendEmail(self.subject, self.body, self.notificationAddress)"""
    def onStateChangeSuccess(self):
        log.warn(self.getName() + " did not override onStateChangeSuccess")
        return True

def sendEmail(config, subject, body, to=""):
    FROM = config.get('email', 'user')
    PASS = config.get('email', 'pass')
    if not to:
        to = config.get('general', 'alertcontact')

    # Prepare actual message
    # Avoid gmail threading
    subject = "[" + config.get('general', 'servername') + "] " + subject + "       " 
    if config.getboolean('email', 'bustgmailthreading'):
        subject += str(random.random())
    message = """\From: %s\nTo: %s\nSubject: %s\n\n%s""" \
        % (FROM, ", ".join(to), subject, body)
    try:
        server = smtplib.SMTP(config.get('email', 'smtpserver'), config.get('email', 'smtpport'))
        server.ehlo()
        server.starttls()
        server.login(FROM, PASS)
        server.sendmail(FROM, to, message)
        server.close()
        return True
    except Exception as e:
        logging.critical("Caught an exception trying to send an email:" + str(e))
        return False