ROS 2 Quality Assurance Documentation

This document contains detailed instructions and tutorial for improving ROS 2 package quality, follow REP-2004 quality level and integrating CI into the development workflow.

Introduction

• Overview

Software Testing

• Configure Dependencies
  • rosdep
  • vcstool
  • Others
  • Example: Using vcstool
• Static Analysis
  • Command Line Static Analysis
  • C++ Static Analysis
  • Python Static Analysis
• Unit Test
  • C++ Unit Test
  • Python Unit Test
• Google Sanitizer
  • Prerequisites
  • Address Sanitizer
  • Thread Sanitizer
  • Example
• Code Coverage
  • Setup
  • C++ Code Coverage
  • Python Code Coverage
  • Example

Quality Declaration

• Version Policy
• Change Control Process
• Documentation
• Software Testing
• Dependencies
• Platform Support
• Security

Continuous Integration

• Industrial CI
• Industrial CI with Github Action
  • Setup Configuration File
  • CI Pipeline Trigger
• Industrial CI with Travis CI
  • Sign Up & Registration
  • Setup Configuration File
  • Trigger CI Pipeline
• Industrial CI with Gitlab CI/CD
  • Setup Configuration File
  • Trigger CI Pipeline
• Code Coverage With Codecov and Coveralls
  • Codecov
  • Coveralls
  • Overall example configuration(s)
• Release and ROS Buildfarm

Guide

• Mixin setup
  • Setting up mixin
• Catch2 setup