From c328cee2218187a390900fa6896eaa54bb9acf62 Mon Sep 17 00:00:00 2001 From: Josef Holzmayr Date: Tue, 4 Feb 2025 00:35:17 +0000 Subject: [PATCH] add meta-mender-validation meta-mender-validation holds the recipe for the bootloader integration script and more in the future. Changelog: Title Ticket: None Signed-off-by: Josef Holzmayr --- kas/include/mender-base.yml | 2 +- kas/include/validation.yml | 14 ++ meta-mender-validation/LICENSE | 202 ++++++++++++++++++ meta-mender-validation/README | 45 ++++ meta-mender-validation/conf/layer.conf | 13 ++ .../bootloader-validation_0.1.bb | 34 +++ 6 files changed, 309 insertions(+), 1 deletion(-) create mode 100644 kas/include/validation.yml create mode 100644 meta-mender-validation/LICENSE create mode 100644 meta-mender-validation/README create mode 100644 meta-mender-validation/conf/layer.conf create mode 100644 meta-mender-validation/recipes-mender/bootloader-validation/bootloader-validation_0.1.bb diff --git a/kas/include/mender-base.yml b/kas/include/mender-base.yml index 646f7a514..fbac40350 100644 --- a/kas/include/mender-base.yml +++ b/kas/include/mender-base.yml @@ -20,7 +20,7 @@ repos: meta-mender: url: https://github.com/mendersoftware/meta-mender.git - commit: 9efa9409684e303472ed9dae749ab663909eb689 + commit: a52f158b033c709df824c7e66a577c41f432ae7f layers: meta-mender-core: diff --git a/kas/include/validation.yml b/kas/include/validation.yml new file mode 100644 index 000000000..59034c691 --- /dev/null +++ b/kas/include/validation.yml @@ -0,0 +1,14 @@ +header: + version: 14 + +repos: + meta-mender-community: + layers: + meta-mender-validation: + +local_conf_header: + validation: | + IMAGE_INSTALL:append = " bootloader-validation " + MENDER_FEATURES_ENABLE:append = " mender-prepopulate-inactive-partition " + MENDER_FEATURES_DISABLE:append = " mender-growfs-data " + EXTRA_IMAGE_FEATURES:append = " allow-empty-password empty-root-password allow-root-login " diff --git a/meta-mender-validation/LICENSE b/meta-mender-validation/LICENSE new file mode 100644 index 000000000..57bc88a15 --- /dev/null +++ b/meta-mender-validation/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/meta-mender-validation/README b/meta-mender-validation/README new file mode 100644 index 000000000..ee5e70692 --- /dev/null +++ b/meta-mender-validation/README @@ -0,0 +1,45 @@ +This README file contains information on the contents of the meta-mender-validation layer. + +Please see the corresponding sections below for details. + +Dependencies +============ + + URI: https://git.yoctoproject.org/poky + branch: kirkstone + + URI: https://github.com/mendersoftware/meta-mender + branch: kirkstone + +Contributions +============= + +Please the README file in the top level directory. + +Table of Contents +================= + + I. Adding the meta-mender-validation layer to your build + II. Misc + + +I. Adding the meta-mender-validation layer to your build +================================================= + +Run 'bitbake-layers add-layer meta-mender-validation' + +II. Misc +======== + +This layer contains various means of validating a Mender integration on +a given device. + +- bootloader-validation: this script implements an automated run of the + integration checklist as documented at https://docs.mender.io/client-installation/integration-checklist. + It installs a systemd service to run the script at startup, which requires + a number of reboots to check the various bootloader integration facets. + Make sure the following preconditions are met: + 1. `INIT_MANAGER = "systemd"` + 2. `MENDER_FEATURES_ENABLE:append = "mender-prepopulate-inactive-partition"` + After completion, the systemd service is automatically disabled and the + result can be found in the `/data/validation.log` file. diff --git a/meta-mender-validation/conf/layer.conf b/meta-mender-validation/conf/layer.conf new file mode 100644 index 000000000..87bbd9d43 --- /dev/null +++ b/meta-mender-validation/conf/layer.conf @@ -0,0 +1,13 @@ +# We have a conf and classes directory, add to BBPATH +BBPATH .= ":${LAYERDIR}" + +# We have recipes-* directories, add to BBFILES +BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ + ${LAYERDIR}/recipes-*/*/*.bbappend" + +BBFILE_COLLECTIONS += "meta-mender-validation" +BBFILE_PATTERN_meta-mender-validation = "^${LAYERDIR}/" +BBFILE_PRIORITY_meta-mender-validation = "6" + +LAYERDEPENDS_meta-mender-validation = "core" +LAYERSERIES_COMPAT_meta-mender-validation = "kirkstone" diff --git a/meta-mender-validation/recipes-mender/bootloader-validation/bootloader-validation_0.1.bb b/meta-mender-validation/recipes-mender/bootloader-validation/bootloader-validation_0.1.bb new file mode 100644 index 000000000..51e8528c6 --- /dev/null +++ b/meta-mender-validation/recipes-mender/bootloader-validation/bootloader-validation_0.1.bb @@ -0,0 +1,34 @@ +SUMMARY = "Mender bootloader validation" +DESCRIPTION = "Automated validation of the Mender bootloader integration" +LICENSE = "Apache-2.0" +LIC_FILES_CHKSUM = "file://LICENSE;md5=86d3f3a95c324c9479bd8986968f4327" + +SRC_URI = "git://github.com/theyoctojester/mender-validation.git;protocol=https;branch=main" +SRCREV = "45033cda680a586d75bb07e0edec81cb92e5e4c9" + +do_configure[noexec] = "1" +do_compile[noexec] = "1" + +# per developer definition, the validation scripts are allowed to use the full +# python3 standard library unconditionally. This RDEPENDS reflects this to not +# break upon future extensions. +RDEPENDS:${PN} = "python3" + +inherit systemd +SYSTEMD_SERVICE:${PN} = "mender-bootloader-validation.service" + +S = "${WORKDIR}/git" + +do_install() { + if ${@bb.utils.contains('MENDER_FEATURES', 'mender-prepopulate-inactive-partition', 'false', 'true', d)}; then + bbwarn "MENDER_FEATURES does not contain 'mender-prepopulate-inactive-partition', validation suite will probably not be functional." + fi + + install -d ${D}${datadir}/mender-validation + install -m 0755 ${S}/mender-bootloader-validation.py ${D}${datadir}/mender-validation/mender-bootloader-validation.py + + install -d ${D}/${systemd_unitdir}/system + install -m 0644 ${S}/support/mender-bootloader-validation.service ${D}/${systemd_unitdir}/system +} + +FILES:${PN} += "${datadir}/mender-validation/mender-bootloader-validation.py"