src/buildstream/_scheduler/queues/sourcepullqueue.py

#
#  Copyright (C) 2019 Bloomberg Finance LP
#
#  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/>.
#

from . import Queue, QueueStatus
from ..resources import ResourceType
from ..._exceptions import SkipJob


# A queue which pushes staged sources
#
class SourcePullQueue(Queue):

    action_name = "Src-pull"
    complete_name = "Sources pulled"
    resources = [ResourceType.DOWNLOAD, ResourceType.CACHE]

    def get_process_func(self):
        return SourcePullQueue._pull_or_skip

    def status(self, element):
        if element._skip_source_pull():
            return QueueStatus.SKIP

        return QueueStatus.READY

    @staticmethod
    def _pull_or_skip(element):
        if not element._source_pull():
            raise SkipJob(SourcePullQueue.action_name)