poky/core at 2768d6f6768c0792fa5347bf12b4a5088b3a6530 - poky

mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00

History

Ross Burton 6091ebc9c5 oeqa/core/case: add file exists assertion Add assertFileExists() to simply tests that want to check that a file exists. (From OE-Core rev: b62e53a0cff2522fef3b89de875c9526a626d7dd) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>		2025-06-23 21:42:54 +01:00
..
cases	meta/lib+scripts: Convert to SPDX license headers	2019-05-09 16:31:55 +01:00
decorator	oeqa decorator/data.py: add skipIfNotBuildArch decorator	2025-06-05 11:02:22 +01:00
target	oeqa/ssh: Improve performance and log sizes	2024-11-21 12:16:28 +00:00
tests	oeqa/core: remove duplicate 'os' import	2024-06-06 11:56:04 +01:00
utils	oeqa/concurrencytest: Remove invalid buffering option	2023-10-05 21:09:10 +01:00
__init__.py	oeqa/core: Add base OEQA framework	2017-01-23 12:05:18 +00:00
case.py	oeqa/core/case: add file exists assertion	2025-06-23 21:42:54 +01:00
context.py	oeqa: loader.py: show warning when skipping selected module and abort if all are skipped	2023-03-22 13:53:29 +00:00
exception.py	meta/lib+scripts: Convert to SPDX license headers	2019-05-09 16:31:55 +01:00
loader.py	oeqa/loader: Ensure module names don't contain uppercase characters	2023-03-31 23:30:36 +01:00
README	oeqa/core: Improve grammar in README and loader comments	2017-06-05 09:19:51 +01:00
runner.py	resulttool: Use single space indentation in json output	2024-11-23 14:44:54 +00:00

README

= OEQA (v2) Framework =

== Introduction ==

This is version 2 of the OEQA framework. Base clases are located in the 'oeqa/core' directory and subsequent components must extend from these.

The main design consideration was to implement the needed functionality on top of the Python unittest framework. To achieve this goal, the following modules are used:

* oeqa/core/runner.py: Provides OETestResult and OETestRunner base
  classes extending the unittest class. These classes support exporting
  results to different formats; currently RAW and XML support exist.

* oeqa/core/loader.py: Provides OETestLoader extending the unittest class.
  It also features a unified implementation of decorator support and
  filtering test cases.

* oeqa/core/case.py: Provides OETestCase base class extending
  unittest.TestCase and provides access to the Test data (td), Test context
  and Logger functionality.

* oeqa/core/decorator: Provides OETestDecorator, a new class to implement
  decorators for Test cases.

* oeqa/core/context: Provides OETestContext, a high-level API for
  loadTests and runTests of certain Test component and
  OETestContextExecutor a base class to enable oe-test to discover/use
  the Test component.

Also, a new 'oe-test' runner is located under 'scripts', allowing scans for components that supports OETestContextExecutor (see below).

== Terminology ==

* Test component: The area of testing in the Project, for example: runtime, SDK, eSDK, selftest.

* Test data: Data associated with the Test component. Currently we use bitbake datastore as
  a Test data input.

* Test context: A context of what tests needs to be run and how to do it; this additionally
  provides access to the Test data and could have custom methods and/or attrs.

== oe-test ==

The new tool, oe-test, has the ability to scan the code base for test components and provide a unified way to run test cases. Internally it scans folders inside oeqa module in order to find specific classes that implement a test component.

== Usage ==

Executing the example test component

$ source oe-init-build-env
$ oe-test core

Getting help

$ oe-test -h

== Creating new Test Component ==

Adding a new test component the developer needs to extend OETestContext/OETestContextExecutor (from context.py) and OETestCase (from case.py)

== Selftesting the framework ==

Run all tests:

$ PATH=$PATH:../../ python3 -m unittest discover -s tests

Run some test:

$ cd tests/
$ ./test_data.py