Move common task functions into a model

Change-Id: If39a70edeaf5736dc84750367678bdb7cbe05506

3 files changed, 103 insertions, 71 deletions

diff --git a/turbo_hipster/task_plugins/gate_real_db_upgrade/gerrit-git-prep.sh b/turbo_hipster/lib/gerrit-git-prep.sh
index 16b4aaf..16b4aaf 100755
--- a/turbo_hipster/task_plugins/gate_real_db_upgrade/gerrit-git-prep.sh
+++ b/turbo_hipster/lib/gerrit-git-prep.sh
diff --git a/turbo_hipster/lib/models.py b/turbo_hipster/lib/models.py
new file mode 100644
index 0000000..8e8cd48
--- /dev/null
+++ b/turbo_hipster/lib/models.py
@@ -0,0 +1,100 @@
+# Copyright 2013 Rackspace Australia
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+import copy
+import json
+import logging
+import os
+
+from turbo_hipster.lib import utils
+
+
+class Task(object):
+
+    log = logging.getLogger("lib.models.Task")
+
+    def __init__(self, global_config, plugin_config, job_name):
+        self.global_config = global_config
+        self.plugin_config = plugin_config
+        self.job_name = job_name
+
+        self.job = None
+        self.job_arguments = None
+        self.work_data = None
+        self.cancelled = False
+
+        # Define the number of steps we will do to determine our progress.
+        self.current_step = 0
+        self.total_steps = 0
+
+    def stop_worker(self, number):
+        # Check the number is for this job instance
+        # (makes it possible to run multiple workers with this task
+        # on this server)
+        if number == self.job.unique:
+            self.log.debug("We've been asked to stop by our gearman manager")
+            self.cancelled = True
+            # TODO: Work out how to kill current step
+
+    def _grab_patchset(self, job_args, job_log_file_path):
+        """ Checkout the reference into config['git_working_dir'] """
+
+        self.log.debug("Grab the patchset we want to test against")
+        local_path = os.path.join(self.global_config['git_working_dir'],
+                                  self.job_name, job_args['ZUUL_PROJECT'])
+        if not os.path.exists(local_path):
+            os.makedirs(local_path)
+
+        git_args = copy.deepcopy(job_args)
+        git_args['GIT_ORIGIN'] = 'git://git.openstack.org/'
+
+        cmd = os.path.join(os.path.join(os.path.dirname(__file__),
+                                        'gerrit-git-prep.sh'))
+        cmd += ' https://review.openstack.org'
+        cmd += ' http://zuul.rcbops.com'
+        utils.execute_to_log(cmd, job_log_file_path, env=git_args,
+                             cwd=local_path)
+        return local_path
+
+    def _get_work_data(self):
+        if self.work_data is None:
+            hostname = os.uname()[1]
+            self.work_data = dict(
+                name=self.job_name,
+                number=self.job.unique,
+                manager='turbo-hipster-manager-%s' % hostname,
+                url='http://localhost',
+            )
+        return self.work_data
+
+    def _send_work_data(self):
+        """ Send the WORK DATA in json format for job """
+        self.log.debug("Send the work data response: %s" %
+                       json.dumps(self._get_work_data()))
+        self.job.sendWorkData(json.dumps(self._get_work_data()))
+
+    def _do_next_step(self):
+        """ Send a WORK_STATUS command to the gearman server.
+        This can provide a progress bar. """
+
+        # Each opportunity we should check if we need to stop
+        if self.cancelled:
+            self.work_data['result'] = "Failed: Job cancelled"
+            self.job.sendWorkStatus(self.current_step, self.total_steps)
+            self.job.sendWorkFail()
+            raise Exception('Job cancelled')
+
+        self.current_step += 1
+        self.job.sendWorkStatus(self.current_step, self.total_steps)
diff --git a/turbo_hipster/task_plugins/gate_real_db_upgrade/task.py b/turbo_hipster/task_plugins/gate_real_db_upgrade/task.py
index 3c4a149..fd59df8 100644
--- a/turbo_hipster/task_plugins/gate_real_db_upgrade/task.py
+++ b/turbo_hipster/task_plugins/gate_real_db_upgrade/task.py
@@ -13,13 +13,13 @@
 # under the License.
 
 
-import copy
 import json
 import logging
 import os
 import re
 
 from turbo_hipster.lib import utils
+from turbo_hipster.lib import models
 
 import turbo_hipster.task_plugins.gate_real_db_upgrade.handle_results\
     as handle_results
@@ -30,7 +30,7 @@ MIGRATION_START_RE = re.compile('([0-9]+) -> ([0-9]+)\.\.\.$')
 MIGRATION_END_RE = re.compile('^done$')
 
 
-class Runner(object):
+class Runner(models.Task):
 
     """ This thread handles the actual sql-migration tests.
         It pulls in a gearman job from the  build:gate-real-db-upgrade
@@ -39,32 +39,15 @@ class Runner(object):
     log = logging.getLogger("task_plugins.gate_real_db_upgrade.task.Runner")
 
     def __init__(self, global_config, plugin_config, job_name):
-        self.global_config = global_config
-        self.plugin_config = plugin_config
-        self.job_name = job_name
+        super(Runner, self).__init__(global_config, plugin_config, job_name)
 
         # Set up the runner worker
         self.datasets = []
-
-        self.job = None
-        self.job_arguments = None
         self.job_datasets = []
-        self.work_data = None
-        self.cancelled = False
 
         # Define the number of steps we will do to determine our progress.
-        self.current_step = 0
         self.total_steps = 4
 
-    def stop_worker(self, number):
-        # Check the number is for this job instance
-        # (makes it possible to run multiple workers with this task
-        # on this server)
-        if number == self.job.unique:
-            self.log.debug("We've been asked to stop by our gearman manager")
-            self.cancelled = True
-            # TODO: Work out how to kill current step
-
     def start_job(self, job):
         self.job = job
         self.success = True
@@ -283,54 +266,3 @@ class Runner(object):
                 ],
             )
             return rc
-
-    def _grab_patchset(self, job_args, job_log_file_path):
-        """ Checkout the reference into config['git_working_dir'] """
-
-        self.log.debug("Grab the patchset we want to test against")
-        local_path = os.path.join(self.global_config['git_working_dir'],
-                                  self.job_name, job_args['ZUUL_PROJECT'])
-        if not os.path.exists(local_path):
-            os.makedirs(local_path)
-
-        git_args = copy.deepcopy(job_args)
-        git_args['GIT_ORIGIN'] = 'git://git.openstack.org/'
-
-        cmd = os.path.join(os.path.join(os.path.dirname(__file__),
-                                        'gerrit-git-prep.sh'))
-        cmd += ' https://review.openstack.org'
-        cmd += ' http://zuul.rcbops.com'
-        utils.execute_to_log(cmd, job_log_file_path, env=git_args,
-                             cwd=local_path)
-        return local_path
-
-    def _get_work_data(self):
-        if self.work_data is None:
-            hostname = os.uname()[1]
-            self.work_data = dict(
-                name=self.job_name,
-                number=self.job.unique,
-                manager='turbo-hipster-manager-%s' % hostname,
-                url='http://localhost',
-            )
-        return self.work_data
-
-    def _send_work_data(self):
-        """ Send the WORK DATA in json format for job """
-        self.log.debug("Send the work data response: %s" %
-                       json.dumps(self._get_work_data()))
-        self.job.sendWorkData(json.dumps(self._get_work_data()))
-
-    def _do_next_step(self):
-        """ Send a WORK_STATUS command to the gearman server.
-        This can provide a progress bar. """
-
-        # Each opportunity we should check if we need to stop
-        if self.cancelled:
-            self.work_data['result'] = "Failed: Job cancelled"
-            self.job.sendWorkStatus(self.current_step, self.total_steps)
-            self.job.sendWorkFail()
-            raise Exception('Job cancelled')
-
-        self.current_step += 1
-        self.job.sendWorkStatus(self.current_step, self.total_steps)