<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Build Result Codes — Buildbot 0.8.8 documentation</title> <link rel="stylesheet" href="../_static/agogo.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '0.8.8', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="shortcut icon" href="../_static/buildbot.ico"/> <link rel="top" title="Buildbot 0.8.8 documentation" href="../index.html" /> <link rel="up" title="Buildbot Development" href="index.html" /> <link rel="next" title="File Formats" href="formats.html" /> <link rel="prev" title="Database" href="database.html" /> </head> <body> <div class="header-wrapper"> <div class="header"> <p class="logo"><a href="../index.html"> <img class="logo" src="../_static/header-text-transparent.png" alt="Logo"/> </a></p> <div class="headertitle"><a href="../index.html">Buildbot 0.8.8 documentation</a></div> <div class="rel"> <a href="database.html" title="Database" accesskey="P">previous</a> | <a href="formats.html" title="File Formats" accesskey="N">next</a> | <a href="../py-modindex.html" title="Python Module Index" >modules</a> | <a href="../genindex.html" title="General Index" accesskey="I">index</a> </div> </div> </div> <div class="content-wrapper"> <div class="content"> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-buildbot.status.results"> <span id="id1"></span><span id="build-result-codes"></span><h1>Build Result Codes<a class="headerlink" href="#module-buildbot.status.results" title="Permalink to this headline">¶</a></h1> <p>Buildbot represents the status of a step, build, or buildset using a set of numeric constants. From Python, these constants are available in the module <tt class="docutils literal"><span class="pre">buildbot.status.results</span></tt>, but the values also appear in the database and in external tools, so the values are fixed.</p> <dl class="data"> <dt id="buildbot.status.results.SUCCESS"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">SUCCESS</tt><a class="headerlink" href="#buildbot.status.results.SUCCESS" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 0; color: green; a successful run.</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.WARNINGS"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">WARNINGS</tt><a class="headerlink" href="#buildbot.status.results.WARNINGS" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 1; color: orange; a successful run, with some warnings.</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.FAILURE"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">FAILURE</tt><a class="headerlink" href="#buildbot.status.results.FAILURE" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 2; color: red; a failed run, due to problems in the build itself, as opposed to a Buildbot misconfiguration or bug.</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.SKIPPED"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">SKIPPED</tt><a class="headerlink" href="#buildbot.status.results.SKIPPED" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 3; color: white; a run that was skipped -- usually a step skipped by <tt class="docutils literal"><span class="pre">doStepIf</span></tt> (see <a class="reference internal" href="../manual/cfg-buildsteps.html#buildstep-common-parameters"><em>Common Parameters</em></a>)</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.EXCEPTION"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">EXCEPTION</tt><a class="headerlink" href="#buildbot.status.results.EXCEPTION" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 4; color: purple; a run that failed due to a problem in Buildbot itself.</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.RETRY"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">RETRY</tt><a class="headerlink" href="#buildbot.status.results.RETRY" title="Permalink to this definition">¶</a></dt> <dd><p>Value: 4; color: purple; a run that should be retried, usually due to a slave disconnection.</p> </dd></dl> <dl class="data"> <dt id="buildbot.status.results.Results"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">Results</tt><a class="headerlink" href="#buildbot.status.results.Results" title="Permalink to this definition">¶</a></dt> <dd><p>A dictionary mapping result codes to their lowercase names.</p> </dd></dl> <dl class="function"> <dt id="buildbot.status.results.worst_status"> <tt class="descclassname">buildbot.status.results.</tt><tt class="descname">worst_status</tt><big>(</big><em>a</em>, <em>b</em><big>)</big><a class="headerlink" href="#buildbot.status.results.worst_status" title="Permalink to this definition">¶</a></dt> <dd><p>This function takes two status values, and returns the "worst" status of the two. This is used (with exceptions) to aggregate step statuses into build statuses, and build statuses into buildset statuses.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sidebar"> <h3>Table Of Contents</h3> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Buildbot Tutorial</a></li> <li class="toctree-l1"><a class="reference internal" href="../manual/index.html">Buildbot Manual</a></li> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Buildbot Development</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="master-overview.html">Master Organization</a></li> <li class="toctree-l2"><a class="reference internal" href="definitions.html">Definitions</a></li> <li class="toctree-l2"><a class="reference internal" href="style.html">Buildbot Coding Style</a></li> <li class="toctree-l2"><a class="reference internal" href="tests.html">Buildbot's Test Suite</a></li> <li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="config.html#error-handling">Error Handling</a></li> <li class="toctree-l2"><a class="reference internal" href="config.html#reconfiguration">Reconfiguration</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="database.html">Database</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="">Build Result Codes</a></li> <li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li> <li class="toctree-l2"><a class="reference internal" href="webstatus.html">Web Status</a></li> <li class="toctree-l2"><a class="reference internal" href="master-slave.html">Master-Slave API</a></li> <li class="toctree-l2"><a class="reference internal" href="encodings.html">String Encodings</a></li> <li class="toctree-l2"><a class="reference internal" href="metrics.html">Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="classes.html">Classes</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../relnotes/index.html">Release Notes for Buildbot v0.8.8</a></li> </ul> <h3 style="margin-top: 1.5em;">Search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <div class="clearer"></div> </div> </div> <div class="footer-wrapper"> <div class="footer"> <div class="left"> <a href="database.html" title="Database" >previous</a> | <a href="formats.html" title="File Formats" >next</a> | <a href="../py-modindex.html" title="Python Module Index" >modules</a> | <a href="../genindex.html" title="General Index" >index</a> <br/> <a href="../_sources/developer/results.txt" rel="nofollow">Show Source</a> </div> <div class="right"> <div class="footer"> © Copyright Buildbot Team Members. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </div> <div class="clearer"></div> </div> </div> </body> </html>