summaryrefslogtreecommitdiff
path: root/src/buildstream/_scheduler/queues/pullqueue.py
blob: 757619a7622e008e56a55776178540032fa6ef7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
#
#  Copyright (C) 2016 Codethink Limited
#
#  This program is free software; you can redistribute it and/or
#  modify it under the terms of the GNU Lesser General Public
#  License as published by the Free Software Foundation; either
#  version 2 of the License, or (at your option) any later version.
#
#  This library 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
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public
#  License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
#  Authors:
#        Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
#        Jürg Billeter <juerg.billeter@codethink.co.uk>

from ..._exceptions import SkipJob
from ..jobs import JobStatus
from ..resources import ResourceType
# Local imports
from . import Queue, QueueStatus


# A queue which pulls element artifacts
#
class PullQueue(Queue):

    action_name = "Pull"
    complete_name = "Artifacts Pulled"
    resources = [ResourceType.DOWNLOAD, ResourceType.CACHE]

    def get_process_func(self):
        return PullQueue._pull_or_skip

    def status(self, element):
        if not element._can_query_cache():
            return QueueStatus.PENDING

        if element._pull_pending():
            return QueueStatus.READY
        else:
            return QueueStatus.SKIP

    def done(self, _, element, result, status):

        if status is JobStatus.FAIL:
            return

        element._pull_done()

    def register_pending_element(self, element):
        # Set a "can_query_cache"_callback for an element which is not
        # immediately ready to query the artifact cache so that it
        # may be pulled.
        element._set_can_query_cache_callback(self._enqueue_element)

    @staticmethod
    def _pull_or_skip(element):
        if not element._pull():
            raise SkipJob(PullQueue.action_name)