| Gyorgy Szing | c805f11 | 2022-11-25 11:53:08 +0100 | [diff] [blame] | 1 | Verification methodology |
| 2 | ======================== |
| 3 | |
| 4 | This page discusses discusses verification tools and techniques used by the project. |
| 5 | |
| 6 | |
| 7 | Static Checks |
| 8 | ------------- |
| 9 | |
| 10 | This verification step checks quality by examining the source code. The project currently uses two tools which are |
| 11 | discussed in the chapters below. |
| 12 | |
| 13 | Checkpatch |
| 14 | '''''''''' |
| 15 | |
| 16 | `Checkpatch`_ is a tool developed and maintained by the Linux Kernel community. It can look for errors related to: |
| 17 | |
| 18 | - C and C++ coding style |
| 19 | - spelling mistakes |
| 20 | - git commit message formatting |
| 21 | |
| Gabor Toth | c307860 | 2024-07-29 11:04:16 +0200 | [diff] [blame^] | 22 | Please find the configuration of this tool in the :download:`TS repository.<../../../.checkpatch>` but do not forget |
| 23 | to set ``CODESPELL_FILE`` variable in the environment to the local copy of the `codespell dictionary v2.3.0`_. |
| Gyorgy Szing | c805f11 | 2022-11-25 11:53:08 +0100 | [diff] [blame] | 24 | |
| 25 | Cppcheck tool |
| 26 | ''''''''''''' |
| 27 | |
| 28 | `CppCheck`_ is a C/C++ static analysis tool. It can detect code depending on implementation defined behavior, and |
| 29 | dangerous coding constructs and thus it verifies coding guidelines. |
| 30 | |
| 31 | Please find the configuration of this tool in the :download:`TS repository.<../../../.cppcheck>` |
| 32 | |
| 33 | Build verification |
| 34 | ------------------ |
| 35 | |
| 36 | The :ref:`Build test runner` captures reference build configurations for all TS build products and can be used to verify |
| 37 | these. |
| 38 | |
| 39 | Runtime verification |
| 40 | -------------------- |
| 41 | |
| 42 | During the runtime versification step various test and demo executables are executed on the host PC and/or on target |
| 43 | platforms. |
| 44 | |
| 45 | Tests are targeting three different environment types: |
| 46 | |
| 47 | - ``arm-linux``: test executables to be run from Linux user-space on the target. |
| 48 | - ``pc-linux``: executables to run on the host PC. These tests have a lower verification level, as the binary is likely |
| 49 | not running on an arm target. Portability issues in the source may hide error or trigger false alarms. In turn |
| 50 | this type of test is cheap, |
| 51 | - ``sp`` and ``opteesp``: test executables targeting these environments run in the SWd and server as: |
| 52 | |
| 53 | - test payloads to help exercise trusted services |
| 54 | - test payload to help platform porting |
| 55 | |
| 56 | Each of these test applications manifest as a "deployment" in trusted services. For more details please see the |
| 57 | :ref:`Deployments` section. |
| 58 | |
| 59 | Compliance testing |
| 60 | '''''''''''''''''' |
| 61 | |
| 62 | The project hosts deployment helping compliance testing. For more information please refer to |
| 63 | :ref:`Platform Certification`. |
| 64 | |
| 65 | ------------------ |
| 66 | |
| 67 | .. _`Checkpatch`: https://docs.kernel.org/dev-tools/checkpatch.html |
| 68 | .. _`CppCheck`: https://cppcheck.sourceforge.io/ |
| Gabor Toth | c307860 | 2024-07-29 11:04:16 +0200 | [diff] [blame^] | 69 | .. _`codespell dictionary v2.3.0`: https://raw.githubusercontent.com/codespell-project/codespell/v2.3.0/codespell_lib/data/dictionary.txt |
| Gyorgy Szing | c805f11 | 2022-11-25 11:53:08 +0100 | [diff] [blame] | 70 | |
| 71 | *Copyright (c) 2022, Arm Limited and Contributors. All rights reserved.* |
| 72 | |
| 73 | SPDX-License-Identifier: BSD-3-Clause |