NUT Quality Assurance and Build Automation Guide

		Next

Jim Klimov

Revision History
Revision 2.8.3	2025-04-07	JK
Some changes to docs and recipes, libusbclient API and functionality. Updated NUT SEMVER definition and added scripting around it. Groundwork for vendor-defined status and INSTCMD buzzwords like "ECO". Fixed some regressions and added improvements for certain new device series.

Table of Contents

1. NUT Quality Assurance

1.1. Documentation
1.2. Source code

2. Code and recipe analysis

2.1. GNU Autotools distcheck
2.2. Valgrind checks
2.3. cppcheck
2.4. Static analysis by compilers
2.5. Shell script checks
2.6. Documentation spelling checks

3. Test automation

3.1. The ci_build.sh script
3.2. Test programs in NUT codebase
3.3. NUT Integration Testing suite (aka NIT)

4. Continuous Integration (NUT CI farm) technologies

4.1. CI Farm configuration notes
4.2. Multiple FOSS CI providers and technologies
4.3. Jenkins is the way
4.4. AppVeyor CI
4.5. CircleCI
4.6. Travis CI
4.7. CodeQL

5. Continuous Integration (NUT CI farm) build agent preparation

5.1. Custom NUT CI farm build agents: VMs on DigitalOcean
5.2. Setting up the non-standard VM farm for NUT CI on DigitalOcean
5.3. Custom NUT CI farm build agents: LXC multi-arch containers
5.4. Setting up the multi-arch Linux LXC container farm for NUT CI
5.5. Connecting Jenkins to the containers

6. Prerequisites for building NUT on different OSes

6.1. General call to Test the ability to configure and build
6.2. Build prerequisites to make NUT from scratch on various Operating Systems

Warning

This is a Work In Progress document.

Abstract

The aim of this document is to describe the different ways we ensure and maintain the source code quality of Network UPS Tools, its portability to various platforms, and non-regression.

Previous NUT releases may have included parts of this documentation in the developer guide or user manual. Most of this information can be applied to both automated testing environments and local development workflows.