Skip to content

Commit

Permalink
doc: Static Analysis requirement
Browse files Browse the repository at this point in the history
Sets static analysis  an indispensable requirement for our project
releases.

Static analysis is not merely a tool but a proactive
strategy to unearth and address potential issues in the early stages
of development, long before they mature into critical
vulnerabilities. By scrutinizing code at rest, static analysis unveils
latent defects and potential security risks, thus bolstering the
resilience of our software against future threats.

Fixes: zephyrproject-rtos#64591

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
  • Loading branch information
Flavio Ceolin committed Nov 21, 2023
1 parent 1dc6279 commit e42b6a3
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 7 deletions.
14 changes: 11 additions & 3 deletions doc/contribute/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -532,9 +532,17 @@ results you have to create an account yourself. From the Zephyr project page,
you may select "Add me to project" to be added to the project. New members must
be approved by an admin.

Coverity scans the Zephyr codebase weekly. GitHub issues are automatically
created for any problems found and assigned to the maintainers of the affected
areas.
Static analysis in the Zephyr codebase happens bi-weekly. GitHub issues are
automatically created for any issues detected by Coverity. These issues will
have the same (or equivalent) priority initially defined by the tool.

To ensure accountability and efficient issue resolution, they are assigned to
the respective code owner who is responsible for the affected code.

A dedicated team comprising members with expertise in static analysis, code
quality, and software security ensures the effectiveness of the static
analysis process and verify that identified issues are properly
triaged and resolved in a timely manner.

Workflow
========
Expand Down
23 changes: 23 additions & 0 deletions doc/project/project_roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,9 @@ in addition to those listed for Contributors and Collaborators:
* Responsibility to ensure all contributions of the project have been reviewed
within reasonable time.
* Responsibility to enforce the code of conduct.
* Responsability to triage static analysis issues in their code area. Improper
triage may lead hidden defects and potential security risks.
See :ref:`static_analysis`.

Contributors or Collaborators are promoted to the Maintainer role by adding the
GitHub user name to one or more ``maintainers`` sections of the
Expand Down Expand Up @@ -170,6 +173,26 @@ the latter is not possible.

.. _release-engineering-team:

Static Analysis Audit Team
++++++++++++++++++++++++++

Static Analysis Audit team works closely to the release engineering
team to ensure that static analysis findings during a development life
cycle are properly addressed. The team has the following rights and
responsibilities:

* Right to revert any changes in a static analysis tool (e.g: Coverity)
that does not follow the project expectations.
* Responsibility to inform code owners about improper classifications.
* Responsibility to alert TSC if any issues are not adequately addressed by the
responsible code owners.

Joining the Static Analysis Audit team

* Contributors highly involved in the project with some expertise
in static analysis.


Release Engineering Team
++++++++++++++++++++++++

Expand Down
16 changes: 12 additions & 4 deletions doc/project/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,15 @@ At that point, the whole process starts over again.
Release Quality Criteria
************************

The current backlog of prioritized bugs shall be used as a quality metric to
gate the final release. The following counts shall be used:
Static Analysis results are a fundamental requirement for the
project. The final release must not contain any high-critical issues
that can potentially compromise the functionality, security, or
reliability of our software. High-critical issues represent
vulnerabilities that, if left unresolved, could have severe
consequences.

The current backlog of prioritized bugs shall also be used as a quality metric
to gate the final release. The following counts shall be used:

.. csv-table:: Bug Count Release Thresholds
:header: "High", "Medium", "Low"
Expand Down Expand Up @@ -269,8 +276,9 @@ components provided by the project:

- Compliance with published coding guidelines, style guides and naming
conventions and documentation of deviations.
- Regular static analysis on the complete tree using available commercial and
open-source tools and documentation of deviations and false positives.
- Static analysis report
- Regular static analysis on the complete tree using available commercial and
open-source tools and documentation of deviations and false positives.
- Documented components and APIS
- Requirements Catalog
- Verification Plans
Expand Down

0 comments on commit e42b6a3

Please sign in to comment.