xref: /openbmc/openbmc/poky/meta/lib/bblayers/create.py (revision 6aa7eec5) 
1#
2# Copyright OpenEmbedded Contributors
3#
4# SPDX-License-Identifier: GPL-2.0-only
5#
6
7import logging
8import os
9import sys
10import shutil
11
12import bb.utils
13
14from bblayers.common import LayerPlugin
15from bblayers.action import ActionPlugin
16
17logger = logging.getLogger('bitbake-layers')
18
19def plugin_init(plugins):
20    return CreatePlugin()
21
22def read_template(template, template_dir='templates'):
23    lines = str()
24    with open(os.path.join(os.path.dirname(__file__), template_dir, template)) as fd:
25        lines = ''.join(fd.readlines())
26    return lines
27
28class CreatePlugin(LayerPlugin):
29    def do_create_layer(self, args):
30        """Create a basic layer"""
31        layerdir = os.path.abspath(args.layerdir)
32        if os.path.exists(layerdir):
33            sys.stderr.write("Specified layer directory exists\n")
34            return 1
35
36        # create dirs
37        conf = os.path.join(layerdir, 'conf')
38        bb.utils.mkdirhier(conf)
39
40        layername = os.path.basename(os.path.normpath(args.layerdir))
41        layerid = args.layerid if args.layerid is not None else layername
42
43        # Create the README from templates/README
44        readme_template =  read_template('README').format(layername=layername)
45        readme = os.path.join(layerdir, 'README')
46        with open(readme, 'w') as fd:
47            fd.write(readme_template)
48
49        # Copy the MIT license from meta
50        copying = 'COPYING.MIT'
51        dn = os.path.dirname
52        license_src = os.path.join(dn(dn(dn(__file__))), copying)
53        license_dst = os.path.join(layerdir, copying)
54        shutil.copy(license_src, license_dst)
55
56        # Get the compat value for core layer.
57        compat = self.tinfoil.config_data.getVar('LAYERSERIES_CORENAMES') or ""
58
59        # Create the layer.conf from templates/layer.conf
60        layerconf_template = read_template('layer.conf').format(
61                layerid=layerid, priority=args.priority, compat=compat)
62        layerconf = os.path.join(conf, 'layer.conf')
63        with open(layerconf, 'w') as fd:
64            fd.write(layerconf_template)
65
66        # Create the example from templates/example.bb
67        example_template = read_template('example.bb')
68        example = os.path.join(layerdir, 'recipes-' + args.examplerecipe, args.examplerecipe)
69        bb.utils.mkdirhier(example)
70        with open(os.path.join(example, args.examplerecipe + '_%s.bb') % args.version, 'w') as fd:
71            fd.write(example_template)
72
73        if args.add_layer:
74            # Add the layer to bblayers.conf
75            args.layerdir = [layerdir]
76            ActionPlugin.do_add_layer(self, args)
77            logger.plain('Layer added %s' % args.layerdir)
78
79        else:
80            logger.plain('Add your new layer with \'bitbake-layers add-layer %s\'' % args.layerdir)
81
82    def register_commands(self, sp):
83        parser_create_layer = self.add_command(sp, 'create-layer', self.do_create_layer, parserecipes=False)
84        parser_create_layer.add_argument('layerdir', help='Layer directory to create')
85        parser_create_layer.add_argument('--add-layer', '-a', action='store_true', help='Add the layer to bblayers.conf after creation')
86        parser_create_layer.add_argument('--layerid', '-i', help='Layer id to use if different from layername')
87        parser_create_layer.add_argument('--priority', '-p', default=6, help='Priority of recipes in layer')
88        parser_create_layer.add_argument('--example-recipe-name', '-e', dest='examplerecipe', default='example', help='Filename of the example recipe')
89        parser_create_layer.add_argument('--example-recipe-version', '-v', dest='version', default='0.1', help='Version number for the example recipe')
90
91