poky/core at 8cee6d31bbc7ae2341074471cd36b87bb3748cfe - poky

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

History

Richard Purdie 8cee6d31bb oeqa/concurrencytest: Avoid unclosed file warnings Avoid an unclosed file per thread warning when running selftests concurrently by closing the result stream. (From OE-Core rev: 33a4a076e8aa72a872807332501e7f5ae1cee0e2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>		2018-11-16 11:46:07 +00:00
..
cases	oeqa/core/cases: Add example test cases	2017-01-23 12:05:18 +00:00
decorator	oeqa/core/decorator: add skipIfInDataVar	2018-08-23 18:02:23 +01:00
target	oeqa/core/target/ssh.py: increase maximum read bytes from 1024 to 4096	2018-06-04 15:15:00 +01:00
tests	oeqa/runner: Simplify code	2018-07-18 10:18:41 +01:00
utils	oeqa/concurrencytest: Avoid unclosed file warnings	2018-11-16 11:46:07 +00:00
__init__.py	oeqa/core: Add base OEQA framework	2017-01-23 12:05:18 +00:00
case.py	oeqa/core/case: fix typo on comment about exception name	2017-06-02 13:36:14 +01:00
context.py	oeqa/context: Only set buffer mode for non-concurrent tests	2018-08-23 07:50:00 +01:00
exception.py	oeqa/{core,selftest}: Add support to validate if a specified test case isn't found	2017-07-30 08:46:19 +01:00
loader.py	oeqa/loader: Fix deprecation warning	2018-11-14 11:14:40 +00:00
README	oeqa/core: Improve grammar in README and loader comments	2017-06-05 09:19:51 +01:00
runner.py	oeqa/core/runner: Correctly markup regexs	2018-11-14 11:14:40 +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