mirror of
https://github.com/eried/portapack-mayhem.git
synced 2024-10-01 01:26:06 -04:00
83 lines
3.8 KiB
Plaintext
Executable File
83 lines
3.8 KiB
Plaintext
Executable File
/*
|
|
ChibiOS/RT - Copyright (C) 2006-2013 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup test Test Runtime
|
|
* @details Runtime code for the test suite execution, this code is not part
|
|
* of the OS and should not be included in user applications.
|
|
*/
|
|
|
|
/**
|
|
* @page testsuite Testing Strategy
|
|
* <h2>Description</h2>
|
|
* Most of the ChibiOS/RT demos link a set of software modules (test suite) in
|
|
* order to verify the proper working of the kernel, the port and the demo
|
|
* itself.
|
|
*
|
|
* <h2>Strategy by Component</h2>
|
|
* The OS components are tested in various modes depending on their importance:
|
|
* - <b>Kernel</b>. The kernel code is subject to rigorous testing. The test
|
|
* suite aims to test <b>all</b> the kernel code and reach a code coverage
|
|
* as close to 100% as possible. In addition to the code coverage, the kernel
|
|
* code is tested for <b>functionality</b> and benchmarked for <b>speed</b>
|
|
* and <b>size</b> before each stable release. In addition to the code
|
|
* coverage and functional testing a <b>batch compilation test</b> is
|
|
* performed before each release, the kernel is compiled by alternatively
|
|
* enabling and disabling all the various configuration options, the
|
|
* kernel code is expected to compile without errors nor warnings and
|
|
* execute the test suite without failures (a specific simulator is used
|
|
* for this execution test, it is done automatically by a script because
|
|
* the entire sequence can take hours).<br>
|
|
* All the tests results are included as reports in the OS distribution
|
|
* under <tt>./docs/reports</tt>.
|
|
* - <b>Ports</b>. The port code is tested by executing the kernel test
|
|
* suite on the target hardware. A port is validated only if it passes all
|
|
* the tests. Speed and size benchmarks for all the supported architectures
|
|
* are performed, both size and speed regressions are <b>monitored</b>.
|
|
* - <b>HAL</b>. The HAL high level code and device drivers implementations
|
|
* are tested through specific test applications under <tt>./testhal</tt>.
|
|
* - <b>Various</b>. The miscellaneous code is tested by use in the various
|
|
* demos.
|
|
* - <b>External Code</b>. Not tested, external libraries or components are
|
|
* used as-is or with minor patching where required, problems are usually
|
|
* reported upstream.
|
|
* .
|
|
* <h2>Kernel Test Suite</h2>
|
|
* The kernel test suite is divided in modules or test sequences. Each Test
|
|
* Module performs a series of tests on a specified kernel subsystem or
|
|
* subsystems and can report a failure/success status and/or a performance
|
|
* index as the test suite output.<br>
|
|
* The test suite is usually activated in the demo applications by pressing a
|
|
* button on the target board, see the readme file into the various demos
|
|
* directories. The test suite output is usually sent through a serial port
|
|
* and can be examined by using a terminal emulator program.
|
|
*
|
|
* <h2>Kernel Test Modules</h2>
|
|
*
|
|
* - @subpage test_threads
|
|
* - @subpage test_dynamic
|
|
* - @subpage test_msg
|
|
* - @subpage test_sem
|
|
* - @subpage test_mtx
|
|
* - @subpage test_events
|
|
* - @subpage test_mbox
|
|
* - @subpage test_queues
|
|
* - @subpage test_heap
|
|
* - @subpage test_pools
|
|
* - @subpage test_benchmarks
|
|
* .
|
|
*/
|