Richard Purdie 17e8751037 oeqa/ssh: Avoid unicode decode exceptions 5 years ago
..
cases 115f80adf1 oeqa/core/cases: Add example test cases 7 years ago
decorator 10b935c713 oeqa/core/decorator: add skipIfInDataVar 5 years ago
target 17e8751037 oeqa/ssh: Avoid unicode decode exceptions 5 years ago
tests b618261811 oeqa/runner: Simplify code 5 years ago
utils 56d2493a9a oeqa/concurrencytest: fix for locating meta-selftest 5 years ago
README 48cd7ff7ae oeqa/core: Improve grammar in README and loader comments 7 years ago
__init__.py c466086ccc oeqa/core: Add base OEQA framework 7 years ago
case.py 943a2a30e8 oeqa/core/case: fix typo on comment about exception name 7 years ago
context.py e2c66aa0f7 oeqa/context: Only set buffer mode for non-concurrent tests 5 years ago
exception.py e50b415aaa oeqa/{core,selftest}: Add support to validate if a specified test case isn't found 6 years ago
loader.py d2deb66830 oeqa/loader: Fix deprecation warning 5 years ago
runner.py fd0048630e oeqa/core/runner: dump stdout and stderr of each test case 5 years ago

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