Welcome to System Testing.
[...]\fP .TP .B suite/whitelist_filter Regular expression to match a subset of whitelist filenames. On checkbox\-gui it defaults to \fB\&.*\fP\&. For checkbox\-launcher it has no default and \fImust\fP be defined. .TP .B suite/whitelist_selection Pattern that whitelists need to match to be preselected. Python regular expression. It has no default and \fImust\fP be defined. (CLI only) .TP .B suite/skip_whitelist_selection If set to true, user will not receive a choice of whitelist. Only the preselected ones (see whitelist_selection) will be selected. (CLI only). .TP .B suite/skip_test_selection If set to true, user will not be allowed to deselect tests prior to run: all tests in the selected whitelist will be run. (CLI only) .TP .B submission/message Header text of the submission pop\-up , shown to the user after submission has completed. (GUI only) .TP .B submission/input_type Show a Text input field to enter the secure ID or the LP address (default). To just save the results to disk, must use the \fBnone\fP value. To validate using a regex, must be \fBregex\fP\&. (GUI only) .TP .B submission/regex Regular expression to validate input in submission field (e.g. email, secure_id) if input_type is regex. (GUI only). RegExpValidator, default \fB\&.*\fP .TP .B submission/input_placeholder Temporary text to put in input field, used to guide the user. \fBLaunchpad E\-Mail Address\fP (default) or \fBSecure ID (15 or 18 characters)\fP\&. (GUI only) .TP .B submission/secure_id Preconfigured secure_id to fill in the text field. .TP .B submission/ok_btn_text The label for the "Send" button. \fBSubmit Results\fP (default) or \fBSave Results\fP\&. (GUI only) .TP .B submission/cancel_warning Show to the user if he wants to exit without having saved the report. You are about to exit this test run without saving your results report. Do you want to save the report? (GUI only) .TP .B submission/submit_to_hexr Boolean, add an extra header to also send the results to HEXR (works with the certification transport) .TP .B exporter/xml_export_path Location to save the XML submission file, if set to an empty string will open a file save dialog. Default: \fB/tmp/submission.xml\fP (GUI only) .TP .B transport/submit_to Transport endpoint. Defaults to \fBWelcome to System Certification!
This application will gather information from your system. Then you will be asked manual tests to confirm that the system is working properly. Finally, you will be asked for the Secure ID of the computer to submit the information to the certification database.
To learn how to create or locate the Secure ID, please see here: certification.canonical.com
" [suite] whitelist_filter = "^client\-(cert|selftest).*" [submission] input_type = "regex" input_placeholder = "Secure ID (15 or 18 characters)" ok_btn_text = "Submit Results" submit_to_hexr = "true" [exporter] xml_export_path = "/tmp/submission.xml" [transport] submit_to = "certification" .ft P .fi .UNINDENT .UNINDENT .sp Graphical launchers are a bit more complicated, but essentially it\(aqs similar, what it allows is for you to define some parameters to customize your testing experience. .sp A very simple text\-mode launcher is canonical\-hw\-collection which just runs the basic hardware information tests and uploads them to a hardware database: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C [welcome] title = Gathering hardware information text = Gathering hardware information. You may be prompted for your password. This process will take approximately 30 seconds and you will be provided with a URL through which you can confirm and register your hardware submission. [suite] whitelist_filter = ^hwsubmit$ whitelist_selection = ^hwsubmit$ skip_whitelist_selection = True skip_test_selection = True [submission] # A bogus secure_id ensures we don\(aqt ask it # It can always be overridden in the .conf file. secure_id = 000 [transport] submit_to = certification submit_url = https://hardware\-server.example.com/ .ft P .fi .UNINDENT .UNINDENT .sp FInally, canonical\-driver\-test\-suite provides both a graphical and a text mode launcher, which are functionally equivalent: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C #!/usr/bin/checkbox\-gui [welcome] title = "Canonical Driver Test Suite" text = "Welcome to the Canonical Driver Test Suite.
This program contains automated and manual tests to help you discover issues that will arise when running your device drivers on Ubuntu.
This application will step the user through these tests in a predetermined order and automatically collect both system information as well as test results. It will also prompt the user for input when manual testing is required.
The run time for the tests is determined by which tests you decide to execute. The user will have the opportunity to customize the test run to accommodate the driver and the amount of time available for testing.
To begin, simply click the Continue button below and follow the onscreen instructions.
" [suite] whitelist_filter = "^ihv\-.*" [submission] ok_btn_text = "Save Results" input_type = "none" [exporter] xml_export_path = "" [transport] submit_to = "local" .ft P .fi .UNINDENT .UNINDENT .sp Text mode: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C #!/usr/bin/env checkbox\-launcher [welcome] text = Welcome to the Canonical Driver Test Suite This program contains automated and manual tests to help you discover issues that will arise when running your device drivers on Ubuntu. This application will step the user through these tests in a predetermined order and automatically collect both system information as well as test results. It will also prompt the user for input when manual testing is required. The run time for the tests is determined by which tests you decide to execute. The user will have the opportunity to customize the test run to accommodate the driver and the amount of time available for testing. To begin, simply click the Continue button below and follow the onscreen instructions. [suite] # Whitelist(s) displayed in the suite selection screen whitelist_filter = ^ihv\-.* # Whitelist_selection is mandatory so we set it to a bogus value so # no whitelists are preselected. whitelist_selection = bogus .ft P .fi .UNINDENT .UNINDENT .SH CHECKBOX RELEASE PROCESS .sp This page describes the necessary steps for releasing versions of Checkbox and Checkbox Certification to the stable PPA belonging to the Hardware Certification team, on a regular basis. Throughout this document the term \(aqCheckbox\(aq is used as a catch\-all term to cover all versions of Checkbox owned by the Hardware Certification team, currently Checkbox itself and the Checkbox Certification extensions. .SS Overview .sp Currently the process runs on a bi\-weekly cadence, with a new release of Checkbox every two weeks. This covers ten working days, and the tasks carried out on each day or group of days is described below: .INDENT 0.0 .IP \(bu 2 Days 1\-4: Time allowed for new changes to be introduced into trunk. .IP \(bu 2 Day 5: Changes are merged from the trunk of \fBlp:checkbox\fP and \fBlp:checkbox\-certification\fP to their respective release branches. The changelogs for both are \fIbumped\fP at this point and revisions are tagged. At this stage it may also be necessary to copy the package \(aqfwts\(aq from the \fI\%FWTS Stable PPA\fP <\fBhttps://launchpad.net/~firmware-testing-team/+archive/ppa-fwts-stable\fP> to the \fI\%Checkbox Release Testing PPA\fP <\fBhttps://launchpad.net/~checkbox-dev/+archive/testing\fP>\&. .IP \(bu 2 Days 6\-9: Testing is performed by the release manager for the Hardware Certification team, and a representative of the CE QA team (the main customer for Checkbox within Canonical) .IP \(bu 2 Day 9: A release meeting is held between the release manager for the Hardware Certification team and the representative of the CE QA team. Potential issues with the release are identified and plans made to address them. .IP \(bu 2 Day 10: The tested version of Checkbox is copied to the stable PPA. .UNINDENT .SS Launchpad Branches .sp The release process requires separate branches in Launchpad containing a semi\-frozen version of the code that was in trunk on day 5 of the process. This is so that development can continue on trunk without jeopardising the stability of the to\-be released version of Checkbox. The relationship between all branches involved in the process is as shown below: .INDENT 0.0 .IP \(bu 2 \fIlp:checkbox/release\fP <\- \fIlp:checkbox\fP .IP \(bu 2 \fIlp:checkbox\-certification/release\fP <\- \fIlp:checkbox\-certification\fP .IP \(bu 2 \fIlp:~checkbox\-dev/checkbox/checkbox\-packaging\-release\fP <\- \fIlp:~checkbox\-dev/checkbox/checkbox\-packaging\fP .UNINDENT .SS Auditing milestoned bugs .sp Prior to creating the release candidate the release manager should review the list of bugs milestoned for the next release of Checkbox. They should visit \fI\%checkbox milestones\fP <\fBhttps://launchpad.net/checkbox/+milestonesmilestones\fP> and locate the milestone dated with the release date. .INDENT 0.0 .IP \(bu 2 For bugs that are set to In Progress with a branch associated \- liase with the branch owner to see if the merge can be completed before the deadline. .IP \(bu 2 For bugs that are in any other non\-closed status (except \fIFix Commited\fP) \- re\-milestone them to the following milestone. .UNINDENT .SS Cutting the release .sp In order to cut the release, we have to merge the changes from trunk into the release branch, commit them with a suitable message and update the changelog in trunk so that future changes go under the correct version. For each combination of branches shown above, do the following (the example uses \fBlp:checkbox\fP and \fBlp:checkbox/release\fP): .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C bzr branch lp:checkbox/release checkbox\-release bzr branch lp:checkbox checkbox\-trunk cd checkbox\-release current_stable=\(gahead \-n1 $(find . \-name \(aqchangelog\(aq) | grep \-oP \(aq(?<=\e().*(?=\e))\(aq\(ga bzr merge lp:checkbox .ft P .fi .UNINDENT .UNINDENT .sp at this point if no changes (other than one to \fBdebian/changelog\fP) get merged in then we do not perform a release of the package in question. In practice this often happens with \fBcheckbox\-certification\fP but never with \fBcheckbox\fP: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C bzr commit \-m "Merged in changes from rev$(bzr revno \-r tag:$current_stable lp:checkbox) to rev$(bzr revno lp:checkbox) from lp:checkbox" bzr push lp:checkbox/release cd \(gafind . \-name \(aqdebian\(aq\(ga; cd .. bzr tag \(gahead \-n1 debian/changelog | grep \-oP \(aq(?<=\e().*(?=\e))\(aq\(ga dch \-r (save modified changelog) dch \-i \-U \(aqIncremented changelog\(aq debcommit bzr push lp:checkbox .ft P .fi .UNINDENT .UNINDENT .sp The last step in the process is to perform a build of the packages in the \fBppa:checkbox\-dev/testing PPA\fP\&. To do this we need to go to the recipe pages for the \fBcheckbox\fP and/or \fBcheckbox\-certification\fP release branches. .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP \(bu 2 \fI\%checkbox\-testing recipe\fP <\fBhttps://code.launchpad.net/~checkbox-dev/+recipe/checkbox-testing\fP> .IP \(bu 2 \fI\%checkbox\-certification\-testing recipe\fP <\fBhttps://code.launchpad.net/~checkbox-dev/+recipe/checkbox-certification-testing\fP> .UNINDENT .UNINDENT .UNINDENT .sp The \fBBuild Now\fP option should be available on the page. Click it to start a build. .SS Copying Firmware Test Suite to the Testing PPA .sp The Firmware Test Suite tool is a test tool for system firmware that is naturally heavily utilised by Checkbox. To make sure the latest version which contains fixes and new tests/features needed by Checkbox is available and also doesn\(aqt break anything in Checkbox, we need to release it alongside Checkbox. After cutting the release if the Firmware Testing team have notified that a new version is available and that this version should be used for certification, we need to copy it to the Testing PPA. To do this we need to go to the \fI\%Copy packages view of the Firmware Test Suite (Stable) PPA\fP <\fBhttps://launchpad.net/~firmware-testing-team/+archive/ppa-fwts-stable/+copy-packages\fP> and select the \(aqfwts\(aq packages for all releases back to Precise. We need to set the \(aqDestination PPA\(aq as \(aqCheckbox Release Testing [~checkbox\-dev/testing]\(aq and the \(aqCopy options\(aq field to \(aqCopy existing binaries\(aq, then click \(aqCopy packages\(aq. This step then needs to be repeated but set the \(aqDestination PPA\(aq field to \(aqPPA for Checkbox Developers [~checkbox\-dev/ppa]\(aq. .SS Next Release of Checkbox e\-mail .sp So that everyone has the opportunity to perform whatever testing is required in a timely manner, after the PPA builds have been completed an email should be sent to the following mailing lists: .INDENT 0.0 .IP \(bu 2 \fI\%hardware\-certification\-team@lists.canonical.com\fP <\fBhardware-certification-team@lists.canonical.com\fP> .IP \(bu 2 \fI\%commercial\-engineering@lists.canonical.com\fP <\fBcommercial-engineering@lists.canonical.com\fP> .UNINDENT .sp The content is typically something like this: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C Subject: Next Release of Checkbox (18/11/2013) Hi, The next release of Checkbox is available in the https://code.launchpad.net/~checkbox\-dev/+archive/testing PPA. Please test it at your convenience. Checkbox is based on revision 2484 of lp:checkbox and Checkbox Certification is based on revision 586 of lp:checkbox\-certification. Thanks, .ft P .fi .UNINDENT .UNINDENT .sp If one or the other of Checkbox and Checkbox Certification have not been updated then there is no need to mention that package .SS Testing the release .sp Now that the release has been cut, testing should take place prior to the release meeting. From the point of view of the certification team, what needs to be tested is \fBcheckbox\-certification\-client\fP and \fBcheckbox\-certification\-server\fP which form the basis for CE QAs OEM specific versions of Checkbox. Checkbox certification server is tested in the CI loop Checkbox certification client needs to be tested manually. .SS Release Meeting .sp On the Thursday before the release is made, a meeting is held between a representative of the Certification team and a representative of the \fBCommercial Engineering QA\fP team. The meeting is held at 7:30 UTC as shown in this \fI\%calendar invite\fP <\fBhttps://www.google.com/calendar/hosted/canonical.com/event?action=TEMPLATE&tmeid=Y3QxcWVla3ViMTRvMXByOHZlOTFvc283Y2NfMjAxMzA4MjlUMDczMDAwWiBicmVuZGFuLmRvbmVnYW5AY2Fub25pY2FsLmNvbQ&tmsrc=brendan.donegan%40canonical.com\fP>\&. An agenda for the meeting is included in the invite. .SS Publishing the release .sp To publish the release we simply need to copy a number of packages from the \fI\%Checkbox Release Testing PPA\fP <\fBhttps://launchpad.net/~checkbox-dev/+archive/testing\fP> to the \fI\%Hardware Certification Public PPA\fP <\fBhttps://launchpad.net/~hardware-certification/+archive/public\fP>\&. To do this we go to the \fI\%Copy packages view of the Checkbox Release Testing PPA\fP <\fBhttps://launchpad.net/~checkbox-dev/+archive/testing/+copy-packages\fP> and select all versions of the following list of packages: \fBcheckbox, checkbox\-certification, fwts\fP\&. Make sure that the \(aqDestination PPA\(aq field is set to \(aqPublic PPA for Hardware Certification [~hardware\-certification/public]\(aq and that the \(aqCopy options\(aq field is set to \(aqCopy existing binaries\(aq, then click \(aqCopy Packages\(aq. .sp After that is done an announcement email should be sent to \fI\%commercial\-engineering@lists.canonical.com\fP <\fBcommercial-engineering@lists.canonical.com\fP>\&. A template for the announcement in included below: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C Hi, A new release of checkbox has been uploaded to the Hardware Certification Public PPA (https://launchpad.net/~hardware\-certification/+archive/public). The release is based on revision 2294 of lp:checkbox Thanks, .ft P .fi .UNINDENT .UNINDENT .sp Please attach the most recent part of the changelog as release notes .INDENT 0.0 .IP \(bu 2 genindex .IP \(bu 2 modindex .IP \(bu 2 search .UNINDENT .SH AUTHOR Zygmunt Krynicki .SH COPYRIGHT 2013-2014, Zygmunt Krynicki .\" Generated by docutils manpage writer. .