__init__.py 43.4 KB
Newer Older
Rémi Duraffort's avatar
Rémi Duraffort committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# -*- coding: utf-8 -*-
# Copyright (C) 2017-2018 Linaro Limited
#
# Author: Neil Williams <neil.williams@linaro.org>
#         Senthil Kumaran <senthil.kumaran@linaro.org>
#
# This file is part of LAVA.
#
# LAVA is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License version 3
# as published by the Free Software Foundation
#
# LAVA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with LAVA.  If not, see <http://www.gnu.org/licenses/>.

21
22
from functools import wraps
from simplejson import JSONDecodeError
23
import yaml
24
import sys
Neil Williams's avatar
Neil Williams committed
25
import xmlrpc.client
26
from django.conf import settings
27
from django.core.exceptions import PermissionDenied
28
from django.db.models import Count, Q
29
from django.db import transaction
30
from linaro_django_xmlrpc.models import ExposedAPI
31
32
33
from lava_scheduler_app.models import (
    Device,
    DeviceType,
34
    JSONDataError,
35
    DevicesUnavailableException,
36
    TestJob,
Neil Williams's avatar
Neil Williams committed
37
)
38
from lava_scheduler_app.views import (
39
    get_restricted_job
40
)
41
42
from lava_scheduler_app.dbutils import (
    device_type_summary,
43
44
    testjob_submission,
    active_device_types,
45
)
46
47
48
49
50
51
52
53
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
54

Neil Williams's avatar
Neil Williams committed
55
56
57
# 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
58

59
60
61
62
63
64
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
65
            raise xmlrpc.client.Fault(
66
67
68
69
70
71
72
                403,
                "User '%s' is not superuser." % self.user.username
            )
        return f(self, *args, **kwargs)
    return wrapper


73
74
75
def build_device_status_display(state, health):
    if state == Device.STATE_IDLE:
        if health in [Device.HEALTH_GOOD, Device.HEALTH_UNKNOWN]:
76
            return "idle"
77
        elif health == Device.HEALTH_RETIRED:
78
            return "retired"
79
        else:
80
            return "offline"
81
    elif state == Device.STATE_RESERVED:
82
        return "reserved"
83
    else:
84
        return "running"
85
86


87
88
89
class SchedulerAPI(ExposedAPI):

    def submit_job(self, job_data):
90
91
92
93
94
95
96
        """
        Name
        ----
        `submit_job` (`job_data`)

        Description
        -----------
97
98
        Submit the given job data which is in LAVA job JSON or YAML format as a
        new job to LAVA scheduler.
99
100
101
102

        Arguments
        ---------
        `job_data`: string
103
            Job JSON or YAML string.
104
105
106
107

        Return value
        ------------
        This function returns an XML-RPC integer which is the newly created
108
        job's id, provided the user is authenticated with an username and token.
109
110
        If the job is a multinode job, this function returns the list of created
        job IDs.
111
        """
112
        self._authenticate()
Michael-Doyle Hudson's avatar
Michael-Doyle Hudson committed
113
        if not self.user.has_perm('lava_scheduler_app.add_testjob'):
Neil Williams's avatar
Neil Williams committed
114
            raise xmlrpc.client.Fault(
115
116
117
                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
118
        try:
119
120
            job = testjob_submission(job_data, self.user)
        except SubmissionException as exc:
Neil Williams's avatar
Neil Williams committed
121
            raise xmlrpc.client.Fault(400, "Problem with submitted job data: %s" % exc)
Rémi Duraffort's avatar
Rémi Duraffort committed
122
        # FIXME: json error is not needed anymore
Neil Williams's avatar
Neil Williams committed
123
        except (JSONDataError, JSONDecodeError, ValueError) as exc:
Neil Williams's avatar
Neil Williams committed
124
            raise xmlrpc.client.Fault(400, "Decoding job submission failed: %s." % exc)
125
        except (Device.DoesNotExist, DeviceType.DoesNotExist):
Neil Williams's avatar
Neil Williams committed
126
            raise xmlrpc.client.Fault(404, "Specified device or device type not found.")
127
        except DevicesUnavailableException as exc:
Neil Williams's avatar
Neil Williams committed
128
            raise xmlrpc.client.Fault(400, "Device unavailable: %s" % str(exc))
129
        if isinstance(job, type(list())):
130
            return [j.sub_id for j in job]
131
132
        else:
            return job.id
133

134
    def resubmit_job(self, job_id):
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
        """
        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.
        """
155
156
        self._authenticate()
        if not self.user.has_perm('lava_scheduler_app.add_testjob'):
Neil Williams's avatar
Neil Williams committed
157
            raise xmlrpc.client.Fault(
158
159
160
                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
161
        try:
162
            job = get_restricted_job(self.user, job_id)
Paul Larson's avatar
Paul Larson committed
163
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
164
            raise xmlrpc.client.Fault(404, "Specified job not found.")
165

166
        if job.is_multinode:
167
168
169
            return self.submit_job(job.multinode_definition)
        else:
            return self.submit_job(job.definition)
170

171
    def cancel_job(self, job_id):
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
        """
        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.
        """
190
191
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
192
193
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
194

195
196
197
198
        with transaction.atomic():
            try:
                job = get_restricted_job(self.user, job_id, for_update=True)
            except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
199
                raise xmlrpc.client.Fault(
200
201
                    401, "Permission denied for user to job %s" % job_id)
            except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
202
                raise xmlrpc.client.Fault(404, "Specified job not found.")
203
204
205
206
207

            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
208
                raise xmlrpc.client.Fault(403, "Permission denied.")
209
210
211
212
213
214
215
216
217
218

            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()
219
        return True
220

221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
    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
247
            yaml_data = yaml.safe_load(yaml_string)
248
        except yaml.YAMLError as exc:
Neil Williams's avatar
Neil Williams committed
249
            raise xmlrpc.client.Fault(400, "Decoding job submission failed: %s." % exc)
250
251
252
253
        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
254
            raise xmlrpc.client.Fault(400, "Invalid YAML submission: %s" % exc)
255

256
    def job_output(self, job_id, offset=0):
257
258
259
        """
        Name
        ----
260
        `job_output` (`job_id`, `offset=0`)
261
262
263
264
265
266
267
268
269

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

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.
270
271
272
        `offset`: integer
            Offset from which to start reading the output file specified in bytes.
            It defaults to 0.
273
274
275

        Return value
        ------------
276
277
        This function returns an XML-RPC binary data of output file, provided
        the user is authenticated with an username and token.
278
        """
279
280
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
281
282
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
283
        try:
284
            job = get_restricted_job(self.user, job_id)
285
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
286
            raise xmlrpc.client.Fault(
287
                401, "Permission denied for user to job %s" % job_id)
288
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
289
            raise xmlrpc.client.Fault(404, "Specified job not found.")
290

291
292
        output_file = job.output_file()
        if output_file:
293
            output_file.seek(offset)
Neil Williams's avatar
Neil Williams committed
294
            return xmlrpc.client.Binary(output_file.read().encode('UTF-8'))
295
        else:
Neil Williams's avatar
Neil Williams committed
296
            raise xmlrpc.client.Fault(404, "Job output not found.")
297
298
299
300
301
302
303
304
305

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

        Description
        -----------
306
        Get all the available devices with their state and type information.
307
308
309
310
311
312
313
314

        Arguments
        ---------
        None

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

318
        [['panda01', 'panda', 'running', 'good', 164, False], ['qemu01', 'qemu', 'idle', 'unknwon', None, True]]
319
320
        """

321
        devices_list = []
322
        for dev in Device.objects.exclude(health=Device.HEALTH_RETIRED):
323
324
            if not dev.is_visible_to(self.user):
                continue
325
            devices_list.append(dev)
326

Rémi Duraffort's avatar
Rémi Duraffort committed
327
        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]
328
                for dev in devices_list]
329
330
331
332
333
334
335
336
337
338

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

        Description
        -----------
        Get all the available device types with their state and count
339
        information.
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354

        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}]
        """

355
356
        device_type_names = []
        all_device_types = []
Neil Williams's avatar
Neil Williams committed
357
        keys = ['busy', 'idle', 'offline']
358

359
        for dev_type in DeviceType.objects.all():
360
            if not dev_type.some_devices_visible_to(self.user):
361
                continue
362
            device_type_names.append(dev_type.name)
363

Neil Williams's avatar
Neil Williams committed
364
        device_types = device_type_summary(device_type_names)
365
366

        for dev_type in device_types:
Neil Williams's avatar
Neil Williams committed
367
            device_type = {'name': dev_type['device_type']}
368
            for key in keys:
Neil Williams's avatar
Neil Williams committed
369
                device_type[key] = dev_type[key]
370
            all_device_types.append(device_type)
371

372
        return all_device_types
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
    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
419
            raise xmlrpc.client.Fault(
420
421
422
                400, "Bad request: device_type was not specified."
            )
        if count < 0:
Neil Williams's avatar
Neil Williams committed
423
            raise xmlrpc.client.Fault(
424
425
426
427
428
                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
429
            raise xmlrpc.client.Fault(
430
431
432
433
                404, "DeviceType '%s' was not found." % device_type
            )

        if not dt.some_devices_visible_to(self.user):
Neil Williams's avatar
Neil Williams committed
434
            raise xmlrpc.client.Fault(
435
436
437
                403, "DeviceType '%s' not available to user '%s'." %
                (device_type, self.user)
            )
438
439
440
        job_qs = TestJob.objects.filter(state=TestJob.STATE_FINISHED) \
                                .filter(requested_device_type=dt) \
                                .order_by('-id')
441
442
443
444
445
446
447
        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
448
                "status": job.get_legacy_status_display(),
449
450
451
452
453
454
455
                "device": job.actual_device.hostname,
            }
            if not job.can_view(self.user):
                job_dict["id"] = None
            job_list.append(job_dict)
        return job_list

456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    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
499
            raise xmlrpc.client.Fault(
500
501
502
                400, "Bad request: device was not specified."
            )
        if count < 0:
Neil Williams's avatar
Neil Williams committed
503
            raise xmlrpc.client.Fault(
504
505
506
507
508
                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
509
            raise xmlrpc.client.Fault(
510
511
512
513
                404, "Device '%s' was not found." % device
            )

        if not device_obj.is_visible_to(self.user):
Neil Williams's avatar
Neil Williams committed
514
            raise xmlrpc.client.Fault(
515
516
517
                403, "Device '%s' not available to user '%s'." %
                (device, self.user)
            )
518
519
520
        job_qs = TestJob.objects.filter(state=TestJob.STATE_FINISHED) \
                                .filter(actual_device=device_obj) \
                                .order_by('-id')
521
522
523
524
525
526
527
        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
528
                "status": job.get_legacy_status_display(),
529
530
531
532
533
534
            }
            if not job.can_view(self.user):
                job_dict["id"] = None
            job_list.append(job_dict)
        return job_list

535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
    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]
        }

575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
    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
605
            raise xmlrpc.client.Fault(
606
607
608
609
610
                400, "Bad request: Hostname was not specified."
            )
        try:
            device = Device.objects.get(hostname=hostname)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
611
            raise xmlrpc.client.Fault(
612
613
614
615
616
617
                404, "Device '%s' was not found." % hostname
            )

        device_dict = {}
        if device.is_visible_to(self.user):
            device_dict["hostname"] = device.hostname
618
            device_dict["status"] = build_device_status_display(device.state, device.health)
619
620
621
            device_dict["job"] = None
            device_dict["offline_since"] = None
            device_dict["offline_by"] = None
Rémi Duraffort's avatar
Rémi Duraffort committed
622
            device_dict["is_pipeline"] = True
623

624
625
626
            current_job = device.current_job()
            if current_job is not None:
                device_dict["job"] = current_job.pk
627
        else:
Neil Williams's avatar
Neil Williams committed
628
            raise xmlrpc.client.Fault(
629
630
631
632
                403, "Permission denied for user to access %s information." % hostname
            )
        return device_dict

633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
    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
662
            raise xmlrpc.client.Fault(
663
664
665
                400, "Bad request: Hostname was not specified."
            )
        if not reason:
Neil Williams's avatar
Neil Williams committed
666
            raise xmlrpc.client.Fault(
667
668
                400, "Bad request: Reason was not specified."
            )
669
670
671
672
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
673
                raise xmlrpc.client.Fault(
674
675
676
677
678
679
                    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
680
                raise xmlrpc.client.Fault(
681
682
                    403, "Permission denied for user to put %s into maintenance mode." % hostname
                )
683

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
    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
713
            raise xmlrpc.client.Fault(
714
715
716
                400, "Bad request: Hostname was not specified."
            )
        if not reason:
Neil Williams's avatar
Neil Williams committed
717
            raise xmlrpc.client.Fault(
718
719
                400, "Bad request: Reason was not specified."
            )
720
721
722
723
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
724
                raise xmlrpc.client.Fault(
725
726
727
728
729
730
                    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
731
                raise xmlrpc.client.Fault(
732
733
                    403, "Permission denied for user to put %s into online mode." % hostname
                )
734

735
    def pending_jobs_by_device_type(self, all=False):
736
737
738
        """
        Name
        ----
739
        `pending_jobs_by_device_type` ()
740
741
742

        Description
        -----------
743
        Get number of pending jobs in each device type.
744
745
        Private test jobs and hidden device types are
        excluded, except for authenticated superusers.
746
747
748

        Arguments
        ---------
749
        `all`: boolean - include retired devices and undisplayed device-types in the listing.
750
751
752

        Return value
        ------------
753
754
        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.
755
756
        For example:

757
        {'qemu': 0, 'panda': 3}
758
759
        """

760
        pending_jobs_by_device = {}
761

762
763
764
765
766
767
768
769
770
        jobs_res = TestJob.objects.filter(state=TestJob.STATE_SUBMITTED)
        jobs_res = jobs_res.exclude(requested_device_type_id__isnull=True)

        if not self.user or not self.user.is_superuser:
            jobs_res = jobs_res.filter(is_public=True)

        jobs_res = jobs_res.values_list('requested_device_type_id')
        jobs_res = jobs_res.annotate(pending_jobs=(Count('id')))

771
772
773
        jobs = {}
        jobs_hash = dict(jobs_res)
        for job in jobs_hash:
774
            jobs[job] = jobs_hash[job]
775
        pending_jobs_by_device.update(jobs)
776

777
        # Get rest of the devices and put number of pending jobs as 0.
778
779
780
781
782
783
784
785
        if all:
            device_types = DeviceType.objects.values_list('name', flat=True)
        else:
            device_types = active_device_types().values_list('name', flat=True)

        if not self.user or not self.user.is_superuser:
            device_types.filter(owners_only=False)

786
787
788
        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
789

790
        return pending_jobs_by_device
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810

    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.
811
812

        The elements available in XML-RPC structure include:
Rémi Duraffort's avatar
Rémi Duraffort committed
813
        _state, submitter_id, is_pipeline, id, failure_comment,
814
815
816
817
818
819
        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
820
        """
821
        self._authenticate()
822
        if not job_id:
Neil Williams's avatar
Neil Williams committed
823
824
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
825
        try:
826
            job = get_restricted_job(self.user, job_id)
Rémi Duraffort's avatar
Rémi Duraffort committed
827
            job.status = job.get_legacy_status_display()
828
829
            job.state = job.get_state_display()
            job.health = job.get_health_display()
830
            job.submitter_username = job.submitter.username
831
            job.absolute_url = job.get_absolute_url()
Rémi Duraffort's avatar
Rémi Duraffort committed
832
            job.is_pipeline = True
833
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
834
            raise xmlrpc.client.Fault(
835
                401, "Permission denied for user to job %s" % job_id)
836
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
837
            raise xmlrpc.client.Fault(404, "Specified job not found.")
838
839

        return job
840
841
842
843
844

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

847
        `job_status` (`job_id`)
848
849
850
851
852
853
854
855
856
857
858
859

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

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

        Return value
        ------------
860
861
        This function returns an XML-RPC structures of job status with the
        following fields.
862
        The user is authenticated with an username and token.
Neil Williams's avatar
Neil Williams committed
863

864
        `job_status`: string
865
        ['Submitted'|'Running'|'Complete'|'Incomplete'|'Canceled'|'Canceling']
866
867

        `bundle_sha1`: string
868
        The sha1 hash code of the bundle, if it existed. Otherwise it will be
869
        an empty string. (LAVA V1 only)
870
        """
871
872
        self._authenticate()
        if not job_id:
Neil Williams's avatar
Neil Williams committed
873
874
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
875
        try:
876
            job = get_restricted_job(self.user, job_id)
877
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
878
            raise xmlrpc.client.Fault(
879
                401, "Permission denied for user to job %s" % job_id)
880
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
881
            raise xmlrpc.client.Fault(404, "Specified job not found.")
882

883
884
885
886
887
888
889
890
        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
891
            'job_status': job.get_legacy_status_display(),
Rémi Duraffort's avatar
Rémi Duraffort committed
892
            'bundle_sha1': ""
893
        })
894
        return job_status
895

896
897
898
899
    def job_list_status(self, job_id_list):
        """
        Name
        ----
900
901
        DEPRECATED - use `job_health` or `job_state` instead.

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
        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
935
            raise xmlrpc.client.Fault(400, "Bad request: needs to be a list")
936
        if not all(isinstance(chk, (float, int)) for chk in job_id_list):
Neil Williams's avatar
Neil Williams committed
937
            raise xmlrpc.client.Fault(400, "Bad request: needs to be a list of integers or floats")
938
939
        jobs = TestJob.objects.filter(
            Q(id__in=job_id_list) | Q(sub_id__in=job_id_list)).select_related(
940
                'actual_device', 'requested_device_type')
941
        for job in jobs:
Rémi Duraffort's avatar
Rémi Duraffort committed
942
            device_type = job.requested_device_type
943
944
            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
945
            if device_type and device_type.owners_only:
946
                # do the more expensive check second and only for a hidden device type
947
                if not device_type.some_devices_visible_to(self.user):
948
                    continue
Rémi Duraffort's avatar
Rémi Duraffort committed
949
            job_status[str(job.display_id)] = job.get_legacy_status_display()
950
951
        return job_status

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
    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
978
979
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
980
981
982
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
983
            raise xmlrpc.client.Fault(
984
985
                401, "Permission denied for user to job %s" % job_id)
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
986
            raise xmlrpc.client.Fault(404, "Specified job not found.")
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025

        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
1026
1027
            raise xmlrpc.client.Fault(
                400, "Bad request: TestJob id was not specified.")
1028
1029
1030
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
1031
            raise xmlrpc.client.Fault(
1032
1033
                401, "Permission denied for user to job %s" % job_id)
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1034
            raise xmlrpc.client.Fault(404, "Specified job not found.")
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047

        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

1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
    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:

1069
1070
1071
        [[73, 'multinode-job', 'submitted', None, 'kvm', '72.1'],
        [72, 'multinode-job', 'submitted', None, 'kvm', '72.0'],
        [71, 'test-job', 'running', 'kvm01', None, None]]
1072
1073
        """

1074
        jobs = TestJob.objects.exclude(state=TestJob.STATE_FINISHED).order_by('-id')
Rémi Duraffort's avatar
Rémi Duraffort committed
1075
        jobs_list = [[job.id, job.description, job.get_legacy_status_display().lower(),
1076
                      job.actual_device, job.requested_device_type, job.sub_id] for job in jobs]
1077
1078

        return jobs_list
1079
1080
1081
1082
1083

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

1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
        `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.

1097
1098
1099
1100
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
1101
        return self.get_device_config(device_hostname)
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124

    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}')`

1125
1126
1127
1128
1129
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        if not device_hostname:
Neil Williams's avatar
Neil Williams committed
1130
1131
            raise xmlrpc.client.Fault(
                400, "Bad request: Device hostname was not specified.")
1132

1133
1134
1135
        job_ctx = None
        if context is not None:
            try:
1136
                job_ctx = yaml.safe_load(context)
1137
            except yaml.YAMLError as exc:
Neil Williams's avatar
Neil Williams committed
1138
                raise xmlrpc.client.Fault(
1139
1140
                    400,
                    "Job context '%s' is not valid. %s" % (context, exc))
1141
1142
1143
        try:
            device = Device.objects.get(hostname=device_hostname)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1144
            raise xmlrpc.client.Fault(404, "Specified device was not found.")
1145

1146
        config = device.load_configuration(job_ctx=job_ctx, output_format="yaml")
1147
1148

        # validate against the device schema
1149
        validate_device(yaml.safe_load(config))
1150

Neil Williams's avatar
Neil Williams committed
1151
        return xmlrpc.client.Binary(config.encode('UTF-8'))
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169

    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
1170
            Device configuration as Jinja2
1171
1172
1173
1174
1175
1176
1177

        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
1178
            raise xmlrpc.client.Fault(
1179
                403,
1180
                "User '%s' is not superuser." % self.user.username
1181
1182
            )
        try:
1183
            device = Device.objects.get(hostname=hostname)
1184
        except DeviceType.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1185
            raise xmlrpc.client.Fault(
1186
1187
                404, "Device '%s' was not found." % hostname
            )
1188
        if not device.save_configuration(jinja_str):
Neil Williams's avatar
Neil Williams committed
1189
            raise xmlrpc.client.Fault(
1190
                400, "Unable to store the configuration for %s on disk" % hostname
1191
            )
1192
1193

        return "Device dictionary updated for %s" % hostname
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219

    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
1220
            raise xmlrpc.client.Fault(
1221
                403, "User '%s' is not superuser." % self.user.username
1222
1223
1224
1225
            )
        try:
            device = Device.objects.get(hostname=hostname)
        except DeviceType.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1226
            raise xmlrpc.client.Fault(
1227
1228
                404, "Device '%s' was not found." % hostname
            )
1229
        device_dict = device.load_configuration(output_format="raw")
1230
        if not device_dict:
Neil Williams's avatar
Neil Williams committed
1231
            raise xmlrpc.client.Fault(
1232
1233
                404, "Device '%s' does not have a device dictionary" % hostname
            )
1234

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

1237
    def validate_pipeline_devices(self, name=None):
1238
1239
1240
        """
        Name
        ----
1241
        `validate_pipeline_device` [`name`]
1242
1243
1244
1245
1246
1247

        Description
        -----------
        Validate that the device dictionary and device-type template
        together create a valid YAML file which matches the pipeline
        device schema.
1248
        Retired devices are ignored.
1249
1250
1251
1252
1253

        See also get_pipeline_device_config

        Arguments
        ---------
1254
1255
1256
1257
1258
1259
1260
        `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.
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272

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

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

        """
1273
        if not name:
Rémi Duraffort's avatar
Rémi Duraffort committed
1274
            devices = Device.objects.exclude(health=Device.HEALTH_RETIRED)
1275
        else:
Rémi Duraffort's avatar
Rémi Duraffort committed
1276
            devices = Device.objects.exclude(health=Device.HEALTH_RETIRED).filter(device_type__name=name)
1277
            if not devices:
Rémi Duraffort's avatar
Rémi Duraffort committed
1278
                devices = Device.objects.exclude(health=Device.HEALTH_RETIRED).filter(hostname=name)
1279
        if not devices and name:
Neil Williams's avatar
Neil Williams committed
1280
            raise xmlrpc.client.Fault(
1281
1282
                404,
                "No devices found with hostname or device type name %s" % name
1283
            )
1284
        if not devices and not name:
Neil Williams's avatar
Neil Williams committed
1285
            raise xmlrpc.client.Fault(
1286
1287
1288
1289
1290
                404, "No pipeline device found on this instance."
            )
        results = {}
        for device in devices:
            key = str(device.hostname)