Files
poky/meta/lib/oeqa/core
Martin Jansa 7eef95d723 oeqa: loader.py: show warning when skipping selected module and abort if all are skipped
* skipped modules were triggering an ERROR before:

  poky $ oe-selftest -v -r eSDK.oeSDKExtSelfTest.test_install_libraries_headers imagefeatures.ImageFeatures.test_image_gen_debugfs -K -B /OE/build/poky/build-eSDK
  2023-03-13 15:07:53,430 - oe-selftest - ERROR - Not found eSDK.oeSDKExtSelfTest.test_install_libraries_headers in loaded test cases

* but didn't show the reason why it wasn't loaded and more importantly -r
  was ignored when all selected modules were silently skipped

* add a warning when skipping some module and abort if some modules were
  selected, but all ended being skipped:

  poky $ oe-selftest -v -r eSDK.oeSDKExtSelfTest.test_install_libraries_headers -K -B /OE/build/poky/build-eSDK
  2023-03-13 15:11:51,028 - oe-selftest - WARNING - module 'eSDK.oeSDKExtSelfTest.test_install_libraries_headers' was skipped from selected modules, because it doesn't match with module name assumptions: package and module names do not contain upper case characters, whereas class names do
  2023-03-13 15:11:51,028 - oe-selftest - ERROR - All selected modules were skipped, this would trigger selftest with all tests and -r ignored.

* I was hit by this in oe-selftest -r eSDK.oeSDKExtSelfTest.test_install_libraries_headers
  which is skipped due to upper case characters in module name and selftest started to run
  all tests (archiver.Archiver.test_archiver_allows_to_filter_on_recipe_name as first from 529)

  poky $ oe-selftest -v -r eSDK.oeSDKExtSelfTest.test_install_libraries_headers -K -B /OE/build/poky/build-eSDK
  2023-03-13 14:00:52,955 - oe-selftest - DEBUG - Selected tests with -r: ['eSDK.oeSDKExtSelfTest.test_install_libraries_headers']
  2023-03-13 14:00:55,531 - oe-selftest - INFO - Changing cwd to /OE/build/poky/build
  ..
  2023-03-13 14:00:58,128 - oe-selftest - INFO - test_archiver_allows_to_filter_on_recipe_name (archiver.Archiver.test_archiver_allows_to_filter_on_recipe_name)

  I'll rename eSDK to esdk in next commit to avoid this.

* also fix small typo in context I've noticed when debugging this

(From OE-Core rev: 15229c9abaf4cc398c31d97d171b9fac57141873)

Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-22 13:53:29 +00:00
..
2023-02-23 12:11:29 +00:00
2017-01-23 12:05:18 +00:00

= 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