Changeset 372 for trunk

Timestamp:

06/10/10 15:45:20 (11 years ago)

Author:

sander

Message:

Allow factory owners to fail and re-queue testsuite jobs

Location:

trunk/server/www/app

Files:

• app_controller.php (modified) (1 diff)
• config/sql/default-data.sql (modified) (1 diff)
• config/sql/schema.php (modified) (2 diffs)
• controllers/jobs_controller.php (modified) (5 diffs)
• models/job.php (modified) (1 diff)
• models/request.php (modified) (4 diffs)
• vendors/shells/upgrade.php (modified) (3 diffs)
• views/elements/gallery.ctp (modified) (1 diff)
• views/helpers/job_model.php (modified) (8 diffs)
• views/jobs/admin_index.ctp (modified) (1 diff)
• views/jobs/search.ctp (added)
• views/jobs/view.ctp (modified) (1 diff)
• views/requests/admin_view.ctp (modified) (1 diff)
• views/requests/view.ctp (modified) (1 diff)

trunk/server/www/app/app_controller.php

@@ -72 +72 @@
                 if ($this->AuthCert->user()) {
                         $bottomControllers[__('Requests', true)] = '/requests';
+
+                        if ($this->__permitted('jobs', 'search')) {
+                                $bottomControllers[__('Jobs', true)] = '/jobs/search';
+                        }
+
                         $bottomControllers[__('Your account', true)] = '/users/view';
                 }

trunk/server/www/app/config/sql/default-data.sql

@@ -242 +242 @@
 ('49b108a9-404c-4f19-80ac-1c6ac0a80105', 'workers:edit', '2009-03-06 12:27:37', '2009-03-06 12:27:37', '49b10879-6cf8-410e-bbe6-1c6ac0a80105'),
 ('49b108af-acdc-4365-892e-1c6ac0a80105', 'workers:delete', '2009-03-06 12:27:43', '2009-03-06 12:27:43', '49b10879-6cf8-410e-bbe6-1c6ac0a80105'),
-('49b108b5-9294-4acf-9a89-1c6ac0a80105', 'xmlrpc:api', '2009-03-06 12:27:49', '2009-03-06 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105');
+('49b108b5-9294-4acf-9a89-1c6ac0a80105', 'xmlrpc:api', '2009-03-06 12:27:49', '2009-03-06 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105')
+('4c10ed1d-3bf8-4d9e-aca8-33abc0a80105', 'jobs:view', '2010-06-10 12:27:49', '2010-06-10 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105'),
+('4c10ecfb-5044-46a9-b5a6-33abc0a80105', 'jobs:search', '2010-06-10 12:27:49', '2010-06-10 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105'),
+('4c10ed07-4110-4ae5-9840-33abc0a80105', 'jobs:fail', '2010-06-10 12:27:49', '2010-06-10 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105'),
+('4c10ed15-6404-49bc-ae5c-33abc0a80105', 'jobs:requeue', '2010-06-10 12:27:49', '2010-06-10 12:27:49', '49b10879-6cf8-410e-bbe6-1c6ac0a80105');
 
 --

trunk/server/www/app/config/sql/schema.php

@@ -1 +1 @@
 <?php 
 /* SVN FILE: $Id$ */
-/* App schema generated on: 2010-03-24 14:03:22 : 1269436882*/
+/* App schema generated on: 2010-06-08 12:06:45 : 1275992085*/
 class AppSchema extends CakeSchema {
         var $name = 'App';
@@ -110 +110 @@
                         'result_id' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 36),
                         'factory_id' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 36),
+                        'state' => array('type' => 'integer', 'null' => false, 'default' => '1'),
                         'locked' => array('type' => 'datetime', 'null' => false, 'default' => '0000-00-00 00:00:00'),
                         'created' => array('type' => 'datetime', 'null' => true, 'default' => NULL),

trunk/server/www/app/controllers/jobs_controller.php

@@ -172 +172 @@
                 }
 
-                $this->set('job', $job);
+                $inTestsuite = $this->Job->Request->inTestsuite($job['Request']['id']);
+                $this->set(compact('job', 'inTestsuite'));
+        }
+
+        /**
+         * Manually change a job's state
+         */
+        private function _setState($state, $id = null)
+        {
+                if (!$id) {
+                        $this->Session->setFlash(__('Invalid Job.', true));
+                        $this->redirect(array('controller' => 'requests', 'action'=>'index'));
+                }
+                
+                $this->Job->contain(array('Request'));
+                $job = $this->Job->read(null, $id);
+                
+                if (!$this->Job->Request->inTestsuite($job['Request']['id'])) {
+                        $this->Session->setFlash(__('Invalid Job.', true));
+                        $this->redirect(array('controller' => 'requests', 'action'=>'index'));
+                }
+
+                $this->Job->id = $id;
+                $this->Job->saveField('state', $state);
+                $this->redirect(array('action' => 'view', $id));
+        }
+
+        /**
+         * Manually mark job as failed
+         */
+        public function fail($id = null)
+        {
+                $this->_setState(Job::STATE_FAILED, $id);
+        }
+
+        /**
+         * Manually mark job as failed
+         */
+        public function requeue($id = null)
+        {
+                $this->_setState(Job::STATE_QUEUED, $id);
         }
 
@@ -240 +280 @@
                 $this->Job->delete();
                 $this->redirect(array('controller' => 'requests', 'action'=>'view', $job['Request']['id']));
+        }
+
+        /**
+         * Search for a given Job ID
+         * This allows factory owners to mark problematic jobs in a test suite as invalid
+         */
+        public function search()
+        {
+                if (!empty($this->data)) {
+                        $job = $this->Job->find('first', array(
+                                'conditions' => array('Job.id' => $this->data['Job']['id']),
+                                'recursive' => -1,
+                        ));
+
+                        if ($job) {
+                                $this->redirect(array('action' => 'view', $job['Job']['id']));
+                        }
+                        
+                        $this->Session->setFlash(__('That Job ID does not exist.', true));
+                }
         }
 
@@ -425 +485 @@
                                         LEFT JOIN `doctypes` AS `Doctype` on (`Mimetype`.`doctype_id` = `Doctype`.`id`)
                                 WHERE `Job`.`result_id` = ''
+                                        AND `Job`.`state` = " . Job::STATE_QUEUED . "
                                         AND `Job`.`locked` < '" . date('Y-m-d H:i:s') . "'
                                         AND `Job`.`platform_id` = '" . $factory['Operatingsystem']['platform_id'] . "'
@@ -431 +492 @@
                                         AND `Job`.`format_id` IN  (" . implode(', ', $formats) . ")
                                         AND `Request`.`state` = " . Request::STATE_QUEUED . "
-                                        AND (`Request`.`expire` > '" . date('Y-m-d H:i:s') . "' OR `Request`.`expire` IS NULL)
                                         AND `Mimetype`.`doctype_id` IN (" . implode(', ', $doctypes) . ")
                                         AND (`Request`.`own_factory` = 0
@@ -456 +516 @@
                         // Something went wrong. Expire the entire request
                         $this->Request->saveField('expire', date('Y-m-d H:i:s', time() -1));
+                        $this->Request->expire();
+
                         return array('faultCode' => 2, 'faultString' => 'Job document could not be read. Please poll again.');
                 }

trunk/server/www/app/models/job.php

@@ -27 +27 @@
 class Job extends AppModel
 {
+        /**#@+
+         * Job model states
+         */
+        const STATE_QUEUED   = 1;
+        const STATE_FINISHED = 2;
+        const STATE_FAILED   = 4;
+        /**#@-*/
+
         /**
          * @var array All jobs belong to a request and factory and are associated with a certain application and platform

trunk/server/www/app/models/request.php

@@ -124 +124 @@
 
         /**
+         * Check if the request belongs to a test suite
+         * @param The request ID, or NULL for $this->id
+         * @return Boolean
+         */
+        public function inTestsuite($id = null)
+        {
+                if (!$id) {
+                        $id = $this->id;
+                }
+
+                if (!$id) {
+                        return false;
+                }
+
+                $request = $this->find('first', array(
+                        'contain' => array('Gallery'),
+                        'conditions' => array('Request.id' => $id),
+                ));
+
+                if (isset($request['Gallery']) && !empty($request['Gallery'])) {
+                        foreach ($request['Gallery'] as $gallery) {
+                                if ($this->Gallery->isTestsuite($gallery['id'])) {
+                                        return true;
+                                }
+                        }
+                }
+
+                return false;
+        }
+
+        /**
          * Add an upload to the request
          *
@@ -272 +303 @@
                         'expire' => date('Y-m-d H:i:s', time() - 1)
                 )));
+
+                $this->failJobs();
         }
 
@@ -281 +314 @@
         public function expireAll()
         {
-                return $this->updateAll(
-                        array('Request.state' => self::STATE_EXPIRED),
-                        array(
+                // Mark all old requests as expired
+
+                $requests = $this->find('all', array(
+                        'conditions' => array(
                                 'Request.expire <=' => date('Y-m-d H:i:s'),
-                                'Request.state' => array(self::STATE_UPLOADING, self::STATE_PREPROCESSOR_QUEUED, self::STATE_QUEUED)
-                        )
-                );
+                                'Request.state' => array(self::STATE_UPLOADING, self::STATE_PREPROCESSOR_QUEUED, self::STATE_QUEUED),
+                                'NOT' => array('Request.expire' => null),
+                        ),
+                        'recursive' => -1,
+                ));
+
+                foreach ($requests as $request) {
+                        $this->id = $request['Request']['id'];
+                        $this->expire();
+                }
+
+                return true;
+        }
+
+        /**
+         * Expire a single request
+         */
+        public function expire()
+        {
+                $this->saveField('state', self::STATE_EXPIRED);
+                $this->failJobs();
         }
 
@@ -314 +366 @@
                 foreach ($request['Job'] as $job) {
                         $this->Job->delete($job['id']); // Results are deleted in Job::beforeDelete
+                }
+        }
+
+        /**
+         * Mark all unfinished jobs for this request as failed
+         */
+        public function failJobs($id = null)
+        {
+                if (!$id) {
+                        $id = $this->id;
+                }
+
+                if (!$id) {
+                        return;
+                }
+
+                $request = $this->find('first', array(
+                        'contain' => array('Job'),
+                        'conditions' => array('Request.id' => $id),
+                ));
+
+                if (!$request || !isset($request['Job']) || empty($request['Job'])) {
+                        return;
+                }
+
+                foreach ($request['Job'] as $job) {
+                        if ($job['state'] == Job::STATE_QUEUED) {
+                                $this->Job->id = $job['id'];
+                                $this->Job->saveField('state', Job::STATE_FAILED);
+                        }
                 }
         }

trunk/server/www/app/vendors/shells/upgrade.php

@@ -27 +27 @@
 {
         /** @var array The models to use */
-        public $uses = array('Request', 'Result', 'User', 'Group', 'Worker');
+        public $uses = array('Request', 'Result', 'User', 'Group', 'Worker', 'Job');
 
         /**
@@ -227 +227 @@
                                         'worker_id'  => $worker['Worker']['id'],
                                 )));
+                        }
+                }
+        }
+
+        /**
+         * Upgrade the state of jobs
+         */
+        public function jobState()
+        {
+                $jobs = $this->Job->find('all', array(
+                        'contain' => array('Request', 'Result'),
+                ));
+
+                foreach ($jobs as $job) {
+                        $this->Job->id = $job['Job']['id'];
+
+                        if (isset($job['Result']) && isset($job['Result']['id']) && !empty($job['Result']['id'])) {
+                                $this->Job->saveField('state', Job::STATE_FINISHED);
+                        } else {
+                                $failed = (
+                                        isset($job['Request']) && isset($job['Request']['state'])
+                                        && $job['Request']['state'] != Request::STATE_UPLOADING
+                                        && $job['Request']['state'] != Request::STATE_PREPROCESSOR_QUEUED
+                                        && $job['Request']['state'] != Request::STATE_QUEUED
+                                );
+
+                                if ($failed) {
+                                        $this->Job->saveField('state', Job::STATE_FAILED);
+                                }
                         }
                 }
@@ -248 +277 @@
                 $this->out("\n\tfilesystemLayout\n\t\tUpdate the layour of requests on the filesystem.");
                 $this->out("\n\tworkerDoctypes\n\t\tAssign the correct doctypes to all workers.");
+                $this->out("\n\tjobState\n\t\tSet the correct state flag on all jobs.");
                 $this->out("\n\thelp\n\t\tShow this help");
                 $this->out('');

trunk/server/www/app/views/elements/gallery.ctp

@@ -56 +56 @@
                                 </td>
                                 <td><?php echo isset($job['Result']['created']) ? $job['Result']['created'] : $job['created']; ?></td>
-                                <td><?php echo $jobModel->getState($job, $request['state']); ?></td>
+                                <td><?php echo $jobModel->getState($job); ?></td>
                                 <?php if ($access):?>
                                         <td class="actions">&nbsp;</td>

trunk/server/www/app/views/helpers/job_model.php

@@ -19 +19 @@
  */
 
+App::import('Model', 'Job');
+
 /**
  * A helper to assist in outputting Jobs
@@ -30 +32 @@
          * Return the description of a Job
          */
-        public function getDescription($job, $request_state)
+        public function getDescription($job)
         {
                 if (!isset($job['Job'])) {
@@ -40 +42 @@
                 }
 
-                return $this->getState($job, $request_state);
+                return $this->getState($job);
         }
 
@@ -46 +48 @@
          * Return the state of a job
          */
-        public function getState($job, $request_state)
+        public function getState($job)
         {
                 if (!isset($job['Job'])) {
@@ -52 +54 @@
                 }
 
-                if (!empty($job['Job']['Result']) && !empty($job['Job']['Result']['id'])) {
+                if ($job['Job']['state'] == Job::STATE_FINISHED) {
                         return $this->output(__('Finished', true));
                 }
 
-                if ($request_state & (Request::STATE_UPLOADING | Request::STATE_PREPROCESSOR_QUEUED | Request::STATE_QUEUED)) {
+                if ($job['Job']['state'] == Job::STATE_QUEUED) {
                         if ($job['Job']['locked'] == '0000-00-00 00:00:00') {
                                 return $this->output(__('Queued'));
                         }
 
-                        if (empty($job['Job']['Result'])) {
-                                return $this->output(__('Processing'));
-                        }
+                        return $this->output(__('Processing'));
                 }
 
@@ -72 +72 @@
          * Return the icon of a Job
          */
-        public function getIcon($job, $request_state)
+        public function getIcon($job)
         {
                 if (!isset($job['Job'])) {
@@ -78 +78 @@
                 }
 
-                if (!empty($job['Job']['Result'])) {
+                if ($job['Job']['state'] == Job::STATE_FINISHED) {
                         if ($job['Job']['Result']['state'] == Result::STATE_SCAN_FOUND) {
                                 $icon = 'virus.png';
@@ -91 +91 @@
                 }
 
-                if ($request_state & (Request::STATE_UPLOADING | Request::STATE_PREPROCESSOR_QUEUED | Request::STATE_QUEUED)) {
+                if ($job['Job']['state'] == Job::STATE_QUEUED) {
                         if ($job['Job']['locked'] == '0000-00-00 00:00:00') {
                                 return $this->output($this->Html->image('icons/queued.png', array('alt' => __('Queued', true))));
                         }
 
-                        if (empty($job['Job']['Result'])) {
-                                return $this->output($this->Html->image('icons/busy.png', array('alt' => __('Processing', true))));
-                        }
+                        return $this->output($this->Html->image('icons/busy.png', array('alt' => __('Processing', true))));
                 }
 

trunk/server/www/app/views/jobs/admin_index.ctp

@@ -40 +40 @@
                 </td>
                 <td>
-                        <?php echo $jobModel->getState($job, $job['Request']['state']); ?><br />
+                        <?php echo $jobModel->getState($job); ?><br />
                 </td>
                 <td class="actions">

trunk/server/www/app/views/jobs/view.ctp

@@ -1 +1 @@
 <div class="jobs view">
-<h2><?php  __('Job');?></h2>
-        <dl><?php $i = 0; $class = ' class="altrow"';?>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Id'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
+<h2><?php echo $job['Application']['name'];?> <?php echo $job['Job']['version'];?> (<?php echo $job['Platform']['name'];?>)</h2>
+<span><?php printf(__('For %s', true), $html->link(
+                $job['Request']['filename'],
+                array(
+                        'controller' => 'requests',
+                        'action' => 'view',
+                        $job['Request']['id']
+                )
+));?></span><br /><br />
+        <dl>
+                <dt><?php __('Id'); ?></dt>
+                <dd>
                         <?php echo $job['Job']['id']; ?>
                         &nbsp;
                 </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Request'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $html->link($job['Request']['filename'], array('controller'=> 'requests', 'action'=>'view', $job['Request']['id'])); ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Platform'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $html->link($job['Platform']['name'], array('controller'=> 'platforms', 'action'=>'view', $job['Platform']['id'])); ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Application'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $html->link($job['Application']['name'], array('controller'=> 'applications', 'action'=>'view', $job['Application']['id'])); ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Version'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $job['Job']['version']; ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Result'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $html->link($job['Result']['filename'], array('controller'=> 'results', 'action'=>'view', $job['Result']['id'])); ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Factory'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $html->link($job['Factory']['name'], array('controller'=> 'factories', 'action'=>'view', $job['Factory']['id'])); ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Locked'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $job['Job']['locked']; ?>
-                        &nbsp;
-                </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Created'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
+                <?php if ($job['Factory']['id']):?>
+                        <dt><?php __('Factory'); ?></dt>
+                        <dd>
+                                <?php echo $html->link($job['Factory']['name'], array('controller'=> 'factories', 'action'=>'view', $job['Factory']['id'])); ?>
+                                &nbsp;
+                        </dd>
+                        <dt><?php __('Locked'); ?></dt>
+                        <dd>
+                                <?php echo $job['Job']['locked']; ?>
+                                &nbsp;
+                        </dd>
+                <?php endif;?>
+                <dt><?php __('Created'); ?></dt>
+                <dd>
                         <?php echo $job['Job']['created']; ?>
                         &nbsp;
                 </dd>
-                <dt<?php if ($i % 2 == 0) echo $class;?>><?php __('Updated'); ?></dt>
-                <dd<?php if ($i++ % 2 == 0) echo $class;?>>
-                        <?php echo $job['Job']['updated']; ?>
+                <dt><?php __('State'); ?></dt>
+                <dd>
+                        <?php echo $jobModel->getState($job); ?>
                         &nbsp;
+                </dd>
+                <dt><?php __('Actions'); ?></dt>
+                <dd>
+                        <?php
+                                if ($inTestsuite && $job['Job']['state'] == Job::STATE_QUEUED) {
+                                        echo $html->link(__('Set as failed', true), array('action' => 'fail', $job['Job']['id']));
+                                }
+                                if ($inTestsuite && $job['Job']['state'] == Job::STATE_FAILED) {
+                                        echo $html->link(__('Re-queue', true), array('action' => 'requeue', $job['Job']['id']));
+                                }
+                        ?>
                 </dd>
         </dl>
 </div>
-
-<div class="related">
-        <h3><?php __('Related Results');?></h3>
-        <?php if (!empty($job['Result'])):?>
-        <table cellpadding = "0" cellspacing = "0">
-        <tr>
-                <th><?php __('Id'); ?></th>
-                <th><?php __('Factory Id'); ?></th>
-                <th><?php __('Filename'); ?></th>
-                <th><?php __('Path'); ?></th>
-                <th><?php __('Mimetype'); ?></th>
-                <th><?php __('Created'); ?></th>
-                <th><?php __('Updated'); ?></th>
-                <th class="actions"><?php __('Actions');?></th>
-        </tr>
-                <tr>
-                        <td><?php echo $job['Result']['id'];?></td>
-                        <td><?php echo $job['Result']['factory_id'];?></td>
-                        <td><?php echo $job['Result']['filename'];?></td>
-                        <td><?php echo $job['Result']['path'];?></td>
-                        <td><?php echo $job['Result']['mimetype'];?></td>
-                        <td><?php echo $job['Result']['created'];?></td>
-                        <td><?php echo $job['Result']['updated'];?></td>
-                        <td class="actions">
-                                <?php echo $html->link(__('View', true), array('controller'=> 'results', 'action'=>'view', $job['Result']['id'])); ?>
-                                <?php echo $html->link(__('Edit', true), array('controller'=> 'results', 'action'=>'edit', $job['Result']['id'])); ?>
-                                <?php echo $html->link(__('Delete', true), array('controller'=> 'results', 'action'=>'delete', $job['Result']['id']), null, sprintf(__('Are you sure you want to delete # %s?', true), $job['Result']['id'])); ?>
-                        </td>
-                </tr>
-        </table>
-<?php endif; ?>

trunk/server/www/app/views/requests/admin_view.ctp

@@ -98 +98 @@
                                 </td>
                                 <td>
-                                        <?php echo $jobModel->getState($job, $request['Request']['state']); ?><br />
+                                        <?php echo $jobModel->getState($job); ?><br />
                                 </td>
                                 <td>

trunk/server/www/app/views/requests/view.ctp

@@ -105 +105 @@
                                 </td>
                                 <td>
-                                        <?php echo $jobModel->getState($job, $request['Request']['state']); ?><br />
+                                        <?php echo $jobModel->getState($job); ?><br />
                                 </td>
                                 <td>