scheduler/monitor_db_unittest.py

#!/usr/bin/python

import unittest, time, subprocess, os, StringIO, tempfile, datetime, shutil
import logging
import common
import MySQLdb
from autotest_lib.frontend import setup_django_environment
from autotest_lib.frontend.afe import frontend_test_utils
from autotest_lib.client.common_lib import global_config, host_protections
from autotest_lib.client.common_lib.test_utils import mock
from autotest_lib.database import database_connection, migrate
from autotest_lib.frontend import thread_local
from autotest_lib.frontend.afe import models
from autotest_lib.scheduler import monitor_db, drone_manager, email_manager
from autotest_lib.scheduler import scheduler_config

_DEBUG = False


class DummyAgent(object):
    started = False
    _is_done = False
    num_processes = 1
    host_ids = []
    queue_entry_ids = []


    def tick(self):
        self.started = True


    def is_done(self):
        return self._is_done


    def set_done(self, done):
        self._is_done = done


class IsRow(mock.argument_comparator):
    def __init__(self, row_id):
        self.row_id = row_id


    def is_satisfied_by(self, parameter):
        return list(parameter)[0] == self.row_id


    def __str__(self):
        return 'row with id %s' % self.row_id


class IsAgentWithTask(mock.argument_comparator):
    def __init__(self, task):
        self._task = task


    def is_satisfied_by(self, parameter):
        if not isinstance(parameter, monitor_db.Agent):
            return False
        tasks = list(parameter.queue.queue)
        if len(tasks) != 1:
            return False
        return tasks[0] == self._task


def _set_host_and_qe_ids(agent_or_task, id_list=None):
    if id_list is None:
        id_list = []
    agent_or_task.host_ids = agent_or_task.queue_entry_ids = id_list


class BaseSchedulerTest(unittest.TestCase,
                        frontend_test_utils.FrontendTestMixin):
    _config_section = 'AUTOTEST_WEB'

    def _do_query(self, sql):
        self._database.execute(sql)


    def _set_monitor_stubs(self):
        # Clear the instance cache as this is a brand new database.
        monitor_db.DBObject._clear_instance_cache()

        self._database = (
            database_connection.DatabaseConnection.get_test_database(
                self._test_db_file))
        self._database.connect()
        self._database.debug = _DEBUG

        monitor_db._db = self._database
        monitor_db._drone_manager._results_dir = '/test/path'
        monitor_db._drone_manager._temporary_directory = '/test/path/tmp'


    def setUp(self):
        self._frontend_common_setup()
        self._set_monitor_stubs()
        self._dispatcher = monitor_db.Dispatcher()


    def tearDown(self):
        self._database.disconnect()
        self._frontend_common_teardown()


    def _update_hqe(self, set, where=''):
        query = 'UPDATE host_queue_entries SET ' + set
        if where:
            query += ' WHERE ' + where
        self._do_query(query)


class DBObjectTest(BaseSchedulerTest):
    # It may seem odd to subclass BaseSchedulerTest for this but it saves us
    # duplicating some setup work for what we want to test.


    def test_compare_fields_in_row(self):
        host = monitor_db.Host(id=1)
        fields = list(host._fields)
        row_data = [getattr(host, fieldname) for fieldname in fields]
        self.assertEqual({}, host._compare_fields_in_row(row_data))
        row_data[fields.index('hostname')] = 'spam'
        self.assertEqual({'hostname': ('host1', 'spam')},
                         host._compare_fields_in_row(row_data))
        row_data[fields.index('id')] = 23
        self.assertEqual({'hostname': ('host1', 'spam'), 'id': (1, 23)},
                         host._compare_fields_in_row(row_data))


    def test_compare_fields_in_row_datetime_ignores_microseconds(self):
        datetime_with_us = datetime.datetime(2009, 10, 07, 12, 34, 56, 7890)
        datetime_without_us = datetime.datetime(2009, 10, 07, 12, 34, 56, 0)
        class TestTable(monitor_db.DBObject):
            _table_name = 'test_table'
            _fields = ('id', 'test_datetime')
        tt = TestTable(row=[1, datetime_without_us])
        self.assertEqual({}, tt._compare_fields_in_row([1, datetime_with_us]))


    def test_always_query(self):
        host_a = monitor_db.Host(id=2)
        self.assertEqual(host_a.hostname, 'host2')
        self._do_query('UPDATE hosts SET hostname="host2-updated" WHERE id=2')
        host_b = monitor_db.Host(id=2, always_query=True)
        self.assert_(host_a is host_b, 'Cached instance not returned.')
        self.assertEqual(host_a.hostname, 'host2-updated',
                         'Database was not re-queried')

        # If either of these are called, a query was made when it shouldn't be.
        host_a._compare_fields_in_row = lambda _: self.fail('eek! a query!')
        host_a._update_fields_from_row = host_a._compare_fields_in_row
        host_c = monitor_db.Host(id=2, always_query=False)
        self.assert_(host_a is host_c, 'Cached instance not returned')


    def test_delete(self):
        host = monitor_db.Host(id=3)
        host.delete()
        host = self.assertRaises(monitor_db.DBError, monitor_db.Host, id=3,
                                 always_query=False)
        host = self.assertRaises(monitor_db.DBError, monitor_db.Host, id=3,
                                 always_query=True)

    def test_save(self):
        # Dummy Job to avoid creating a one in the HostQueueEntry __init__.
        class MockJob(object):
            def __init__(self, id):
                pass
            def tag(self):
                return 'MockJob'
        self.god.stub_with(monitor_db, 'Job', MockJob)
        hqe = monitor_db.HostQueueEntry(
                new_record=True,
                row=[0, 1, 2, 'Queued', None, 0, 0, 0, '.', None, False, None])
        hqe.save()
        new_id = hqe.id
        # Force a re-query and verify that the correct data was stored.
        monitor_db.DBObject._clear_instance_cache()
        hqe = monitor_db.HostQueueEntry(id=new_id)
        self.assertEqual(hqe.id, new_id)
        self.assertEqual(hqe.job_id, 1)
        self.assertEqual(hqe.host_id, 2)
        self.assertEqual(hqe.status, 'Queued')
        self.assertEqual(hqe.meta_host, None)
        self.assertEqual(hqe.active, False)
        self.assertEqual(hqe.complete, False)
        self.assertEqual(hqe.deleted, False)
        self.assertEqual(hqe.execution_subdir, '.')
        self.assertEqual(hqe.atomic_group_id, None)
        self.assertEqual(hqe.started_on, None)


class DispatcherSchedulingTest(BaseSchedulerTest):
    _jobs_scheduled = []


    def tearDown(self):
        super(DispatcherSchedulingTest, self).tearDown()


    def _set_monitor_stubs(self):
        super(DispatcherSchedulingTest, self)._set_monitor_stubs()

        def hqe__do_schedule_pre_job_tasks_stub(queue_entry):
            """Called by HostQueueEntry.run()."""
            self._record_job_scheduled(queue_entry.job.id, queue_entry.host.id)
            queue_entry.set_status('Starting')

        self.god.stub_with(monitor_db.HostQueueEntry,
                           '_do_schedule_pre_job_tasks',
                           hqe__do_schedule_pre_job_tasks_stub)

        def hqe_queue_log_record_stub(self, log_line):
            """No-Op to avoid calls down to the _drone_manager during tests."""

        self.god.stub_with(monitor_db.HostQueueEntry, 'queue_log_record',
                           hqe_queue_log_record_stub)


    def _record_job_scheduled(self, job_id, host_id):
        record = (job_id, host_id)
        self.assert_(record not in self._jobs_scheduled,
                     'Job %d scheduled on host %d twice' %
                     (job_id, host_id))
        self._jobs_scheduled.append(record)


    def _assert_job_scheduled_on(self, job_id, host_id):
        record = (job_id, host_id)
        self.assert_(record in self._jobs_scheduled,
                     'Job %d not scheduled on host %d as expected\n'
                     'Jobs scheduled: %s' %
                     (job_id, host_id, self._jobs_scheduled))
        self._jobs_scheduled.remove(record)


    def _assert_job_scheduled_on_number_of(self, job_id, host_ids, number):
        """Assert job was scheduled on exactly number hosts out of a set."""
        found = []
        for host_id in host_ids:
            record = (job_id, host_id)
            if record in self._jobs_scheduled:
                found.append(record)
                self._jobs_scheduled.remove(record)
        if len(found) < number:
            self.fail('Job %d scheduled on fewer than %d hosts in %s.\n'
                      'Jobs scheduled: %s' % (job_id, number, host_ids, found))
        elif len(found) > number:
            self.fail('Job %d scheduled on more than %d hosts in %s.\n'
                      'Jobs scheduled: %s' % (job_id, number, host_ids, found))


    def _check_for_extra_schedulings(self):
        if len(self._jobs_scheduled) != 0:
            self.fail('Extra jobs scheduled: ' +
                      str(self._jobs_scheduled))


    def _convert_jobs_to_metahosts(self, *job_ids):
        sql_tuple = '(' + ','.join(str(i) for i in job_ids) + ')'
        self._do_query('UPDATE host_queue_entries SET '
                       'meta_host=host_id, host_id=NULL '
                       'WHERE job_id IN ' + sql_tuple)


    def _lock_host(self, host_id):
        self._do_query('UPDATE hosts SET locked=1 WHERE id=' +
                       str(host_id))


    def setUp(self):
        super(DispatcherSchedulingTest, self).setUp()
        self._jobs_scheduled = []


    def _test_basic_scheduling_helper(self, use_metahosts):
        'Basic nonmetahost scheduling'
        self._create_job_simple([1], use_metahosts)
        self._create_job_simple([2], use_metahosts)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(1, 1)
        self._assert_job_scheduled_on(2, 2)
        self._check_for_extra_schedulings()


    def _test_priorities_helper(self, use_metahosts):
        'Test prioritization ordering'
        self._create_job_simple([1], use_metahosts)
        self._create_job_simple([2], use_metahosts)
        self._create_job_simple([1,2], use_metahosts)
        self._create_job_simple([1], use_metahosts, priority=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(4, 1) # higher priority
        self._assert_job_scheduled_on(2, 2) # earlier job over later
        self._check_for_extra_schedulings()


    def _test_hosts_ready_helper(self, use_metahosts):
        """
        Only hosts that are status=Ready, unlocked and not invalid get
        scheduled.
        """
        self._create_job_simple([1], use_metahosts)
        self._do_query('UPDATE hosts SET status="Running" WHERE id=1')
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()

        self._do_query('UPDATE hosts SET status="Ready", locked=1 '
                       'WHERE id=1')
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()

        self._do_query('UPDATE hosts SET locked=0, invalid=1 '
                       'WHERE id=1')
        self._dispatcher._schedule_new_jobs()
        if not use_metahosts:
            self._assert_job_scheduled_on(1, 1)
        self._check_for_extra_schedulings()


    def _test_hosts_idle_helper(self, use_metahosts):
        'Only idle hosts get scheduled'
        self._create_job(hosts=[1], active=True)
        self._create_job_simple([1], use_metahosts)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def _test_obey_ACLs_helper(self, use_metahosts):
        self._do_query('DELETE FROM acl_groups_hosts WHERE host_id=1')
        self._create_job_simple([1], use_metahosts)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_basic_scheduling(self):
        self._test_basic_scheduling_helper(False)


    def test_priorities(self):
        self._test_priorities_helper(False)


    def test_hosts_ready(self):
        self._test_hosts_ready_helper(False)


    def test_hosts_idle(self):
        self._test_hosts_idle_helper(False)


    def test_obey_ACLs(self):
        self._test_obey_ACLs_helper(False)


    def test_one_time_hosts_ignore_ACLs(self):
        self._do_query('DELETE FROM acl_groups_hosts WHERE host_id=1')
        self._do_query('UPDATE hosts SET invalid=1 WHERE id=1')
        self._create_job_simple([1])
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(1, 1)
        self._check_for_extra_schedulings()


    def test_non_metahost_on_invalid_host(self):
        """
        Non-metahost entries can get scheduled on invalid hosts (this is how
        one-time hosts work).
        """
        self._do_query('UPDATE hosts SET invalid=1')
        self._test_basic_scheduling_helper(False)


    def test_metahost_scheduling(self):
        """
        Basic metahost scheduling
        """
        self._test_basic_scheduling_helper(True)


    def test_metahost_priorities(self):
        self._test_priorities_helper(True)


    def test_metahost_hosts_ready(self):
        self._test_hosts_ready_helper(True)


    def test_metahost_hosts_idle(self):
        self._test_hosts_idle_helper(True)


    def test_metahost_obey_ACLs(self):
        self._test_obey_ACLs_helper(True)


    def _setup_test_only_if_needed_labels(self):
        # apply only_if_needed label3 to host1
        models.Host.smart_get('host1').labels.add(self.label3)
        return self._create_job_simple([1], use_metahost=True)


    def test_only_if_needed_labels_avoids_host(self):
        job = self._setup_test_only_if_needed_labels()
        # if the job doesn't depend on label3, there should be no scheduling
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_only_if_needed_labels_schedules(self):
        job = self._setup_test_only_if_needed_labels()
        job.dependency_labels.add(self.label3)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(1, 1)
        self._check_for_extra_schedulings()


    def test_only_if_needed_labels_via_metahost(self):
        job = self._setup_test_only_if_needed_labels()
        job.dependency_labels.add(self.label3)
        # should also work if the metahost is the only_if_needed label
        self._do_query('DELETE FROM jobs_dependency_labels')
        self._create_job(metahosts=[3])
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(2, 1)
        self._check_for_extra_schedulings()


    def test_nonmetahost_over_metahost(self):
        """
        Non-metahost entries should take priority over metahost entries
        for the same host
        """
        self._create_job(metahosts=[1])
        self._create_job(hosts=[1])
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(2, 1)
        self._check_for_extra_schedulings()


    def test_metahosts_obey_blocks(self):
        """
        Metahosts can't get scheduled on hosts already scheduled for
        that job.
        """
        self._create_job(metahosts=[1], hosts=[1])
        # make the nonmetahost entry complete, so the metahost can try
        # to get scheduled
        self._update_hqe(set='complete = 1', where='host_id=1')
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    # TODO(gps): These should probably live in their own TestCase class
    # specific to testing HostScheduler methods directly.  It was convenient
    # to put it here for now to share existing test environment setup code.
    def test_HostScheduler_check_atomic_group_labels(self):
        normal_job = self._create_job(metahosts=[0])
        atomic_job = self._create_job(atomic_group=1)
        # Indirectly initialize the internal state of the host scheduler.
        self._dispatcher._refresh_pending_queue_entries()

        atomic_hqe = monitor_db.HostQueueEntry.fetch(where='job_id=%d' %
                                                     atomic_job.id)[0]
        normal_hqe = monitor_db.HostQueueEntry.fetch(where='job_id=%d' %
                                                     normal_job.id)[0]

        host_scheduler = self._dispatcher._host_scheduler
        self.assertTrue(host_scheduler._check_atomic_group_labels(
                [self.label4.id], atomic_hqe))
        self.assertFalse(host_scheduler._check_atomic_group_labels(
                [self.label4.id], normal_hqe))
        self.assertFalse(host_scheduler._check_atomic_group_labels(
                [self.label5.id, self.label6.id, self.label7.id], normal_hqe))
        self.assertTrue(host_scheduler._check_atomic_group_labels(
                [self.label4.id, self.label6.id], atomic_hqe))
        self.assertTrue(host_scheduler._check_atomic_group_labels(
                        [self.label4.id, self.label5.id],
                        atomic_hqe))


    def test_HostScheduler_get_host_atomic_group_id(self):
        job = self._create_job(metahosts=[self.label6.id])
        queue_entry = monitor_db.HostQueueEntry.fetch(
                where='job_id=%d' % job.id)[0]
        # Indirectly initialize the internal state of the host scheduler.
        self._dispatcher._refresh_pending_queue_entries()

        # Test the host scheduler
        host_scheduler = self._dispatcher._host_scheduler

        # Two labels each in a different atomic group.  This should log an
        # error and continue.
        orig_logging_error = logging.error
        def mock_logging_error(message, *args):
            mock_logging_error._num_calls += 1
            # Test the logging call itself, we just wrapped it to count it.
            orig_logging_error(message, *args)
        mock_logging_error._num_calls = 0
        self.god.stub_with(logging, 'error', mock_logging_error)
        self.assertNotEquals(None, host_scheduler._get_host_atomic_group_id(
                [self.label4.id, self.label8.id], queue_entry))
        self.assertTrue(mock_logging_error._num_calls > 0)
        self.god.unstub(logging, 'error')

        # Two labels both in the same atomic group, this should not raise an
        # error, it will merely cause the job to schedule on the intersection.
        self.assertEquals(1, host_scheduler._get_host_atomic_group_id(
                [self.label4.id, self.label5.id]))

        self.assertEquals(None, host_scheduler._get_host_atomic_group_id([]))
        self.assertEquals(None, host_scheduler._get_host_atomic_group_id(
                [self.label3.id, self.label7.id, self.label6.id]))
        self.assertEquals(1, host_scheduler._get_host_atomic_group_id(
                [self.label4.id, self.label7.id, self.label6.id]))
        self.assertEquals(1, host_scheduler._get_host_atomic_group_id(
                [self.label7.id, self.label5.id]))


    def test_atomic_group_hosts_blocked_from_non_atomic_jobs(self):
        # Create a job scheduled to run on label6.
        self._create_job(metahosts=[self.label6.id])
        self._dispatcher._schedule_new_jobs()
        # label6 only has hosts that are in atomic groups associated with it,
        # there should be no scheduling.
        self._check_for_extra_schedulings()


    def test_atomic_group_hosts_blocked_from_non_atomic_jobs_explicit(self):
        # Create a job scheduled to run on label5.  This is an atomic group
        # label but this job does not request atomic group scheduling.
        self._create_job(metahosts=[self.label5.id])
        self._dispatcher._schedule_new_jobs()
        # label6 only has hosts that are in atomic groups associated with it,
        # there should be no scheduling.
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_basics(self):
        # Create jobs scheduled to run on an atomic group.
        job_a = self._create_job(synchronous=True, metahosts=[self.label4.id],
                         atomic_group=1)
        job_b = self._create_job(synchronous=True, metahosts=[self.label5.id],
                         atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        # atomic_group.max_number_of_machines was 2 so we should run on 2.
        self._assert_job_scheduled_on_number_of(job_a.id, (5, 6, 7), 2)
        self._assert_job_scheduled_on(job_b.id, 8)  # label5
        self._assert_job_scheduled_on(job_b.id, 9)  # label5
        self._check_for_extra_schedulings()

        # The three host label4 atomic group still has one host available.
        # That means a job with a synch_count of 1 asking to be scheduled on
        # the atomic group can still use the final machine.
        #
        # This may seem like a somewhat odd use case.  It allows the use of an
        # atomic group as a set of machines to run smaller jobs within (a set
        # of hosts configured for use in network tests with eachother perhaps?)
        onehost_job = self._create_job(atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on_number_of(onehost_job.id, (5, 6, 7), 1)
        self._check_for_extra_schedulings()

        # No more atomic groups have hosts available, no more jobs should
        # be scheduled.
        self._create_job(atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_obeys_acls(self):
        # Request scheduling on a specific atomic label but be denied by ACLs.
        self._do_query('DELETE FROM acl_groups_hosts WHERE host_id in (8,9)')
        job = self._create_job(metahosts=[self.label5.id], atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_dependency_label_exclude(self):
        # A dependency label that matches no hosts in the atomic group.
        job_a = self._create_job(atomic_group=1)
        job_a.dependency_labels.add(self.label3)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_metahost_dependency_label_exclude(self):
        # A metahost and dependency label that excludes too many hosts.
        job_b = self._create_job(synchronous=True, metahosts=[self.label4.id],
                                 atomic_group=1)
        job_b.dependency_labels.add(self.label7)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_dependency_label_match(self):
        # A dependency label that exists on enough atomic group hosts in only
        # one of the two atomic group labels.
        job_c = self._create_job(synchronous=True, atomic_group=1)
        job_c.dependency_labels.add(self.label7)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on_number_of(job_c.id, (8, 9), 2)
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_no_metahost(self):
        # Force it to schedule on the other group for a reliable test.
        self._do_query('UPDATE hosts SET invalid=1 WHERE id=9')
        # An atomic job without a metahost.
        job = self._create_job(synchronous=True, atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on_number_of(job.id, (5, 6, 7), 2)
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_partial_group(self):
        # Make one host in labels[3] unavailable so that there are only two
        # hosts left in the group.
        self._do_query('UPDATE hosts SET status="Repair Failed" WHERE id=5')
        job = self._create_job(synchronous=True, metahosts=[self.label4.id],
                         atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        # Verify that it was scheduled on the 2 ready hosts in that group.
        self._assert_job_scheduled_on(job.id, 6)
        self._assert_job_scheduled_on(job.id, 7)
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_not_enough_available(self):
        # Mark some hosts in each atomic group label as not usable.
        # One host running, another invalid in the first group label.
        self._do_query('UPDATE hosts SET status="Running" WHERE id=5')
        self._do_query('UPDATE hosts SET invalid=1 WHERE id=6')
        # One host invalid in the second group label.
        self._do_query('UPDATE hosts SET invalid=1 WHERE id=9')
        # Nothing to schedule when no group label has enough (2) good hosts..
        self._create_job(atomic_group=1, synchronous=True)
        self._dispatcher._schedule_new_jobs()
        # There are not enough hosts in either atomic group,
        # No more scheduling should occur.
        self._check_for_extra_schedulings()

        # Now create an atomic job that has a synch count of 1.  It should
        # schedule on exactly one of the hosts.
        onehost_job = self._create_job(atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on_number_of(onehost_job.id, (7, 8), 1)


    def test_atomic_group_scheduling_no_valid_hosts(self):
        self._do_query('UPDATE hosts SET invalid=1 WHERE id in (8,9)')
        self._create_job(synchronous=True, metahosts=[self.label5.id],
                         atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        # no hosts in the selected group and label are valid.  no schedulings.
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_metahost_works(self):
        # Test that atomic group scheduling also obeys metahosts.
        self._create_job(metahosts=[0], atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        # There are no atomic group hosts that also have that metahost.
        self._check_for_extra_schedulings()

        job_b = self._create_job(metahosts=[self.label5.id], atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(job_b.id, 8)
        self._assert_job_scheduled_on(job_b.id, 9)
        self._check_for_extra_schedulings()


    def test_atomic_group_skips_ineligible_hosts(self):
        # Test hosts marked ineligible for this job are not eligible.
        # How would this ever happen anyways?
        job = self._create_job(metahosts=[self.label4.id], atomic_group=1)
        models.IneligibleHostQueue.objects.create(job=job, host_id=5)
        models.IneligibleHostQueue.objects.create(job=job, host_id=6)
        models.IneligibleHostQueue.objects.create(job=job, host_id=7)
        self._dispatcher._schedule_new_jobs()
        # No scheduling should occur as all desired hosts were ineligible.
        self._check_for_extra_schedulings()


    def test_atomic_group_scheduling_fail(self):
        # If synch_count is > the atomic group number of machines, the job
        # should be aborted immediately.
        model_job = self._create_job(synchronous=True, atomic_group=1)
        model_job.synch_count = 4
        model_job.save()
        job = monitor_db.Job(id=model_job.id)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()
        queue_entries = job.get_host_queue_entries()
        self.assertEqual(1, len(queue_entries))
        self.assertEqual(queue_entries[0].status,
                         models.HostQueueEntry.Status.ABORTED)


    def test_atomic_group_no_labels_no_scheduling(self):
        # Never schedule on atomic groups marked invalid.
        job = self._create_job(metahosts=[self.label5.id], synchronous=True,
                               atomic_group=1)
        # Deleting an atomic group via the frontend marks it invalid and
        # removes all label references to the group.  The job now references
        # an invalid atomic group with no labels associated with it.
        self.label5.atomic_group.invalid = True
        self.label5.atomic_group.save()
        self.label5.atomic_group = None
        self.label5.save()

        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_schedule_directly_on_atomic_group_host_fail(self):
        # Scheduling a job directly on hosts in an atomic group must
        # fail to avoid users inadvertently holding up the use of an
        # entire atomic group by using the machines individually.
        job = self._create_job(hosts=[5])
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_schedule_directly_on_atomic_group_host(self):
        # Scheduling a job directly on one host in an atomic group will
        # work when the atomic group is listed on the HQE in addition
        # to the host (assuming the sync count is 1).
        job = self._create_job(hosts=[5], atomic_group=1)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(job.id, 5)
        self._check_for_extra_schedulings()


    def test_schedule_directly_on_atomic_group_hosts_sync2(self):
        job = self._create_job(hosts=[5,8], atomic_group=1, synchronous=True)
        self._dispatcher._schedule_new_jobs()
        self._assert_job_scheduled_on(job.id, 5)
        self._assert_job_scheduled_on(job.id, 8)
        self._check_for_extra_schedulings()


    def test_schedule_directly_on_atomic_group_hosts_wrong_group(self):
        job = self._create_job(hosts=[5,8], atomic_group=2, synchronous=True)
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_only_schedule_queued_entries(self):
        self._create_job(metahosts=[1])
        self._update_hqe(set='active=1, host_id=2')
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


    def test_no_ready_hosts(self):
        self._create_job(hosts=[1])
        self._do_query('UPDATE hosts SET status="Repair Failed"')
        self._dispatcher._schedule_new_jobs()
        self._check_for_extra_schedulings()


class DispatcherThrottlingTest(BaseSchedulerTest):
    """
    Test that the dispatcher throttles:
     * total number of running processes
     * number of processes started per cycle
    """
    _MAX_RUNNING = 3
    _MAX_STARTED = 2

    def setUp(self):
        super(DispatcherThrottlingTest, self).setUp()
        scheduler_config.config.max_processes_per_drone = self._MAX_RUNNING
        scheduler_config.config.max_processes_started_per_cycle = (
            self._MAX_STARTED)

        def fake_max_runnable_processes(fake_self):
            running = sum(agent.num_processes
                          for agent in self._agents
                          if agent.started and not agent.is_done())
            return self._MAX_RUNNING - running
        self.god.stub_with(drone_manager.DroneManager, 'max_runnable_processes',
                           fake_max_runnable_processes)


    def _setup_some_agents(self, num_agents):
        self._agents = [DummyAgent() for i in xrange(num_agents)]
        self._dispatcher._agents = list(self._agents)


    def _run_a_few_cycles(self):
        for i in xrange(4):
            self._dispatcher._handle_agents()


    def _assert_agents_started(self, indexes, is_started=True):
        for i in indexes:
            self.assert_(self._agents[i].started == is_started,
                         'Agent %d %sstarted' %
                         (i, is_started and 'not ' or ''))


    def _assert_agents_not_started(self, indexes):
        self._assert_agents_started(indexes, False)


    def test_throttle_total(self):
        self._setup_some_agents(4)
        self._run_a_few_cycles()
        self._assert_agents_started([0, 1, 2])
        self._assert_agents_not_started([3])


    def test_throttle_per_cycle(self):
        self._setup_some_agents(3)
        self._dispatcher._handle_agents()
        self._assert_agents_started([0, 1])
        self._assert_agents_not_started([2])


    def test_throttle_with_synchronous(self):
        self._setup_some_agents(2)
        self._agents[0].num_processes = 3
        self._run_a_few_cycles()
        self._assert_agents_started([0])
        self._assert_agents_not_started([1])


    def test_large_agent_starvation(self):
        """
        Ensure large agents don't get starved by lower-priority agents.
        """
        self._setup_some_agents(3)
        self._agents[1].num_processes = 3
        self._run_a_few_cycles()
        self._assert_agents_started([0])
        self._assert_agents_not_started([1, 2])

        self._agents[0].set_done(True)
        self._run_a_few_cycles()
        self._assert_agents_started([1])
        self._assert_agents_not_started([2])


    def test_zero_process_agent(self):
        self._setup_some_agents(5)
        self._agents[4].num_processes = 0
        self._run_a_few_cycles()
        self._assert_agents_started([0, 1, 2, 4])
        self._assert_agents_not_started([3])


class FindAbortTest(BaseSchedulerTest):
    """
    Test the dispatcher abort functionality.
    """
    def _check_host_agent(self, agent, host_id):
        self.assert_(isinstance(agent, monitor_db.Agent))
        self.assert_(agent.task)
        cleanup = agent.task

        self.assert_(isinstance(cleanup, monitor_db.CleanupTask))
        self.assertEquals(cleanup.host.id, host_id)


    def _check_agents(self, agents):
        agents = list(agents)
        self.assertEquals(len(agents), 2)
        self._check_host_agent(agents[0], 1)
        self._check_host_agent(agents[1], 2)


    def _common_setup(self):
        self._create_job(hosts=[1, 2])
        self._update_hqe(set='aborted=1')
        self._agent = self.god.create_mock_class(monitor_db.Agent, 'old_agent')
        self._agent.started = True
        _set_host_and_qe_ids(self._agent, [1, 2])
        self._agent.abort.expect_call()
        self._agent.abort.expect_call() # gets called once for each HQE
        self._dispatcher.add_agent(self._agent)


    def test_find_aborting(self):
        self._common_setup()
        self._dispatcher._find_aborting()
        self.god.check_playback()


    def test_find_aborting_verifying(self):
        self._common_setup()
        self._update_hqe(set='active=1, status="Verifying"')

        self._agent.tick.expect_call()
        self._agent.is_done.expect_call().and_return(True)
        self._dispatcher._find_aborting()
        self._dispatcher._handle_agents()
        self._dispatcher._schedule_special_tasks()
        self._check_agents(self._dispatcher._agents)
        self.god.check_playback()


class PidfileRunMonitorTest(unittest.TestCase):
    execution_tag = 'test_tag'
    pid = 12345
    process = drone_manager.Process('myhost', pid)
    num_tests_failed = 1

    def setUp(self):
        self.god = mock.mock_god()
        self.mock_drone_manager = self.god.create_mock_class(
            drone_manager.DroneManager, 'drone_manager')
        self.god.stub_with(monitor_db, '_drone_manager',
                           self.mock_drone_manager)
        self.god.stub_function(email_manager.manager, 'enqueue_notify_email')
        self.god.stub_with(monitor_db, '_get_pidfile_timeout_secs',
                           self._mock_get_pidfile_timeout_secs)

        self.pidfile_id = object()

        (self.mock_drone_manager.get_pidfile_id_from
             .expect_call(self.execution_tag,
                          pidfile_name=monitor_db._AUTOSERV_PID_FILE)
             .and_return(self.pidfile_id))
        self.mock_drone_manager.register_pidfile.expect_call(self.pidfile_id)

        self.monitor = monitor_db.PidfileRunMonitor()
        self.monitor.attach_to_existing_process(self.execution_tag)


    def tearDown(self):
        self.god.unstub_all()


    def _mock_get_pidfile_timeout_secs(self):
        return 300


    def setup_pidfile(self, pid=None, exit_code=None, tests_failed=None,
                      use_second_read=False):
        contents = drone_manager.PidfileContents()
        if pid is not None:
            contents.process = drone_manager.Process('myhost', pid)
        contents.exit_status = exit_code
        contents.num_tests_failed = tests_failed
        self.mock_drone_manager.get_pidfile_contents.expect_call(
            self.pidfile_id, use_second_read=use_second_read).and_return(
            contents)


    def set_not_yet_run(self):
        self.setup_pidfile()


    def set_empty_pidfile(self):
        self.setup_pidfile()


    def set_running(self, use_second_read=False):
        self.setup_pidfile(self.pid, use_second_read=use_second_read)


    def set_complete(self, error_code, use_second_read=False):
        self.setup_pidfile(self.pid, error_code, self.num_tests_failed,
                           use_second_read=use_second_read)


    def _check_monitor(self, expected_pid, expected_exit_status,
                       expected_num_tests_failed):
        if expected_pid is None:
            self.assertEquals(self.monitor._state.process, None)
        else:
            self.assertEquals(self.monitor._state.process.pid, expected_pid)
        self.assertEquals(self.monitor._state.exit_status, expected_exit_status)
        self.assertEquals(self.monitor._state.num_tests_failed,
                          expected_num_tests_failed)


        self.god.check_playback()


    def _test_read_pidfile_helper(self, expected_pid, expected_exit_status,
                                  expected_num_tests_failed):
        self.monitor._read_pidfile()
        self._check_monitor(expected_pid, expected_exit_status,
                            expected_num_tests_failed)


    def _get_expected_tests_failed(self, expected_exit_status):
        if expected_exit_status is None:
            expected_tests_failed = None
        else:
            expected_tests_failed = self.num_tests_failed
        return expected_tests_failed


    def test_read_pidfile(self):
        self.set_not_yet_run()
        self._test_read_pidfile_helper(None, None, None)

        self.set_empty_pidfile()
        self._test_read_pidfile_helper(None, None, None)

        self.set_running()
        self._test_read_pidfile_helper(self.pid, None, None)

        self.set_complete(123)
        self._test_read_pidfile_helper(self.pid, 123, self.num_tests_failed)


    def test_read_pidfile_error(self):
        self.mock_drone_manager.get_pidfile_contents.expect_call(
            self.pidfile_id, use_second_read=False).and_return(
            drone_manager.InvalidPidfile('error'))
        self.assertRaises(monitor_db.PidfileRunMonitor._PidfileException,
                          self.monitor._read_pidfile)
        self.god.check_playback()


    def setup_is_running(self, is_running):
        self.mock_drone_manager.is_process_running.expect_call(
            self.process).and_return(is_running)


    def _test_get_pidfile_info_helper(self, expected_pid, expected_exit_status,
                                      expected_num_tests_failed):
        self.monitor._get_pidfile_info()
        self._check_monitor(expected_pid, expected_exit_status,
                            expected_num_tests_failed)


    def test_get_pidfile_info(self):
        """
        normal cases for get_pidfile_info
        """
        # running
        self.set_running()
        self.setup_is_running(True)
        self._test_get_pidfile_info_helper(self.pid, None, None)

        # exited during check
        self.set_running()
        self.setup_is_running(False)
        self.set_complete(123, use_second_read=True) # pidfile gets read again
        self._test_get_pidfile_info_helper(self.pid, 123, self.num_tests_failed)

        # completed
        self.set_complete(123)
        self._test_get_pidfile_info_helper(self.pid, 123, self.num_tests_failed)


    def test_get_pidfile_info_running_no_proc(self):
        """
        pidfile shows process running, but no proc exists
        """
        # running but no proc
        self.set_running()
        self.setup_is_running(False)
        self.set_running(use_second_read=True)
        email_manager.manager.enqueue_notify_email.expect_call(
            mock.is_string_comparator(), mock.is_string_comparator())
        self._test_get_pidfile_info_helper(self.pid, 1, 0)
        self.assertTrue(self.monitor.lost_process)


    def test_get_pidfile_info_not_yet_run(self):
        """
        pidfile hasn't been written yet
        """
        self.set_not_yet_run()
        self._test_get_pidfile_info_helper(None, None, None)


    def test_process_failed_to_write_pidfile(self):
        self.set_not_yet_run()
        email_manager.manager.enqueue_notify_email.expect_call(
            mock.is_string_comparator(), mock.is_string_comparator())
        self.monitor._start_time = (time.time() -
                                    monitor_db._get_pidfile_timeout_secs() - 1)
        self._test_get_pidfile_info_helper(None, 1, 0)
        self.assertTrue(self.monitor.lost_process)


class AgentTest(unittest.TestCase):
    def setUp(self):
        self.god = mock.mock_god()
        self._dispatcher = self.god.create_mock_class(monitor_db.Dispatcher,
                                                      'dispatcher')


    def tearDown(self):
        self.god.unstub_all()


    def _create_mock_task(self, name):
        task = self.god.create_mock_class(monitor_db.AgentTask, name)
        _set_host_and_qe_ids(task)
        return task

    def _create_agent(self, task):
        agent = monitor_db.Agent(task)
        agent.dispatcher = self._dispatcher
        return agent


    def _finish_agent(self, agent):
        while not agent.is_done():
            agent.tick()


    def test_agent_abort(self):
        task = self._create_mock_task('task')
        task.poll.expect_call()
        task.is_done.expect_call().and_return(False)
        task.abort.expect_call()
        task.aborted = True

        agent = self._create_agent(task)
        agent.tick()
        agent.abort()
        self._finish_agent(agent)
        self.god.check_playback()


    def _test_agent_abort_before_started_helper(self, ignore_abort=False):
        task = self._create_mock_task('task')
        task.abort.expect_call()
        if ignore_abort:
            task.aborted = False
            task.poll.expect_call()
            task.is_done.expect_call().and_return(True)
            task.success = True
        else:
            task.aborted = True

        agent = self._create_agent(task)
        agent.abort()
        self._finish_agent(agent)
        self.god.check_playback()


    def test_agent_abort_before_started(self):
        self._test_agent_abort_before_started_helper()
        self._test_agent_abort_before_started_helper(True)


class DelayedCallTaskTest(unittest.TestCase):
    def setUp(self):
        self.god = mock.mock_god()


    def tearDown(self):
        self.god.unstub_all()


    def test_delayed_call(self):
        test_time = self.god.create_mock_function('time')
        test_time.expect_call().and_return(33)
        test_time.expect_call().and_return(34.01)
        test_time.expect_call().and_return(34.99)
        test_time.expect_call().and_return(35.01)
        def test_callback():
            test_callback.calls += 1
        test_callback.calls = 0
        delay_task = monitor_db.DelayedCallTask(
                delay_seconds=2, callback=test_callback,
                now_func=test_time)  # time 33
        self.assertEqual(35, delay_task.end_time)
        agent = monitor_db.Agent(delay_task, num_processes=0)
        self.assert_(not agent.started)
        agent.tick()  # activates the task and polls it once, time 34.01
        self.assertEqual(0, test_callback.calls, "callback called early")
        agent.tick()  # time 34.99
        self.assertEqual(0, test_callback.calls, "callback called early")
        agent.tick()  # time 35.01
        self.assertEqual(1, test_callback.calls)
        self.assert_(agent.is_done())
        self.assert_(delay_task.is_done())
        self.assert_(delay_task.success)
        self.assert_(not delay_task.aborted)
        self.god.check_playback()


    def test_delayed_call_abort(self):
        delay_task = monitor_db.DelayedCallTask(
                delay_seconds=987654, callback=lambda : None)
        agent = monitor_db.Agent(delay_task, num_processes=0)
        agent.abort()
        agent.tick()
        self.assert_(agent.is_done())
        self.assert_(delay_task.aborted)
        self.assert_(delay_task.is_done())
        self.assert_(not delay_task.success)
        self.god.check_playback()



class AgentTasksTest(BaseSchedulerTest):
    ABSPATH_BASE = '/abspath/'
    HOSTNAME = 'myhost'
    BASE_TASK_DIR = 'hosts/%s/' % HOSTNAME
    RESULTS_DIR = '/results/dir'
    DUMMY_PROCESS = object()
    HOST_PROTECTION = host_protections.default
    PIDFILE_ID = object()
    JOB_OWNER = 'test_owner'
    JOB_NAME = 'test_job_name'
    JOB_AUTOSERV_PARAMS = set(['-u', JOB_OWNER, '-l', JOB_NAME])
    PLATFORM = 'test_platform'

    def setUp(self):
        super(AgentTasksTest, self).setUp()
        self.god = mock.mock_god()
        self.god.stub_with(drone_manager.DroneManager, 'get_temporary_path',
                           mock.mock_function('get_temporary_path',
                                              default_return_val='tempdir'))
        self.god.stub_function(drone_manager.DroneManager,
                               'copy_results_on_drone')
        self.god.stub_function(drone_manager.DroneManager,
                               'copy_to_results_repository')
        self.god.stub_function(drone_manager.DroneManager,
                               'get_pidfile_id_from')
        self.god.stub_function(drone_manager.DroneManager,
                               'attach_file_to_execution')

        def dummy_absolute_path(drone_manager_self, path):
            return self.ABSPATH_BASE + path
        self.god.stub_with(drone_manager.DroneManager, 'absolute_path',
                           dummy_absolute_path)

        def dummy_abspath(path):
            return self.ABSPATH_BASE + path
        self.god.stub_with(os.path, 'abspath', dummy_abspath)

        self.god.stub_class_method(monitor_db.PidfileRunMonitor, 'run')
        self.god.stub_class_method(monitor_db.PidfileRunMonitor, 'exit_code')
        self.god.stub_class_method(monitor_db.PidfileRunMonitor, 'kill')
        self.god.stub_class_method(monitor_db.PidfileRunMonitor, 'get_process')
        self.god.stub_class_method(monitor_db.PidfileRunMonitor,
                                   'try_copy_to_results_repository')
        self.god.stub_class_method(monitor_db.PidfileRunMonitor,
                                   'try_copy_results_on_drone')
        def mock_has_process(unused):
            return True
        self.god.stub_with(monitor_db.PidfileRunMonitor, 'has_process',
                           mock_has_process)

        self.host = self.god.create_mock_class(monitor_db.Host, 'host')
        self.host.id = 1
        self.host.hostname = self.HOSTNAME
        self.host.protection = self.HOST_PROTECTION

        # For this (and other model creations), we must create the entry this
        # way; otherwise, if an entry matching the id already exists, Django 1.0
        # will raise an exception complaining about a duplicate primary key.
        # This way, Django performs an UPDATE query if an entry matching the id
        # already exists.
        host = models.Host(id=self.host.id, hostname=self.host.hostname,
                           protection=self.host.protection)
        host.save()

        self.job = self.god.create_mock_class(monitor_db.Job, 'job')
        self.job.owner = self.JOB_OWNER
        self.job.name = self.JOB_NAME
        self.job.id = 1337
        self.job.tag = lambda: 'fake-job-tag'
        job = models.Job(id=self.job.id, owner=self.job.owner,
                         name=self.job.name, created_on=datetime.datetime.now())
        job.save()

        self.queue_entry = self.god.create_mock_class(
            monitor_db.HostQueueEntry, 'queue_entry')
        self.queue_entry.id = 1
        self.queue_entry.job = self.job
        self.queue_entry.host = self.host
        self.queue_entry.meta_host = None
        queue_entry = models.HostQueueEntry(id=self.queue_entry.id, job=job,
                                            host=host, meta_host=None)
        queue_entry.save()

        self.task = models.SpecialTask(id=1, host=host,
                                       task=models.SpecialTask.Task.CLEANUP,
                                       is_active=False, is_complete=False,
                                       time_requested=datetime.datetime.now(),
                                       time_started=None,
                                       queue_entry=queue_entry)
        self.task.save()
        self.god.stub_function(self.task, 'activate')
        self.god.stub_function(self.task, 'finish')
        self.god.stub_function(models.SpecialTask.objects, 'create')

        self._dispatcher = self.god.create_mock_class(monitor_db.Dispatcher,
                                                      'dispatcher')


    def tearDown(self):
        super(AgentTasksTest, self).tearDown()
        self.god.unstub_all()


    def run_task(self, task, success):
        """
        Do essentially what an Agent would do, but protect againt
        infinite looping from test errors.
        """
        if not getattr(task, 'agent', None):
            task.agent = object()
        count = 0
        while not task.is_done():
            count += 1
            if count > 10:
                print 'Task failed to finish'
                # in case the playback has clues to why it
                # failed
                self.god.check_playback()
                self.fail()
            task.poll()
        self.assertEquals(task.success, success)


    def setup_run_monitor(self, exit_status, task_tag, copy_log_file=True,
                          aborted=False):
        monitor_db.PidfileRunMonitor.run.expect_call(
            mock.is_instance_comparator(list),
            self.BASE_TASK_DIR + task_tag,
            nice_level=monitor_db.AUTOSERV_NICE_LEVEL,
            log_file=mock.anything_comparator(),
            pidfile_name=monitor_db._AUTOSERV_PID_FILE,
            paired_with_pidfile=None)
        monitor_db.PidfileRunMonitor.exit_code.expect_call()
        if aborted:
            monitor_db.PidfileRunMonitor.kill.expect_call()
        else:
            monitor_db.PidfileRunMonitor.exit_code.expect_call().and_return(
                    exit_status)

        self.task.finish.expect_call()

        if copy_log_file:
            self._setup_move_logfile()


    def _setup_move_logfile(self, copy_on_drone=False,
                            include_destination=False):
        monitor = monitor_db.PidfileRunMonitor
        if copy_on_drone:
            self.queue_entry.execution_path.expect_call().and_return('tag')
            monitor.try_copy_results_on_drone.expect_call(
                source_path=mock.is_string_comparator(),
                destination_path=mock.is_string_comparator())
        elif include_destination:
            monitor.try_copy_to_results_repository.expect_call(
                mock.is_string_comparator(),
                destination_path=mock.is_string_comparator())
        else:
            monitor.try_copy_to_results_repository.expect_call(
                mock.is_string_comparator())


    def _setup_special_task(self, task_id, task_type, use_queue_entry):
        self.task.id = task_id
        self.task.task = task_type
        if use_queue_entry:
            queue_entry = models.HostQueueEntry(id=self.queue_entry.id)
        else:
            queue_entry = None
        self.task.queue_entry = queue_entry
        self.task.save()


    def _setup_write_host_keyvals_expects(self, task_tag):
        self.host.platform_and_labels.expect_call().and_return(
                (self.PLATFORM, (self.PLATFORM,)))

        execution_path = os.path.join(self.BASE_TASK_DIR, task_tag)
        file_contents = ('platform=%(platform)s\nlabels=%(platform)s\n'
                         % dict(platform=self.PLATFORM))
        file_path = os.path.join(execution_path, 'host_keyvals', self.HOSTNAME)
        drone_manager.DroneManager.attach_file_to_execution.expect_call(
                execution_path, file_contents, file_path=file_path)


    def _test_repair_task_helper(self, success, task_id, use_queue_entry=False):
        self._setup_special_task(task_id, models.SpecialTask.Task.REPAIR,
                                 use_queue_entry)
        task_tag = '%d-repair' % task_id

        self.task.activate.expect_call()
        self._setup_write_host_keyvals_expects(task_tag)

        self.host.set_status.expect_call('Repairing')
        if success:
            self.setup_run_monitor(0, task_tag)
            self.host.set_status.expect_call('Ready')
        else:
            self.setup_run_monitor(1, task_tag)
            self.host.set_status.expect_call('Repair Failed')

        task = monitor_db.RepairTask(task=self.task)
        task.host = self.host
        if use_queue_entry:
            task.queue_entry = self.queue_entry

        self.run_task(task, success)

        expected_protection = host_protections.Protection.get_string(
            host_protections.default)
        expected_protection = host_protections.Protection.get_attr_name(
            expected_protection)

        self.assertTrue(set(task.cmd) >=
                        set([monitor_db._autoserv_path, '-p', '-R', '-m',
                             self.HOSTNAME, '-r',
                             drone_manager.WORKING_DIRECTORY,
                             '--host-protection', expected_protection]))
        self.god.check_playback()


    def test_repair_task(self):
        self._test_repair_task_helper(True, 1)
        self._test_repair_task_helper(False, 2)


    def test_repair_task_with_hqe_already_requeued(self):
        # during recovery, a RepairTask can be passed a queue entry that has
        # already been requeued.  ensure it leaves the HQE alone in that case.
        self.queue_entry.meta_host = 1
        self.queue_entry.host = None
        self._test_repair_task_helper(False, 1, True)


    def test_recovery_repair_task_working_directory(self):
        # ensure that a RepairTask recovering an existing SpecialTask picks up
        # the working directory immediately
        class MockSpecialTask(object):
            def execution_path(self):
                return '/my/path'
            host = models.Host(id=self.host.id)
            queue_entry = None

        task = monitor_db.RepairTask(task=MockSpecialTask())

        self.assertEquals(task._working_directory, '/my/path')


    def test_repair_task_aborted(self):
        self._setup_special_task(1, models.SpecialTask.Task.REPAIR, False)
        task_tag = '1-repair'

        self.task.activate.expect_call()
        self._setup_write_host_keyvals_expects(task_tag)

        self.host.set_status.expect_call('Repairing')
        self.setup_run_monitor(0, task_tag, aborted=True)

        task = monitor_db.RepairTask(task=self.task)
        task.host = self.host
        task.agent = object()

        task.poll()
        task.abort()

        self.assertTrue(task.done)
        self.assertTrue(task.aborted)
        self.god.check_playback()


    def _test_repair_task_with_queue_entry_helper(self, parse_failed_repair,
                                                  task_id):
        self._setup_special_task(task_id, models.SpecialTask.Task.REPAIR, True)
        task_tag = '%d-repair' % task_id

        self.god.stub_class(monitor_db, 'FinalReparseTask')
        self.god.stub_class(monitor_db, 'Agent')
        self.god.stub_class_method(monitor_db.TaskWithJobKeyvals,
                                   '_write_keyval_after_job')
        agent = DummyAgent()
        agent.dispatcher = self._dispatcher

        self.task.activate.expect_call()
        self._setup_write_host_keyvals_expects(task_tag)

        self.host.set_status.expect_call('Repairing')
        self.setup_run_monitor(1, task_tag)
        self.host.set_status.expect_call('Repair Failed')
        self.queue_entry.update_from_database.expect_call()
        self.queue_entry.status = 'Queued'
        self.queue_entry.set_execution_subdir.expect_call()
        monitor_db.TaskWithJobKeyvals._write_keyval_after_job.expect_call(
            'job_queued', mock.is_instance_comparator(int))
        monitor_db.TaskWithJobKeyvals._write_keyval_after_job.expect_call(
            'job_finished', mock.is_instance_comparator(int))
        self._setup_move_logfile(copy_on_drone=True)
        self.queue_entry.execution_path.expect_call().and_return('tag')
        self._setup_move_logfile()
        self.job.parse_failed_repair = parse_failed_repair
        self.queue_entry.handle_host_failure.expect_call()
        if parse_failed_repair:
            self.queue_entry.set_status.expect_call('Parsing')
        self.queue_entry.execution_path.expect_call().and_return('tag')
        drone_manager.DroneManager.get_pidfile_id_from.expect_call(
                'tag', pidfile_name=monitor_db._AUTOSERV_PID_FILE).and_return(
                        self.PIDFILE_ID)

        task = monitor_db.RepairTask(task=self.task)
        task.agent = agent
        task.host = self.host
        task.queue_entry = self.queue_entry
        self.queue_entry.status = 'Queued'
        self.job.created_on = datetime.datetime(2009, 1, 1)

        self.run_task(task, False)
        self.assertTrue(set(task.cmd) >= self.JOB_AUTOSERV_PARAMS)
        self.god.check_playback()


    def test_repair_task_with_queue_entry(self):
        self._test_repair_task_with_queue_entry_helper(True, 1)
        self._test_repair_task_with_queue_entry_helper(False, 2)


    def _setup_prejob_task_failure(self, task_tag, use_queue_entry):
        self.setup_run_monitor(1, task_tag)
        if use_queue_entry:
            if not self.queue_entry.meta_host:
                self.queue_entry.set_execution_subdir.expect_call()
                self.queue_entry.execution_path.expect_call().and_return('tag')
                self._setup_move_logfile(include_destination=True)
            self.queue_entry.requeue.expect_call()
            queue_entry = models.HostQueueEntry(id=self.queue_entry.id)
        else:
            queue_entry = None
        models.SpecialTask.objects.create.expect_call(
                host=models.Host(id=self.host.id),
                task=models.SpecialTask.Task.REPAIR,
                queue_entry=queue_entry)


    def setup_verify_expects(self, success, use_queue_entry, task_tag):
        self.task.activate.expect_call()
        self._setup_write_host_keyvals_expects(task_tag)

        if use_queue_entry:
            self.queue_entry.set_status.expect_call('Verifying')
        self.host.set_status.expect_call('Verifying')
        if success:
            self.setup_run_monitor(0, task_tag)
            if use_queue_entry:
                self.queue_entry.on_pending.expect_call()
            else:
                self.host.set_status.expect_call('Ready')
        else:
            self._setup_prejob_task_failure(task_tag, use_queue_entry)


    def _test_verify_task_helper(self, success, task_id, use_queue_entry=False,
                                 use_meta_host=False):
        self._setup_special_task(task_id, models.SpecialTask.Task.VERIFY,
                                 use_queue_entry)
        task_tag = '%d-verify' % task_id
        self.setup_verify_expects(success, use_queue_entry, task_tag)

        task = monitor_db.VerifyTask(task=self.task)
        task.host = self.host
        if use_queue_entry:
            task.queue_entry = self.queue_entry

        self.run_task(task, success)
        self.assertTrue(set(task.cmd) >=
                        set([monitor_db._autoserv_path, '-p', '-v', '-m',
                             self.HOSTNAME, '-r',
                             drone_manager.WORKING_DIRECTORY]))
        if use_queue_entry:
            self.assertTrue(set(task.cmd) >= self.JOB_AUTOSERV_PARAMS)
        self.god.check_playback()


    def test_verify_task_with_host(self):
        self._test_verify_task_helper(True, 1)
        self._test_verify_task_helper(False, 2)


    def test_verify_task_with_queue_entry(self):
        self._test_verify_task_helper(True, 1, use_queue_entry=True)
        self._test_verify_task_helper(False, 2, use_queue_entry=True)


    def test_verify_task_with_metahost(self):
        self.queue_entry.meta_host = 1
        self.test_verify_task_with_queue_entry()


    def test_specialtask_abort_before_prolog(self):
        self._setup_special_task(1, models.SpecialTask.Task.REPAIR, False)
        task = monitor_db.RepairTask(task=self.task)
        self.task.finish.expect_call()
        task.abort()
        self.assertTrue(task.aborted)


    def _setup_post_job_task_expects(self, autoserv_success, hqe_status=None,
                                     hqe_aborted=False, host_status=None):
        self.queue_entry.execution_path.expect_call().and_return('tag')
        self.pidfile_monitor = monitor_db.PidfileRunMonitor.expect_new()
        self.pidfile_monitor.pidfile_id = self.PIDFILE_ID
        self.pidfile_monitor.attach_to_existing_process.expect_call('tag')
        if autoserv_success:
            code = 0
        else:
            code = 1
        self.queue_entry.update_from_database.expect_call()
        self.queue_entry.aborted = hqe_aborted
        if not hqe_aborted:
            self.pidfile_monitor.exit_code.expect_call().and_return(code)

        if hqe_status:
            self.queue_entry.status = hqe_status
        if host_status:
            self.host.status = host_status


    def _setup_pre_parse_expects(self, autoserv_success):
        self._setup_post_job_task_expects(autoserv_success, 'Parsing')


    def _setup_post_parse_expects(self, autoserv_success):
        if autoserv_success:
            status = 'Completed'
        else:
            status = 'Failed'
        self.queue_entry.set_status.expect_call(status)


    def _expect_execute_run_monitor(self):
        self.monitor.exit_code.expect_call()
        self.monitor.exit_code.expect_call().and_return(0)
        self._expect_copy_results()


    def _setup_post_job_run_monitor(self, pidfile_name):
        self.pidfile_monitor.has_process.expect_call().and_return(True)
        autoserv_pidfile_id = object()
        self.monitor = monitor_db.PidfileRunMonitor.expect_new()
        self.monitor.run.expect_call(
            mock.is_instance_comparator(list),
            'tag',
            nice_level=monitor_db.AUTOSERV_NICE_LEVEL,
            log_file=mock.anything_comparator(),
            pidfile_name=pidfile_name,
            paired_with_pidfile=self.PIDFILE_ID)
        self._expect_execute_run_monitor()


    def _expect_copy_results(self, monitor=None, queue_entry=None):
        if monitor is None:
            monitor = self.monitor
        if queue_entry:
            queue_entry.execution_path.expect_call().and_return('tag')
        monitor.try_copy_to_results_repository.expect_call(
                mock.is_string_comparator())


    def _test_final_reparse_task_helper(self, autoserv_success=True):
        self._setup_pre_parse_expects(autoserv_success)
        self._setup_post_job_run_monitor(monitor_db._PARSER_PID_FILE)
        self._setup_post_parse_expects(autoserv_success)

        task = monitor_db.FinalReparseTask([self.queue_entry])
        self.run_task(task, True)

        self.god.check_playback()
        cmd = [monitor_db._parser_path, '--write-pidfile', '-l', '2', '-r',
               '-o', '-P', '/abspath/tag']
        self.assertEquals(task.cmd, cmd)


    def test_final_reparse_task(self):
        self.god.stub_class(monitor_db, 'PidfileRunMonitor')
        self._test_final_reparse_task_helper()
        self._test_final_reparse_task_helper(autoserv_success=False)


    def test_final_reparse_throttling(self):
        self.god.stub_class(monitor_db, 'PidfileRunMonitor')
        self.god.stub_function(monitor_db.FinalReparseTask,
                               '_can_run_new_parse')

        self._setup_pre_parse_expects(True)
        monitor_db.FinalReparseTask._can_run_new_parse.expect_call().and_return(
            False)
        monitor_db.FinalReparseTask._can_run_new_parse.expect_call().and_return(
            True)
        self._setup_post_job_run_monitor(monitor_db._PARSER_PID_FILE)
        self._setup_post_parse_expects(True)

        task = monitor_db.FinalReparseTask([self.queue_entry])
        self.run_task(task, True)
        self.god.check_playback()


    def test_final_reparse_recovery(self):
        self.god.stub_class(monitor_db, 'PidfileRunMonitor')
        self.monitor = self.god.create_mock_class(monitor_db.PidfileRunMonitor,
                                                  'run_monitor')
        self._setup_post_job_task_expects(True)
        self._expect_execute_run_monitor()
        self._setup_post_parse_expects(True)

        task = monitor_db.FinalReparseTask([self.queue_entry],
                                           recover_run_monitor=self.monitor)
        self.run_task(task, True)
        self.god.check_playback()


    def _setup_gather_logs_expects(self, autoserv_killed=True,
                                   hqe_aborted=False, has_process=True):
        self.god.stub_class(monitor_db, 'PidfileRunMonitor')
        self.god.stub_class(monitor_db, 'FinalReparseTask')
        self._setup_post_job_task_expects(not autoserv_killed, 'Gathering',
                                          hqe_aborted, host_status='Running')
        if hqe_aborted or not has_process:
            exit_code = None
        elif autoserv_killed:
            exit_code = 271
        else:
            exit_code = 0
        self.pidfile_monitor.exit_code.expect_call().and_return(exit_code)

        if has_process:
            if exit_code != 0:
                self._setup_post_job_run_monitor('.collect_crashinfo_execute')
            self.pidfile_monitor.has_process.expect_call().and_return(True)
            self.pidfile_monitor.has_process.expect_call().and_return(True)
            self._expect_copy_results(monitor=self.pidfile_monitor,
                                      queue_entry=self.queue_entry)
        else:
            # The first has_process() is in GatherLogsTask.run(), and the second
            # is in AgentTask._copy_results()
            self.pidfile_monitor.has_process.expect_call().and_return(False)
            self.pidfile_monitor.has_process.expect_call().and_return(False)

        self.queue_entry.set_status.expect_call('Parsing')
        self.pidfile_monitor.has_process.expect_call().and_return(has_process)

        if has_process:
            self.pidfile_monitor.num_tests_failed.expect_call().and_return(0)


    def _run_gather_logs_task(self, success=True):
        task = monitor_db.GatherLogsTask(self.job, [self.queue_entry])
        task.agent = DummyAgent()
        task.agent.dispatcher = self._dispatcher
        self.run_task(task, success)
        self.god.check_playback()


    def test_gather_logs_task(self):
        self._setup_gather_logs_expects()
        # no rebooting for this basic test
        self.job.reboot_after = models.RebootAfter.NEVER
        self.host.set_status.expect_call('Ready')

        self._run_gather_logs_task()


    def test_gather_logs_task_successful_autoserv(self):
        # When Autoserv exits successfully, no collect_crashinfo stage runs
        self._setup_gather_logs_expects(autoserv_killed=False)
        self.job.reboot_after = models.RebootAfter.NEVER
        self.host.set_status.expect_call('Ready')

        self._run_gather_logs_task()


    def _setup_gather_task_cleanup_expects(self):
        models.SpecialTask.objects.create.expect_call(
                host=models.Host(id=self.host.id),
                task=models.SpecialTask.Task.CLEANUP)


    def test_gather_logs_reboot_hosts(self):
        self._setup_gather_logs_expects()
        self.job.reboot_after = models.RebootAfter.ALWAYS
        self._setup_gather_task_cleanup_expects()

        self._run_gather_logs_task()


    def test_gather_logs_reboot_on_abort(self):
        self._setup_gather_logs_expects(hqe_aborted=True)
        self.job.reboot_after = models.RebootAfter.NEVER
        self._setup_gather_task_cleanup_expects()

        self._run_gather_logs_task()


    def test_gather_logs_no_process(self):
        self._setup_gather_logs_expects(has_process=False)
        self.job.reboot_after = models.RebootAfter.NEVER
        self.host.set_status.expect_call('Ready')

        self._run_gather_logs_task(success=False)


    def _test_cleanup_task_helper(self, success, task_id,
                                  use_queue_entry=False):
        self._setup_special_task(task_id, models.SpecialTask.Task.CLEANUP,
                                 use_queue_entry)
        task_tag = '%d-cleanup' % task_id

        self.task.activate.expect_call()
        self._setup_write_host_keyvals_expects(task_tag)

        self.host.set_status.expect_call('Cleaning')

        if use_queue_entry:
            self.queue_entry.set_status.expect_call('Verifying')

        if success:
            self.setup_run_monitor(0, task_tag)
            self.host.update_field.expect_call('dirty', 0)
            if use_queue_entry:
                queue_entry = models.HostQueueEntry(id=self.queue_entry.id)
                models.SpecialTask.objects.create.expect_call(
                        host=models.Host(id=self.host.id),
                        task=models.SpecialTask.Task.VERIFY,
                        queue_entry=queue_entry)
            else:
                self.host.set_status.expect_call('Ready')
        else:
            self._setup_prejob_task_failure(task_tag, use_queue_entry)

        task = monitor_db.CleanupTask(task=self.task)
        task.host = self.host
        if use_queue_entry:
            task.queue_entry = self.queue_entry

        self.run_task(task, success)

        self.god.check_playback()
        self.assert_(set(task.cmd) >=
                     set([monitor_db._autoserv_path, '-p', '--cleanup', '-m',
                          self.HOSTNAME, '-r',
                          drone_manager.WORKING_DIRECTORY]))
        if use_queue_entry:
            self.assertTrue(set(task.cmd) >= self.JOB_AUTOSERV_PARAMS)

    def test_cleanup_task(self):
        self._test_cleanup_task_helper(True, 1)
        self._test_cleanup_task_helper(False, 2)


    def test_cleanup_task_with_queue_entry(self):
        self._test_cleanup_task_helper(False, 1, use_queue_entry=True)


    def test_recovery_queue_task_aborted_early(self):
        # abort a recovery QueueTask right after it's created
        self.god.stub_class_method(monitor_db.QueueTask, '_log_abort')
        self.god.stub_class_method(monitor_db.QueueTask, '_finish_task')
        run_monitor = self.god.create_mock_class(monitor_db.PidfileRunMonitor,
                                                 'run_monitor')

        self.queue_entry.get_group_name.expect_call().and_return('')
        self.queue_entry.execution_path.expect_call().and_return('tag')
        run_monitor.kill.expect_call()
        monitor_db.QueueTask._log_abort.expect_call()
        monitor_db.QueueTask._finish_task.expect_call()

        task = monitor_db.QueueTask(self.job, [self.queue_entry],
                                    recover_run_monitor=run_monitor)
        task.abort()
        self.assert_(task.aborted)
        self.god.check_playback()


class HostTest(BaseSchedulerTest):
    def test_cmp_for_sort(self):
        expected_order = [
                'alice', 'Host1', 'host2', 'host3', 'host09', 'HOST010',
                'host10', 'host11', 'yolkfolk']
        hostname_idx = list(monitor_db.Host._fields).index('hostname')
        row = [None] * len(monitor_db.Host._fields)
        hosts = []
        for hostname in expected_order:
            row[hostname_idx] = hostname
            hosts.append(monitor_db.Host(row=row, new_record=True))

        host1 = hosts[expected_order.index('Host1')]
        host010 = hosts[expected_order.index('HOST010')]
        host10 = hosts[expected_order.index('host10')]
        host3 = hosts[expected_order.index('host3')]
        alice = hosts[expected_order.index('alice')]
        self.assertEqual(0, monitor_db.Host.cmp_for_sort(host10, host10))
        self.assertEqual(1, monitor_db.Host.cmp_for_sort(host10, host010))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host010, host10))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host1, host10))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host1, host010))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host3, host10))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host3, host010))
        self.assertEqual(1, monitor_db.Host.cmp_for_sort(host3, host1))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(host1, host3))
        self.assertEqual(-1, monitor_db.Host.cmp_for_sort(alice, host3))
        self.assertEqual(1, monitor_db.Host.cmp_for_sort(host3, alice))
        self.assertEqual(0, monitor_db.Host.cmp_for_sort(alice, alice))

        hosts.sort(cmp=monitor_db.Host.cmp_for_sort)
        self.assertEqual(expected_order, [h.hostname for h in hosts])

        hosts.reverse()
        hosts.sort(cmp=monitor_db.Host.cmp_for_sort)
        self.assertEqual(expected_order, [h.hostname for h in hosts])


class HostQueueEntryTest(BaseSchedulerTest):
    def _create_hqe(self, dependency_labels=(), **create_job_kwargs):
        job = self._create_job(**create_job_kwargs)
        for label in dependency_labels:
            job.dependency_labels.add(label)
        hqes = list(monitor_db.HostQueueEntry.fetch(where='job_id=%d' % job.id))
        self.assertEqual(1, len(hqes))
        return hqes[0]


    def _check_hqe_labels(self, hqe, expected_labels):
        expected_labels = set(expected_labels)
        label_names = set(label.name for label in hqe.get_labels())
        self.assertEqual(expected_labels, label_names)


    def test_get_labels_empty(self):
        hqe = self._create_hqe(hosts=[1])
        labels = list(hqe.get_labels())
        self.assertEqual([], labels)


    def test_get_labels_metahost(self):
        hqe = self._create_hqe(metahosts=[2])
        self._check_hqe_labels(hqe, ['label2'])


    def test_get_labels_dependancies(self):
        hqe = self._create_hqe(dependency_labels=(self.label3, self.label4),
                               metahosts=[1])
        self._check_hqe_labels(hqe, ['label1', 'label3', 'label4'])


class JobTest(BaseSchedulerTest):
    def setUp(self):
        super(JobTest, self).setUp()
        self.god.stub_with(
            drone_manager.DroneManager, 'attach_file_to_execution',
            mock.mock_function('attach_file_to_execution',
                               default_return_val='/test/path/tmp/foo'))

        def _mock_create(**kwargs):
            task = models.SpecialTask(**kwargs)
            task.save()
            self._task = task
        self.god.stub_with(models.SpecialTask.objects, 'create', _mock_create)


    def _test_pre_job_tasks_helper(self):
        """
        Calls HQE._do_schedule_pre_job_tasks() and returns the created special
        task
        """
        self._task = None
        queue_entry = monitor_db.HostQueueEntry.fetch('id = 1')[0]
        queue_entry._do_schedule_pre_job_tasks()
        return self._task


    def _test_run_helper(self, expect_agent=True, expect_starting=False,
                         expect_pending=False):
        if expect_starting:
            expected_status = models.HostQueueEntry.Status.STARTING
        elif expect_pending:
            expected_status = models.HostQueueEntry.Status.PENDING
        else:
            expected_status = models.HostQueueEntry.Status.VERIFYING
        job = monitor_db.Job.fetch('id = 1')[0]
        queue_entry = monitor_db.HostQueueEntry.fetch('id = 1')[0]
        assert queue_entry.job is job
        job.run_if_ready(queue_entry)

        self.god.check_playback()

        self._dispatcher._schedule_delay_tasks()
        self._dispatcher._schedule_running_host_queue_entries()
        agent = self._dispatcher._agents[0]

        actual_status = models.HostQueueEntry.smart_get(1).status
        self.assertEquals(expected_status, actual_status)

        if not expect_agent:
            self.assertEquals(agent, None)
            return

        self.assert_(isinstance(agent, monitor_db.Agent))
        self.assert_(agent.task)
        return agent.task


    def test_schedule_running_host_queue_entries_fail(self):
        self._create_job(hosts=[2])
        self._update_hqe("status='%s', execution_subdir=''" %
                         models.HostQueueEntry.Status.PENDING)
        job = monitor_db.Job.fetch('id = 1')[0]
        queue_entry = monitor_db.HostQueueEntry.fetch('id = 1')[0]
        assert queue_entry.job is job
        job.run_if_ready(queue_entry)
        self.assertEqual(queue_entry.status,
                         models.HostQueueEntry.Status.STARTING)
        self.assert_(queue_entry.execution_subdir)
        self.god.check_playback()

        class dummy_test_agent(object):
            task = 'dummy_test_agent'
        self._dispatcher._register_agent_for_ids(
                self._dispatcher._host_agents, [queue_entry.host.id],
                dummy_test_agent)

        # Attempted to schedule on a host that already has an agent.
        self.assertRaises(monitor_db.SchedulerError,
                          self._dispatcher._schedule_running_host_queue_entries)


    def test_run_if_ready_delays(self):
        # Also tests Job.run_with_ready_delay() on atomic group jobs.
        django_job = self._create_job(hosts=[5, 6], atomic_group=1)
        job = monitor_db.Job(django_job.id)
        self.assertEqual(1, job.synch_count)
        django_hqes = list(models.HostQueueEntry.objects.filter(job=job.id))
        self.assertEqual(2, len(django_hqes))
        self.assertEqual(2, django_hqes[0].atomic_group.max_number_of_machines)

        def set_hqe_status(django_hqe, status):
            django_hqe.status = status
            django_hqe.save()
            monitor_db.HostQueueEntry(django_hqe.id).host.set_status(status)

        # An initial state, our synch_count is 1
        set_hqe_status(django_hqes[0], models.HostQueueEntry.Status.VERIFYING)
        set_hqe_status(django_hqes[1], models.HostQueueEntry.Status.PENDING)

        # So that we don't depend on the config file value during the test.
        self.assert_(scheduler_config.config
                     .secs_to_wait_for_atomic_group_hosts is not None)
        self.god.stub_with(scheduler_config.config,
                           'secs_to_wait_for_atomic_group_hosts', 123456)

        # Get the pending one as a monitor_db.HostQueueEntry object.
        hqe = monitor_db.HostQueueEntry(django_hqes[1].id)
        self.assert_(not job._delay_ready_task)
        self.assertTrue(job.is_ready())

        # Ready with one pending, one verifying and an atomic group should
        # result in a DelayCallTask to re-check if we're ready a while later.
        job.run_if_ready(hqe)
        self.assertEquals('Waiting', hqe.status)
        self._dispatcher._schedule_delay_tasks()
        self.assertEquals('Pending', hqe.status)
        agent = self._dispatcher._agents[0]
        self.assert_(job._delay_ready_task)
        self.assert_(isinstance(agent, monitor_db.Agent))
        self.assert_(agent.task)
        delay_task = agent.task
        self.assert_(isinstance(delay_task, monitor_db.DelayedCallTask))
        self.assert_(not delay_task.is_done())

        self.god.stub_function(delay_task, 'abort')

        self.god.stub_function(job, 'run')

        self.god.stub_function(job, '_pending_count')
        self.god.stub_function(job, '_pending_threshold')

        # Test that the DelayedCallTask's callback queued up above does the
        # correct thing and does not call run if there are not enough hosts
        # in pending after the delay.
        job._pending_threshold.expect_call(hqe.atomic_group).and_return(9)
        job._pending_count.expect_call().and_return(0)
        delay_task._callback()
        self.god.check_playback()

        # Test that the DelayedCallTask's callback queued up above does the
        # correct thing and returns the Agent returned by job.run() if
        # there are still enough hosts pending after the delay.
        job._pending_threshold.expect_call(hqe.atomic_group).and_return(4)
        job._pending_count.expect_call().and_return(4)
        job.run.expect_call(hqe)
        delay_task._callback()
        self.god.check_playback()

        job._pending_threshold.expect_call(hqe.atomic_group).and_return(4)
        job._pending_count.expect_call().and_return(4)

        # Adjust the delay deadline so that enough time has passed.
        job._delay_ready_task.end_time = time.time() - 111111
        job.run.expect_call(hqe)
        # ...the delay_expired condition should cause us to call run()
        self._dispatcher._handle_agents()
        self.god.check_playback()
        delay_task.success = False

        # Adjust the delay deadline back so that enough time has not passed.
        job._delay_ready_task.end_time = time.time() + 111111
        self._dispatcher._handle_agents()
        self.god.check_playback()

        # Now max_number_of_machines HQEs are in pending state.  Remaining
        # delay will now be ignored.
        other_hqe = monitor_db.HostQueueEntry(django_hqes[0].id)
        self.god.unstub(job, 'run')
        self.god.unstub(job, '_pending_count')
        self.god.unstub(job, '_pending_threshold')
        # ...the over_max_threshold test should cause us to call run()
        delay_task.abort.expect_call()
        other_hqe.on_pending()
        self.assertEquals('Starting', other_hqe.status)
        self.assertEquals('Starting', hqe.status)
        self.god.stub_function(job, 'run')
        self.god.unstub(delay_task, 'abort')

        hqe.set_status('Pending')
        other_hqe.set_status('Pending')
        # Now we're not over the max for the atomic group.  But all assigned
        # hosts are in pending state.  over_max_threshold should make us run().
        hqe.atomic_group.max_number_of_machines += 1
        hqe.atomic_group.save()
        job.run.expect_call(hqe)
        hqe.on_pending()
        self.god.check_playback()
        hqe.atomic_group.max_number_of_machines -= 1
        hqe.atomic_group.save()

        other_hqe = monitor_db.HostQueueEntry(django_hqes[0].id)
        self.assertTrue(hqe.job is other_hqe.job)
        # DBObject classes should reuse instances so these should be the same.
        self.assertEqual(job, other_hqe.job)
        self.assertEqual(other_hqe.job, hqe.job)
        # Be sure our delay was not lost during the other_hqe construction.
        self.assertEqual(job._delay_ready_task, delay_task)
        self.assert_(job._delay_ready_task)
        self.assertFalse(job._delay_ready_task.is_done())
        self.assertFalse(job._delay_ready_task.aborted)

        # We want the real run() to be called below.
        self.god.unstub(job, 'run')

        # We pass in the other HQE this time the same way it would happen
        # for real when one host finishes verifying and enters pending.
        job.run_if_ready(other_hqe)

        # The delayed task must be aborted by the actual run() call above.
        self.assertTrue(job._delay_ready_task.aborted)
        self.assertFalse(job._delay_ready_task.success)
        self.assertTrue(job._delay_ready_task.is_done())

        # Check that job run() and _finish_run() were called by the above:
        self._dispatcher._schedule_running_host_queue_entries()
        agent = self._dispatcher._agents[0]
        self.assert_(agent.task)
        task = agent.task
        self.assert_(isinstance(task, monitor_db.QueueTask))
        # Requery these hqes in order to verify the status from the DB.
        django_hqes = list(models.HostQueueEntry.objects.filter(job=job.id))
        for entry in django_hqes:
            self.assertEqual(models.HostQueueEntry.Status.STARTING,
                             entry.status)

        # We're already running, but more calls to run_with_ready_delay can
        # continue to come in due to straggler hosts enter Pending.  Make
        # sure we don't do anything.
        self.god.stub_function(job, 'run')
        job.run_with_ready_delay(hqe)
        self.god.check_playback()
        self.god.unstub(job, 'run')


    def test__atomic_and_has_started__on_atomic(self):
        self._create_job(hosts=[5, 6], atomic_group=1)
        job = monitor_db.Job.fetch('id = 1')[0]
        self.assertFalse(job._atomic_and_has_started())

        self._update_hqe("status='Pending'")
        self.assertFalse(job._atomic_and_has_started())
        self._update_hqe("status='Verifying'")
        self.assertFalse(job._atomic_and_has_started())
        self.assertFalse(job._atomic_and_has_started())
        self._update_hqe("status='Failed'")
        self.assertFalse(job._atomic_and_has_started())
        self._update_hqe("status='Stopped'")
        self.assertFalse(job._atomic_and_has_started())

        self._update_hqe("status='Starting'")
        self.assertTrue(job._atomic_and_has_started())
        self._update_hqe("status='Completed'")
        self.assertTrue(job._atomic_and_has_started())
        self._update_hqe("status='Aborted'")


    def test__atomic_and_has_started__not_atomic(self):
        self._create_job(hosts=[1, 2])
        job = monitor_db.Job.fetch('id = 1')[0]
        self.assertFalse(job._atomic_and_has_started())
        self._update_hqe("status='Starting'")
        self.assertFalse(job._atomic_and_has_started())


    def _check_special_task(self, task, task_type, queue_entry_id=None):
        self.assertEquals(task.task, task_type)
        self.assertEquals(task.host.id, 1)
        if queue_entry_id:
            self.assertEquals(task.queue_entry.id, queue_entry_id)


    def test_run_asynchronous(self):
        self._create_job(hosts=[1, 2])

        task = self._test_pre_job_tasks_helper()

        self._check_special_task(task, models.SpecialTask.Task.VERIFY, 1)


    def test_run_asynchronous_skip_verify(self):
        job = self._create_job(hosts=[1, 2])
        job.run_verify = False
        job.save()

        task = self._test_pre_job_tasks_helper()

        self.assertEquals(task, None)


    def test_run_synchronous_verify(self):
        self._create_job(hosts=[1, 2], synchronous=True)

        task = self._test_pre_job_tasks_helper()

        self._check_special_task(task, models.SpecialTask.Task.VERIFY, 1)


    def test_run_synchronous_skip_verify(self):
        job = self._create_job(hosts=[1, 2], synchronous=True)
        job.run_verify = False
        job.save()

        task = self._test_pre_job_tasks_helper()

        self.assertEquals(task, None)


    def test_run_synchronous_ready(self):
        self._create_job(hosts=[1, 2], synchronous=True)
        self._update_hqe("status='Pending', execution_subdir=''")

        queue_task = self._test_run_helper(expect_starting=True)

        self.assert_(isinstance(queue_task, monitor_db.QueueTask))
        self.assertEquals(queue_task.job.id, 1)
        hqe_ids = [hqe.id for hqe in queue_task.queue_entries]
        self.assertEquals(hqe_ids, [1, 2])


    def test_run_atomic_group_already_started(self):
        self._create_job(hosts=[5, 6], atomic_group=1, synchronous=True)
        self._update_hqe("status='Starting', execution_subdir=''")

        job = monitor_db.Job.fetch('id = 1')[0]
        queue_entry = monitor_db.HostQueueEntry.fetch('id = 1')[0]
        assert queue_entry.job is job
        self.assertEqual(None, job.run(queue_entry))

        self.god.check_playback()


    def test_run_synchronous_atomic_group_ready(self):
        self._create_job(hosts=[5, 6], atomic_group=1, synchronous=True)
        self._update_hqe("status='Pending', execution_subdir=''")

        queue_task = self._test_run_helper(expect_starting=True)

        self.assert_(isinstance(queue_task, monitor_db.QueueTask))
        # Atomic group jobs that do not depend on a specific label in the
        # atomic group will use the atomic group name as their group name.
        self.assertEquals(queue_task.group_name, 'atomic1')


    def test_run_synchronous_atomic_group_with_label_ready(self):
        job = self._create_job(hosts=[5, 6], atomic_group=1, synchronous=True)
        job.dependency_labels.add(self.label4)
        self._update_hqe("status='Pending', execution_subdir=''")

        queue_task = self._test_run_helper(expect_starting=True)

        self.assert_(isinstance(queue_task, monitor_db.QueueTask))
        # Atomic group jobs that also specify a label in the atomic group
        # will use the label name as their group name.
        self.assertEquals(queue_task.group_name, 'label4')


    def test_reboot_before_always(self):
        job = self._create_job(hosts=[1])
        job.reboot_before = models.RebootBefore.ALWAYS
        job.save()

        task = self._test_pre_job_tasks_helper()

        self._check_special_task(task, models.SpecialTask.Task.CLEANUP)


    def _test_reboot_before_if_dirty_helper(self, expect_reboot):
        job = self._create_job(hosts=[1])
        job.reboot_before = models.RebootBefore.IF_DIRTY
        job.save()

        task = self._test_pre_job_tasks_helper()
        if expect_reboot:
            task_type = models.SpecialTask.Task.CLEANUP
        else:
            task_type = models.SpecialTask.Task.VERIFY
        self._check_special_task(task, task_type)


    def test_reboot_before_if_dirty(self):
        models.Host.smart_get(1).update_object(dirty=True)
        self._test_reboot_before_if_dirty_helper(True)


    def test_reboot_before_not_dirty(self):
        models.Host.smart_get(1).update_object(dirty=False)
        self._test_reboot_before_if_dirty_helper(False)


    def test_next_group_name(self):
        django_job = self._create_job(metahosts=[1])
        job = monitor_db.Job(id=django_job.id)
        self.assertEqual('group0', job._next_group_name())

        for hqe in django_job.hostqueueentry_set.filter():
            hqe.execution_subdir = 'my_rack.group0'
            hqe.save()
        self.assertEqual('my_rack.group1', job._next_group_name('my/rack'))


class TopLevelFunctionsTest(unittest.TestCase):
    def setUp(self):
        self.god = mock.mock_god()


    def tearDown(self):
        self.god.unstub_all()


    def test_autoserv_command_line(self):
        machines = 'abcd12,efgh34'
        extra_args = ['-Z', 'hello']
        expected_command_line = [monitor_db._autoserv_path, '-p',
                                 '-m', machines, '-r',
                                 drone_manager.WORKING_DIRECTORY]

        command_line = monitor_db._autoserv_command_line(machines, extra_args)
        self.assertEqual(expected_command_line + ['--verbose'] + extra_args,
                         command_line)

        class FakeJob(object):
            owner = 'Bob'
            name = 'fake job name'
            id = 1337

        class FakeHQE(object):
            job = FakeJob

        command_line = monitor_db._autoserv_command_line(
                machines, extra_args=[], queue_entry=FakeHQE, verbose=False)
        self.assertEqual(expected_command_line +
                         ['-u', FakeJob.owner, '-l', FakeJob.name],
                         command_line)


if __name__ == '__main__':
    unittest.main()