<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE doc SYSTEM "doc.dtd">
<doc title="{[project]}" subtitle="Contributing to {[project]}" toc="y" cmd-line-len="132">
    <description>{[project]} Contributing Guidelines.</description>

    <!-- Variables used by the rest of the script ============================================================================== -->
    <variable-list>
        <variable key="host-user-id" eval="y">use English; $UID</variable>

        <!-- Options to pass to test.pl so log output is reproducible -->
        <variable key="test-cmd-extra">--no-log-timestamp</variable>

        <variable key="host-contrib-id">contrib</variable>
        <variable key="host-contrib">pgbackrest-dev</variable>
        <variable key="host-contrib-user">{[host-user]}</variable>
        <variable key="host-contrib-image">pgbackrest/doc:contrib</variable>

        <variable key="cwd" eval="y">use Cwd qw(cwd); cwd()</variable>
    </variable-list>

    <!-- Setup hosts used to build the documentation =========================================================================== -->
    <host-define if="{[os-type-is-debian]}" image="{[host-contrib-image]}" from="ubuntu:19.04">
        {[copy-ca-cert]}

        # Fix root tty
        RUN sed -i 's/^mesg n/tty -s \&amp;\&amp; mesg n/g' /root/.profile &amp;&amp; \

        # Suppress dpkg interactive output
            rm /etc/apt/apt.conf.d/70debconf

        # Install base packages
        RUN apt-get update &amp;&amp; \
            apt-get install -y sudo ssh curl vim 2>&amp;1

        # Add test user with sudo privileges
        RUN adduser --disabled-password --uid={[host-user-id]} --gecos "" {[host-user]} &amp;&amp; \
            echo '%{[host-user]} ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers

        WORKDIR /home/{[host-user]}

        ENTRYPOINT service ssh restart &amp;&amp; bash
    </host-define>

    <!-- ======================================================================================================================= -->
    <section id="introduction">
        <title>Introduction</title>

        <p>This documentation is intended to assist contributors to <backrest/> by outlining some basic steps and guidelines for contributing to the project.  Coding standards to follow are defined in <link url="{[github-url-master]}/CODING.md">CODING.md</link>. At a minimum, unit tests must be written and run and the documentation generated before submitting a Pull Request; see the <link section="/testing">Testing</link> section below for details.</p>
    </section>

    <!-- ======================================================================================================================= -->
    <section id="environment">
        <title>Building a Development Environment</title>

        <p>This example is based on <proper>Ubuntu 19.04</proper>, but it should work on many versions of <proper>Debian</proper> and <proper>Ubuntu</proper>.</p>

        <host-add id="{[host-contrib-id]}" name="{[host-contrib]}" user="{[host-contrib-user]}" image="{[host-contrib-image]}" os="u19" option="-v /var/run/docker.sock:/var/run/docker.sock -v {[cwd]}/test:{[cwd]}/test" mount="/home/{[host-contrib-user]}/pgbackrest:/home/{[host-contrib-user]}/pgbackrest"/>

        <execute-list host="{[host-contrib]}">
            <title>Install development tools</title>

            <execute user="root" pre="y">
                <exe-cmd>
                    apt-get install rsync git devscripts build-essential valgrind lcov autoconf
                    autoconf-archive libssl-dev zlib1g-dev libxml2-dev libpq-dev pkg-config
                    libxml-checker-perl libyaml-libyaml-perl libdbd-pg-perl liblz4-dev liblz4-tool
                </exe-cmd>
                <exe-cmd-extra>-y 2>&amp;1</exe-cmd-extra>
            </execute>

            <!-- Clean so the tests give consistent output -->
            <execute show="n">
                <exe-cmd>
                    pgbackrest/test/test.pl --clean-only
                </exe-cmd>
            </execute>
        </execute-list>

        <p>Some unit tests and all the integration test require <proper>Docker</proper>.  Running in containers allows us to simulate multiple hosts, test on different distributions and versions of <postgres/>, and use sudo without affecting the host system.</p>

        <execute-list host="{[host-contrib]}">
            <title>Install Docker</title>

            <execute pre="y">
                <exe-cmd>curl -fsSL https://get.docker.com | sudo sh</exe-cmd>
                <exe-cmd-extra>2>&amp;1</exe-cmd-extra>
            </execute>

            <execute user="root">
                <exe-cmd>
                    usermod -aG docker `whoami`
                </exe-cmd>
            </execute>
        </execute-list>

        <p>This clone of the <backrest/> repository is sufficient for experimentation.  For development, create a fork and clone that instead.</p>

        <execute-list host="{[host-contrib]}">
            <title>Clone <backrest/> repository</title>

            <execute skip="y">
                <exe-cmd>
                    git clone https://github.com/pgbackrest/pgbackrest.git
                </exe-cmd>
            </execute>
        </execute-list>
    </section>

    <section id="running">
        <title>Running Tests</title>

        <section id="without-docker">
            <title>Without Docker</title>

            <p>If <proper>Docker</proper> is not installed, then the available tests can be listed using <setting>--vm-none</setting>.</p>

            <execute-list host="{[host-contrib]}">
                <title>List tests that don't require a container</title>

                <execute output="y">
                    <exe-cmd>pgbackrest/test/test.pl --vm=none --dry-run</exe-cmd>
                    <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
                    <exe-highlight>[0-9]+ tests selected|DRY RUN COMPLETED SUCCESSFULLY</exe-highlight>
                </execute>
            </execute-list>

            <p>Once a test has been selected it can be run by specifying the module and test.  The <setting>--dev</setting> option sets several flags that are appropriate for development rather than test.  Most importantly, it reuses object files from the previous test run to speed testing.  The <setting>--vm-out</setting> option displays the test output.</p>

            <execute-list host="{[host-contrib]}">
                <title>Run a test</title>

                <execute output="y">
                    <exe-cmd>pgbackrest/test/test.pl --vm=none --dev --vm-out --module=common --test=wait</exe-cmd>
                    <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
                </execute>
            </execute-list>

            <p>An entire module can be run by using only the <setting>--module</setting> option.</p>

            <execute-list host="{[host-contrib]}">
                <title>Run a module</title>

                <execute output="y">
                    <exe-cmd>pgbackrest/test/test.pl --vm=none --dev --module=postgres</exe-cmd>
                    <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
                </execute>
            </execute-list>
        </section>

        <section id="with-docker" depend="/environment">
            <title>With Docker</title>

            <p>Build a container to run tests.  The vm must be pre-configured but a variety are available.  The vm names are all three character abbreviations, e.g. <id>u19</id> for <proper>Ubuntu 19.04</proper>.</p>

            <execute-list host="{[host-contrib]}">
                <title>Build a VM</title>

                <execute output="y">
                    <exe-cmd>pgbackrest/test/test.pl --vm-build --vm=u19</exe-cmd>
                    <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
                </execute>
            </execute-list>

            <execute-list host="{[host-contrib]}">
                <title>Run a Test</title>

                <execute output="y">
                    <exe-cmd>pgbackrest/test/test.pl {[dash]}-vm=u19 {[dash]}-dev {[dash]}-module=mock {[dash]}-test=archive {[dash]}-run=2</exe-cmd>
                    <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
                </execute>
            </execute-list>
        </section>
    </section>

    <section id="option">
        <title>Adding an Option</title>

        <p>Options can be added to a command or multiple commands. Options can be configuration file only, command-line only or valid for both. Once an option is added, <file>config.auto.*</file>, <file>define.auto.*</file> and <file>parse.auto.*</file> files will automatically be generated by the build system.</p>

        <p> To add an option, two files need be to be modified:</p>
        <list>
            <list-item><file>build/lib/pgBackRestBuild/Config/Data.pm</file></list-item>
            <list-item><file>doc/xml/reference.xml</file></list-item>
        </list>

        <p>These files are discussed in the following sections.</p>

        <section id="data-file">
            <title>Data.pm</title>

            <p>There is a detailed comment at the top of this file on the configuration definitions which one can refer to in determining how to define the rules for the option.</p>

            <section id="command-line-only">
                <title>Command Line Only Options</title>

                <p>Command-line only options are options where <id>CFGDEF_SECTION</id> rule is not defined. There are two sections to be updated when adding a command-line only option, each of which is marked by the comment <code>Command-line only options</code>.</p>

                <list>
                    <list-item><b>Section 1:</b> Find the first section with the <code>Command-line only options</code> comment. This section defines and exports the constant for the actual option.</list-item>
                    <list-item><b>Section 2:</b> Find the second section with the <code>Command-line only options</code> comment. This is where the rules for the option are defined.</list-item>
                </list>

                <p>The steps for how to update these sections are detailed below.</p>

                <p><b>Section 1</b></p>

                <p>Copy the two lines (<quote>use constant</quote>/<quote>push</quote>) of an existing option and paste them where the option would be in alphabetical order and rename it to the same name as the new option name. For example CFGOPT_DRY_RUN, defined as <quote>dry-run</quote>.</p>

                <p><b>Section 2</b></p>

                <p>To better explain this section, <id>CFGOPT_ONLINE</id> will be used as an example:</p>

                <code-block>
    &amp;CFGOPT_ONLINE =>
    {
        &amp;CFGDEF_TYPE => CFGDEF_TYPE_BOOLEAN,
        &amp;CFGDEF_NEGATE => true,
        &amp;CFGDEF_DEFAULT => true,
        &amp;CFGDEF_COMMAND =>
        {
            &amp;CFGCMD_BACKUP => {},
            &amp;CFGCMD_STANZA_CREATE => {},
            &amp;CFGCMD_STANZA_UPGRADE => {},
        }
    },
                </code-block>

                <p>Note that <id>CFGDEF_SECTION</id> is not present thereby making this a command-line only option. Each line is explained below:</p>

                <list>
                    <list-item><id>CFGOPT_ONLINE</id> - the name of the option as defined in <b>Section 1</b></list-item>
                    <list-item><id>CFGDEF_TYPE</id> - the type of the option. Valid types are: <id>CFGDEF_TYPE_BOOLEAN</id>, <id>CFGDEF_TYPE_FLOAT</id>, <id>CFGDEF_TYPE_HASH</id>, <id>CFGDEF_TYPE_INTEGER</id>, <id>CFGDEF_TYPE_LIST</id>, <id>CFGDEF_TYPE_PATH</id>, <id>CFGDEF_TYPE_SIZE</id>, and <id>CFGDEF_TYPE_STRING</id>
                    </list-item>
                    <list-item><id>CFGDEF_NEGATE</id> - being a command-line only boolean option, this rule would automatically default to false so it must be defined if the option is negatable. Ask yourself if negation makes sense, for example, would a --dry-run option make sense as --no-dry-run? If the answer is no, then this rule can be omitted as it would automatically default to false. Any boolean option that cannot be negatable, must be a command-line only and not a configuration file option as all configuration boolean options must be negatable.</list-item>
                    <list-item><id>CFGDEF_DEFAULT</id> - sets a default for the option if the option is not provided when the command is run. The default can be global or it can be specified for a specific command in the <id>CFGDEF_COMMAND</id> section. For example, if it was desirable for the default to be false for the <id>CFGCMD_STANZA_CREATE</id> then CFGDEF_NEGATE =>  would be set to <id>true</id> in each command listed except for <id>CFGCMD_STANZA_CREATE</id> where it would be <id>false</id> and it would not be specified (as it is here) in the global section (meaning global for all commands listed).</list-item>
                    <list-item><id>CFGDEF_COMMAND</id> - list each command for which the option is valid. If a command is not listed, then the option is not valid for the command and an error will be thrown if it attempted to be used for that command.</list-item>
                </list>

            </section>
        </section>

        <section id="reference-file">
            <title>reference.xml</title>

            <p>All options must be documented or the system will error during the build.  To add an option, find the command section identified by <code>command id="COMMAND"</code> section where <id>COMMAND</id> is the name of the command (e.g. <cmd>expire</cmd>) or, if the option is used by more than one command and the definition for the option is the same for all of the commands, the <code>operation-general title="General Options"</code> section.</p>

            <p>To add an option, add the following to the <code>&lt;option-list&gt;</code> section; if it does not exist, then wrap the following in <code>&lt;option-list&gt;</code> <code>&lt;/option-list&gt;</code>. This example uses the boolean option <code>force</code> of the <cmd>restore</cmd> command. Simply replace that with your new option and the appropriate <code>summary</code>, <code>text</code> and <code>example</code>.</p>

            <code-block>
&lt;option id="force" name="Force"&gt;
    &lt;summary&gt;Force a restore.&lt;/summary&gt;

    &lt;text&gt;By itself this option forces the &lt;postgres/&gt; data and tablespace paths to be completely overwritten.  In combination with &lt;br-option&gt;--delta&lt;/br-option&gt; a timestamp/size delta will be performed instead of using checksums.&lt;/text&gt;

    &lt;example>y&lt;/example&gt;
&lt;/option&gt;
            </code-block>
            <admonition type="important">currently a period (.) is required to end the <code>summary</code> section.</admonition>
        </section>
    </section>

    <section id="testing">
        <title>Testing</title>

        <p>For testing, it is recommended that Vagrant and Docker be used; instructions are provided in the <file>README.md</file> file of the <backrest/> <link url="{[github-url-master]}/test">test</link> directory. A list of all possible test combinations can be viewed by running:</p>
        <code-block>
            /backrest/test/test.pl --dry-run
        </code-block>

        <admonition type="warning">currently the <id>BACKREST_USER</id> in <file>ContainerTest.pm</file> must exist, or the test suite will fail with a string concatenation error.</admonition>

        <p>If using a RHEL system, the CPAN XML parser is required for running <file>test.pl</file> and <file>doc.pl</file>. Instructions for installing Docker and the XML parse can be found in the <file>README.md</file> file of the <backrest/> <link url="{[github-url-master]}/doc">doc</link> directory in the section <quote>The following is a sample CentOS/RHEL 7 configuration that can be used for building the documentation</quote>. NOTE that the <code>Install latex (for building PDF)</code> is not required since testing of the docs need only be run for HTML output.</p>

        <p>While some files are automatically generated during <code>make</code>, others are generated by running the test harness as follows:</p>

        <code-block>
            /backrest/test/test.pl --gen-only
        </code-block>

        <p>Prior to any submission, the html version of the documentation should also be run.</p>

        <code-block>
            /backrest/doc/doc.pl --out=html
        </code-block>

        <admonition type="note"><code>ERROR: [028]</code> regarding cache is invalid is OK; it just means there have been changes and the documentation will be built from scratch. In this case, be patient as the build could take 20 minutes or more depending on your system.</admonition>

        <section id="unit-test">
            <title>Writing a Unit Test</title>

            <p>The goal of unit testing is to have 100 percent coverage. Two files will usually be involved in this process:</p>

            <list>
                <list-item><b>define.yaml</b> - defines the number of tests to be run for each module and test file. There is a comment at the top of the file that provides more information about this file.</list-item>
                <list-item><b>src/module/somefileTest.c</b> - where <quote>somefile</quote> is the path and name of the test file where the unit tests are located for the code being updated (e.g. <file>src/module/command/expireTest.c</file>).</list-item>
            </list>

            <section id="define-yaml">
                <title>define.yaml</title>

                <p>Each module is separated by a line of asterisks (*) and each test within is separated by a line of dashes (-). In the example below, the module is <code>command</code> and the unit test is <code>check</code>. The number of calls to <code>testBegin()</code> in a unit test file will dictate the number following <code>total:</code>, in this case 2. Under <code>coverage:</code>, the list of files that will be tested must be listed followed by the coverage level, which should always be <code>full</code>.</p>

                <code-block>
  # ********************************************************************************************************************************
  - name: command

    test:
      # ----------------------------------------------------------------------------------------------------------------------------
      - name: check
        total: 2

        coverage:
          command/check/common: full
          command/check/check: full
                </code-block>

            </section>

            <section id="test-file">
                <title>somefileTest.c</title>
                <p>Assuming that a test file already exists, new unit tests will either go in a new <code>testBegin()</code> section or be added to an existing section.</p>

                <p>Unit test files are organized in the test/src/module directory with the same directory structure as the source code being tested. For example, if new code is added to src/<b>command/expire</b>.c then test/src/module/<b>command/expire</b>Test.c will need to be updated.</p>

                <code-block>
// *****************************************************************************************************************************
if (testBegin("expireBackup()"))
                </code-block>

                <p><b>Setting up the command to be run</b></p>
                <p>If configuration options are required then a string list with the command and options must be defined and passed to the function <code>harnessCfgLoad()</code>. For example, the following will set up a test to run <cmd>pgbackrest --repo-path=test/test-0/repo info</cmd> command:</p>

                <code-block>
String *repoPath = strNewFmt("%s/repo", testPath());                    // create a string defining the repo path on the test system
StringList *argList = strLstNew();                                      // create an empty string list
strLstAdd(argList, strNewFmt("--repo-path=%s/", strPtr(repoPath)));     // add the --repo-path option as a formatted string
strLstAddZ(argList, "info");                                            // add the command
harnessCfgLoad(cfgCmdExpire, argList);                                  // load the command and option list into the test harness

TEST_RESULT_STR_Z(infoRender(), "No stanzas exist in the repository.\n", "text - no stanzas");  // run the test
                </code-block>

                <p>Tests are run via macros. All test macros expect the first parameter to be the function to call that is being tested. With the exception of TEST_RESULT_VOID, the second parameter is the expected result, and with the exception of TEST_ERROR, the third parameter is a short description of the test. The most common macros are:</p>

                <list>
                    <list-item><id>TEST_RESULT_STR</id> - Test the actual value of the string returned by the function.</list-item>
                    <list-item><id>TEST_RESULT_UINT</id> / <id>TEST_RESULT_INT</id> - Test for an unsigned integer / integer.</list-item>
                    <list-item><id>TEST_RESULT_BOOL</id> - Test a boolean return value.</list-item>
                    <list-item><id>TEST_RESULT_PTR</id> / <id>TEST_RESULT_PTR_NE</id> - Test a pointer: useful for testing if the pointer is <id>NULL</id> or not equal (<id>NE</id>) to <id>NULL</id>.</list-item>
                    <list-item><id>TEST_RESULT_VOID</id> - The function being tested returns a <code>void</code>. This is then usually followed by tests that ensure other actions occurred (e.g. a file was written to disk).</list-item>
                    <list-item><id>TEST_ERROR</id> / <id>TEST_ERROR_FMT</id> - Test for that a specific error code was raised with specific wording.</list-item>
                </list>

                <p><b>Storing a file</b></p>
                <p>Sometimes it is necessary to store a file to the test directory. The following demonstrates that. It is not necessary to wrap the storagePutNP in TEST_RESULT_VOID, but doing so allows a short description to be displayed when running the tests (in this case <quote>store a corrupt backup.info file</quote>).</p>

                <code-block>
String *content = strNew("bad content");
TEST_RESULT_VOID(
    storagePutP(storageNewWriteP(storageTest, strNewFmt("%s/backup/demo/backup.info", strPtr(repoPath))),
        harnessInfoChecksum(content)), "store a corrupt backup.info file");
                </code-block>

                <p><b>Testing a log message</b></p>
                <p>If a function being tested logs something with <id>LOG_WARN</id>, <id>LOG_INFO</id> or other <id>LOG_</id> macro, then the logged message must be cleared before the end of the test by using the <code>harnessLogResult()</code> function.</p>

                <code-block>
harnessLogResult(
    "P00   WARN: WAL segment '000000010000000100000001' was not pushed due to error [25] and was manually skipped: error");
                </code-block>
            </section>
        </section>

        <section id="unit-test-run">
            <title>Running a Unit Test</title>

            <p>Unit tests are run, and coverage of the code being tested is provided, by running the following. This example would run the test set from the <b>define.yaml</b> section detailed above.</p>

            <code-block>
/backrest/test/test.pl --vm-out --dev --module=command --test=check --coverage-only
            </code-block>

            <p>Because no test run is specified and <code>--coverage-only</code> has been requested, a coverage report will be generated and written to the local file system under the <backrest/> directory <file>test/result/coverage</file> (or <file>test/coverage</file> prior to version 2.25) and will highlight code that has not been tested.</p>

            <p>Sometimes it is useful to look at files that were generated during the test. The default for running any test is that, at the start/end of the test, the test harness will clean up all files and directories created. To override this behavior, a single test run must be specified and the option <code>--no-cleanup</code> provided. Again, continuing with the check command, we see in <b>define.yaml</b> above that there are two tests. Below, test one will be run and nothing will be cleaned up so that the files and directories in test/test-0 can be inspected.</p>

            <code-block>
/backrest/test/test.pl --vm-out --dev --module=command --test=check --coverage-only --run=1 --no-cleanup
            </code-block>

            <p> For more details on running tests, again, please refer to the <file>README.md</file> file of the <backrest/> <link url="{[github-url-master]}/test">test</link> directory.</p>
        </section>
    </section>
</doc>
