#
# Copyright (C) 2017 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 .
#
# Authors:
# Tristan Van Berkom
# Jonathan Maw
"""
script - Run scripts to create output
=====================================
This element allows one to run some commands to mutate the
input and create some output.
.. note::
Script elements may only specify build dependencies. See
:ref:`the format documentation ` for more
detail on specifying dependencies.
The default configuration and possible options are as such:
.. literalinclude:: ../../../src/buildstream/plugins/elements/script.yaml
:language: yaml
"""
import buildstream
# Element implementation for the 'script' kind.
class ScriptElement(buildstream.ScriptElement):
# pylint: disable=attribute-defined-outside-init
# This plugin has been modified to avoid the use of Sandbox.get_directory
BST_VIRTUAL_DIRECTORY = True
def configure(self, node):
for n in node.get_sequence('layout', []):
dst = self.node_subst_member(n, 'destination')
elm = self.node_subst_member(n, 'element', None)
self.layout_add(elm, dst)
node.validate_keys([
'commands', 'root-read-only', 'layout'
])
cmds = self.node_subst_list(node, "commands")
self.add_commands("commands", cmds)
self.set_work_dir()
self.set_install_root()
self.set_root_read_only(node.get_bool('root-read-only', default=False))
# Plugin entry point
def setup():
return ScriptElement