Go to file
Claudius Heine 75fa095aa5 config: Added schema validation for configuration files
Currently many of the error messages regarding the configuration file
are not really helpful.

To improve reporting this patch adds validation of the configuration
files using the jsonschema module.

Example:

  Forgetting ':' at the end of a layer definition, like this:

    repos:
      meta-iot2000:
        layers:
          meta-iot2000-example
                              ^

  Exception before:

    TypeError: string indices must be integers

  Exception after:

    Validation Error:
     'meta-iot2000-example' is not of type 'object'

     Failed validating 'type' in schema['properties']['repos']['additionalProperties']['properties']['layers']:
         {'additionalProperties': {'oneOf': [{'type': 'null'},
                                             {'type': 'integer'},
                                             {'type': 'boolean'},
                                             {'type': 'string'}]},
          'type': 'object'}

     On instance['repos']['meta-iot2000']['layers']:
         'meta-iot2000-example'

This patch adds 'jsonschema' as an additional dependency.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-10-13 14:11:10 +02:00
docs config: Added schema validation for configuration files 2017-10-13 14:11:10 +02:00
kas config: Added schema validation for configuration files 2017-10-13 14:11:10 +02:00
scripts Added initial sphinx documentation 2017-06-28 15:12:15 +02:00
tests config: Added schema validation for configuration files 2017-10-13 14:11:10 +02:00
.dockerignore add dockerignore 2017-06-26 09:29:07 +02:00
.gitignore Expanded and documented .gitignore 2017-06-28 15:12:15 +02:00
.pylintrc Fixed issues that occured with pylint 1.7.2 2017-06-28 15:10:14 +02:00
.travis.yml travis: Push next builds under separate tag 2017-07-12 10:22:15 +02:00
CHANGELOG.md Release 0.13.0 2017-10-10 09:13:50 +02:00
CONTRIBUTING.md Initial public release 2017-06-14 15:21:19 +02:00
docker-entrypoint docker: Allow to call with USER_ID=0 2017-07-21 15:35:05 +02:00
Dockerfile Dockerfile: added less and vim 2017-08-01 09:35:17 +02:00
Dockerfile.isar docker: Add binfmt-support for Isar cross-building 2017-09-06 17:25:41 +02:00
LICENSE Initial public release 2017-06-14 15:21:19 +02:00
README.rst README: Convert to structured text 2017-07-20 15:29:12 +02:00
requirements_rtd.txt Made project buildable with rtd 2017-06-28 15:12:15 +02:00
run-kas Initial public release 2017-06-14 15:21:19 +02:00
setup.py config: Added schema validation for configuration files 2017-10-13 14:11:10 +02:00

Setup tool for bitbake based projects
=====================================

+------------+------------------+
|   Branch   |   Build Status   |
+============+==================+
| ``master`` | |travis-master|_ |
+------------+------------------+
| ``next``   | |travis-next|_   |
+------------+------------------+

.. |travis-master| image:: https://travis-ci.org/siemens/kas.svg?branch=master
.. _travis-master: https://travis-ci.org/siemens/kas/branches
.. |travis-next| image:: https://travis-ci.org/siemens/kas.svg?branch=next
.. _travis-next: https://travis-ci.org/siemens/kas/branches

This tool provides an easy mechanism to setup bitbake based
projects.

The OpenEmbedded tooling support starts at step 2 with bitbake. The
downloading of sources and then configuration has to be done by
hand. Usually, this is explained in a README. Instead kas is using a
project configuration file and does the download and configuration
phase.

Key features provided by the build tool:

- clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process

See the `kas documentation <https://kas.readthedocs.io>`_ for further details.