__init__.py 42.1 KB
Newer Older
1
2
from functools import wraps
from simplejson import JSONDecodeError
3
import yaml
4
import sys
Neil Williams's avatar
Neil Williams committed
5
import xmlrpc.client
6
from django.conf import settings
7
from django.core.exceptions import PermissionDenied
8
from django.db.models import Count, Q
9
from django.db import transaction
10
from linaro_django_xmlrpc.models import ExposedAPI
11
12
13
from lava_scheduler_app.models import (
    Device,
    DeviceType,
14
    JSONDataError,
15
    DevicesUnavailableException,
16
    TestJob,
Neil Williams's avatar
Neil Williams committed
17
)
18
from lava_scheduler_app.views import (
19
    get_restricted_job
20
)
21
22
23
from lava_scheduler_app.dbutils import (
    device_type_summary,
    testjob_submission
24
)
25
26
27
28
29
30
31
32
from lava_scheduler_app.schema import (
    validate_submission,
    validate_device,
    SubmissionException,
)

# functions need to be members to be exposed in the API
# pylint: disable=no-self-use
Michael-Doyle Hudson's avatar
Michael-Doyle Hudson committed
33

Neil Williams's avatar
Neil Williams committed
34
35
36
# to make a function visible in the API, it must be a member of SchedulerAPI
# pylint: disable=no-self-use

Michael-Doyle Hudson's avatar
Michael-Doyle Hudson committed
37

38
39
40
41
42
43
def check_superuser(f):
    """ decorator to check that the caller is a super-user """
    @wraps(f)
    def wrapper(self, *args, **kwargs):
        self._authenticate()
        if not self.user.is_superuser:
Neil Williams's avatar
Neil Williams committed
44
            raise xmlrpc.client.Fault(
45
46
47
48
49
50
51
                403,
                "User '%s' is not superuser." % self.user.username
            )
        return f(self, *args, **kwargs)
    return wrapper


52
53
54
def build_device_status_display(state, health):
    if state == Device.STATE_IDLE:
        if health in [Device.HEALTH_GOOD, Device.HEALTH_UNKNOWN]:
55
            return "idle"
56
        elif health == Device.HEALTH_RETIRED:
57
            return "retired"
58
        else:
59
            return "offline"
60
    elif state == Device.STATE_RESERVED:
61
        return "reserved"
62
    else:
63
        return "running"
64
65


66
67
68
class SchedulerAPI(ExposedAPI):

    def submit_job(self, job_data):
69
70
71
72
73
74
75
        """
        Name
        ----
        `submit_job` (`job_data`)

        Description
        -----------
76
77
        Submit the given job data which is in LAVA job JSON or YAML format as a
        new job to LAVA scheduler.
78
79
80
81

        Arguments
        ---------
        `job_data`: string
82
            Job JSON or YAML string.
83
84
85
86

        Return value
        ------------
        This function returns an XML-RPC integer which is the newly created
87
        job's id, provided the user is authenticated with an username and token.
88
89
        If the job is a multinode job, this function returns the list of created
        job IDs.
90
        """
91
        self._authenticate()
Michael-Doyle Hudson's avatar
Michael-Doyle Hudson committed
92
        if not self.user.has_perm('lava_scheduler_app.add_testjob'):
Neil Williams's avatar
Neil Williams committed
93
            raise xmlrpc.client.Fault(
94
95
96
                403, "Permission denied.  User %r does not have the "
                "'lava_scheduler_app.add_testjob' permission.  Contact "
                "the administrators." % self.user.username)
Neil Williams's avatar
Neil Williams committed
97
        try:
98
99
            job = testjob_submission(job_data, self.user)
        except SubmissionException as exc:
Neil Williams's avatar
Neil Williams committed
100
            raise xmlrpc.client.Fault(400, "Problem with submitted job data: %s" % exc)
Rémi Duraffort's avatar
Rémi Duraffort committed
101
        # FIXME: json error is not needed anymore
Neil Williams's avatar
Neil Williams committed
102
        except (JSONDataError, JSONDecodeError, ValueError) as exc:
Neil Williams's avatar
Neil Williams committed
103
            raise xmlrpc.client.Fault(400, "Decoding job submission failed: %s." % exc)
104
        except (Device.DoesNotExist, DeviceType.DoesNotExist):
Neil Williams's avatar
Neil Williams committed
105
            raise xmlrpc.client.Fault(404, "Specified device or device type not found.")
106
        except DevicesUnavailableException as exc:
Neil Williams's avatar
Neil Williams committed
107
            raise xmlrpc.client.Fault(400, "Device unavailable: %s" % str(exc))
108
        if isinstance(job, type(list())):
109
            return [j.sub_id for j in job]
110
111
        else:
            return job.id
112

113
    def resubmit_job(self, job_id):
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
        """
        Name
        ----
        `resubmit_job` (`job_id`)

        Description
        -----------
        Resubmit the given job reffered by its id.

        Arguments
        ---------
        `job_id`: string
            The job's id which should be re-submitted.

        Return value
        ------------
        This function returns an XML-RPC integer which is the newly created
        job's id,  provided the user is authenticated with an username and
        token.
        """
134
135
        self._authenticate()
        if not self.user.has_perm('lava_scheduler_app.add_testjob'):
Neil Williams's avatar
Neil Williams committed
136
            raise xmlrpc.client.Fault(
137
138
139
                403, "Permission denied.  User %r does not have the "
                "'lava_scheduler_app.add_testjob' permission.  Contact "
                "the administrators." % self.user.username)
Paul Larson's avatar
Paul Larson committed
140
        try:
141
            job = get_restricted_job(self.user, job_id)
Paul Larson's avatar
Paul Larson committed
142
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
143
            raise xmlrpc.client.Fault(404, "Specified job not found.")
144

145
        if job.is_multinode:
146
147
148
            return self.submit_job(job.multinode_definition)
        else:
            return self.submit_job(job.definition)
149

150
    def cancel_job(self, job_id):
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
        """
        Name
        ----
        `cancel_job` (`job_id`)

        Description
        -----------
        Cancel the given job reffered by its id.

        Arguments
        ---------
        `job_id`: string
            Job id which should be canceled.

        Return value
        ------------
        None. The user should be authenticated with an username and token.
        """
169
170
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
171
172
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
173

174
175
176
177
        with transaction.atomic():
            try:
                job = get_restricted_job(self.user, job_id, for_update=True)
            except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
178
                raise xmlrpc.client.Fault(
179
180
                    401, "Permission denied for user to job %s" % job_id)
            except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
181
                raise xmlrpc.client.Fault(404, "Specified job not found.")
182
183
184
185
186

            if job.state in [TestJob.STATE_CANCELING, TestJob.STATE_FINISHED]:
                # Don't do anything for jobs that ended already
                return True
            if not job.can_cancel(self.user):
Neil Williams's avatar
Neil Williams committed
187
                raise xmlrpc.client.Fault(403, "Permission denied.")
188
189
190
191
192
193
194
195
196
197

            if job.is_multinode:
                multinode_jobs = TestJob.objects.select_for_update().filter(
                    target_group=job.target_group)
                for multinode_job in multinode_jobs:
                    multinode_job.go_state_canceling()
                    multinode_job.save()
            else:
                job.go_state_canceling()
                job.save()
198
        return True
199

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    def validate_yaml(self, yaml_string):
        """
        Name
        ----
        validate_yaml (yaml_job_data)

        Description
        -----------
        Validate the supplied pipeline YAML against the submission schema.

        Note: this does not validate the job itself, just the YAML against the
        submission schema. A job which validates against the schema can still be
        an invalid job for the dispatcher and such jobs will be accepted as Submitted,
        scheduled and then marked as Incomplete with a failure comment. Full validation
        only happens after a device has been assigned to the Submitted job.

        Arguments
        ---------
        'yaml_job_data': string

        Return value
        ------------
        Raises an Exception if the yaml_job_data is invalid.
        """
        try:
            # YAML can parse JSON as YAML, JSON cannot parse YAML at all
            yaml_data = yaml.load(yaml_string)
        except yaml.YAMLError as exc:
Neil Williams's avatar
Neil Williams committed
228
            raise xmlrpc.client.Fault(400, "Decoding job submission failed: %s." % exc)
229
230
231
232
        try:
            # validate against the submission schema.
            validate_submission(yaml_data)  # raises SubmissionException if invalid.
        except SubmissionException as exc:
Neil Williams's avatar
Neil Williams committed
233
            raise xmlrpc.client.Fault(400, "Invalid YAML submission: %s" % exc)
234

235
    def job_output(self, job_id, offset=0):
236
237
238
        """
        Name
        ----
239
        `job_output` (`job_id`, `offset=0`)
240
241
242
243
244
245
246
247
248

        Description
        -----------
        Get the output of given job id.

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.
249
250
251
        `offset`: integer
            Offset from which to start reading the output file specified in bytes.
            It defaults to 0.
252
253
254

        Return value
        ------------
255
256
        This function returns an XML-RPC binary data of output file, provided
        the user is authenticated with an username and token.
257
        """
258
259
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
260
261
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
262
        try:
263
            job = get_restricted_job(self.user, job_id)
264
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
265
            raise xmlrpc.client.Fault(
266
                401, "Permission denied for user to job %s" % job_id)
267
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
268
            raise xmlrpc.client.Fault(404, "Specified job not found.")
269

270
271
        output_file = job.output_file()
        if output_file:
272
            output_file.seek(offset)
Neil Williams's avatar
Neil Williams committed
273
            return xmlrpc.client.Binary(output_file.read().encode('UTF-8'))
274
        else:
Neil Williams's avatar
Neil Williams committed
275
            raise xmlrpc.client.Fault(404, "Job output not found.")
276
277
278
279
280
281
282
283
284

    def all_devices(self):
        """
        Name
        ----
        `all_devices` ()

        Description
        -----------
285
        Get all the available devices with their state and type information.
286
287
288
289
290
291
292
293

        Arguments
        ---------
        None

        Return value
        ------------
        This function returns an XML-RPC array in which each item is a list of
294
295
        device hostname, device type, device state, current running job id and
        if device is pipeline. For example:
296

297
        [['panda01', 'panda', 'running', 'good', 164, False], ['qemu01', 'qemu', 'idle', 'unknwon', None, True]]
298
299
        """

300
        devices_list = []
301
        for dev in Device.objects.exclude(health=Device.HEALTH_RETIRED):
302
303
            if not dev.is_visible_to(self.user):
                continue
304
            devices_list.append(dev)
305

Rémi Duraffort's avatar
Rémi Duraffort committed
306
        return [[dev.hostname, dev.device_type.name, build_device_status_display(dev.state, dev.health), dev.current_job().pk if dev.current_job() else None, True]
307
                for dev in devices_list]
308
309
310
311
312
313
314
315
316
317

    def all_device_types(self):
        """
        Name
        ----
        `all_device_types` ()

        Description
        -----------
        Get all the available device types with their state and count
318
        information.
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333

        Arguments
        ---------
        None

        Return value
        ------------
        This function returns an XML-RPC array in which each item is a dict
        which contains name (device type), idle, busy, offline counts.
        For example:

        [{'idle': 1, 'busy': 0, 'name': 'panda', 'offline': 0},
        {'idle': 1, 'busy': 0, 'name': 'qemu', 'offline': 0}]
        """

334
335
        device_type_names = []
        all_device_types = []
Neil Williams's avatar
Neil Williams committed
336
        keys = ['busy', 'idle', 'offline']
337

338
        for dev_type in DeviceType.objects.all():
339
            if not dev_type.some_devices_visible_to(self.user):
340
                continue
341
            device_type_names.append(dev_type.name)
342

Neil Williams's avatar
Neil Williams committed
343
        device_types = device_type_summary(device_type_names)
344
345

        for dev_type in device_types:
Neil Williams's avatar
Neil Williams committed
346
            device_type = {'name': dev_type['device_type']}
347
            for key in keys:
Neil Williams's avatar
Neil Williams committed
348
                device_type[key] = dev_type[key]
349
            all_device_types.append(device_type)
350

351
        return all_device_types
352

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
    def get_recent_jobs_for_device_type(self, device_type, count=1, restrict_to_user=False):
        """
        Name
        ----

        `get_recent_jobs_for_device_type` (`device_type`, `count=1`, `restrict_to_user=False`)

        Description
        -----------
        Get details of recently finished jobs for a given device_type. Limits the list
        to test jobs submitted by the user making the query if restrict_to_user is set to
        True. Get only the most recent job by default, but count can be set higher to
        get for example the last 10 jobs.

        Arguments
        ---------
        `device_type`: string
            Name of the device_type for which you want the jobs
        `count`: integer (Optional, default=1)
            Number of last jobs you want
        `restrict_to_user`: boolean (Optional, default=False)
            Fetch only the jobs submitted by the user making the query if set to True

        Return value
        ------------
        This function returns a list of dictionaries, which correspond to the
        list of recently finished jobs informations (Complete or Incomplete)
        for this device, ordered from youngest to oldest.

        [
            {
                'description': 'ramdisk health check',
                'id': 359828,
                'status': 'Complete',
                'device': 'black01'
            },
            {
                'description': 'standard ARMMP NFS',
                'id': 359827
                'status': 'Incomplete',
                'device': 'black02'
            }
        ]
        """
        if not device_type:
Neil Williams's avatar
Neil Williams committed
398
            raise xmlrpc.client.Fault(
399
400
401
                400, "Bad request: device_type was not specified."
            )
        if count < 0:
Neil Williams's avatar
Neil Williams committed
402
            raise xmlrpc.client.Fault(
403
404
405
406
407
                400, "Bad request: count must not be negative."
            )
        try:
            dt = DeviceType.objects.get(name=device_type, display=True)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
408
            raise xmlrpc.client.Fault(
409
410
411
412
                404, "DeviceType '%s' was not found." % device_type
            )

        if not dt.some_devices_visible_to(self.user):
Neil Williams's avatar
Neil Williams committed
413
            raise xmlrpc.client.Fault(
414
415
416
                403, "DeviceType '%s' not available to user '%s'." %
                (device_type, self.user)
            )
417
418
419
        job_qs = TestJob.objects.filter(state=TestJob.STATE_FINISHED) \
                                .filter(requested_device_type=dt) \
                                .order_by('-id')
420
421
422
423
424
425
426
        if restrict_to_user:
            job_qs = job_qs.filter(submitter=self.user)
        job_list = []
        for job in job_qs.all()[:count]:
            job_dict = {
                "id": job.id,
                "description": job.description,
Rémi Duraffort's avatar
Rémi Duraffort committed
427
                "status": job.get_legacy_status_display(),
428
429
430
431
432
433
434
                "device": job.actual_device.hostname,
            }
            if not job.can_view(self.user):
                job_dict["id"] = None
            job_list.append(job_dict)
        return job_list

435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
    def get_recent_jobs_for_device(self, device, count=1, restrict_to_user=False):
        """
        Name
        ----

        `get_recent_jobs_for_device` (`device`, `count=1`, `restrict_to_user=False`)

        Description
        -----------
        Get details of recently finished jobs for a given device. Limits the list
        to test jobs submitted by the user making the query if restrict_to_user is set to
        True. Get only the most recent job by default, but count can be set higher to
        get for example the last 10 jobs.

        Arguments
        ---------
        `device`: string
            Name of the device for which you want the jobs
        `count`: integer (Optional, default=1)
            Number of last jobs you want
        `restrict_to_user`: boolean (Optional, default=False)
            Fetch only the jobs submitted by the user making the query if set to True

        Return value
        ------------
        This function returns a list of dictionaries, which correspond to the
        list of recently finished jobs informations (Complete or Incomplete)
        for this device, ordered from youngest to oldest.

        [
            {
                'description': 'mainline--armada-370-db--multi_v7_defconfig--network',
                'id': 359828,
                'status': 'Complete'
            },
            {
                'description': 'mainline--armada-370-db--multi_v7_defconfig--sata',
                'id': 359827
                'status': 'Incomplete'
            }
        ]
        """
        if not device:
Neil Williams's avatar
Neil Williams committed
478
            raise xmlrpc.client.Fault(
479
480
481
                400, "Bad request: device was not specified."
            )
        if count < 0:
Neil Williams's avatar
Neil Williams committed
482
            raise xmlrpc.client.Fault(
483
484
485
486
487
                400, "Bad request: count must not be negative."
            )
        try:
            device_obj = Device.objects.get(hostname=device)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
488
            raise xmlrpc.client.Fault(
489
490
491
492
                404, "Device '%s' was not found." % device
            )

        if not device_obj.is_visible_to(self.user):
Neil Williams's avatar
Neil Williams committed
493
            raise xmlrpc.client.Fault(
494
495
496
                403, "Device '%s' not available to user '%s'." %
                (device, self.user)
            )
497
498
499
        job_qs = TestJob.objects.filter(state=TestJob.STATE_FINISHED) \
                                .filter(actual_device=device_obj) \
                                .order_by('-id')
500
501
502
503
504
505
506
        if restrict_to_user:
            job_qs = job_qs.filter(submitter=self.user)
        job_list = []
        for job in job_qs.all()[:count]:
            job_dict = {
                "id": job.id,
                "description": job.description,
Rémi Duraffort's avatar
Rémi Duraffort committed
507
                "status": job.get_legacy_status_display(),
508
509
510
511
512
513
            }
            if not job.can_view(self.user):
                job_dict["id"] = None
            job_list.append(job_dict)
        return job_list

514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
    def get_device_type_by_alias(self, alias):
        """
        Name
        ----

        `get_device_type_by_alias` (`alias`)

        Description
        -----------
        Get the matching device-type(s) for the specified alias. It is
        possible that more than one device-type can be returned, depending
        on local admin configuration. An alias can be used to provide the
        link between the device-type name and the Device Tree name.
        It is possible for multiple device-types to have the same alias
        (to assist in transitions and migrations).
        The specified alias string can be a partial match, returning all
        device-types which have an alias name containing the requested
        string.

        Arguments
        ---------
        `alias`: string
            Name of the alias to lookup

        Return value
        ------------
        This function returns a dictionary containing the alias as the key
        and a list of device-types which use that alias as the value. If the
        specified alias does not match any device-type, the dictionary contains
        an empty list for the alias key.

        {'apq8016-sbc': ['dragonboard410c']}
        {'ompa4-panda': ['panda', 'panda-es']}
        """

        aliases = DeviceType.objects.filter(aliases__name__contains=alias)
        return {
            alias: [device_type.name for device_type in aliases]
        }

554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
    def get_device_status(self, hostname):
        """
        Name
        ----
        `get_device_status` (`hostname`)

        Description
        -----------
        Get status, running job, date from which it is offline of the given
        device and the user who put it offline.

        Arguments
        ---------
        `hostname`: string
            Name of the device for which the status is asked.

        Return value
        ------------
        This function returns an XML-RPC dictionary which contains hostname,
        status, date from which the device is offline if the device is offline,
        the user who put the device offline if the device is offline and the
        job id of the running job.
        The device has to be visible to the user who requested device's status.

        Note that offline_since and offline_by can be empty strings if the device
        status is manually changed by an administrator in the database or from
        the admin site of LAVA even if device's status is offline.
        """

        if not hostname:
Neil Williams's avatar
Neil Williams committed
584
            raise xmlrpc.client.Fault(
585
586
587
588
589
                400, "Bad request: Hostname was not specified."
            )
        try:
            device = Device.objects.get(hostname=hostname)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
590
            raise xmlrpc.client.Fault(
591
592
593
594
595
596
                404, "Device '%s' was not found." % hostname
            )

        device_dict = {}
        if device.is_visible_to(self.user):
            device_dict["hostname"] = device.hostname
597
            device_dict["status"] = build_device_status_display(device.state, device.health)
598
599
600
            device_dict["job"] = None
            device_dict["offline_since"] = None
            device_dict["offline_by"] = None
Rémi Duraffort's avatar
Rémi Duraffort committed
601
            device_dict["is_pipeline"] = True
602

603
604
605
            current_job = device.current_job()
            if current_job is not None:
                device_dict["job"] = current_job.pk
606
        else:
Neil Williams's avatar
Neil Williams committed
607
            raise xmlrpc.client.Fault(
608
609
610
611
                403, "Permission denied for user to access %s information." % hostname
            )
        return device_dict

612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
    def put_into_maintenance_mode(self, hostname, reason, notify=None):
        """
        Name
        ----
        `put_into_maintenance_mode` (`hostname`, `reason`, `notify`)

        Description
        -----------
        Put the given device in maintenance mode with the given reason and optionally
        notify the given mail address when the job has finished.

        Arguments
        ---------
        `hostname`: string
            Name of the device to put into maintenance mode.
        `reason`: string
            The reason given to justify putting the device into maintenance mode.
        `notify`: string
            Email address of the user to notify when the job has finished. Can be
            omitted.

        Return value
        ------------
        None. The user should be authenticated with a username and token and has
        sufficient permission.
        """

        self._authenticate()
        if not hostname:
Neil Williams's avatar
Neil Williams committed
641
            raise xmlrpc.client.Fault(
642
643
644
                400, "Bad request: Hostname was not specified."
            )
        if not reason:
Neil Williams's avatar
Neil Williams committed
645
            raise xmlrpc.client.Fault(
646
647
                400, "Bad request: Reason was not specified."
            )
648
649
650
651
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
652
                raise xmlrpc.client.Fault(
653
654
655
656
657
658
                    404, "Device '%s' was not found." % hostname
                )
            if device.can_admin(self.user):
                device.health = Device.HEALTH_MAINTENANCE
                device.save()
            else:
Neil Williams's avatar
Neil Williams committed
659
                raise xmlrpc.client.Fault(
660
661
                    403, "Permission denied for user to put %s into maintenance mode." % hostname
                )
662

663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
    def put_into_online_mode(self, hostname, reason, skip_health_check=False):
        """
        Name
        ----
        `put_into_online_mode` (`hostname`, `reason`, `skip_health_check`)

        Description
        -----------
        Put the given device into online mode with the given reason ans skip health
        check if asked.

        Arguments
        ---------
        `hostname`: string
            Name of the device to put into online mode.
        `reason`: string
            The reason given to justify putting the device into online mode.
        `skip_health_check`: boolean
            Skip health check when putting the board into online mode. If
            omitted, health check is not skipped by default.

        Return value
        ------------
        None. The user should be authenticated with a username and token and has
        sufficient permission.
        """

        self._authenticate()
        if not hostname:
Neil Williams's avatar
Neil Williams committed
692
            raise xmlrpc.client.Fault(
693
694
695
                400, "Bad request: Hostname was not specified."
            )
        if not reason:
Neil Williams's avatar
Neil Williams committed
696
            raise xmlrpc.client.Fault(
697
698
                400, "Bad request: Reason was not specified."
            )
699
700
701
702
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
703
                raise xmlrpc.client.Fault(
704
705
706
707
708
709
                    404, "Device '%s' was not found." % hostname
                )
            if device.can_admin(self.user):
                device.health = Device.HEALTH_UNKNOWN
                device.save()
            else:
Neil Williams's avatar
Neil Williams committed
710
                raise xmlrpc.client.Fault(
711
712
                    403, "Permission denied for user to put %s into online mode." % hostname
                )
713

714
    def pending_jobs_by_device_type(self):
715
716
717
        """
        Name
        ----
718
        `pending_jobs_by_device_type` ()
719
720
721

        Description
        -----------
722
        Get number of pending jobs in each device type.
723
724
725
726
727
728
729

        Arguments
        ---------
        None

        Return value
        ------------
730
731
        This function returns a dict where the key is the device type and
        the value is the number of jobs pending in that device type.
732
733
        For example:

734
        {'qemu': 0, 'panda': 3}
735
736
        """

737
        pending_jobs_by_device = {}
738

739
740
741
        jobs_res = TestJob.objects.filter(state=TestJob.STATE_SUBMITTED) \
                                  .values_list('requested_device_type_id')\
                                  .annotate(pending_jobs=(Count('id')))
742
743
744
745
746
747
        jobs = {}
        jobs_hash = dict(jobs_res)
        for job in jobs_hash:
            if job:
                jobs[job] = jobs_hash[job]
        pending_jobs_by_device.update(jobs)
748

749
750
751
752
753
        # Get rest of the devices and put number of pending jobs as 0.
        device_types = DeviceType.objects.values_list('name', flat=True)
        for device_type in device_types:
            if device_type not in pending_jobs_by_device:
                pending_jobs_by_device[device_type] = 0
Neil Williams's avatar
Neil Williams committed
754

755
        return pending_jobs_by_device
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775

    def job_details(self, job_id):
        """
        Name
        ----
        `job_details` (`job_id`)

        Description
        -----------
        Get the details of given job id.

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.

        Return value
        ------------
        This function returns an XML-RPC structures of job details, provided
        the user is authenticated with an username and token.
776
777

        The elements available in XML-RPC structure include:
Rémi Duraffort's avatar
Rémi Duraffort committed
778
        _state, submitter_id, is_pipeline, id, failure_comment,
779
780
781
782
783
784
        multinode_definition, user_id, priority, _actual_device_cache,
        original_definition, status, health_check, description,
        admin_notifications, start_time, target_group, visibility,
        pipeline_compatibility, submit_time, is_public, _old_status,
        actual_device_id, definition, sub_id, requested_device_type_id,
        end_time, group_id, absolute_url, submitter_username
785
        """
786
        self._authenticate()
787
        if not job_id:
Neil Williams's avatar
Neil Williams committed
788
789
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
790
        try:
791
            job = get_restricted_job(self.user, job_id)
Rémi Duraffort's avatar
Rémi Duraffort committed
792
            job.status = job.get_legacy_status_display()
793
794
            job.state = job.get_state_display()
            job.health = job.get_health_display()
795
            job.submitter_username = job.submitter.username
796
            job.absolute_url = job.get_absolute_url()
Rémi Duraffort's avatar
Rémi Duraffort committed
797
            job.is_pipeline = True
798
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
799
            raise xmlrpc.client.Fault(
800
                401, "Permission denied for user to job %s" % job_id)
801
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
802
            raise xmlrpc.client.Fault(404, "Specified job not found.")
803
804

        return job
805
806
807
808
809

    def job_status(self, job_id):
        """
        Name
        ----
810
811
        DEPRECATED - use `job_health` or `job_state` instead.

812
        `job_status` (`job_id`)
813
814
815
816
817
818
819
820
821
822
823
824

        Description
        -----------
        Get the status of given job id.

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.

        Return value
        ------------
825
826
        This function returns an XML-RPC structures of job status with the
        following fields.
827
        The user is authenticated with an username and token.
Neil Williams's avatar
Neil Williams committed
828

829
        `job_status`: string
830
        ['Submitted'|'Running'|'Complete'|'Incomplete'|'Canceled'|'Canceling']
831
832

        `bundle_sha1`: string
833
        The sha1 hash code of the bundle, if it existed. Otherwise it will be
834
        an empty string. (LAVA V1 only)
835
        """
836
837
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
838
839
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
840
        try:
841
            job = get_restricted_job(self.user, job_id)
842
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
843
            raise xmlrpc.client.Fault(
844
                401, "Permission denied for user to job %s" % job_id)
845
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
846
            raise xmlrpc.client.Fault(404, "Specified job not found.")
847

848
849
850
851
852
853
854
855
        job_status = {'job_id': job.id}

        if job.is_multinode:
            job_status.update({
                'sub_id': job.sub_id
            })

        job_status.update({
Rémi Duraffort's avatar
Rémi Duraffort committed
856
            'job_status': job.get_legacy_status_display(),
Rémi Duraffort's avatar
Rémi Duraffort committed
857
            'bundle_sha1': ""
858
        })
859
        return job_status
860

861
862
863
864
    def job_list_status(self, job_id_list):
        """
        Name
        ----
865
866
        DEPRECATED - use `job_health` or `job_state` instead.

867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
        job_list_status ([job_id, job_id, job_id])

        Description
        -----------
        Get the status of a list of job ids.

        Arguments
        ---------
        `job_id_list`: list
            List of job ids for which the output is required.
            For multinode jobs specify the job sub_id as a float
            in the XML-RPC call:
            job_list_status([1, 2, 3,1, 5])

        Return value
        ------------
        The user needs to be authenticated with an username and token.

        This function returns an XML-RPC structure of job status with the
        following content.

        `job_status`: string
        {ID: ['Submitted'|'Running'|'Complete'|'Incomplete'|'Canceled'|'Canceling']}

        If the user is not able to view one of the specified jobs, that entry
        will be omitted.

        """
        self._authenticate()
        job_status = {}
        # optimise the query for a long list instead of using the
        # convenience handlers
        if not isinstance(job_id_list, list):
Neil Williams's avatar
Neil Williams committed
900
            raise xmlrpc.client.Fault(400, "Bad request: needs to be a list")
901
        if not all(isinstance(chk, (float, int)) for chk in job_id_list):
Neil Williams's avatar
Neil Williams committed
902
            raise xmlrpc.client.Fault(400, "Bad request: needs to be a list of integers or floats")
903
904
        jobs = TestJob.objects.filter(
            Q(id__in=job_id_list) | Q(sub_id__in=job_id_list)).select_related(
905
                'actual_device', 'requested_device_type')
906
        for job in jobs:
Rémi Duraffort's avatar
Rémi Duraffort committed
907
            device_type = job.requested_device_type
908
909
            if not job.can_view(self.user) or not job.is_accessible_by(self.user) and not self.user.is_superuser:
                continue
Rémi Duraffort's avatar
Rémi Duraffort committed
910
            if device_type and device_type.owners_only:
911
                # do the more expensive check second and only for a hidden device type
912
                if not device_type.some_devices_visible_to(self.user):
913
                    continue
Rémi Duraffort's avatar
Rémi Duraffort committed
914
            job_status[str(job.display_id)] = job.get_legacy_status_display()
915
916
        return job_status

917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
    def job_health(self, job_id):
        """
        Name
        ----
        `job_health` (`job_id`)

        Description
        -----------
        Get the health of given job id.

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.

        Return value
        ------------
        This function returns an XML-RPC structures of job health with the
        following fields.
        The user is authenticated with an username and token.

        `job_health`: string
        ['Unknown'|'Complete'|'Incomplete'|'Canceled']
        """
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
943
944
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
945
946
947
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
948
            raise xmlrpc.client.Fault(
949
950
                401, "Permission denied for user to job %s" % job_id)
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
951
            raise xmlrpc.client.Fault(404, "Specified job not found.")
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990

        job_health = {
            'job_id': job.id,
            'job_health': job.get_health_display()
        }

        if job.is_multinode:
            job_health.update({
                'sub_id': job.sub_id
            })

        return job_health

    def job_state(self, job_id):
        """
        Name
        ----
        `job_state` (`job_id`)

        Description
        -----------
        Get the state of given job id.

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.

        Return value
        ------------
        This function returns an XML-RPC structures of job state with the
        following fields.
        The user is authenticated with an username and token.

        `job_state`: string
        ['Submitted'|'Scheduling'|'Scheduled'|'Running'|'Canceling'|'Finished']
        """
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
991
992
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
993
994
995
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
996
            raise xmlrpc.client.Fault(
997
998
                401, "Permission denied for user to job %s" % job_id)
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
999
            raise xmlrpc.client.Fault(404, "Specified job not found.")
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012

        job_state = {
            'job_id': job.id,
            'job_state': job.get_state_display()
        }

        if job.is_multinode:
            job_state.update({
                'sub_id': job.sub_id
            })

        return job_state

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
    def all_jobs(self):
        """
        Name
        ----
        `all_jobs` ()

        Description
        -----------
        Get submitted or running jobs.

        Arguments
        ---------
        None

        Return value
        ------------
        This function returns a XML-RPC array of submitted and running jobs with their status and
        actual device for running jobs and requested device or device type for submitted jobs and
        job sub_id for multinode jobs.
        For example:

1034
1035
1036
        [[73, 'multinode-job', 'submitted', None, 'kvm', '72.1'],
        [72, 'multinode-job', 'submitted', None, 'kvm', '72.0'],
        [71, 'test-job', 'running', 'kvm01', None, None]]
1037
1038
        """

1039
        jobs = TestJob.objects.exclude(state=TestJob.STATE_FINISHED).order_by('-id')
Rémi Duraffort's avatar
Rémi Duraffort committed
1040
        jobs_list = [[job.id, job.description, job.get_legacy_status_display().lower(),
1041
                      job.actual_device, job.requested_device_type, job.sub_id] for job in jobs]
1042
1043

        return jobs_list
1044
1045
1046
1047
1048

    def get_pipeline_device_config(self, device_hostname):
        """
        Name
        ----
1049
1050
        DEPRECATED - use `get_device_config` instead.

1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
        `get_pipeline_device_config` (`device_hostname`)

        Description
        -----------
        Get the pipeline device configuration for given device hostname.

        Arguments
        ---------
        `device_hostname`: string
            Device hostname for which the configuration is required.

1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        return get_device_config(device_hostname, context)

    def get_device_config(self, device_hostname, context=None):
        """
        New in api_version 2 - see system.api_version()

        Name
        ----
        `get_device_config` (`device_hostname`, context=None)

        Description
        -----------
        Get the device configuration for given device hostname.

        Arguments
        ---------
        `device_hostname`: string
            Device hostname for which the configuration is required.

        Some device templates need a context specified when processing the
        device-type template. This can be specified as a YAML string:

        `get_device_config` `('qemu01', '{arch: amd64}')`

1090
1091
1092
1093
1094
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        if not device_hostname:
Neil Williams's avatar
Neil Williams committed
1095
1096
            raise xmlrpc.client.Fault(
                400, "Bad request: Device hostname was not specified.")
1097

1098
1099
1100
1101
1102
        job_ctx = None
        if context is not None:
            try:
                job_ctx = yaml.load(context)
            except yaml.YAMLError as exc:
Neil Williams's avatar
Neil Williams committed
1103
                raise xmlrpc.client.Fault(
1104
1105
                    400,
                    "Job context '%s' is not valid. %s" % (context, exc))
1106
1107
1108
        try:
            device = Device.objects.get(hostname=device_hostname)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1109
            raise xmlrpc.client.Fault(404, "Specified device was not found.")
1110

1111
        config = device.load_configuration(job_ctx=job_ctx, output_format="yaml")
1112
1113

        # validate against the device schema
1114
        validate_device(yaml.load(config))
1115

Neil Williams's avatar
Neil Williams committed
1116
        return xmlrpc.client.Binary(config.encode('UTF-8'))
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134

    def import_device_dictionary(self, hostname, jinja_str):
        """
        Name
        ----
        `import_device_dictionary` (`device_hostname`, `jinja_string`)

        Description
        -----------
        [superuser only]
        Import or update the device dictionary key value store for a
        pipeline device.

        Arguments
        ---------
        `device_hostname`: string
            Device hostname to update.
        `jinja_str`: string
1135
            Device configuration as Jinja2
1136
1137
1138
1139
1140
1141
1142

        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        self._authenticate()
        if not self.user.is_superuser:
Neil Williams's avatar
Neil Williams committed
1143
            raise xmlrpc.client.Fault(
1144
                403,
1145
                "User '%s' is not superuser." % self.user.username
1146
1147
            )
        try:
1148
            device = Device.objects.get(hostname=hostname)
1149
        except DeviceType.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1150
            raise xmlrpc.client.Fault(
1151
1152
                404, "Device '%s' was not found." % hostname
            )
1153
        if not device.save_configuration(jinja_str):
Neil Williams's avatar
Neil Williams committed
1154
            raise xmlrpc.client.Fault(
1155
                400, "Unable to store the configuration for %s on disk" % hostname
1156
            )
1157
1158

        return "Device dictionary updated for %s" % hostname
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184

    def export_device_dictionary(self, hostname):
        """
        Name
        ----
        `export_device_dictionary` (`device_hostname`)

        Description
        -----------
        [superuser only]
        Export the device dictionary key value store for a
        pipeline device.

        See also get_pipeline_device_config

        Arguments
        ---------
        `device_hostname`: string
            Device hostname to update.

        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        self._authenticate()
        if not self.user.is_superuser:
Neil Williams's avatar
Neil Williams committed
1185
            raise xmlrpc.client.Fault(
1186
                403, "User '%s' is not superuser." % self.user.username
1187
1188
1189
1190
            )
        try:
            device = Device.objects.get(hostname=hostname)
        except DeviceType.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1191
            raise xmlrpc.client.Fault(
1192
1193
                404, "Device '%s' was not found." % hostname
            )
1194
        device_dict = device.load_configuration(output_format="raw")
1195
        if not device_dict:
Neil Williams's avatar
Neil Williams committed
1196
            raise xmlrpc.client.Fault(
1197
1198
                404, "Device '%s' does not have a device dictionary" % hostname
            )
1199

Neil Williams's avatar
Neil Williams committed
1200
        return xmlrpc.client.Binary(device_dict.encode('UTF-8'))
1201

1202
    def validate_pipeline_devices(self, name=None):
1203
1204
1205
        """
        Name
        ----
1206
        `validate_pipeline_device` [`name`]
1207
1208
1209
1210
1211
1212

        Description
        -----------
        Validate that the device dictionary and device-type template
        together create a valid YAML file which matches the pipeline
        device schema.
1213
        Retired devices are ignored.
1214
1215
1216
1217
1218

        See also get_pipeline_device_config

        Arguments
        ---------
1219
1220
1221
1222
1223
1224
1225
        `name`: string
            Can be device hostname or device type name.
        If name is specified, method will search for either a matching device
        hostname or matching device type name in which case it will only
        validate that(those) device(s).
        If not specified, this method will validate all non-retired devices
        in the system.
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237

        Return value
        ------------
        This function returns an XML-RPC structure of results with the
        following fields.

        `device_hostname`: {'Valid': null}
        or
        `device_hostname`: {'Invalid': message}
        `

        """
1238
        if not name:
Rémi Duraffort's avatar
Rémi Duraffort committed
1239
            devices = Device.objects.exclude(health=Device.HEALTH_RETIRED)
1240
        else:
Rémi Duraffort's avatar
Rémi Duraffort committed
1241
            devices = Device.objects.exclude(health=Device.HEALTH_RETIRED).filter(device_type__name=name)
1242
            if not devices:
Rémi Duraffort's avatar
Rémi Duraffort committed
1243
                devices = Device.objects.exclude(health=Device.HEALTH_RETIRED).filter(hostname=name)
1244
        if not devices and name:
Neil Williams's avatar
Neil Williams committed
1245
            raise xmlrpc.client.Fault(
1246
1247
                404,
                "No devices found with hostname or device type name %s" % name
1248
            )
1249
        if not devices and not name:
Neil Williams's avatar
Neil Williams committed
1250
            raise xmlrpc.client.Fault(
1251
1252
1253
1254
1255
                404, "No pipeline device found on this instance."
            )
        results = {}
        for device in devices:
            key = str(device.hostname)
1256
1257
            config = device.load_configuration(output_format="yaml")
            if config is None:
1258
1259
1260
1261
                results[key] = {'Invalid': "Missing device dictionary"}
                continue
            try:
                # validate against the device schema
1262
                validate_device(yaml.load(config))
1263
1264
1265
1266
            except SubmissionException as exc:
                results[key] = {'Invalid': exc}
                continue
            results[key] = {'Valid': None}
Neil Williams's avatar
Neil Williams committed
1267
        return xmlrpc.client.Binary(yaml.dump(results).encode('UTF-8'))
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280

    def get_publisher_event_socket(self):
        """
        Name
        ----
        `get_publisher_event_socket`

        Return value
        ------------
        This function exposes the EVENT_SOCKET from the settings file which is
        used for the lava-publisher daemon.
        """
        return settings.EVENT_SOCKET