Toaster testing plan

Category:Toaster
This article is the test plan for Toaster.
= About Toaster =
Toaster is a web interface to the Yocto Project’s OpenEmbedded build system that allows a user to run and build his own builds. The information is collected and stored in a database, so Toaster provides information and statistics about the build process. Toaster can be used to configure and start builds on multiple remote build servers.
Currently positive testing is being executed for existing features.
Tasks:
*Validating the current build (running regression test)
*Bug & Feature verification
*Exploratory on existing functionalities
= Objectives =
Verify all Toaster components to be fully functional.
 
Components to be verified:
* UI interface
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.
Verifying the bugs and features.
=LEGACY= Starting with 2.1 M3, the following will no longer be tested by the QA team. The dev team will be taking over responsibility for these components:
* Backend interaction with bitbake for build purposes
* Backend interaction with database for storing and accessing build information
= Team members =
==QA Team involved in Toaster testing==
 Mihail, Stanciu
 Agurida, Cristina 
 Georgescu, Alexandru
= Scope =
Testing scope has been agreed upon as local installation only, using sqlite database on Fedora and Ubuntu operating systems on Firefox browser.
New features are to be tested as they are finished with test cases written for them once features are stabilized.
UI features being tested:
*Create new project
*Modify project settings and variables
*Add/Remove layers to project
*Building images
*Build details
*All builds report table
Backend features:
*Toaster installation and first time configuration
*Data presence
*Data consistency 
*Build data
 YP2.1 TODO - we need Toaster-next on poky-contrib to be tested. Basically to add some of the poky-contrib branches to be tested routinely
 YP2.1 TODO - add mysql testing as well
= Test Strategy =
There are several test approaches for Toaster Testing, such as:
*Perform test cases agreed upon the development during periodic full passes according to the Schedule
*Write new test cases based on developer request or new features requires it.
**Maintain current test cases and update them accordingly
*Perform exploratory testing on existing functionalities. 
**YP 2.1 Testopia template here.
== Major feature groups and their testing approach ==
=== FrontEnd - UI Basic functionalities ===
Toaster UI features are tested such as links, buttons, tables, pages basic functionalities.
Testing needs :
*Built only in python 2.7
*Latest version of Selenium as python module
*Latest version of Firefox
*In order to test Selenium automated based tests (https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4027 ), the following steps need to be taken before running, on a clean Toaster setup
**ckeck the steps and requirements for “The Selenium automated UI tests” from https://wiki.yoctoproject.org/wiki/Testing_Toaster 
*For UI manual testing follow the steps from https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4029 TCs 
**currently working on their automation using Selenium
=== BackEnd functionalities ===
=== LEGACY === Starting with 2.1 M3 the dev team will be taking responsibility for these tests. They will become a part of their internal CI testing.
Covers data integrity, data transfer between Bitbake and Toaster, Start/Stop, building images, configuration, etc
Testing needs:
*Built in python 2.7
*Direct sql requests to local sqlite instance
 YP2.1 TODO: Direct SQL tests are going to be hard to maintain and could be done more effectively by either using unit tests in django or by accessing the django ORM. This would also make the test database database backend agnostic.
*Requires sqlite3 client installed (for manual debugging/investigation)
*BackEnd automated tests are verifying the correctness of the data gathered by the build process as presented in the Backend template: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4028
**In order for these tests to run properly, check the the steps for “The oe-selftest Toaster tests” from https://wiki.yoctoproject.org/wiki/Testing_Toaster 
*For BackEnd managed mode manual testing follow the steps from the following template https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4030 
*please validate and add info from Testing Toaster wiki in this section(Test Strategy): https://wiki.yoctoproject.org/wiki/Testing_Toaster
== Test automation ==
Toaster has 3 testing suites, targeted at verifying different parts of the system.
=== Django Unit Tests ===
Toaster is primarely a Django application. As such, it makes use of the Django test system that runs unit tests on mock data to ensure pieces of functionality work as expected, and prevent regressions.
To run the django unit tests, invoke them as with any Django test suite
 ./bitbake/lib/Toaster/manage.py test
To add unit tests, simply add needed tests to the _tests.py_ file in the module you're editing.
 YP2.1 TODO: QA start running tests
=== The oe-selftest Toaster tests ===
=== LEGACY === These are no longer valid as of 2.1 M3
These tests are verifying the correctness of the data gathered by the build process - it tests the bitbake/lib/bb/ui/Toasterui.py and bitbake/lib/bb/ui/buildinfohelper.py files and the interface to the bitbake server process.
In order for these tests to run properly, the following steps need to be taken before running, on a clean Toaster setup:
*Create new project using local poky release
*Create 1 core-image-minimal image
*Create 1 core-image-sato image to check building from cache
*Break a recipe file (by modifying a link, for example)
*Create a new image using broken recipe to check error detection is working
To run these tests you need to source an environment by issuing:
 source oe-init-build-env
then modify the bblayers.conf file to add the meta-selftest layer, create a symbolic link to the Toaster.sqlite file:
 ln -s ../Toaster.sqlite Toaster.sqlite
and then run the command:
 oe-selftest --run-tests _Toaster
=== The selenium automated UI tests ===
The automated UI tests are targeted at validating and identifying regressions in the UI pages. These tests are based on the Selenium framework to drive interactions in the interface.
The selenium tests require a couple of components:
*scrot (a screen capture utility) and pip - a utility for installing python modules. The following is how you install it for ubuntu:
 sudo apt-get install scrot python-pip python-virtualenv
 virtualenv t-selenium
 source ./t-selenium/bin/activate
 pip install selenium
*Since this is a web application, the UI can also be tested from a mac. To install the requirements there do:
 sudo easy_install pip
 sudo pip install virtualenv
 virtualenv t-selenium
 source ./t-selenium/bin/activate
*also install the latest filefox extension from selenium located at: http://release.seleniumhq.org/selenium-ide/ and install all the extensions.
The selenium tests are located in:
 ./ bitbake/lib/Toaster/contrib/tts/Toasteruitest
You run them with:
 ./bitbake/lib/Toaster/contrib/tts/Toasteruitest/run_Toastertests.py
The above command takes the list of the tests to run from the Toaster_test.cfg file. The tests themselves are located in Toaster_automation_test.py. The Toaster_test.cfg file has a couple of important variables in it separated by which os you are running the tests on. These varables control where the Toaster instance is located (defaults to http://127.0.0.1:8000) what browser to use (firefox is safest for selenium though there is a chrome driver available as well), what tests to run and what log level to save data at.
In order for these tests to run properly, the following steps need to be taken before running, on a clean Toaster setup:
*Create new project named "selenium-project" using local poky release
*Create 1 core-image-minimal image
*Break a recipe file (by modifying a link, for example)
*Create a new image using broken recipe to check error detection is working
*Fix the recipe broken in previous step
*Create 1 core-image-sato image
 YP2.1 TODO: Update this section, since the steps are a WIP for automation.
In order to run all current tests, you need to modify the configuration file "Toaster_test.cfg" with the following line:
 test_cases = [901, 902, 903, 904, 906, 910, 911, 912, 913, 914, 915, 916, 923, 924, 940, 941, 942, 943, 944, 945, 946, 947, 948, 949, 950, 951, 955, 956]
The code for running Selenium UI tests is available here: http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=alimon/Toaster_tests_squash
== Test Approach ==
Regression
Regression testing is being performed by the QA team for Backend and Frontend according to the Schedule matrix. Part of regression Backend and Frontend are covered.
=== Sanity testing ===
*Not covered at this moment
*TBD following DEV discussions
=== Performance and Stress ===
*Testing two concurrent builds
*TC…
=== Load testing ===
*Not covered
*TBD
=== System Integration Testing ===
*Not covered (maybe covered by DEV w/ Jenkins)
===Regression===
*All Full pass tests for
**BackEnd
**FrontEnd
== Maintaining the test cases ==
Toaster test cases are officially stored in Testopia, the Yocto Project test case management system. Testopia is a test case management platform and an extension for Bugzilla developed by the Mozilla Foundation that helps organize test cases using a tight relation with elements in Bugzilla. More details on Testopia, can be found on the YP Wiki at https://wiki.yoctoproject.org/wiki/Testopia. 
A quick start guide for Testopia is found on the Testopia wiki at https://wiki.yoctoproject.org/wiki/Testopia#What_do_I_need_to_start_using_Testopia.3F.
As currently Testopia is structured, all Toaster test cases are stored under Classifications/Build System & Metadata/ Toaster component within Testopia. All the test cases are organized in Test Run Templates as following:
*Toaster Backend - Weekly: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4028
*Toaster Backend - Managed Mode: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4030
*Toaster UI: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4027
*Toaster UI - Managed Mode: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4029
*Toaster Exploratory - https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4043
== Submitting Bugs ==
Being part of the Yocto Project, Toaster follows the same Yocto Project guidelines and principles. The guidelines can be found at https://wiki.yoctoproject.org/wiki/Community_Guidelines. 
Toaster bugs are no different and are tracked into Bugzilla, the official Yocto Project bug tracker. Learn more about our process for reporting bugs.
=Requirements=
==HW Requirements==
A host system with a minimum of 50 Gbytes of free disk space that is running a supported Linux distribution
==Software Requirements==
*Django 1.6
*South 0.8.4
*argparse 1.2.1
*wsgiref 0.1.2
*beautifulsoup4 4.4.0 or greater
*A release of the Yocto Project: http://git.yoctoproject.org/cgit/cgit.cgi/poky/
*YP Quick Start requirements 
**Git 1.7.8 or greater 
**tar 1.24 or greater
**Python 2.7.3
==Environment Requirements==
*Supported Browsers – no official browser selected yet, usually Firefox is used
*Supported operating systems as per SANITY_TESTED_DISTROS listed in meta-yocto/conf/distro/poky.conf
**YP 2.0 Release:
**Ubuntu-14.04
**Ubuntu-14.10
**Ubuntu-15.04
**Fedora-21
**CentOS-6.*
**CentOS-7.*
**Debian-7.*
**Debian-8.*
**openSUSE-project-13.2
*Latest version of Selenium installed as python module
*YP QS (Maybe, depending where Toaster server is installed)
*SQLITE 3 Client
=Features=
==Features to be tested==
===Backend===
*Toaster installation and first time configuration
**Download poky 
**Checkout on desired version
**Start Toaster with “bitbake/bin/Toaster” command
*Data integrity 
**Data presence - the information is being recorded into the database
**Data consistency - the information is being recorded properly when modified from UI
**Build data - all the information from bitbake process is being transmitted properly to the database
*Data transfer between Toaster and Bitbake 
*Toaster and Bitbake complete cycle communication
;The test runs templates for Toaster backend are are found in Testopia, as following
*Toaster Backend - Weekly: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4028
*Toaster Backend - Managed Mode: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4030
===Frontend===
*Verifying if all view elements work (buttons, tables, sort buttons, etc.)
*Configurations
**Communication between UI-BackEnd
**Browse and build any layers published in OpenEmbedded Metadata Index
**Import your own layers for building
**Add/Remove layers from configuration
**Set configurations variables
**Select a target or multiple targets to build 
*Building images
**Build base images(core-image-minimal, core-image-sato etc)
**Build images with added layers
**Build images after modifying project settings
*Data Presentation
**All builds report table
**View what was built and what packages were installed into final image
**Browse the directory structure of the image 
**View the value of all variables form build configuration
**Examine errors, warnings and trace messages 
**View information about the Bitbake task executed and reused during a build
**View dependency relations between recipes, packages and tasks
**View performance informations such as build time, task time, CPU usage and disk I/O
**Build details
***Build configuration page
****Build artifacts
****Bitbake variables table
***Tasks report table
***Metrics report tables
****CPU usage
****Disk I/O
****Time
***Included packages report table
****Package details page
***Recipes used during build
****Recipe details page
**Definition data from JSON file
***file path: “/poky/meta-yocto/conf”
***contains default settings and informations for:
****configuration
****layer source
****releases
****bitbake
;The test runs templates for Toaster frontend are are found in Testopia, as following:
*Toaster UI: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4027
*Toaster UI - Managed Mode: https://bugzilla.yoctoproject.org/tr_show_run.cgi?run_id=4029
== New Features to be tested 2.1 ==
Image Customization
*Create, edit, delete custom image
*Add/remove packages
*Build image
*Image details page
*Downloading the image custom recipe
== Setup covered by QA tests ==
*SQLITE database
**add MySQL database testing
**add running Toaster as a service with Apache (e.g. production instance)
*YP 2.0 Release:
**Ubuntu-14.04
**Ubuntu-14.10
**Ubuntu-15.04
**Fedora-21
**CentOS-6.*
**CentOS-7.*
**Debian-7.*
**Debian-8.*
**openSUSE-project-13.2
*Firefox browser
*Add Chrome as well
== We don’t cover yet ==
*Layer integrity (covering all layers is impossible)
**AR Mihai to get Brian’s supported layer list
*Toaster-next branch
**what’s the easiest way to run the automated tests for a person.
**holy grail - make a single framework solution.
*Safari browser
*TBD - to check with DEV what it’s not covered yet.
= Schedule =
*Toaster is tested only at Full Pass by QA Team
**the plan is to run it according to the Test execution Cycle, after automation is in place.
*Toaster is tested on Toaster-next branch before every merge into Master by Dev team
*Toaster will be tested according to the YP 2.1 Schedule.
==Test execution Cycle==
Build 	Sanity Test/E2E	Weekly Test	Full Pass
Daily Master 	Y 	Y 	NO
Weekly Build 	Y 	Y 	NO
Milestone Build	Y 	Y 	Y
;Sanity Test is described here.
*run on Toaster-next or poky-contrib. 
**TBD 
***need info from DEV owners on what Sanity testing is done by them
***detail the set of tests. e.g. django unit tests, Toaster oe-selftest
Weekly test
*Weekly testing is performed on a weekly basis on the poky weekly build.
*E2E consists of all automated tests that can be run on Toaster
**oe-selftest Toaster tests
*selenium UI tests
*TBD 
**add E2E integration information
**add more information
Full Pass
*On full pass all available tests will be run:
**Automated tests:
***Django Unit Tests
***oe-selftest Toaster tests
***Selenium automated UI tests
**Manual tests
***The non-automated tests from the Toaster test runs.
*Full pass is scheduled to be run on every YP release candidate. The YP is divided in four release milestone structure as described in the YP Schedule.
=Dependencies=
*YP Dependencies
**Bitbake works
*Some changes in the Toaster UI might affect running the UI automated tests using Selenium 
**e.g. Changing the element ID’s in the Toaster pages reflected in failing all UI related automated TC’s
*recipe image we’re testing to get build data (metadata broken)
=Risk Assumptions=
*TBD (AlexG)
*Project Risks
**QA and DEV to define this
**Toaster doesn’t affect atm any other YP component (confirmed)
**Changes in Bitbake, bitbake logging might affect Toaster functionality
**Is reliant by host/browser environment
***TBD - add opensuse as well at some point
***TBD - expand the Toaster test framework to the supported host distributions of YP
*Testing Risks
**Toaster quality might be affected
=Tools=
*Refer to Requirements section
*TBD (need more detailed info of required tools)
= Release Criteria/ Exit Criteria =