Issue-Id: SCM-3042
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I73608f8e64529334fdffe86550995ea1c90c8150

The user should be able to execute the run-checks.py script from any location.
This patch fixes an issue where the relative path to the configuration YAML file
was not being resolved properly.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ia5ede51cf240eddb4fed436ed2ccc69d33b5bd3e

This patch updates the documentation to state that the kas-ci-build.py build
script may be found in the project's tools/build directory, and clarifies that
the YAML files provided to it must be valid and present as kas configuration
files within meta-ewaol-config/kas.

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I9743ab0964b89c55a60793f1996867f6e4e3efed

This patch improves the spelling QA check to make the check less likely to
produce false-positives, and to reduce the maintainence effort on the internal
custom dictionary.

This patch:
* Avoids 'spelling errors' found within ReStructuredText code-blocks or links,
  as these are almost certainly going to be technical words that do not need to
  be validated against standard English spelling. Headers are still checked, so
  internal links are validated at the definition.
* Expand substrings before validation, to allow the custom dictionary to
  contain (and successfully pass) only proper words.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I5303b93293d27c8b04116e19313c60790b5b1710

This patch allows the user to provide a set of commits to the commit message
check, enabling the ability to analyse a patch chain.

To do this, the commit message accepts a 'commits' parameter, which should be
defined in one of the follow two formats:

* '-N' to check the latest N commit messages
* 'commit1(,commit2,...)' as a string list of commits to check. The commits
  must be valid when passed to the 'git show' command, for example a commit SHA
  or a relative commit like HEAD~2.

This patch also excludes lines that are URLs from the message length check, as
URLs are allowed break the maximum character length.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I0a6aa7552206c7e4a963d9ddf0687ff773386957

In order to read the configuration file, the host system must have the pyyaml
Python package. As this is needed prior to any virtual environment set up, this
patch notifies the user if it cannot be found and aborts gracefully.

In addition, wrap the module import to warn if email_validator cannot be found
for the commit message QA-check (this should only happen if not using a virtual
environment).

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ia564ecdd2a26fa499d1a524232882a32883d4279

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I750c07d22e2c3175c6b31358e5176abc38043619

Richard Neill authored Sep 07, 2021 and Diego Sueiro committed Sep 15, 2021

User-provided relative paths are considered relative from the root directory.
This patch allows the user to configure that root directory, so that the checks
may be easily applied to other projects on the file system,

The patch also refactors how keyword values are initialised, making them only
evaluate if they are needed. For example, the contents of the project's
.gitignore will only be read and processed if needed for the check
configuration.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I02a087477942e5b152546b23a01d38f45be004da

Richard Neill authored Sep 07, 2021 and Diego Sueiro committed Sep 15, 2021

This patch adds the --keep_venv option to run-checks.py. If this is not passed,
the temporary venv will be deleted after the script has been executed, to avoid
unexpectedly filling up the user's /tmp directory.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iaf6fcc3329d7608c5bc6b997a1de887638c64b2b

Richard Neill authored Aug 24, 2021 and Diego Sueiro committed Sep 15, 2021

Externally-licensed works may be included and modified within meta-ewaol. This
patch allows these files to pass the license and copyright header QA-check by
validating an additional alternative format:

    Based on: <Original filename>
    In open-source project: <Source project/repository>
    Original file: Copyright (c) YYYY(-YYYY) <Contributor>
    Modifications: Copyright (c) YYYY(-YYYY) <Contributor>
    SPDX-License-Identifier: <License name>

Original works contributed directly to meta-ewaol continue to use the standard
license and copyright header format:

    Copyright (c) YYYY(-YYYY) <Contributor>
    SPDX-License-Identifier: <License name>

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Id1b031f29ddb26b3a910365dab9781bd9bd3c4b1

Kamil Dzieżyk authored Aug 10, 2021 and Diego Sueiro committed Sep 15, 2021

This patch adds 'ewaol-sdk' DISTRO_FEATURE to ease image customization.
It contains set of libraries, headers and packages that are useful during
software development on target board.
'ewaol-sdk' is inherited by default in EWAOL SDK images:
 * ewaol-image-docker-sdk
 * ewaol-image-podman-sdk

ewaol-sdk enables:
 * Packages:
   - gator-daemon
   - kernel-devsrc
   - kernel-modules
 * IMAGE_FEATURES:
   - package-management
   - dev-pkgs
   - tools-debug
   - tools-sdk
   - tools-profile
   - debug-tweaks
   - ssh-server-openssh

Issue-ID: SCM-2394
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I22ea4ead8711671af6d9bc360f45748031720eca

Kamil Dzieżyk authored Aug 11, 2021 and Diego Sueiro committed Sep 15, 2021

Gator recipe source is:
http://git.yoctoproject.org/cgit/cgit.cgi/meta-arm/tree/meta-arm/recipes-devtools/gator-daemon?id=453f4094e16b26494268f801d97eb71110ea3f86



Issue-ID: SCM-2394
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I82163184411085f87a16186f7e53eafb19e79d42

Richard Neill authored Aug 18, 2021 and Diego Sueiro committed Sep 15, 2021

This patch handles the case where a previous test suite may fail in a
hanging state, be user-interrupted and suspended, or orphaned during its
execution, in order to avoid the possibility of running multiple interleaving
test suites on the system which may interfere and cause the tests to fail
unexpectedly with difficult-to-diagnose errors.

To do this, when a test suite execution begins it writes its PGID to a
run-file, and removes this run-file when it ends. Before any execution
begins, the existance of a run-file is checked in order to determine if a
previous execution is running. If it is running, a SIGINT to sent to the
previous execution's PGID, before continuing.

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I44dfeff7c4566e7ce6b0b65c6c71e95238298209

Richard Neill authored Aug 18, 2021 and Diego Sueiro committed Sep 15, 2021

BATS uses file descriptor 3 internally, which is subsequently inherited by its
subprocesses. As BATS blocks until FD3 is closed, and a subprocess may be take
a long time to run (e.g. executing a background daemon/service), this can cause
execution to hang, especially after a user-initiated SIGINT.

This is documented isue with BATS, where more information can be found here:
    https://bats-core.readthedocs.io/en/stable/writing-tests.html



To avoid hanging execution, this patch provides a wrapper around the run
function that discards FD3.

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ic2523240d5db600d4f763390579ea7d7d14fc1a4

Richard Neill authored Aug 13, 2021 and Diego Sueiro committed Sep 15, 2021

This patch adjusts the test logging to:
* Output the location of the log file to the terminal on test failure
* Add a clean-up category to the log messages to clarify which messages relate
  to the tests and which relate to surrounding environment clean-up activities
* Ensure all arguments to the log function are recorded

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I92bc776cb6c9d428ec6bbf2c0cd59aa3803d16ac

Richard Neill authored Aug 06, 2021 and Diego Sueiro committed Sep 15, 2021

Issue-Id: SCM-2365
Issue-Id: SCM-2366
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iae0b03219dcc485741a3c4ceb8f1fbfb5c198889

Richard Neill authored Jul 23, 2021 and Diego Sueiro committed Sep 15, 2021

Issue-Id: SCM-2366
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I3a2ec7494763af822727952a8c575207f47403a7

Richard Neill authored Jul 23, 2021 and Diego Sueiro committed Sep 15, 2021

This patch moves files for a specific runtime integration test suite into a
separate corresponding folder, leaving only common files in a shared folder.
Common recipe code is also moved to an .inc file that can be shared between
multiple integration test suite recipes.

Environment variables that would be used by multiple integration test suites
are made generic (e.g. TEST_LOG_FILE), but are initialised by the prefixed
version for the corresponding suite (e.g. CE_TEST_LOG_FILE).

This patch also adds in-source clarification that test log messages with a
message type of FAIL will implicitly produce an additional DEBUG message that
contains the ${status} and ${output} variables (these are normally defined by
BATS) as well as the latest contents of ${TEST_STDERR_FILE}.

Issue-Id: SCM-2366
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iff27838b9fb835fc4cd0e6c26b255f1f6cef5312

Richard Neill authored Jul 23, 2021 and Diego Sueiro committed Sep 15, 2021

K3S is a lightweight Kubernetes distribution designed for orchestrating
containerised edge workloads.

This patch adds the K3S-server package from meta-virtualization to EWAOL build
targets, and adds a systemd service override to stop K3S orchestration and all
associated containers on device shutdown via a modified version of the
Rancher-provided k3s-killall.sh script.

Also include the xt-statistic kernel module required by K3S for iptables
configuration.

Issue-Id: SCM-2365
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ic649cbe74a3ab56a56ab6c296160d942dd597bab

Richard Neill authored Aug 23, 2021 and Diego Sueiro committed Sep 15, 2021

Rather than each QA-check performing identical work (e.g. recursive descent
into files and sub-directories of a given path, filtering on regex and file
types), provide such functionality as common code that can be shared across
multiple checks.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I3990049ba0d7576ea62e45e09ecbd323aa750879

Richard Neill authored Aug 19, 2021 and Diego Sueiro committed Sep 15, 2021

Exclude .patch and .scc files from the license and copyright header check.

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Idf89078183549e4d6122aa21504516ad4a43caaa

Richard Neill authored Jun 25, 2021 and Diego Sueiro committed Sep 15, 2021

This patch enables:
* Per-check configuration (and global defaults) to be provided via YAML file
* The contents of .gitignore to be easily passed to checks
* Gitstyle pattern matching supplied to checks (e.g. exclude or include files
  matching patterns like "*.log" or "/*artifacts*")
* Checks to define their required variables seemlessly, so that maintaining or
  extending a check module requires no changes to wrapper scripts.
* Fewer hard-coded variables defined in the check sources

This patch also adds in-source descriptions of the wrapper script and each
QA-check, fixes relative path handling, logging formatting inconsistencies, and
updates the checker outputs to record the number of files checked (to avoid
silently excluding all files with an unintentionally excessive pattern).

Issue-Id: SCM-3033
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ib64fab9c1eee954febc7e5bf6e7a6b8ee26dab57

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I569e5ed1d3dffa482b167a3b6c6aaa3cb4aa228f

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I4237b8ab0c663b4e6ff1259769cd5d79f1ce6ce0

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I8151300dcd6ecd26211b6ed41fe5cf07938b9757

For now we will be only building and deploying the documentation for the
v0.1.1 release.

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I2a3f3985edff778ce0d6182fd1e57b1ade2e5070

Add the list of the dependant layers per repository.

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: Ic79ce1be18e384b7cb7b4b578598ceac7a8cabf0

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I977ab8485eb377630e9f5741f30f55a7be864300

Also, put the Documentation section on top and update the mentioned release tag.

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I0a7d32e4ca2c593671b1873968654e577fe8e6b3

Also, update the instructions to the v0.1.1 tag.

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I47b77e779a495ee23e837895573b7a19ee26f5be

Also fix misspelling and URL to meta-arm-bsp documentation.

Issue-Id: SCM-3318
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I46b871bc7c0066dc24141a5b34036b4fac58e944

The script's --kas-command option was expanded to the --kas-arguments option.
This patch updates the documentation to reflect this.

Issue-Id: SCM-3318
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I7c14b7c0c24642105b261427c41d6ba1742adc23

Issue-Id: SCM-3318
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I28fd41a1eb6ef691139f2dc7e60d83b6b5d37e22

Issue-Id: SCM-3318
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I9ce5505152ebef46dd031da44fecf2672bc52af7

This patch clarifies that the kas build tool and provided kas configuration YAML
files are the recommended approach to building EWAOL images, but adds additional
documentation to briefly describe the necessary steps for preparing and building
an image without kas.

Issue-Id: SCM-3318
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I2ca57786ad3b2ddbab6e9450a1477f31315a2cba

Richard Neill authored Jul 13, 2021 and Richard Neill committed Jul 13, 2021

Issue-Id: SCM-3042
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I0e03ffb12601aad6bc51b42198f833cb7fb94312

Issue-Id: SCM-2777
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I558bb03ca1fb2f240595d3c704b2157bceacecdb

Users should be downloading the FVP_Base_RevC-2xAEMvA_11.14_21.tgz package from
Arm's website.

Issue-Id: SCM-2575
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: Ide0641106fc9bd0074c2979ab263719d85fe0172

Issue-Id: SCM-2575
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I6a23a58ffa835464ea967c993205bbfe32ee06ce

Issue-Id: SCM-2575
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I593655c6355327a3d3b8682620f2fbfe87274c0f