QA/Master Test Plan

From Yocto Project
Jump to navigationJump to search

Reversion history

Version Modifier Comments
1.0 Jose Perez Carranza first draft


Introduction

The Yocto Project is an open source collaboration project that provides templates, tools and methods to help you create custom Linux-based systems for embedded products regardless of the hardware architecture. The QA team is in charge to validate some of the tools and components available as well as the images integrity and functionality across different platforms supported. In below sections more detailed information will be provided.

Objectives and Tasks

The test process is mainly focused to track and review the quality and performance of the Yocto Project, along with its reference system and internal projects. The plan also includes identifying and tracking areas subject to improvement, regression, validation of enhancements and bugs, development of testing methods with emphasis on automated testing. Documentation and licensing status is not included in the scope of the testing process, unless otherwise noted e.g. as part of the process of verifying new features.


Objectives

The Overall testing plan during Yocto Project 2.1 cycle aims to validate the overall enhancements that are currently in development for Yocto Project 2.1 as well as detecting regressions that might appear along.

  • Bug and feature verification
  • Running regression tests
  • Perform exploratory testing on required areas (e.g. Toaster)
  • Improve and extend overall automation

Tasks

Here is a list with all tasks identified by this testing plan.

  • General component testing
  • Bug and Feature reporting
  • Bug and Feature verification
  • Test automation
  • Exploratory testing
  • Creating testing plans for required areas
  • Review testing approaches with development peers
  • Assign QA owners on major features


Scope

This article contains an overview of the testing process, such as testing areas, types, cycles and reports, along with a summary and objective for each of the conducted validation activities. Further on, sections may be linked to other articles that contain further details or information related to them. Note that the information provided in this article, or articles linked here, is subject to changes when needed as to reflect the actual activities held for the current version of the Yocto Project.

Testing Strategy

Test Areas

Each internal project under Yocto Project, is an area subject to a testing process. Areas are grouped by the nature of their functionality, as follows:


Build System

The build engine and the surrounding components, that provide the means to build an image or bake a bit of software. In this area the build-time tests are executed. Currently, oe-selftest covers all #Bitbake, oe-core and #Metadata autoamted tests.

BitBake

Functional testing of BitBake, as a build engine with all its features and components against various configuration and scenarios.


Toaster

Toaster is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project. This project was formely known as Web Hob / Webhob / webhob, and you may still find references to the old name in the documentation. The Toaster testing plan wiki covers all the validation performed against Toaster. The test process focuses mostly on validating the data collected from the build process and verifying the correct functionality of the Toaster GUI such as:

  • UI interface
  • Backend interaction with bitbake for build purposes
  • Backend interaction with database for storing and accessing build informations
  • The testing objective involves only positive testing for existing features on Toaster.
  • Perform exploratory testing focusing on newer features; this can sometimes generate new test cases.


Metadata

Testing the core metadata of the Yocto Project is mainly covered in the overall testing process, through other #Test Areas like #BitBake and #Toaster mentioned above. We also have specific tests covering meta-yocto in the meta-yocto test run template, which we are running regularly at Full Pass:


Distro Testing

Distro Testing is intended to catch bugs that are distribution specific using the yocto-autobuilder. The tests are all run on identical hardware and with all OS-es updated. The distributions used are Fedora, Ubuntu, CentOS, OpenSuse with their latest update. If for a distribution, a beta version is available during the release, the n+1 (beta version) will be validated as well.
Refer to Distribution Support wiki for more details.

[TBD] - distribution support wiki needs to be updated

Our Distro config can be found here on contrib: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder/log/?h=contrib/QAsetup/ABubuntu

Runtime testing

Area focused on a target operating system or an application that comes with it, as the output of a build process. In this area the run-time tests are executed.

For test coverage, we are running the automated tests using Image tests.

Release CPU Class HW Platform BSP Name linux-yocto Image-type WR FP Compliance pTest
generic BSPs (x86) Big Core MinwMax 32bit genericx86 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk Y
genericx86-wic 4.x core-image-sato Y
4,x-ltsi core-image-lsb-sdk
MinwMax 64bit genericx86-64 4.x core-image-sato-sdk Y
4,x-ltsi core-image-lsb-sdk
genericx86-64-wic 4.x core-image-sato Y
4,x-ltsi core-image-lsb-sdk
NUC genericx86-64 4.x core-image-sato-sdk Y Y Y
4,x-ltsi core-image-lsb-sdk Y Y
genericx86-64-wic 4.x core-image-sato Y
4,x-ltsi core-image-lsb-sdk
VM QEMU qemux86 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
qemux86-64 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
generic BSPs (n-x86) MIPS EdgeRouter EdgeRouter 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
PPC MPC8315e-rdb MPC8315e-rdb 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
PPC P1022ds P1022ds 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
ARM Beaglebone Black beaglebone 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk Y
VM QEMU qemuarm 4.x core-image-sato-sdk Y
4,x-ltsi core-image-lsb-sdk
qemuarm64 4.x core-image-sato-sdk Y Y
4,x-ltsi core-image-lsb-sdk
qemuppc 4.x core-image-sato-sdk Y
4,x-ltsi core-image-lsb-sdk
qemumips 4.x core-image-sato-sdk Y
4,x-ltsi core-image-lsb-sdk
qemumips64 4.x core-image-sato-sdk Y
4,x-ltsi core-image-lsb-sdk


Sanity Testing

BSP Sanity testing is performed by the public AutoBuilder, where all the BSP artifacts are built and checked if they are built correctly. On public AutoBuilder, Image tests is being run also on the QEMU images as well.

Weekly Testing

Consists in running all automated BSP tests, whihc are targeted to run on a weekly basis against the weekly build. Enabling and running the tests is described on the Image tests wiki page. The tests are available for QEMU BSPs and as well BSPs installed on real Hardware. For Coverage, please check #Runtime testing WR column


Full Pass

The full pass testing aims to run the BSP test cases which are not automated. They extend what is covered by #Weekly Testing by containing more complex scenarios like changing runlevels, or audio tests. for reference, please check #Runtime testing FP column.

Stress Testing

Stress tests are run on Beagleboard and genericx86-64 BSPs. Details as follow:

  • Beaglebone core-image-sato-sdk image is tested using LTP and Crashme stress tests
  • genericx86-64 core-image-lsb-sdk image is tested using Helltest and Crashme stress tests

The Runtime test plan Template is available in Runtime Bugzilla product: 

* Runtime Full Pass


System Performance (not implemented)

  • Objective
    • Track the run-time performance of targeted systems;
    • Track the run-time performance of targeted systems with gcc security flags;
  • Indicators
    • Boot time for systemd and sysvinit;
    • Image size from Buildhistory to track regression;
    • Piglit test suite results;
    • Other benchmarks that can be integrated, such as the ones listed in the openbenchmarking site.

Developer Tools

Application Development Toolkit

ADT testing includes tests for meta-toolchain-sdk and user build sdk. It will be covered in Weekly and Fullpass testing.

  • Cross-toolchain install&compiling Test
  • relocatable SDK
  • extensible SDK (eSDK)
  • toolchain tarballs
  • yocto build tree

The Testopia templates are as following: 

* ADT Full Pass
* ADT Weekly

Eclipse IDE Plugin

Eclipse plugin tests will cover the basic functionalities. This includes installation, configuring Yocto Project ADT settings, Yocto BSP, Bitbake project and project compiling and deployment to the target. Based on the features that will be implemented, new test cases will be added, to support Windows and Mac support. This will be more detailed in the Features section.

  • headless build
  • C/C++ project creation
  • debug/deploy
  • user space tools
  • Bitbake project

Depending on the new SDK features (e.g. MacOS and Windows support), additional tests will be run in order to validate the new features.

Currently, Eclipse plugin Testopia templates are available here: 

* Eclipse Full Pass
* Exploratory New Test Cases

For eclipse test automation, refer to #Eclipse Testing Framework section.

Build Appliance

The basic functionality of the Build appliance will be tested. The tests consists on building successfully a build-appliance-image, launch HOB. Here is the Build Appliance Testopia Template: 

* Build Appliance Template

Testing tools

Autobuilder

More information can be found in the AutoBuilder wiki.

oe-selftest

Oe-selftest is a test framework used for testing the OpenEmbedded build system. Following are some key points in describing oe-selftest:

  • based on Python unittest
  • designed to simulate normal usage patterns
  • does not cover image run-time testing
  • implements a new layer that contains generic/specific metadata used only by tests

Details regarding oe-selftest implementation and usage are available on Oe-selftest wiki.

Image tests

Compliance Testing

Compliance test suites / frameworks used on genericx86-64:

  • LSB tests
  • POSIX tests
  • LTP tests

Install steps:

  1. Download lsb image from autobuilder( same image as in LSB weekly testing for genericx86-64-lsb bsp)
    • we test compliance on NUC with genericx86-64-lsb, core-image-lsb-sdk
  2. Install the image on DUT
  3. Configure the network so it be able to work externally:
    • edit /etc/resolv.conf and add the gateway ip_address
    • add the ip and netmask using "ifconfig" command
    • add the route using "route add default gw <ip_address>"
    • export the proxy using "export http_proxy=<add your proxy link>" command
    there is a bug and if you make these steps in another order than above, it may be possible not work
  4. Copy "compliance_test.py" script on DUT
  5. Make sure that your network connection is working
  6. Run the script like this:
    • make the script executable: "chmod a+x compliance_local.py"
    • run in command line the following command "./compliance_test.py <milestone> <date>"
    • wait until "Configuration done. LSB script must be started from machine." in command line( about 8-12 hours)
  7. Run "LSB_test.sh" via ssh or manually and wait for it to finish( about a day)
  8. Get the logs from DUT:
    • result-<milestone>-data.fulllog
    • result-<milestone>-data.log
    • result-<milestone>-data.fail
    • posix.log (can be found in: /opt/ltp/testcases/open_posix_testsuite)
      • the three others are found in /opt/ltp directory, in output, temp, result folders . The logs need to be sent to yi.zhao@windriver.com specifying the version and the type of image
    • in /var/opt/lsb/test/manager/results/x86.../x86....tar.gz (you can find it with auto-complete(tab) easily)
  9. Put the tests from Testopia - Runtime test run on passed


The scripts can be found here: http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=cagurida/compliance

pTest

Ptest (package test) is a concept for building, installing and running the test suites that the packages include for and by themselves, while producing a consistent test execution output format. More details on enabling and installing pTest are available on Ptest.

Install an run steps:

  1. Download pTest image from autobuilder( you can find core-image-sato-sdk image in pTest directory)
  2. Install the image on DUT (using legacy boot)
  3. Boot the image and copy "ptest-runner.sh" script on DUT
  4. In command line run "ptest-runner.sh > ptest.log" and wait for it to finish ( about 5 hours)

Eclipse Testing Framework

Eclipse Testing Framework uses Dogtail for test automation. Refer to eclipse-framework README on contrib for installation and framework details. Dogtail is a GUI test tool and automation framework written in Python. It uses Accessibility (a11y) technologies to communicate with desktop applications. dogtail scripts are written in Python and executed like any other Python program.

Build Performance test

The performance of the build system is tracked, with regards to time spent on passing through a build process, in multiple, commonly used, configurations.

The tool used: http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/scripts/contrib/build-perf-test.sh
For more details, refer to Performance Test wiki.
Currently, build performance results can be viewed here as chart view (starting YP 1.6) here

Automatic testing of incoming patches

[TBD] - Not covered yet

Test Cycle

  • Execution according to Yocto 2.1 Schedule. The first section of the table, "Build Type", details what type of tests are performed on Weekly, Release Candidate or Release test.
  • List of all Test Cases, included in a cycle or not.


Test execution cycle
#Sanity Test #Weekly Test #Full Pass Test (Release)
Build type Daily (M.U.T.) yes
Weekly yes yes
Release Candidate yes yes yes
Release yes yes yes
#Test Areas #Build System (oe-selftest) yes yes yes
#BitBake yes
#Toaster yes yes yes
#Metadata yes
#Runtime testing yes yes yes
#Application Development Toolkit yes yes
#Eclipse IDE Plugin yes
#Build Appliance yes
Distro Testing yes yes yes
Target machine generic BSPs (x86) yes yes yes
generic BSPs (non x86) yes yes yes
VM (x86 and non-x86) yes yes yes
Target image core-image-sato yes
core-image-sato-dev yes
core-image-sato-sdk yes yes yes
core-image-lsb-sdk yes yes
core-image-minimal yes
core-image-minimal-dev yes


Sanity Test

Brief and quick automated tests, with execution time of maximum 10 minutes.

  • Objective
    • Build finished with no errors;
    • Check basic QEMU image functionality, e.g. boot, network, package manager, etc.;
    • Establish if testing cycle can continue, depending on the build type.
    • The tests run on AB are the Image tests. Their configurations are stored in the AB config files "yocto-autobuilder/buildset-config" depending on the target image types.

Weekly Test

  • Scope
    • Images built weekly and released through the distribution team.
    • Passed #Sanity Test
  • Objective
    • Functionality test on most areas with minimum sets of tests;
    • Regression test with high probability to find bugs.

Full Pass Test

  • Scope
    • Images built as candidates for milestone or final release;
    • Passed #Weekly Test
  • Objective
    • Ensure functionality of all Yocto Project components.

Release Test

  • Objective
    • All scheduled features are covered, or rescheduled;
    • All relevant bugs are fixed and verified.
  • Coverage
    • Stress test on RC
    • Compliance test on RC
    • Distribution test on RC

Test Automation

  • Objectives
    • Reduce effort with manual testing, by automating current tests;
    • Improve run-time testing.
    • Improve build-time testing.


Test Automation contrib repositories

Validation

  • Objective
    • Verify the correct functionality of new changes introduced in current version of the Yocto Project.
  • Entry criteria
    • The change is tracked by filling in the "QA Owner" field for the Medium+/High enhancements
    • The change is prioritized in Bugzilla
    • Bugzilla entry has a target milestone within the current version
    • The change is documented or pointed out when no documentation is necessary (the doc flag is set accordingly)
    • Bug status is set to RESOLVED.
  • Exit criteria
    • The change is well documented for writing test case, where applicable
    • Planned test case has passed
    • Bug status is set to VERIFIED

Test Reporting

Retrieved from "https://wiki.yoctoproject.org/wiki/index.php?title=QA/Master_Test_Plan&oldid=18744"