__init__.py 42.3 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 os
24
import sys
Neil Williams's avatar
Neil Williams committed
25
import xmlrpc.client
26
27
import yaml

28
from django.conf import settings
29
from django.core.exceptions import PermissionDenied
30
from django.db.models import Count, Q
31
from django.db import transaction
32
from linaro_django_xmlrpc.models import ExposedAPI
33
34
35
from lava_scheduler_app.models import (
    Device,
    DeviceType,
36
    JSONDataError,
37
    DevicesUnavailableException,
38
    TestJob,
Neil Williams's avatar
Neil Williams committed
39
)
40
from lava_scheduler_app.views import get_restricted_job
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
from lava_scheduler_app.schema import (
    validate_submission,
    validate_device,
    SubmissionException,
)

# functions need to be members to be exposed in the API
53

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

Neil Williams's avatar
Neil Williams committed
55
56
# to make a function visible in the API, it must be a member of SchedulerAPI

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

58
59
def check_perm(perm):
    """ decorator to check that the caller has the given permission """
60

61
62
63
64
65
66
67
    def decorator(f):
        @wraps(f)
        def wrapper(self, *args, **kwargs):
            self._authenticate()
            if not self.user.has_perm(perm):
                raise xmlrpc.client.Fault(
                    403,
68
                    "User '%s' is missing permission %s ." % (self.user.username, perm),
69
70
                )
            return f(self, *args, **kwargs)
71

72
        return wrapper
73

74
    return decorator
75
76


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


91
92
class SchedulerAPI(ExposedAPI):
    def submit_job(self, job_data):
93
94
95
96
97
98
99
        """
        Name
        ----
        `submit_job` (`job_data`)

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

        Arguments
        ---------
        `job_data`: string
106
            Job JSON or YAML string.
107
108
109
110

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

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

159
        if job.is_multinode:
160
161
162
            return self.submit_job(job.multinode_definition)
        else:
            return self.submit_job(job.definition)
163

164
    def cancel_job(self, job_id):
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
        """
        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.
        """
183
184
        self._authenticate()
        if not job_id:
185
            raise xmlrpc.client.Fault(400, "Bad request: TestJob id was not specified.")
186

187
188
189
190
        with transaction.atomic():
            try:
                job = get_restricted_job(self.user, job_id, for_update=True)
            except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
191
                raise xmlrpc.client.Fault(
192
193
                    401, "Permission denied for user to job %s" % job_id
                )
194
            except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
195
                raise xmlrpc.client.Fault(404, "Specified job not found.")
196
197
198
199
200

            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
201
                raise xmlrpc.client.Fault(403, "Permission denied.")
202
203
204

            if job.is_multinode:
                multinode_jobs = TestJob.objects.select_for_update().filter(
205
206
                    target_group=job.target_group
                )
207
208
209
210
211
212
                for multinode_job in multinode_jobs:
                    multinode_job.go_state_canceling()
                    multinode_job.save()
            else:
                job.go_state_canceling()
                job.save()
213
        return True
214

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

250
    def job_output(self, job_id, offset=0):
251
252
253
        """
        Name
        ----
254
        `job_output` (`job_id`, `offset=0`)
255
256
257
258
259
260
261
262
263

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

        Arguments
        ---------
        `job_id`: string
            Job id for which the output is required.
264
265
266
        `offset`: integer
            Offset from which to start reading the output file specified in bytes.
            It defaults to 0.
267
268
269

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

285
286
287
288
289
290
291
292
        # Open the logs
        output_path = os.path.join(job.output_dir, "output.yaml")
        try:
            with open(output_path, encoding="utf-8", errors="replace") as f_logs:
                if f_logs:
                    f_logs.seek(offset)
                return xmlrpc.client.Binary(f_logs.read().encode("UTF-8"))
        except OSError:
Neil Williams's avatar
Neil Williams committed
293
            raise xmlrpc.client.Fault(404, "Job output not found.")
294
295
296
297
298
299
300
301
302

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

        Description
        -----------
303
        Get all the available devices with their state and type information.
304
305
306
307
308
309
310
311

        Arguments
        ---------
        None

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

315
        [['panda01', 'panda', 'running', 'good', 164, False], ['qemu01', 'qemu', 'idle', 'unknwon', None, True]]
316
317
        """

Stevan Radakovic's avatar
Stevan Radakovic committed
318
319
320
        devices_list = Device.objects.visible_by_user(self.user).exclude(
            health=Device.HEALTH_RETIRED
        )
321

322
323
324
325
326
327
328
329
330
331
        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,
            ]
            for dev in devices_list
        ]
332
333
334
335
336
337
338
339
340
341

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

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

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

358
        all_device_types = []
359
        keys = ["busy", "idle", "offline"]
360

Stevan Radakovic's avatar
Stevan Radakovic committed
361
        device_types = device_type_summary(self.user)
362
363

        for dev_type in device_types:
364
            device_type = {"name": dev_type["device_type"]}
365
            for key in keys:
Neil Williams's avatar
Neil Williams committed
366
                device_type[key] = dev_type[key]
367
            all_device_types.append(device_type)
368

369
        return all_device_types
370

371
372
373
    def get_recent_jobs_for_device_type(
        self, device_type, count=1, restrict_to_user=False
    ):
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
        """
        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
418
            raise xmlrpc.client.Fault(
419
420
421
                400, "Bad request: device_type was not specified."
            )
        if count < 0:
422
            raise xmlrpc.client.Fault(400, "Bad request: count must not be negative.")
423
424
425
        try:
            dt = DeviceType.objects.get(name=device_type, display=True)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
426
            raise xmlrpc.client.Fault(
427
428
429
                404, "DeviceType '%s' was not found." % device_type
            )

430
431
432
        job_qs = (
            TestJob.objects.filter(state=TestJob.STATE_FINISHED)
            .filter(requested_device_type=dt)
Stevan Radakovic's avatar
Stevan Radakovic committed
433
            .visible_by_user(self.user)
434
435
            .order_by("-id")
        )
436
437
438
439
        if restrict_to_user:
            job_qs = job_qs.filter(submitter=self.user)
        job_list = []
        for job in job_qs.all()[:count]:
440
            hostname = ""
441
442
            if job.actual_device:
                hostname = job.actual_device.hostname
443
444
445
            job_dict = {
                "id": job.id,
                "description": job.description,
Rémi Duraffort's avatar
Rémi Duraffort committed
446
                "status": job.get_legacy_status_display(),
447
                "device": hostname,
448
449
450
451
            }
            job_list.append(job_dict)
        return job_list

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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
    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:
495
            raise xmlrpc.client.Fault(400, "Bad request: device was not specified.")
496
        if count < 0:
497
            raise xmlrpc.client.Fault(400, "Bad request: count must not be negative.")
498
499
500
        try:
            device_obj = Device.objects.get(hostname=device)
        except Device.DoesNotExist:
501
            raise xmlrpc.client.Fault(404, "Device '%s' was not found." % device)
502

Stevan Radakovic's avatar
Stevan Radakovic committed
503
        if not device_obj.can_view(self.user):
Neil Williams's avatar
Neil Williams committed
504
            raise xmlrpc.client.Fault(
505
                403, "Device '%s' not available to user '%s'." % (device, self.user)
506
            )
507
508
509
        job_qs = (
            TestJob.objects.filter(state=TestJob.STATE_FINISHED)
            .filter(actual_device=device_obj)
Stevan Radakovic's avatar
Stevan Radakovic committed
510
            .visible_by_user(self.user)
511
512
            .order_by("-id")
        )
513
514
515
516
517
518
519
        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
520
                "status": job.get_legacy_status_display(),
521
522
523
524
            }
            job_list.append(job_dict)
        return job_list

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
554
555
556
557
558
559
    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']}
        """

Stevan Radakovic's avatar
Stevan Radakovic committed
560
561
562
        aliases = DeviceType.objects.filter(
            aliases__name__contains=alias
        ).visible_by_user(self.user)
563
        return {alias: [device_type.name for device_type in aliases]}
564

565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
    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:
595
            raise xmlrpc.client.Fault(400, "Bad request: Hostname was not specified.")
596
597
598
        try:
            device = Device.objects.get(hostname=hostname)
        except Device.DoesNotExist:
599
            raise xmlrpc.client.Fault(404, "Device '%s' was not found." % hostname)
600
601

        device_dict = {}
Stevan Radakovic's avatar
Stevan Radakovic committed
602
        if device.can_view(self.user):
603
            device_dict["hostname"] = device.hostname
604
605
606
            device_dict["status"] = build_device_status_display(
                device.state, device.health
            )
607
608
609
            device_dict["job"] = None
            device_dict["offline_since"] = None
            device_dict["offline_by"] = None
Rémi Duraffort's avatar
Rémi Duraffort committed
610
            device_dict["is_pipeline"] = True
611

612
613
614
            current_job = device.current_job()
            if current_job is not None:
                device_dict["job"] = current_job.pk
615
        else:
Neil Williams's avatar
Neil Williams committed
616
            raise xmlrpc.client.Fault(
617
618
619
620
                403, "Permission denied for user to access %s information." % hostname
            )
        return device_dict

621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
    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:
650
            raise xmlrpc.client.Fault(400, "Bad request: Hostname was not specified.")
651
        if not reason:
652
            raise xmlrpc.client.Fault(400, "Bad request: Reason was not specified.")
653
654
655
656
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
657
                raise xmlrpc.client.Fault(404, "Device '%s' was not found." % hostname)
658
            if device.can_change(self.user):
659
660
661
                device.health = Device.HEALTH_MAINTENANCE
                device.save()
            else:
Neil Williams's avatar
Neil Williams committed
662
                raise xmlrpc.client.Fault(
663
664
665
                    403,
                    "Permission denied for user to put %s into maintenance mode."
                    % hostname,
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
692
693
694
695
696
    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:
697
            raise xmlrpc.client.Fault(400, "Bad request: Hostname was not specified.")
698
        if not reason:
699
            raise xmlrpc.client.Fault(400, "Bad request: Reason was not specified.")
700
701
702
703
        with transaction.atomic():
            try:
                device = Device.objects.select_for_update().get(hostname=hostname)
            except Device.DoesNotExist:
704
                raise xmlrpc.client.Fault(404, "Device '%s' was not found." % hostname)
705
            if device.can_change(self.user):
706
707
708
                device.health = Device.HEALTH_UNKNOWN
                device.save()
            else:
Neil Williams's avatar
Neil Williams committed
709
                raise xmlrpc.client.Fault(
710
711
                    403,
                    "Permission denied for user to put %s into online mode." % hostname,
712
                )
713

714
    def pending_jobs_by_device_type(self, all=False):
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
        Private test jobs and hidden device types are
        excluded, except for authenticated superusers.
725
726
727

        Arguments
        ---------
728
        `all`: boolean - include retired devices and undisplayed device-types in the listing.
729
730
731

        Return value
        ------------
732
733
        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.
734
735
        For example:

736
        {'qemu': 0, 'panda': 3}
737
738
        """

739
        pending_jobs_by_device = {}
740

Stevan Radakovic's avatar
Stevan Radakovic committed
741
742
743
        jobs_res = TestJob.objects.filter(
            state=TestJob.STATE_SUBMITTED
        ).visible_by_user(self.user)
744
        jobs_res = jobs_res.exclude(requested_device_type_id__isnull=True)
745
746
        jobs_res = jobs_res.values_list("requested_device_type_id")
        jobs_res = jobs_res.annotate(pending_jobs=(Count("id")))
747

748
749
750
        jobs = {}
        jobs_hash = dict(jobs_res)
        for job in jobs_hash:
751
            jobs[job] = jobs_hash[job]
752
        pending_jobs_by_device.update(jobs)
753

754
        # Get rest of the devices and put number of pending jobs as 0.
755
        if all:
756
            device_types = DeviceType.objects.all()
757
        else:
758
            device_types = active_device_types()
759

Stevan Radakovic's avatar
Stevan Radakovic committed
760
        device_types = device_types.visible_by_user(self.user)
761
        for device_type in device_types.values_list("name", flat=True):
762
763
            if device_type not in pending_jobs_by_device:
                pending_jobs_by_device[device_type] = 0
Neil Williams's avatar
Neil Williams committed
764

765
        return pending_jobs_by_device
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785

    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.
786
787

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

        return job
814
815
816
817
818

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

821
        `job_status` (`job_id`)
822
823
824
825
826
827
828
829
830
831
832
833

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

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

        Return value
        ------------
834
835
        This function returns an XML-RPC structures of job status with the
        following fields.
836
        The user is authenticated with an username and token.
Neil Williams's avatar
Neil Williams committed
837

838
        `job_status`: string
839
        ['Submitted'|'Running'|'Complete'|'Incomplete'|'Canceled'|'Canceling']
840
841

        `bundle_sha1`: string
842
        The sha1 hash code of the bundle, if it existed. Otherwise it will be
843
        an empty string. (LAVA V1 only)
844
        """
845
846
        self._authenticate()
        if not job_id:
847
            raise xmlrpc.client.Fault(400, "Bad request: TestJob id was not specified.")
848
        try:
849
            job = get_restricted_job(self.user, job_id)
850
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
851
            raise xmlrpc.client.Fault(
852
853
                401, "Permission denied for user to job %s" % job_id
            )
854
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
855
            raise xmlrpc.client.Fault(404, "Specified job not found.")
856

857
        job_status = {"job_id": job.id}
858
859

        if job.is_multinode:
860
861
862
863
864
            job_status.update({"sub_id": job.sub_id})

        job_status.update(
            {"job_status": job.get_legacy_status_display(), "bundle_sha1": ""}
        )
865
        return job_status
866

867
868
869
870
    def job_list_status(self, job_id_list):
        """
        Name
        ----
871
872
        DEPRECATED - use `job_health` or `job_state` instead.

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
900
901
902
903
904
905
        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
906
            raise xmlrpc.client.Fault(400, "Bad request: needs to be a list")
907
        if not all(isinstance(chk, (float, int)) for chk in job_id_list):
908
909
910
            raise xmlrpc.client.Fault(
                400, "Bad request: needs to be a list of integers or floats"
            )
Stevan Radakovic's avatar
Stevan Radakovic committed
911
912
913
914
915
        jobs = (
            TestJob.objects.filter(Q(id__in=job_id_list) | Q(sub_id__in=job_id_list))
            .visible_by_user(self.user)
            .select_related("actual_device", "requested_device_type")
        )
916
        for job in jobs:
Rémi Duraffort's avatar
Rémi Duraffort committed
917
            job_status[str(job.display_id)] = job.get_legacy_status_display()
918
919
        return job_status

920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
    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:
946
            raise xmlrpc.client.Fault(400, "Bad request: TestJob id was not specified.")
947
948
949
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
950
            raise xmlrpc.client.Fault(
951
952
                401, "Permission denied for user to job %s" % job_id
            )
953
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
954
            raise xmlrpc.client.Fault(404, "Specified job not found.")
955

956
        job_health = {"job_id": job.id, "job_health": job.get_health_display()}
957
958

        if job.is_multinode:
959
            job_health.update({"sub_id": job.sub_id})
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

        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:
989
            raise xmlrpc.client.Fault(400, "Bad request: TestJob id was not specified.")
990
991
992
        try:
            job = get_restricted_job(self.user, job_id)
        except PermissionDenied:
Neil Williams's avatar
Neil Williams committed
993
            raise xmlrpc.client.Fault(
994
995
                401, "Permission denied for user to job %s" % job_id
            )
996
        except TestJob.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
997
            raise xmlrpc.client.Fault(404, "Specified job not found.")
998

999
        job_state = {"job_id": job.id, "job_state": job.get_state_display()}
1000
1001

        if job.is_multinode:
1002
            job_state.update({"sub_id": job.sub_id})
1003
1004
1005

        return job_state

1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
    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:

1027
1028
1029
        [[73, 'multinode-job', 'submitted', None, 'kvm', '72.1'],
        [72, 'multinode-job', 'submitted', None, 'kvm', '72.0'],
        [71, 'test-job', 'running', 'kvm01', None, None]]
1030
1031
        """

Stevan Radakovic's avatar
Stevan Radakovic committed
1032
1033
1034
1035
1036
        jobs = (
            TestJob.objects.exclude(state=TestJob.STATE_FINISHED)
            .visible_by_user(self.user)
            .order_by("-id")
        )
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
        jobs_list = [
            [
                job.id,
                job.description,
                job.get_legacy_status_display().lower(),
                job.actual_device,
                job.requested_device_type,
                job.sub_id,
            ]
            for job in jobs
        ]
1048
1049

        return jobs_list
1050
1051
1052
1053
1054

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

1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
        `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.

1068
1069
1070
1071
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
1072
        return self.get_device_config(device_hostname)
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095

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

1096
1097
1098
1099
1100
        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        if not device_hostname:
Neil Williams's avatar
Neil Williams committed
1101
            raise xmlrpc.client.Fault(
1102
1103
                400, "Bad request: Device hostname was not specified."
            )
1104

1105
1106
1107
        job_ctx = None
        if context is not None:
            try:
1108
                job_ctx = yaml.safe_load(context)
1109
            except yaml.YAMLError as exc:
Neil Williams's avatar
Neil Williams committed
1110
                raise xmlrpc.client.Fault(
1111
1112
                    400, "Job context '%s' is not valid. %s" % (context, exc)
                )
1113
1114
1115
        try:
            device = Device.objects.get(hostname=device_hostname)
        except Device.DoesNotExist:
Neil Williams's avatar
Neil Williams committed
1116
            raise xmlrpc.client.Fault(404, "Specified device was not found.")
1117

Stevan Radakovic's avatar
Stevan Radakovic committed
1118
1119
1120
1121
1122
        if not device.can_view(self.user):
            raise xmlrpc.client.Fault(
                401, "Permission denied for user to device %s" % device.hostname
            )

1123
        config = device.load_configuration(job_ctx=job_ctx, output_format="yaml")
1124
1125

        # validate against the device schema
1126
        validate_device(yaml.safe_load(config))
1127

1128
        return xmlrpc.client.Binary(config.encode("UTF-8"))
1129
1130
1131
1132
1133
1134
1135
1136
1137

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

        Description
        -----------
1138
        [user with change_device permission only]
1139
1140
1141
1142
1143
1144
1145
1146
        Import or update the device dictionary key value store for a
        pipeline device.

        Arguments
        ---------
        `device_hostname`: string
            Device hostname to update.
        `jinja_str`: string
1147
            Device configuration as Jinja2
1148
1149
1150
1151
1152
1153
1154

        Return value
        ------------
        This function returns an XML-RPC binary data of output file.
        """
        self._authenticate()
        try:
1155
            device = Device.objects.get(hostname=hostname)
1156
        except DeviceType.DoesNotExist:
1157
            raise xmlrpc.client.Fault(404, "Device '%s' was not found." % hostname)
1158
        if device.can_change(self.user):
Stevan Radakovic's avatar
Stevan Radakovic committed
1159
1160
1161
1162
1163
            if not device.save_configuration(jinja_str):
                raise xmlrpc.client.Fault(
                    400, "Unable to store the configuration for %s on disk" % hostname
                )
        else:
Neil Williams's avatar
Neil Williams committed
1164
            raise xmlrpc.client.Fault(
1165
1166
1167
                403,
                "Permission denied for user to store the configuration for %s on disk."
                % hostname,
1168
            )
1169
1170

        return "Device dictionary updated for %s" % hostname
1171
1172
1173
1174
1175
1176
1177
1178
1179

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

        Description
        -----------
Stevan Radakovic's avatar
Stevan Radakovic committed
1180
        [user with admin permission only]
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
        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()
        try:
            device = Device.objects.get(hostname=hostname)
        except DeviceType.DoesNotExist:
1199
            raise xmlrpc.client.Fault(404, "Device '%s' was not found." % hostname)
1200
        if device.can_change(self.user):
Stevan Radakovic's avatar
Stevan Radakovic committed
1201
1202
1203
1204
1205
1206
            device_dict = device.load_configuration(output_format="raw")
            if not device_dict:
                raise xmlrpc.client.Fault(
                    404, "Device '%s' does not have a device dictionary" % hostname
                )
        else:
Neil Williams's avatar
Neil Williams committed
1207
            raise xmlrpc.client.Fault(
1208
1209
1210
                403,
                "Permission denied for user to retrieve device dictionary for '%s'."
                % hostname,
1211
            )
1212

1213
        return xmlrpc.client.Binary(device_dict.encode("UTF-8"))
1214

1215
    def validate_pipeline_devices(self, name=None):
1216
1217
1218
        """
        Name
        ----
1219
        `validate_pipeline_device` [`name`]
1220
1221
1222
1223
1224
1225

        Description
        -----------
        Validate that the device dictionary and device-type template
        together create a valid YAML file which matches the pipeline
        device schema.
1226
        Retired devices are ignored.
1227
1228
1229
1230
1231

        See also get_pipeline_device_config

        Arguments
        ---------
1232
1233
1234
1235
1236
1237
1238
        `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.
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250

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

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

        """
1251
        if not name:
Rémi Duraffort's avatar
Rémi Duraffort committed
1252
            devices = Device.objects.exclude(health=Device.HEALTH_RETIRED)
1253
        else: