A framework for creating and executing performance tests on PCP brokers.
Assuming the above packages installed, you simply:
mkdir build && cd build
cmake ..
make -j
pcp-test requires SSL certificates signed by the same Certificate Authorithy
as the one used by the PCP brokers under test. You can use puppet cert for
that; please refer to the pcp-broker docs.
The directory that contains the certificates can be specified by the
--certificates-dir option. The default directory is
pcp-test/dev-resources/pcp-certificates. The requirements for storing the
certificate files are explained in this document.
The compressed file pcp-certificates.tar.gz, located in the
test-resources directory, includes SSL certificates that
allow executing pcp-test with up to 6000 pairs of agent / controllers nodes.
To retrieve pcp-certificates.tar.gz you need to use:
git lfs fetch && git lfs checkout
You can then un-archive it in the <PCP_TEST_ROOT>/dev-resources; by doing so,
you'll have the certificates directory tree in the default --certificates-dir
path (see the option description below). Note that the dev-resources directory
is included in pcp-test's .gitignore, so it won't affect update operations on
your local repo. In alternative, if you want to use a different location, you
just need to specify it with --certificates-dir.
pcp-test is invoked by command line as:
pcp-test <test-type> global-options
test-types are:
trivial: a trivial test with 1 controller and 2 agents; no specific option is available for this testconnection: creates a number of PCP connections concurrently; more details here
global-options are:
-h [ --help ] produce help message
-v [ --version ] print the version and exit
--loglevel arg pcp-test log level (none, trace, debug, info, warning, error, fatal)
--client-loglevel arg client lib log level (none, trace, debug, info, warning, error, fatal)
--logfile arg log file
--config-file arg configuration file (mandatory);
defaults to /etc/puppetlabs/pcp-test/pcp-test.conf
-u [ --broker-ws-uris ] arg PCP broker WebSocket URIs
--certificates-dir arg SSL certificates path (see doc for the expected directory tree structure);
defaults to <PCP_TEST_ROOT>/dev-resources/pcp-certificates
--results-dir arg results directory; defaults to /opt/puppetlabs/pcp-test/results
Other options are specific to each test-type and can be only specified in the
configuration file, in JSON format. Note that global-options can also be
specified in the configuration file, without the double hyphen prefix.
An example of configuration file is:
{
"logfile" : "~/logs/pcp-test.log",
"loglevel" : "trace",
"client-loglevel" : "info",
"broker-ws-uris" : ["wss://broker01.example.com:8142/pcp",
"wss://broker02.example.com:8142/pcp"],
"connection-test-parameters" : {
"num-runs" : 1,
"inter-run-pause-ms" : 5000,
"num-endpoints" : 1,
"inter-endpoint-pause-ms" : 150,
"randomize-inter-endpoint-pause" : true,
"inter-endpoint-pause-rng-seed" : 42,
"concurrency" : 1,
"endpoints-increment" : 0,
"concurrency-increment" : 0,
"ws-connection-timeout-ms" : 500,
"ws-connection-check-interval-s" : 30,
"association-timeout-s" : 1,
"association-request-ttl-s" : 1,
"persist-connections" : true,
"show-stats" : true
}
}
Results will be shown on standard out and written on a text file in CSV format.
Results files will be stored in the specified results-dir and named as
<test-type>_<date-time>.csv.
Maintainers: Alessandro Parisi alessandro@puppet.com, Michael Smith michael.smith@puppet.com, Michal Ruzicka michal.ruzicka@puppet.com.
Contributing: Please refer to this document.
Tickets: File bug tickets at https://tickets.puppet.com/browse/PCP and add the
pcp-test component to the ticket.