You've already forked pgbackrest
mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-07-05 00:28:52 +02:00
272 lines
14 KiB
C
272 lines
14 KiB
C
|
/***********************************************************************************************************************************
|
||
|
|
Test Help Command
|
||
|
|
***********************************************************************************************************************************/
|
||
|
|
#include "config/parse.h"
|
||
|
|
#include "storage/storage.h"
|
||
|
|
#include "version.h"
|
||
|
|
|
||
|
|
/***********************************************************************************************************************************
|
||
|
|
Test Run
|
||
|
|
***********************************************************************************************************************************/
|
||
|
|
void testRun()
|
||
|
|
{
|
||
|
|
// Program name a version are used multiple times
|
||
|
|
const char *helpVersion = PGBACKREST_NAME " " PGBACKREST_VERSION;
|
||
|
|
|
||
|
|
// General help text is used in more than one test
|
||
|
|
const char *generalHelp = strPtr(strNewFmt(
|
||
|
|
"%s - General help\n"
|
||
|
|
"\n"
|
||
|
|
"Usage:\n"
|
||
|
|
" pgbackrest [options] [command]\n"
|
||
|
|
"\n"
|
||
|
|
"Commands:\n"
|
||
|
|
" archive-get Get a WAL segment from the archive.\n"
|
||
|
|
" archive-push Push a WAL segment to the archive.\n"
|
||
|
|
" backup Backup a database cluster.\n"
|
||
|
|
" check Check the configuration.\n"
|
||
|
|
" expire Expire backups that exceed retention.\n"
|
||
|
|
" help Get help.\n"
|
||
|
|
" info Retrieve information about backups.\n"
|
||
|
|
" restore Restore a database cluster.\n"
|
||
|
|
" stanza-create Create the required stanza data.\n"
|
||
|
|
" stanza-delete Delete a stanza.\n"
|
||
|
|
" stanza-upgrade Upgrade a stanza.\n"
|
||
|
|
" start Allow pgBackRest processes to run.\n"
|
||
|
|
" stop Stop pgBackRest processes from running.\n"
|
||
|
|
" version Get version.\n"
|
||
|
|
"\n"
|
||
|
|
"Use 'pgbackrest help [command]' for more information.\n",
|
||
|
|
helpVersion));
|
||
|
|
|
||
|
|
// *****************************************************************************************************************************
|
||
|
|
if (testBegin("helpRenderText()"))
|
||
|
|
{
|
||
|
|
TEST_RESULT_STR(
|
||
|
|
strPtr(helpRenderText(strNew("this is a short sentence"), 0, false, 80)), "this is a short sentence", "one line");
|
||
|
|
|
||
|
|
TEST_RESULT_STR(
|
||
|
|
strPtr(helpRenderText(strNew("this is a short sentence"), 4, false, 14)),
|
||
|
|
"this is a\n"
|
||
|
|
" short\n"
|
||
|
|
" sentence",
|
||
|
|
"three lines, no indent first");
|
||
|
|
|
||
|
|
TEST_RESULT_STR(
|
||
|
|
strPtr(helpRenderText(strNew("This is a short paragraph.\n\nHere is another one."), 2, true, 16)),
|
||
|
|
" This is a\n"
|
||
|
|
" short\n"
|
||
|
|
" paragraph.\n"
|
||
|
|
"\n"
|
||
|
|
" Here is\n"
|
||
|
|
" another one.",
|
||
|
|
"two paragraphs, indent first");
|
||
|
|
}
|
||
|
|
|
||
|
|
// *****************************************************************************************************************************
|
||
|
|
if (testBegin("helpRenderValue()"))
|
||
|
|
{
|
||
|
|
TEST_RESULT_STR(strPtr(helpRenderValue(varNewBool(true))), "y", "boolean y");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRenderValue(varNewBool(false))), "n", "boolean n");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRenderValue(varNewStrZ("test-string"))), "test-string", "string");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRenderValue(varNewDbl(1.234))), "1.234", "double");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRenderValue(varNewInt(1234))), "1234", "int");
|
||
|
|
}
|
||
|
|
|
||
|
|
// *****************************************************************************************************************************
|
||
|
|
if (testBegin("helpRender()"))
|
||
|
|
{
|
||
|
|
StringList *argList = NULL;
|
||
|
|
|
||
|
|
// -------------------------------------------------------------------------------------------------------------------------
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help from empty command line");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRender()), generalHelp, " check text");
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help from help command");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRender()), generalHelp, " check text");
|
||
|
|
|
||
|
|
// -------------------------------------------------------------------------------------------------------------------------
|
||
|
|
const char *commandHelp = strPtr(strNewFmt(
|
||
|
|
"%s - 'archive-push' command help\n"
|
||
|
|
"\n"
|
||
|
|
"Push a WAL segment to the archive.\n"
|
||
|
|
"\n"
|
||
|
|
"The WAL segment may be pushed immediately to the archive or stored locally\n"
|
||
|
|
"depending on the value of archive-async\n"
|
||
|
|
"\n"
|
||
|
|
"Command Options:\n"
|
||
|
|
"\n"
|
||
|
|
" --archive-async archive WAL segments asynchronously [default=n]\n"
|
||
|
|
" --archive-queue-max limit size (in bytes) of the PostgreSQL archive\n"
|
||
|
|
" queue\n"
|
||
|
|
" --archive-timeout archive timeout [default=60]\n"
|
||
|
|
"\n"
|
||
|
|
"General Options:\n"
|
||
|
|
"\n"
|
||
|
|
" --buffer-size buffer size for file operations [current=32768,\n"
|
||
|
|
" default=4194304]\n"
|
||
|
|
" --cmd-ssh path to ssh client executable [default=ssh]\n"
|
||
|
|
" --compress use gzip file compression [default=y]\n"
|
||
|
|
" --compress-level compression level for stored files [default=6]\n"
|
||
|
|
" --compress-level-network compression level for network transfer when\n"
|
||
|
|
" compress=n [default=3]\n"
|
||
|
|
" --config pgBackRest configuration file\n"
|
||
|
|
" [default=/etc/pgbackrest.conf]\n"
|
||
|
|
" --db-timeout database query timeout [default=1800]\n"
|
||
|
|
" --lock-path path where lock files are stored\n"
|
||
|
|
" [default=/tmp/pgbackrest]\n"
|
||
|
|
" --neutral-umask use a neutral umask [default=y]\n"
|
||
|
|
" --perl-bin path of Perl binary\n"
|
||
|
|
" --process-max max processes to use for compress/transfer\n"
|
||
|
|
" [default=1]\n"
|
||
|
|
" --protocol-timeout protocol timeout [default=1830]\n"
|
||
|
|
" --spool-path path where WAL segments are spooled during async\n"
|
||
|
|
" archiving [default=/var/spool/pgbackrest]\n"
|
||
|
|
" --stanza defines the stanza\n"
|
||
|
|
"\n"
|
||
|
|
"Log Options:\n"
|
||
|
|
"\n"
|
||
|
|
" --log-level-console level for console logging [default=warn]\n"
|
||
|
|
" --log-level-file level for file logging [default=info]\n"
|
||
|
|
" --log-level-stderr level for stderr logging [default=warn]\n"
|
||
|
|
" --log-path path where log files are stored\n"
|
||
|
|
" [default=/var/log/pgbackrest]\n"
|
||
|
|
" --log-timestamp enable timestamp in logging [default=y]\n"
|
||
|
|
"\n"
|
||
|
|
"Repository Options:\n"
|
||
|
|
"\n"
|
||
|
|
" --backup-cmd pgBackRest exe path on the backup host\n"
|
||
|
|
" --backup-config pgBackRest backup host configuration file\n"
|
||
|
|
" [default=/etc/pgbackrest.conf]\n"
|
||
|
|
" --backup-host backup host when operating remotely via SSH\n"
|
||
|
|
" [current=backup.example.net]\n"
|
||
|
|
" --backup-ssh-port backup server SSH port when backup-host is set\n"
|
||
|
|
" --backup-user backup host user when backup-host is set\n"
|
||
|
|
" [default=backrest]\n"
|
||
|
|
" --repo-cipher-pass repository cipher passphrase\n"
|
||
|
|
" --repo-cipher-type cipher used to encrypt the repository [default=none]\n"
|
||
|
|
" --repo-path path where backups and archive are stored\n"
|
||
|
|
" [default=/var/lib/pgbackrest]\n"
|
||
|
|
" --repo-s3-bucket s3 repository bucket\n"
|
||
|
|
" --repo-s3-ca-file s3 SSL CA File\n"
|
||
|
|
" --repo-s3-ca-path s3 SSL CA Path\n"
|
||
|
|
" --repo-s3-endpoint s3 repository endpoint\n"
|
||
|
|
" --repo-s3-host s3 repository host\n"
|
||
|
|
" --repo-s3-key s3 repository access key\n"
|
||
|
|
" --repo-s3-key-secret s3 repository secret access key\n"
|
||
|
|
" --repo-s3-region s3 repository region\n"
|
||
|
|
" --repo-s3-verify-ssl verify S3 server certificate [default=y]\n"
|
||
|
|
" --repo-type type of storage used for the repository\n"
|
||
|
|
" [default=posix]\n"
|
||
|
|
"\n"
|
||
|
|
"Stanza Options:\n"
|
||
|
|
"\n"
|
||
|
|
" --db-host cluster host for operating remotely via SSH\n"
|
||
|
|
" --db-path cluster data directory\n"
|
||
|
|
" --db-ssh-port database server SSH port when db-host is set\n"
|
||
|
|
"\n"
|
||
|
|
"Use 'pgbackrest help archive-push [option]' for more information.\n",
|
||
|
|
helpVersion));
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, "--buffer-size=32768");
|
||
|
|
strLstAddZ(argList, "--backup-host=backup.example.net");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help for archive-push command");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRender()), commandHelp, " check text");
|
||
|
|
|
||
|
|
// -------------------------------------------------------------------------------------------------------------------------
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, "buffer-size");
|
||
|
|
strLstAddZ(argList, "buffer-size");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "parse too many options");
|
||
|
|
TEST_ERROR(helpRender(), ParamInvalidError, "only one option allowed for option help");
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, BOGUS_STR);
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "parse bogus option");
|
||
|
|
TEST_ERROR(helpRender(), OptionInvalidError, "option 'BOGUS' is not valid for command 'archive-push'");
|
||
|
|
|
||
|
|
// -------------------------------------------------------------------------------------------------------------------------
|
||
|
|
const char *optionHelp = strPtr(strNewFmt(
|
||
|
|
"%s - 'archive-push' command - 'buffer-size' option help\n"
|
||
|
|
"\n"
|
||
|
|
"Buffer size for file operations.\n"
|
||
|
|
"\n"
|
||
|
|
"Set the buffer size used for copy, compress, and uncompress functions. A\n"
|
||
|
|
"maximum of 3 buffers will be in use at a time per process. An additional\n"
|
||
|
|
"maximum of 256K per process may be used for zlib buffers.\n",
|
||
|
|
helpVersion));
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, "buffer-size");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, buffer-size option");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRender()), strPtr(strNewFmt("%s\ndefault: 4194304\n", optionHelp)), " check text");
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, "buffer-size");
|
||
|
|
strLstAddZ(argList, "--buffer-size=32768");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, buffer-size option");
|
||
|
|
TEST_RESULT_STR(
|
||
|
|
strPtr(helpRender()), strPtr(strNewFmt("%s\ncurrent: 32768\ndefault: 4194304\n", optionHelp)), " check text");
|
||
|
|
|
||
|
|
// -------------------------------------------------------------------------------------------------------------------------
|
||
|
|
optionHelp = strPtr(strNewFmt(
|
||
|
|
"%s - 'archive-push' command - 'perl-bin' option help\n"
|
||
|
|
"\n"
|
||
|
|
"Path of Perl binary.\n"
|
||
|
|
"\n"
|
||
|
|
"Path of the Perl binary if /usr/bin/env perl won't work.\n",
|
||
|
|
helpVersion));
|
||
|
|
|
||
|
|
argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
strLstAddZ(argList, "help");
|
||
|
|
strLstAddZ(argList, "archive-push");
|
||
|
|
strLstAddZ(argList, "perl-bin");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, perl-bin option");
|
||
|
|
TEST_RESULT_STR(strPtr(helpRender()), optionHelp, " check text");
|
||
|
|
}
|
||
|
|
|
||
|
|
// *****************************************************************************************************************************
|
||
|
|
if (testBegin("cmdHelp()"))
|
||
|
|
{
|
||
|
|
StringList *argList = strLstNew();
|
||
|
|
strLstAddZ(argList, "/path/to/pgbackrest");
|
||
|
|
TEST_RESULT_VOID(configParse(strLstSize(argList), strLstPtr(argList)), "parse help from empty command line");
|
||
|
|
|
||
|
|
// Redirect stdout to a file
|
||
|
|
int stdoutSave = dup(STDOUT_FILENO);
|
||
|
|
String *stdoutFile = strNewFmt("%s/stdout.help", testPath());
|
||
|
|
THROW_ON_SYS_ERROR(freopen(strPtr(stdoutFile), "w", stdout) == NULL, FileWriteError, "unable to reopen stdout");
|
||
|
|
|
||
|
|
// Not in a test wrapper to avoid writing to stdout
|
||
|
|
cmdHelp();
|
||
|
|
|
||
|
|
// Restore normal stdout
|
||
|
|
dup2(stdoutSave, STDOUT_FILENO);
|
||
|
|
|
||
|
|
Storage *storage = storageNew(strNew(testPath()), 0750, 65536, NULL);
|
||
|
|
TEST_RESULT_STR(strPtr(strNewBuf(storageGet(storage, stdoutFile, false))), generalHelp, " check text");
|
||
|
|
}
|
||
|
|
}
|