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