nut-qa.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<meta name="description" content="Power Devices support" />
<meta name="keywords" content="NUT, Network UPS Tools, Eaton, APC, Free Software, UPS, Uninterruptible Power Supplies, PDU, Power Distributions Units, Solar Controllers, power, power devices, control, monitor, Linux, Unix, Windows, Mac OS X" />
<meta name="format-detection" content="telephone=no" />
<link rel="stylesheet" href="css/xhtml11.css" type="text/css" />
<link rel="stylesheet" href="css/xhtml11-quirks.css" type="text/css" />
<link rel="stylesheet" href="css/web-layout.css" type="text/css" />
<link rel="stylesheet" href="css/anchorjs.css" type="text/css" />
<link rel="shortcut icon" href="faviconut.ico" />
<link rel="icon" type="image/png" href="faviconut.png" />
<script type="text/javascript" src="./scripts/anchorjs.min.js"></script>
<script type="text/javascript" src="./scripts/asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
<!--[if lte IE 7]>
<link rel="stylesheet" href="css/ie-overrides.css" type="text/css" />
<![endif]-->
<!--[if lte IE 6]>
<script type="text/javascript" src="./scripts/filter_png.js"></script>
<![endif]-->
</head>
<body>
<div id="layout-banner-box">
<div id="layout-banner">
  <div id="layout-logo"><img src="images/nut-logo.svg" alt="NUT logo" width="60" height="60" /></div>
  <div id="layout-title">Network UPS Tools</div>
  <div id="layout-description">Power Devices support</div>
</div>
</div>
<div id="layout-menu-box">
  <ul id="layout-menu">
    <li><a href="index.html">Home</a></li>
    <li><a href="download.html">Download</a></li>
    <li><a href="projects.html">Related projects</a></li>
    <li><a href="stable-hcl.html">Compatibility</a></li>
    <li><a href="features.html">Features</a></li>
    <li><a href="documentation.html">Documentation</a></li>
    <li><a href="support.html">Support</a></li>
    <li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsuser/">NUT UPS User archive</a></li>
    <li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsdev/">NUT UPS Dev archive</a></li>
    <li>* <a href="https://github.com/networkupstools/nut/">GitHub</a>:<a
        href="https://github.com/networkupstools/nut/issues">issues</a>,<a
        href="https://github.com/networkupstools/nut/wiki">wiki</a>
        and more</li>
    <li><a href="/historic/index.html">Sub-sites for historic releases</a></li>
    <li><a href="https://opencollective.com/networkupstools/">Sponsor NUT</a></li>
  </ul>
  <!-- div id="sponsor"><span>Hosted by<br/></span>
    <a href="http://sponsor.com"><img src="images/sponsor-logo.png" alt="Sponsor" /></a>
  </div -->
</div>
<div id="layout-content-box">
<div id="layout-content">
<div id="header">
</div>
<div id="content">
<div class="sect1">
<h2 id="_nut_quality_assurance">NUT Quality Assurance</h2>
<div class="sectionbody">
<div class="paragraph"><p>Recognizing the critical nature of NUT, the NUT Quality Assurance (NQA) effort
has been established to improve NUT where necessary, and to maintain software
quality as high as it should be.</p></div>
<div class="paragraph"><p>NQA is present in many aspects and areas of NUT.</p></div>
<div class="sect2">
<h3 id="_documentation">Documentation</h3><div style="clear:left"></div>
<div class="paragraph"><p>The documentation toolchain uses
<a href="https://asciidoc.org/">AsciiDoc</a> to output both HTML pages and
manual pages (troff). This single point of control fills many gaps,
suppresses many redundancies, and optimizes documentation management in
general.</p></div>
<div class="ulist"><ul>
<li>
<p>
The NUT website and HTML documentation are tested for W3C XHTML 1.1 and CSS
  compliance. This can be counter verified by clicking the W3C XHTML 1.1 and
  CSS icons, at the bottom of each page.
</p>
</li>
</ul></div>
<div class="ulist"><ul>
<li>
<p>
Documentation source files are spell checked, using
  <a href="http://aspell.net">Aspell</a>, both interactively (using
  <em>make spellcheck-interactive</em>) and automatically in NUT CI
  farm runs (using <em>make spellcheck</em>).
</p>
</li>
</ul></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/note.png" alt="Note" />
</td>
<td class="content">A NUT dictionary is also available (as <code>docs/nut.dict</code> in NUT sources),
providing a glossary of terms related to power devices and management, as well
as partial terms, technical jargon and author names.</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="_source_code">Source code</h3><div style="clear:left"></div>
<div class="sect3">
<h4 id="_use_of_standards">Use of standards</h4>
<div class="paragraph"><p>NUT promotes and uses many standards, such as:</p></div>
<div class="ulist"><ul>
<li>
<p>
the variable names standard used in NUT,
</p>
</li>
<li>
<p>
the coding rules and best practices for developers,
</p>
</li>
<li>
<p>
the use of a software architecture limiting developments to the very minimum,
</p>
</li>
<li>
<p>
the use of standard Free and OpenSource Software components, like:
</p>
<div class="ulist"><ul>
<li>
<p>
the USB library,
</p>
</li>
<li>
<p>
the Net SNMP project,
</p>
</li>
<li>
<p>
the Neon library,
</p>
</li>
<li>
<p>
the OpenSSL library (to be replaced by NSS, which is more license compliant
    with NUT and can be FIPS 140 certified),
</p>
</li>
<li>
<p>
the TCP Wrappers library.
</p>
</li>
</ul></div>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_qa_tools_and_metrics">QA tools and metrics</h4>
<div class="paragraph"><p>NUT&#8217;s quality is constantly monitored using many tools, like:</p></div>
<div class="ulist"><ul>
<li>
<p>
a Revision Control System (<a href="https://github.com/networkupstools/nut">Git</a>)
  to track development and ease regression fixes.
</p>
</li>
</ul></div>
<div class="ulist"><ul>
<li>
<p>
OBSOLETE: <a href="http://buildbot.networkupstools.org/public/nut/">Buildbot</a>
  for older take on multi-platform builds, and the
</p>
</li>
<li>
<p>
new dedicated Jenkins incarnation of the NUT CI Farm with "legacy UI"
  for <a href="https://ci.networkupstools.org/job/nut/job/nut/job/master/">main branch</a>
  and <a href="https://ci.networkupstools.org/job/nut/job/nut/view/change-requests/">PRs</a>,
  also accessible at the slower but slicker-looking Blue Ocean user interface for
  <a href="https://ci.networkupstools.org/blue/organizations/jenkins/nut%2Fnut/activity/">activity</a>,
  <a href="https://ci.networkupstools.org/blue/organizations/jenkins/nut%2Fnut/branches/">branches</a>
  and <a href="https://ci.networkupstools.org/blue/organizations/jenkins/nut%2Fnut/pr/">PRs</a>,
  are all used to automate the compile/test cycle, using numerous platforms,
  target distributions, C/C++ revisions, compiler toolkits and make program
  implementations. Any build failure is caught early, and fixed quickly.
  Also we get to see if incoming pull requests (as well as Git branch HEADs)
  do not have code (or recipe) that is instantly faulty and can not build on
  one of the platforms we track even with relaxed warnings.
</p>
</li>
</ul></div>
<div class="ulist"><ul>
<li>
<p>
a project portal with trackers for bugs, feature request, patches and tasks,
  currently at GitHub
</p>
</li>
<li>
<p>
CodeQL (previously LGTM.COM) automatically checking C/C++ and Python code
</p>
</li>
<li>
<p>
Static code analysis:
</p>
<div class="ulist"><ul>
<li>
<p>
<a href="https://scan.coverity.com/projects/networkupstools-nut">Coverity Scan overview of NUT</a>
</p>
</li>
<li>
<p>
status: <span class="image">
<img src="https://scan.coverity.com/projects/8829/badge.svg" alt="Coverity Scan Build Status" />
</span>
</p>
</li>
<li>
<p>
cppcheck as part of NUT CI farm builds and reports
</p>
</li>
</ul></div>
</li>
</ul></div>
<div class="paragraph"><p>NUT QA also relies on external tools and trackers, like:</p></div>
<div class="ulist"><ul>
<li>
<p>
Clang
</p>
</li>
<li>
<p>
the Debian QA tools, available through the <a href="https://tracker.debian.org/pkg/nut">NUT Package Tracking System</a>:
</p>
<div class="ulist"><ul>
<li>
<p>
Lintian general QA checks,
</p>
</li>
<li>
<p>
<a href="http://piuparts.debian.org/sid/source/n/nut.html">piuparts</a> automates
     the installation, upgrade and removal testing processes.
</p>
</li>
</ul></div>
</li>
<li>
<p>
a runtime testing suite, which automates the inter-layer communication testing
  (driver&#8201;&#8212;&#8201;upsd&#8201;&#8212;&#8201;upsmon / clients), that is part of Ubuntu.
  <a href="https://git.launchpad.net/ubuntu/+source/nut/tree/debian/tests/test-nut.py">The NUT testing script</a>
  is available in the <a href="https://code.edge.launchpad.net/qa-regression-testing">Ubuntu QA Regression Testing suite</a>.
</p>
<div class="paragraph"><p>It installs NUT packages, configures it with the dummy-ups driver, changes
  a few data points and checks that these are well propagated with upsc.</p></div>
</li>
<li>
<p>
similar approach is explored in NIT (NUT Integration Testing) suite,
  which is part of the codebase and automated with <code>make check-NIT</code>;
  it can also be added to default <code>make check</code> activities by running
  <code>configure --enable-check-NIT</code>
</p>
<div class="ulist"><ul>
<li>
<p>
Note that developers updating components which directly impact NIT runs
    may benefit from <code>make check-NIT-devel</code> target, to rebuild the <code>upsd</code>,
    <code>dummy-ups</code>, <code>cppnit</code> and other programs used in the test as they iterate.
</p>
</li>
</ul></div>
</li>
<li>
<p>
<a href="https://bugzilla.redhat.com/buglist.cgi?component=nut">Redhat / Fedora Bug tracker</a>
</p>
</li>
<li>
<p>
<a href="https://www.openhub.net/p/nut">Black Duck Open Hub</a> (formerly Ohloh.net)
  provides metrics on NUT source code base and activity.
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_runtime_quality">Runtime quality</h4>
<div class="ulist"><ul>
<li>
<p>
NUT provides many 
  to ensure a maximum runtime security level.
</p>
</li>
<li>
<p>
Packages use several <a href="http://wiki.debian.org/Hardening">Hardening methods</a>
  to protect NUT binaries.
</p>
</li>
</ul></div>
</div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version nut:v2.8.5.1411-1411+g1a8369f86 ddl:v2.8.5-12-g8b936185d4 web:v2.8.5-72-g6fd7f2f8-master<br />
Last updated 2026-10-07 10:14:55
</div>
<div id="footer-badges">
<a href="https://github.com/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/checks-status/networkupstools/nut/master"
    alt="Latest GitHub checks status: master branch"/>
</a>
<!--
<a href="https://travis-ci.org/github/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://api.travis-ci.org/networkupstools/nut.svg?branch=master"
    alt="Latest Travis CI build status: master branch"/>
</a>
-->
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/master/">
  <img style="border:0;height:20"
    src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Fmaster"
    alt="Latest NUT CI build status: master branch"/>
</a>
<a href="https://build.opensuse.org/package/show/home:networkupstools:nut-stable/nut">
  <img style="border:0;height:20"
    src="https://build.opensuse.org/projects/home:networkupstools:nut-stable/packages/nut/badge.svg?type=percent"
    alt="Latest OBS build status: master branch packaged for different Linux distributions"/>
</a>
<!-- MacOS, maybe later Windows builds: -->
<a href="https://app.circleci.com/pipelines/github/networkupstools">
  <img style="border:0;height:20"
    src="https://circleci.com/gh/networkupstools/nut/tree/master.svg?style=svg"
    alt="Latest Circle CI build status: master branch"/>
</a>
<!-- Windows, maybe later MacOS builds: -->
<a href="https://ci.appveyor.com/project/nut-travis/nut/build/artifacts">
  <img style="border:0;height:20"
    src="https://ci.appveyor.com/api/projects/status/vrhkatid9hr7lq7r/branch/master?svg=true&failingText=Windows-FAIL&passingText=Windows-OK&pendingText-Windows-PENDING"
    alt="Latest AppVeyor build status (NUT for Windows iterations)"/>
</a>
<!--
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/fightwarn/">
  <img style="border:0;height:20"
    src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Ffightwarn&subject=Fightwarn%20Branch"
    alt="Latest NUT CI build status: fightwarn branch"/>
</a>
-->
<!--
<a href="https://github.com/networkupstools/nut/releases">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/v/release/networkupstools/nut"
    alt="Latest GitHub drafted NUT source release"/>
</a>
-->
<a href="https://github.com/networkupstools/nut/releases">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/v/tag/networkupstools/nut?sort=semver"
    alt="Latest Git-tagged NUT source release"/>
</a>
<!-- Maintainer note: for the counter below to work, a git tag
     is not sufficient -- a release must be drafted and published
     at https://github.com/networkupstools/nut/releases
     Counter URL may also be .../latest/BRANCHNAME -->
<a href="https://github.com/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/commits-since/networkupstools/nut/latest.svg"
    alt="Commits on master branch since latest release on GitHub"/>
</a>
<!-- See also:
 // https://web.archive.org/web/20200731075618/http://www.methods.co.nz/asciidoc/
 // https://github.com/asciidoc-py/asciidoc-py
 -->
<a href="https://asciidoc.org/">
  <img style="border:0;width:88px;height:31px"
    src="images/asciidoc.png"
    alt="Powered by AsciiDoc"/>
</a>
<a href="https://validator.w3.org/check?uri=referer">
  <img style="border:0;width:88px;height:31px"
    src="https://www.w3.org/Icons/valid-xhtml11-blue"
    alt="Valid XHTML 1.1"/>
</a>
<a href="https://jigsaw.w3.org/css-validator/check?uri=referer">
  <img style="border:0;width:88px;height:31px"
    src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
    alt="Valid CSS!"/>
</a>
<a href="https://www.gandi.net/">
  <img style="border:0;height:38px;"
       src="images/gandi-ar21.svg"
       alt="DNS, redirection and related services Hoster"/>
</a>
<!--
// FH web site defunct since ~Apr 2024
<a href="https://fosshost.org/">
  <img style="border:0;width:112px;height:38px;"
       src="images/ci/fosshost.org_Host_Light_38px.png"
       alt="Dedicated Hosting for NUT CI"/>
</a>
-->
<a href="https://www.digitalocean.com/?refcode=d2fbf2b9e082&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
  <img style="border:0;height:38px;"
       src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg"
       alt="Dedicated Hosting for NUT CI"/>
</a>
</div>
</div>
</div>
</div>
<!-- Google Analytics integration -->
<script type="text/javascript">

        var _gaq = _gaq || [];
        _gaq.push(['_setAccount', 'UA-9664272-1']);
        _gaq.push(['_trackPageview']);

        (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
        })();

</script>
<!-- Assume this footer is at the end of the page (after main contents)?
     Have a willing browser run the javascript to add permalinks: -->
<script type="text/javascript">anchors.add();</script>
</body>
</html>