db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-14 10:13:05 +02:00
Code Issues Releases Activity
c8ea17c68f
pgbackrest/test/define.yaml

945 lines
31 KiB
YAML
Raw Normal View History

Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# **********************************************************************************************************************************
# Test Definition
#
# Contains definitions for all unit and integration tests.
#
# The definitions consist of modules and tests. Modules group together tests that are related and allow common settings for all the
# tests. Every module and test must have a name. Tests must also have a total. If this total does not match the actual number of
# runs in a test then an error will be thrown.
#
# Most options can be set for modules and tests (test option will override module option if both are set):
# * db - determines if the test will be run against multiple db versions
Improve single test run performance. Improve on 7794ab50 by including the build flag files directly into the Makefile as dependencies (even though they are not includes). This simplifies some of the rsync logic and allows make to do what it does best. Also split build flag files into test, harness, and build to reduce rebuilds. Test flags are used to build test.c, harness flags are used to build the rest of the files in the test harness, and build flags are used for the files that are not directly involved in testing.
2018-11-03 22:34:04 +02:00
# * define - defines for C code (will also be applied to the test harness)
pgBackRest is now pure C. Remove embedded Perl from the distributed binary. This includes code, configure, Makefile, and packages. The distributed binary is now pure C. Remove storagePathEnforceSet() from the C Storage object which allowed Perl to write outside of the storage base directory. Update mock/all and real/all integration tests to use storageLocal() where they were violating this rule. Remove "c" option that allowed the remote to tell if it was being called from C or Perl. Code to convert options to JSON for passing to Perl (perl/config.c) has been moved to LibC since it is still required for Perl integration tests. Update build and installation instructions in the user guide. Remove all Perl unit tests. Remove obsolete Perl code. In particular this included all the Perl protocol code which required modifications to the Perl storage, manifest, and db objects that are still required for integration testing but only run locally. Any remaining Perl code is required for testing, documentation, or code generation. Rename perlReq to binReq in define.yaml to indicate that the binary is required for a test. This had been the actual meaning for quite some time but the key was never renamed.
2019-12-14 00:55:41 +02:00
# * binReq - is the pgbackrest binary required for this test?
Allow most unit tests to run outside of a container. Three major changes were required to get this working: 1) Provide the path to pgbackrest in the build directory when running outside a container. Tests in a container will continue to install and run against /usr/bin/pgbackrest. 1) Set a per-test lock path so tests don't conflict on the default /tmp/pgbackrest path. Also set a per-test log-path while we are at it. 2) Use localhost instead of a custom host for TLS test connections. Tests in containers will continue to update /etc/hosts and use the custom host. Add infrastructure and update harnessCfgLoad*() to get the correct exe and paths loaded for testing. Since new tests are required to verify that running outside a container works, also rework the tests in Travis CI to provide coverage within a reasonable amount of time. Mainly, break up to doc tests by VM and run an abbreviated unit test suite on co6 and co7.
2019-10-08 18:06:30 +02:00
# * containerReq - is this test required to run in a container?
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
#
# Some options are unique to tests:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
# * coverage - a list of code modules that the test provides coverage for. A code module may be covered by multiple tests. That
# means you must run all the tests by providing the --run option multiple times to get full coverage on the code module. If
# a code module contains only data it should be marked noCode (e.g. - help/help.auto.c: noCode).
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# * feature - Defines a feature that is now available in the harness. For example, the "error" feature defines HRN_FEATURE_ERROR
# used to automatically check for errors in later tests. The common/error test is not able to access this error handling
# because it is used to implement the error handling, so it must do error testing in a more primitive way.
# * harness - Adds a harness module that contains functions to aid in testing. For example, the "log" harness includes the
# common/harnessLog module to aid in expect log testing.
Add shim feature for unit tests. A shim allows a test harness to access static functions and variables in a C module, and also allows functions to be shimmed (i.e. overridden) for the purposes of testing. For instance, coverage testing works when a process that is normally exec'd is run as a forked child process instead.
2021-05-21 00:47:31 +02:00
# * shim - list of modules that are shimmed in the harness. This allows the harness to access static elements of the module to
# provide additional services for unit testing. A shim can have a 'function' list. In this case the listed functions in the
# C module will be appended with _SHIMMED and an implementation with the same function signature must be provided in the
# harness. Generally speaking this function will default to calling the original function, but after some initialization the
# shim may implement other logic that is useful for unit testing.
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# * depend - Source modules that this test depends on that have not already been included in prior tests via coverage. Ideally
# this option would never be used because it is essentially documenting cross-dependencies in the code.
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# * total - total runs in the test
# * vm - VMs that the test will be run on
Allow modules to be included for testing without requiring coverage. Sometimes it is useful to get at the internals of a module that is not being tested for coverage in order to provide coverage for another module that is being tested. The include directive allows this. Update modules that had previously been added to coverage that only need to be included.
2019-07-26 02:15:06 +02:00
# * include - modules to include directly into test.c (all files in coverage are automatically included)
# This is useful when a module's internal data needs to be manipulated for testing but no coverage is added by the test.
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# **********************************************************************************************************************************
Divide tests into three types (unit, integration, performance). Many options that were set per test can instead be inferred from the types, i.e. container, c, expect, and individual. Also finish renaming Perl unit tests with the -perl suffix.
2018-04-24 15:12:25 +02:00
# **********************************************************************************************************************************
# Unit tests
# **********************************************************************************************************************************
unit:
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: common
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: error
Full branch coverage for command/help/help, common/error, common/ini, and common/log modules.
2018-05-05 15:38:09 +02:00
total: 8
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
feature: error
Add error test harness/shim. The hrnErrorThrowP() macro allows errors with specified fields to be generated, which simplifies testing. Update the common/exit test to use the new macro.
2021-06-10 15:21:15 +02:00
harness:
name: error
shim:
common/error: ~
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/error
- common/error.auto: noCode
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
depend:
- common/stackTrace
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: stack-trace
total: 4
Add configurable error handlers. The stackTrace and memContext error handlers were hard-coded which made testing the error module in isolation impossible. Making the error handlers configurable also makes adding new ones in the future easier.
2021-01-28 00:25:13 +02:00
feature: stackTrace
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/stackTrace
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Add configurable error handlers. The stackTrace and memContext error handlers were hard-coded which made testing the error module in isolation impossible. Making the error handlers configurable also makes adding new ones in the future easier.
2021-01-28 00:25:13 +02:00
depend:
- common/debug
Move cvtDoubleToStr() to strNewDbl(). This is a more logical location and it reduces the dependencies required to compile the common/convert module.
2021-01-27 18:50:10 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-convert
total: 11
coverage:
- common/type/convert
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: assert-off
Rename FUNCTION_DEBUG_* and consolidate ASSERT_* macros for consistency. Rename FUNCTION_DEBUG_* macros to FUNCTION_LOG_* to more accurately reflect what they do. Further rename FUNCTION_DEBUG_RESULT* macros to FUNCTION_LOG_RETURN* to make it clearer that they return from the function as well as logging. Leave FUNCTION_TEST_* macros as they are. Consolidate the various ASSERT* macros into a single ASSERT macro that is always compiled out of production builds. It was difficult to figure out when an assert would be checked with all the different types in play. When ASSERTs are compiled in they will always be checked regardless of the log level -- tying these two concepts together was not a good idea.
2019-01-21 17:41:59 +02:00
total: 1
Improve single test run performance. Improve on 7794ab50 by including the build flag files directly into the Makefile as dependencies (even though they are not includes). This simplifies some of the rsync logic and allows make to do what it does best. Also split build flag files into test, harness, and build to reduce rebuilds. Test flags are used to build test.c, harness flags are used to build the rest of the files in the test harness, and build flags are used for the files that are not directly involved in testing.
2018-11-03 22:34:04 +02:00
define: -DNDEBUG
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/assert: noCode
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Move async forking and more error handling to C. The Perl process was exiting directly when called but that interfered with proper locking for the forked async process. Now Perl returns results to the C process which handles all errors, including signals.
2018-04-13 02:42:26 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: debug-off
Add log shim. This allows DEBUG_UNIT and DEBUG_UNIT_EXTERN to be removed since static log variables can now be exposed by functions in the harness.
2021-05-21 18:51:32 +02:00
total: 1
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
define: -DNDEBUG
Move async forking and more error handling to C. The Perl process was exiting directly when called but that interfered with proper locking for the forked async process. Now Perl returns results to the C process which handles all errors, including signals.
2018-04-13 02:42:26 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/debug
Move async forking and more error handling to C. The Perl process was exiting directly when called but that interfered with proper locking for the forked async process. Now Perl returns results to the C process which handles all errors, including signals.
2018-04-13 02:42:26 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: assert-on
total: 1
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/assert: noCode
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: mem-context
total: 7
feature: memContext
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/memContext
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
depend:
- common/type/convert
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: time
total: 3
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/time
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Add strNewEncode(), strCatEncode(), and bufNewDecode(). These constructors wrap encodeToStr() and decodeToBin(), making them convenient and safe by eliminating the need to create intermediate buffers. Encoding/decoding is performed directly into the target String/Buffer. Sizing of the destination buffer is handled by the new functions so it doesn't have to be done at each call site.
2021-02-20 00:05:15 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: encode
Add base64url encoding. For now only encoding is supported. Decoding is not needed and may never be.
2021-02-20 02:21:06 +02:00
total: 2
Add strNewEncode(), strCatEncode(), and bufNewDecode(). These constructors wrap encodeToStr() and decodeToBin(), making them convenient and safe by eliminating the need to create intermediate buffers. Encoding/decoding is performed directly into the target String/Buffer. Sizing of the destination buffer is handled by the new functions so it doesn't have to be done at each call site.
2021-02-20 00:05:15 +02:00
coverage:
- common/encode
Replace OBJECT_DEFINE_MOVE() and OBJECT_DEFINE_FREE() with inlines. Inline functions are more efficient and if they are not used are automatically omitted from the binary. This also makes the implementation of these functions easier to find and removes the need for a declaration. That is, the complete implementation is located in the header rather than being spread between the header and C file.
2021-04-08 16:04:57 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-object
total: 1
coverage:
- common/type/object
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: type-string
Add StringId type. It is often useful to represent identifiers as strings when they cannot easily be represented as an enum/integer, e.g. because they are distributed among a number of unrelated modules or need to be passed to remote processes. Strings are also more helpful in debugging since they can be recognized without cross-referencing the source. However, strings are awkward to work with in C since they cannot be directly used in switch statements leading to less efficient if-else structures. A StringId encodes a short string into an integer so it can be used in switch statements but may also be readily converted back into a string for debugging purposes. StringIds may also be suitable for matching user input providing the strings are short enough. This patch includes a sample of StringId usage by converting protocol commands to StringIds. There are many other possible use cases. To list a few: * All "types" in storage, filters. IO , etc. These types are primarily for identification and debugging so they fit well with this model. * MemContext names would work well as StringIds since these are entirely for debugging. * Option values could be represented as StringIds which would mean we could remove the functions that convert strings to enums, e.g. CipherType. * There are a number of places where enums need to be converted back to strings for logging/debugging purposes. An example is protocolParallelJobToConstZ. If ProtocolParallelJobState were defined as: typedef enum { protocolParallelJobStatePending = STRID5("pend", ...), protocolParallelJobStateRunning = STRID5("run", ...), protocolParallelJobStateDone = STRID5("done", ...), } ProtocolParallelJobState; then protocolParallelJobToConstZ() could be replaced with strIdToZ(). This also applies to many enums that we don't covert to strings for logging, such as CipherMode. As an example of usage, convert all protocol commands from strings to StringIds.
2021-04-20 21:22:42 +02:00
total: 26
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
feature: string
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/type/string
Add StringId type. It is often useful to represent identifiers as strings when they cannot easily be represented as an enum/integer, e.g. because they are distributed among a number of unrelated modules or need to be passed to remote processes. Strings are also more helpful in debugging since they can be recognized without cross-referencing the source. However, strings are awkward to work with in C since they cannot be directly used in switch statements leading to less efficient if-else structures. A StringId encodes a short string into an integer so it can be used in switch statements but may also be readily converted back into a string for debugging purposes. StringIds may also be suitable for matching user input providing the strings are short enough. This patch includes a sample of StringId usage by converting protocol commands to StringIds. There are many other possible use cases. To list a few: * All "types" in storage, filters. IO , etc. These types are primarily for identification and debugging so they fit well with this model. * MemContext names would work well as StringIds since these are entirely for debugging. * Option values could be represented as StringIds which would mean we could remove the functions that convert strings to enums, e.g. CipherType. * There are a number of places where enums need to be converted back to strings for logging/debugging purposes. An example is protocolParallelJobToConstZ. If ProtocolParallelJobState were defined as: typedef enum { protocolParallelJobStatePending = STRID5("pend", ...), protocolParallelJobStateRunning = STRID5("run", ...), protocolParallelJobStateDone = STRID5("done", ...), } ProtocolParallelJobState; then protocolParallelJobToConstZ() could be replaced with strIdToZ(). This also applies to many enums that we don't covert to strings for logging, such as CipherMode. As an example of usage, convert all protocol commands from strings to StringIds.
2021-04-20 21:22:42 +02:00
- common/type/stringId
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/type/stringList
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Move cvtDoubleToStr() to strNewDbl(). This is a more logical location and it reduces the dependencies required to compile the common/convert module.
2021-01-27 18:50:10 +02:00
depend:
- common/type/buffer
- common/type/keyValue
- common/type/list
- common/type/variant
- common/type/variantList
Improved lock implementation written in C. Now only two types of locks can be taken: archive and backup. Most commands use one or the other but the stanza-* commands acquire both locks. This provides better protection than the old command-based locking scheme.
2018-04-11 15:36:12 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: type-list
total: 4
Improved lock implementation written in C. Now only two types of locks can be taken: archive and backup. Most commands use one or the other but the stanza-* commands acquire both locks. This provides better protection than the old command-based locking scheme.
2018-04-11 15:36:12 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/type/list
Improved lock implementation written in C. Now only two types of locks can be taken: archive and backup. Most commands use one or the other but the stanza-* commands acquire both locks. This provides better protection than the old command-based locking scheme.
2018-04-11 15:36:12 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: type-buffer
total: 6
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/type/buffer
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: type-variant
total: 12
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/type/variant
- common/type/variantList
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: reg-exp
total: 3
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/regExp
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 17:57:32 +02:00
Move common/object.h to common/type/object.h. This header does not contain a type but is used to define types so this seems like a better location.
2020-03-31 02:52:57 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: log
total: 5
feature: log
Add log shim. This allows DEBUG_UNIT and DEBUG_UNIT_EXTERN to be removed since static log variables can now be exposed by functions in the harness.
2021-05-21 18:51:32 +02:00
harness:
name: log
shim:
common/log: ~
Move common/object.h to common/type/object.h. This header does not contain a type but is used to define types so this seems like a better location.
2020-03-31 02:52:57 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/log
Move common/object.h to common/type/object.h. This header does not contain a type but is used to define types so this seems like a better location.
2020-03-31 02:52:57 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: debug-on
Add log shim. This allows DEBUG_UNIT and DEBUG_UNIT_EXTERN to be removed since static log variables can now be exposed by functions in the harness.
2021-05-21 18:51:32 +02:00
total: 3
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
feature: debug
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/debug
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: fork
total: 1
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/fork
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: wait
total: 1
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/wait
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Add MostCommonValue object. Calculate the most common value in a list of variants. If there is a tie then the first value passed to mcvUpdate() wins. mcvResult() can be called multiple times because it does not end processing, but there is a cost to calculating the result each time since it is not stored.
2019-08-19 02:46:34 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-mcv
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/type/mcv
Add MostCommonValue object. Calculate the most common value in a list of variants. If there is a tie then the first value passed to mcvUpdate() wins. mcvResult() can be called multiple times because it does not end processing, but there is a cost to calculating the result each time since it is not stored.
2019-08-19 02:46:34 +02:00
Add basic C JSON parser.
2018-08-09 14:06:23 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-json
Add separate functions to encode/decode each JSON type. In most cases the JSON type is known so this is more efficient than converting to Variant first, both in terms of memory and time. Also rename some of the existing functions for consistency.
2019-04-23 00:41:01 +02:00
total: 11
Add basic C JSON parser.
2018-08-09 14:06:23 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/type/json
Add basic C JSON parser.
2018-08-09 14:06:23 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-key-value
total: 2
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/type/keyValue
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Implement filters that do not modify the buffer. Update cryptoHash to use the new interface.
2018-07-25 03:08:27 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Add interface objects for libxml2. Add XmlDocument, XmlNode, and XmlNodeList objects as a thin interface layer on libxml2. This interface is not intended to be comprehensive. Only a few libxml2 capabilities are exposed but more can be added as needed.
2018-11-21 03:40:11 +02:00
- name: type-xml
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/type/xml
Add interface objects for libxml2. Add XmlDocument, XmlNode, and XmlNodeList objects as a thin interface layer on libxml2. This interface is not intended to be comprehensive. Only a few libxml2 capabilities are exposed but more can be added as needed.
2018-11-21 03:40:11 +02:00
Add general-purpose statistics collector. Currently each module that needs to collect statistics implements custom code to do so. This is cumbersome. Create a general purpose module for collecting and reporting statistics. Statistics are output in the log at detail level, but there are other uses they could be put to eventually. No new functionality is added. This is just a drop-in replacement for the current statistics, with the advantage of being more flexible. The new stats are slower because they involve a list lookup, but performance testing shows stats can be updated at about 40,000/ms which seems fast enough for our purposes.
2020-08-20 20:04:26 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: stat
total: 1
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
feature: STAT
Add general-purpose statistics collector. Currently each module that needs to collect statistics implements custom code to do so. This is cumbersome. Create a general purpose module for collecting and reporting statistics. Statistics are output in the log at detail level, but there are other uses they could be put to eventually. No new functionality is added. This is just a drop-in replacement for the current statistics, with the advantage of being more flexible. The new stats are slower because they involve a list lookup, but performance testing shows stats can be updated at about 40,000/ms which seems fast enough for our purposes.
2020-08-20 20:04:26 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/stat
Add general-purpose statistics collector. Currently each module that needs to collect statistics implements custom code to do so. This is cumbersome. Create a general purpose module for collecting and reporting statistics. Statistics are output in the log at detail level, but there are other uses they could be put to eventually. No new functionality is added. This is just a drop-in replacement for the current statistics, with the advantage of being more flexible. The new stats are slower because they involve a list lookup, but performance testing shows stats can be updated at about 40,000/ms which seems fast enough for our purposes.
2020-08-20 20:04:26 +02:00
Add user module for managing system users/groups. Centralize the management of users and groups. Also update Posix storage driver where users/groups were already in use.
2019-09-09 02:11:51 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: user
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/user
Add user module for managing system users/groups. Centralize the management of users and groups. Also update Posix storage driver where users/groups were already in use.
2019-09-09 02:11:51 +02:00
Add interface objects for libxml2. Add XmlDocument, XmlNode, and XmlNodeList objects as a thin interface layer on libxml2. This interface is not intended to be comprehensive. Only a few libxml2 capabilities are exposed but more can be added as needed.
2018-11-21 03:40:11 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Implement filters that do not modify the buffer. Update cryptoHash to use the new interface.
2018-07-25 03:08:27 +02:00
- name: io
total: 4
Automatically create IoRead/IoWrite interfaces in HRN_FORK*() macros. This removes a lot of boiler plate where every instance needs to create these interfaces. Also add HRN_FORK_*_NOTIFY*() macros to standardize synchronizing between the parent and child processes. In both cases update the tests with the new macros.
2021-07-14 20:31:57 +02:00
feature: IO
Convert filter param/result to Pack type. The Pack type is more compact and flexible than the Variant type. The Pack type also allows binary data to be stored, which is useful for transferring the passphrase in the CipherBlock filter. The primary purpose is to allow more (and more complex) result data to be returned efficiently from the PageChecksum filter. For now the PageChecksum filter still returns the original Variant. Converting the result data will be the subject of a future commit. Also convert filter types to StringId.
2021-09-22 16:48:21 +02:00
harness: pack
Implement filters that do not modify the buffer. Update cryptoHash to use the new interface.
2018-07-25 03:08:27 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/io/bufferRead
- common/io/bufferWrite
- common/io/fd
- common/io/fdRead
- common/io/fdWrite
- common/io/filter/buffer
- common/io/filter/filter
- common/io/filter/group
- common/io/filter/sink
- common/io/filter/size
- common/io/io
- common/io/read
- common/io/write
Implement filters that do not modify the buffer. Update cryptoHash to use the new interface.
2018-07-25 03:08:27 +02:00
Convert filter param/result to Pack type. The Pack type is more compact and flexible than the Variant type. The Pack type also allows binary data to be stored, which is useful for transferring the passphrase in the CipherBlock filter. The primary purpose is to allow more (and more complex) result data to be returned efficiently from the PageChecksum filter. For now the PageChecksum filter still returns the original Variant. Converting the result data will be the subject of a future commit. Also convert filter types to StringId.
2021-09-22 16:48:21 +02:00
depend:
- common/type/pack
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-pack
total: 1
coverage:
- common/type/pack
# ----------------------------------------------------------------------------------------------------------------------------
- name: crypto
total: 3
coverage:
- common/crypto/cipherBlock
- common/crypto/common
- common/crypto/hash
- common/crypto/md5.vendor
Add TlsClient object. A simple, secure TLS client intended to allow access to services that are exposed via HTTPS. We call it TLS instead of SSL because SSL methods are disabled so only TLS connections are allowed. This object is intended to be used for multiple TLS connections against a service so tlsClientOpen() can be called each time a new connection is needed. By default, an open connection will be reused for pipelining so the user must be prepared to retry their transaction on a read/write error if the server closes the connection before it can be reused. If this behavior is not desirable then tlsClientClose() may be used to ensure that the next call to tlsClientOpen() will create a new TLS session. Note that tlsClientRead() is non-blocking unless there are *zero* bytes to be read from the session in which case it will raise an error after the defined timeout. In any case the tlsClientRead()/tlsClientWrite()/tlsClientEof() functions should not generally be called directly. Instead use the read/write interfaces available from tlsClientIoRead()/tlsClientIoWrite().
2018-11-22 01:43:25 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: io-tls
Non-blocking TLS implementation. The prior blocking implementation seemed to be prone to locking up on some (especially recent) kernel versions. Since we were unable to reproduce the issue in a development environment we can only speculate as to the cause, but there is a good chance that blocking sockets were the issue or contributed to the issue. So move to a non-blocking implementation to hopefully clear up these issues. Testing in production environments that were prone to locking shows that the approach is promising and at the very least not a regression. The main differences from the blocking version are the non-blocking connect() implementation and handling of WANT_READ/WANT_WRITE retries for all SSL*() functions. Timeouts in the tests needed to be increased because socket connect() and TLS SSL_connect() were not included in the timeout before. The tests don't run any slower, though. In fact, all platforms but Ubuntu 12.04 worked fine with the shorter timeouts.
2020-04-16 22:05:44 +02:00
total: 5
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
feature: SOCKET
harness: server
Add TlsClient object. A simple, secure TLS client intended to allow access to services that are exposed via HTTPS. We call it TLS instead of SSL because SSL methods are disabled so only TLS connections are allowed. This object is intended to be used for multiple TLS connections against a service so tlsClientOpen() can be called each time a new connection is needed. By default, an open connection will be reused for pipelining so the user must be prepared to retry their transaction on a read/write error if the server closes the connection before it can be reused. If this behavior is not desirable then tlsClientClose() may be used to ensure that the next call to tlsClientOpen() will create a new TLS session. Note that tlsClientRead() is non-blocking unless there are *zero* bytes to be read from the session in which case it will raise an error after the defined timeout. In any case the tlsClientRead()/tlsClientWrite()/tlsClientEof() functions should not generally be called directly. Instead use the read/write interfaces available from tlsClientIoRead()/tlsClientIoWrite().
2018-11-22 01:43:25 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/io/client
- common/io/session
- common/io/tls/client
- common/io/tls/session
- common/io/socket/client
- common/io/socket/common
- common/io/socket/session
Add TlsClient object. A simple, secure TLS client intended to allow access to services that are exposed via HTTPS. We call it TLS instead of SSL because SSL methods are disabled so only TLS connections are allowed. This object is intended to be used for multiple TLS connections against a service so tlsClientOpen() can be called each time a new connection is needed. By default, an open connection will be reused for pipelining so the user must be prepared to retry their transaction on a read/write error if the server closes the connection before it can be reused. If this behavior is not desirable then tlsClientClose() may be used to ensure that the next call to tlsClientOpen() will create a new TLS session. Note that tlsClientRead() is non-blocking unless there are *zero* bytes to be read from the session in which case it will raise an error after the defined timeout. In any case the tlsClientRead()/tlsClientWrite()/tlsClientEof() functions should not generally be called directly. Instead use the read/write interfaces available from tlsClientIoRead()/tlsClientIoWrite().
2018-11-22 01:43:25 +02:00
Move file descriptor read/write ready into IoRead/IoWrite. Move sckSessionReadyRead()/Write() into the IoRead/IoWrite interfaces. This is a more logical place for them and the alternative would be to add them to the IoSession interface, which does not seem like a good idea. This is mostly a refactor, but a big change is the select() logic in fdRead.c has been replaced by ioReadReady(). This was duplicated code that was being used by our protocol but not TLS. Since we have not had any problems with requiring poll() in the field this seems like a good time to remove our dependence on select(). Also, IoFdWrite now requires a timeout so update where required, mostly in the tests.
2020-08-08 17:23:37 +02:00
include:
- common/io/fdRead
- common/io/read
Add HttpClient object. A robust HTTP client with pipelining support and automatic retries. Using a single object to make multiple requests is more efficient because requests are pipelined whenever possible. Requests are automatically retried when the connection has been closed by the server. Any 5xx response is also retried. Only the HTTPS protocol is currently supported.
2018-11-22 02:11:45 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: io-http
Add HttpUrl object. Parse a URL into component parts.
2021-03-01 20:44:47 +02:00
total: 6
Add HttpClient object. A robust HTTP client with pipelining support and automatic retries. Using a single object to make multiple requests is more efficient because requests are pipelined whenever possible. Requests are automatically retried when the connection has been closed by the server. Any 5xx response is also retried. Only the HTTPS protocol is currently supported.
2018-11-22 02:11:45 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/io/http/client
- common/io/http/common
- common/io/http/header
- common/io/http/query
- common/io/http/request
- common/io/http/response
- common/io/http/session
Add HttpUrl object. Parse a URL into component parts.
2021-03-01 20:44:47 +02:00
- common/io/http/url
Add HttpClient object. A robust HTTP client with pipelining support and automatic retries. Using a single object to make multiple requests is more efficient because requests are pipelined whenever possible. Requests are automatically retried when the connection has been closed by the server. Any 5xx response is also retried. Only the HTTPS protocol is currently supported.
2018-11-22 02:11:45 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: exec
total: 1
coverage:
- common/exec
# ----------------------------------------------------------------------------------------------------------------------------
- name: ini
total: 4
coverage:
- common/ini
depend:
- storage/posix/read
- storage/posix/storage
- storage/posix/write
- storage/read
- storage/storage
- storage/write
Move compress module to common/compress. It makes sense for the compression code to be in common since it is not pgBackRest-specific.
2019-03-10 13:11:20 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Rename "gzip" to "gz". "gz" was used as the extension but "gzip" was generally used for function and type naming. With a new compression format on the way, it makes sense to standardize on a single abbreviation to represent a compression format in the code. Since the extension is standard and we must use it, also use the extension for all naming.
2020-02-27 19:09:05 +02:00
- name: compress
Add bzip2 compression support. bzip2 is a widely available, high-quality data compressor. It typically compresses files to within 10% to 15% of the best available techniques (the PPM family of statistical compressors), while being around twice as fast at compression and six times faster at decompression. bzip2 is currently available on all supported platforms.
2020-05-05 22:49:01 +02:00
total: 5
Move compress module to common/compress. It makes sense for the compression code to be in common since it is not pgBackRest-specific.
2019-03-10 13:11:20 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- common/compress/bz2/common
- common/compress/bz2/compress
- common/compress/bz2/decompress
- common/compress/gz/common
- common/compress/gz/compress
- common/compress/gz/decompress
- common/compress/lz4/common
- common/compress/lz4/compress
- common/compress/lz4/decompress
- common/compress/zst/common
- common/compress/zst/compress
- common/compress/zst/decompress
- common/compress/helper
Move compress module to common/compress. It makes sense for the compression code to be in common since it is not pgBackRest-specific.
2019-03-10 13:11:20 +02:00
Move crypto module to common/crypto. It makes sense for the crypto code to be in common since it is not pgBackRest-specific. Also combine the crypto tests into a single module.
2019-03-10 13:27:30 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: exit
Move crypto module to common/crypto. It makes sense for the crypto code to be in common since it is not pgBackRest-specific. Also combine the crypto tests into a single module.
2019-03-10 13:27:30 +02:00
total: 3
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
harness: config
Move crypto module to common/crypto. It makes sense for the crypto code to be in common since it is not pgBackRest-specific. Also combine the crypto tests into a single module.
2019-03-10 13:27:30 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/exit
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
depend:
- command/backup/pageChecksum
- common/lock
- config/config
- config/parse
- config/exec
- config/load
- config/protocol
- command/command
- postgres/interface
- postgres/interface/page
- postgres/interface/v083
- postgres/interface/v084
- postgres/interface/v090
- postgres/interface/v091
- postgres/interface/v092
- postgres/interface/v093
- postgres/interface/v094
- postgres/interface/v095
- postgres/interface/v096
- postgres/interface/v100
- postgres/interface/v110
- postgres/interface/v120
- postgres/interface/v130
Add PostgreSQL 14 support. There are no code changes from PostgreSQL 13 so simply add the new version. Add CATALOG_VERSION_NO_MAX to allow the catalog version to "float" during the PostgreSQL beta/rc period so new pgBackRest versions are not required when the catalog version changes. Update the integration tests to handle new PostgreSQL startup messages.
2021-05-24 23:17:03 +02:00
- postgres/interface/v140
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- protocol/client
- protocol/command
- protocol/helper
- protocol/server
- storage/azure/read
- storage/azure/storage
- storage/azure/write
- storage/cifs/storage
GCS support for repository storage. GCS and GCS-compatible object stores can now be used for repository storage.
2021-03-05 19:13:51 +02:00
- storage/gcs/read
- storage/gcs/storage
- storage/gcs/write
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- storage/helper
- storage/remote/read
- storage/remote/protocol
- storage/remote/storage
- storage/remote/write
- storage/s3/read
- storage/s3/storage
- storage/s3/write
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: lock
total: 2
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- common/lock
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: postgres
test:
Add PostgreSQL query client. This direct interface to libpq allows simple queries to be run against PostgreSQL and supports timeouts. Testing is performed using a shim that can use scripted responses to test all aspects of the client code. The shim will be very useful for testing backup scenarios on complex topologies. Reviewed by Cynthia Shang.
2019-07-25 20:50:02 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: client
total: 1
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
harness: pq
Add PostgreSQL query client. This direct interface to libpq allows simple queries to be run against PostgreSQL and supports timeouts. Testing is performed using a shim that can use scripted responses to test all aspects of the client code. The shim will be very useful for testing backup scenarios on complex topologies. Reviewed by Cynthia Shang.
2019-07-25 20:50:02 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- postgres/client
Add PostgreSQL query client. This direct interface to libpq allows simple queries to be run against PostgreSQL and supports timeouts. Testing is performed using a shim that can use scripted responses to test all aspects of the client code. The shim will be very useful for testing backup scenarios on complex topologies. Reviewed by Cynthia Shang.
2019-07-25 20:50:02 +02:00
Add pgControlInfo() to read pg_control and determine the PostgreSQL version.
2018-04-29 17:20:51 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Support configurable WAL segment size. PostgreSQL 11 introduces configurable WAL segment sizes, from 1MB to 1GB. There are two areas that needed to be updated to support this: building the archive-get queue and checking that WAL has been archived after a backup. Both operations require the WAL segment size to properly build a list. Checking the archive after a backup is still implemented in Perl and has an active database connection, so just get the WAL segment size from the database. The archive-get command does not have a connection to the database, so get the WAL segment size from pg_control instead. This requires a deeper inspection of pg_control than has been done in the past, so it seemed best to copy the relevant data structures from each version of PostgreSQL and build a generic interface layer to address them. While this approach is a bit verbose, it has the advantage of being relatively simple, and can easily be updated for new versions of PostgreSQL. Since the integration tests generate pg_control files for testing, teach Perl how to generate files with the correct offsets for both 32-bit and 64-bit architectures.
2018-09-25 11:24:42 +02:00
- name: interface
Move logic from postgres/pageChecksum to command/backup/pageChecksum(). The postgres/pageChecksum module was designed as an interface to the C structs for the Perl code. The new C code can do this directly so no need for an interface. Move the remaining test for pgPageChecksum() into the postgres/interface test module.
2020-03-05 23:12:54 +02:00
total: 9
Move PostgreSQL version interface test functions to a test harness. Some version interface test functions were integrated into the core code because they relied on the PostgreSQL versioned interface. Even though they were compiled out for production builds they cluttered the core code and made it harder to determine what was required by core. Create a PostgreSQL version interface in a test harness to contain these functions. This does require some duplication but the cleaner core code seems a good tradeoff. It is possible for some of this code to be auto-generated but since it is only updated once per year the matter is not pressing.
2021-05-17 13:20:28 +02:00
harness: postgres
Add pgControlInfo() to read pg_control and determine the PostgreSQL version.
2018-04-29 17:20:51 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- postgres/interface
- postgres/interface/page
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Move protocol test module before config module. The protocol module should be tested before modules that have a dependency on it.
2021-05-25 17:08:51 +02:00
# ********************************************************************************************************************************
- name: protocol
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: protocol
Binary protocol. Switch from JSON-based to binary protocol for communicating with local and remote process. The pack type is used to implement the binary protocol. There are a number advantages: * The pack type is more compact than JSON and are more efficient to render/parse. * Packs are more strictly typed than JSON. * Each protocol message is written entirely within ProtocolServer/ProtocolClient so is less likely to get interrupted by an error and leave the protocol in a bad state. * There is no limit on message size. Previously this was limited by buffer size without a custom implementation, as was done for read/writing files. Some cruft from the Perl days was removed, specifically allowing NULL messages and stack traces. This is no longer possible in C. There is room for improvement here, in particular locking down the allowed sequence of protocol messages and building a state machine to enforce it. This will be useful for resetting the protocol when it gets in a bad state.
2021-06-24 19:31:16 +02:00
total: 7
Move protocol test module before config module. The protocol module should be tested before modules that have a dependency on it.
2021-05-25 17:08:51 +02:00
harness:
name: protocol
shim:
protocol/helper:
function:
- protocolLocalExec
Add remote process shim. Run the remote process inside a forked child process instead of exec'ing it. This allows coverage to accumulate in the remote process rather than needing to test the remote protocol functions directly, resulting in better end-to-end testing and less test duplication. Another advantage is that the pgbackrest binary does not need to be built for the test and the test does not need to run in a container.
2021-05-26 00:16:59 +02:00
- protocolRemoteExec
Move protocol test module before config module. The protocol module should be tested before modules that have a dependency on it.
2021-05-25 17:08:51 +02:00
containerReq: true
binReq: true
coverage:
- protocol/client
- protocol/command
- protocol/helper
- protocol/parallel
- protocol/parallelJob
- protocol/server
include:
- common/exec
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: config
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: parse
Move all parse-related rules to parse module. Data required for parsing was spread between the config and defined modules, mostly for historical reasons because the same data was used by Perl. Requiring all the parse rules to be accessed with function interfaces makes the code more complicated and new rules harder to implement. Instead, move the data to the parse module so in the most complex cases no interface functions are needed. This reduces the total amount of code and paves the way for more complex parse rules.
2020-12-17 16:32:31 +02:00
total: 6
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- config/config
- config/parse
- config/parse.auto: noCode
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: load
Fix error after log file open failure when processing should continue. The C code was warning on failure and continuing but the Perl logging code was never updated with the same feature. Rather than add the feature to Perl, just disable file logging if the log file cannot be opened. Log files are always opened by C first, so this will eliminate the error in Perl. Reported by vthriller.
2018-10-25 15:58:25 +02:00
total: 4
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- config/load
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Reduce variables extern'd by the common/log module in debug builds. These days it is better to include the module in define.yaml when we need to poke at the internal implementation. This doesn't quite work for the log test harness, so for now some variables will need to remain extern'd in debug builds.
2020-03-17 00:16:27 +02:00
include:
Rename tcp-keep-alive option to sck-keep-alive. This is really a socket option so the new name is clearer. Since common/io/socket/tcp will contains a mix of options it makes sense to rename it to socket and cascade name changes as needed.
2020-04-01 21:44:51 +02:00
- common/io/socket/common
Reduce variables extern'd by the common/log module in debug builds. These days it is better to include the module in define.yaml when we need to poke at the internal implementation. This doesn't quite work for the log test harness, so for now some variables will need to remain extern'd in debug builds.
2020-03-17 00:16:27 +02:00
Add cfgExecParam() to generate parameters for executing commands. Parameters for the local/remote commands are based on parameters that are passed to the current command. Generate parameters for the new command based on the intersection of parameters between the current command and the command to be executed.
2019-01-17 22:29:19 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: exec
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- config/exec
Add cfgExecParam() to generate parameters for executing commands. Parameters for the local/remote commands are based on parameters that are passed to the current command. Generate parameters for the new command based on the intersection of parameters between the current command and the command to be executed.
2019-01-17 22:29:19 +02:00
Migrate remote command to C. Prior to this the Perl remote was used to satisfy C requests. This worked fine but since the remote needed to be migrated to C anyway there was no reason to wait. Add the ProtocolServer object and tweak ProtocolClient to work with it. It was also necessary to add a mechanism to get option values from the remote so that encryption settings could be read and used in the storage object. Update the remote storage objects to comply with the protocol changes and add the storage protocol handler. Ideally this commit would have been broken up into smaller chunks but there are cross-dependencies in the protocol layer and it didn't seem worth the extra effort.
2019-02-19 20:57:38 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: protocol
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- config/protocol
Migrate remote command to C. Prior to this the Perl remote was used to satisfy C requests. This worked fine but since the remote needed to be migrated to C anyway there was no reason to wait. Add the ProtocolServer object and tweak ProtocolClient to work with it. It was also necessary to add a mechanism to get option values from the remote so that encryption settings could be read and used in the storage object. Update the remote storage objects to comply with the protocol changes and add the storage protocol handler. Ideally this commit would have been broken up into smaller chunks but there are cross-dependencies in the protocol layer and it didn't seem worth the extra effort.
2019-02-19 20:57:38 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: storage
test:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: posix
total: 21
feature: STORAGE
harness: storage
coverage:
- storage/posix/read
- storage/posix/storage
- storage/posix/write
- storage/helper
- storage/read
- storage/storage
- storage/write
GCS support for repository storage. GCS and GCS-compatible object stores can now be used for repository storage.
2021-03-05 19:13:51 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: gcs
total: 3
coverage:
- storage/gcs/read
- storage/gcs/storage
- storage/gcs/write
- storage/helper
include:
- storage/storage
- storage/write
Azure support for repository storage. Azure and Azure-compatible object stores can now be used for repository storage. Currently only shared key authentication is supported but SAS will be added soon.
2020-07-02 22:24:34 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: azure
total: 3
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- storage/azure/read
- storage/azure/storage
- storage/azure/write
- storage/helper
Azure support for repository storage. Azure and Azure-compatible object stores can now be used for repository storage. Currently only shared key authentication is supported but SAS will be added soon.
2020-07-02 22:24:34 +02:00
include:
- storage/storage
- storage/write
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Add CIFS storage driver. This driver borrows heavily from the Posix driver. At this point the only difference is that CIFS does not allow explicit directory fsyncs so they need to be suppressed. At some point the CIFS diver will also omit link support. With the addition of this driver repository storage is now writable.
2019-03-14 11:28:33 +02:00
- name: cifs
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- storage/cifs/storage
- storage/posix/storage
- storage/helper
Allow modules to be included for testing without requiring coverage. Sometimes it is useful to get at the internals of a module that is not being tested for coverage in order to provide coverage for another module that is being tested. The include directive allows this. Update modules that had previously been added to coverage that only need to be included.
2019-07-26 02:15:06 +02:00
include:
- storage/storage
Add CIFS storage driver. This driver borrows heavily from the Posix driver. At this point the only difference is that CIFS does not allow explicit directory fsyncs so they need to be suppressed. At some point the CIFS diver will also omit link support. With the addition of this driver repository storage is now writable.
2019-03-14 11:28:33 +02:00
Add remote storage objects. This is a partial implementation of remote storage with just enough functionality to get the info command working. The client is written in C but the server is still in Perl, which limits progress until a C server is written.
2019-01-18 22:04:37 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: remote
Simplify storage driver info and list functions. The storage driver requires two list functions to be implemented, list and infoList. But the former is a subset of the latter so implementing both in every driver is wasteful. The reason both exist is that in Posix it is cheaper to get a list of names than it is to stat files to get size, time, etc. In S3 these operations are equivalent. Introduce storageInfoLevelType to determine the amount of information required by the caller. That way Posix can work efficiently and all drivers can return only the data required which saves some bandwidth. The storageList() and storageInfoList() functions remain in the storage interface since they are useful -- the only change is simplifying the drivers with no external impact. Note that since list() accepted an expression infoList() must now do so. Checking the expression is optional for the driver but can be used to limit results or save IO costs. Similarly, exists() and pathExists() are just specialized forms of info() so adapt them to call info() instead.
2020-04-06 22:09:18 +02:00
total: 9
Add remote storage objects. This is a partial implementation of remote storage with just enough functionality to get the info command working. The client is written in C but the server is still in Perl, which limits progress until a C server is written.
2019-01-18 22:04:37 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- storage/remote/read
- storage/remote/protocol
- storage/remote/storage
- storage/remote/write
- storage/helper
- storage/storage
Add remote storage objects. This is a partial implementation of remote storage with just enough functionality to get the info command working. The client is written in C but the server is still in Perl, which limits progress until a C server is written.
2019-01-18 22:04:37 +02:00
Allow modules to be included for testing without requiring coverage. Sometimes it is useful to get at the internals of a module that is not being tested for coverage in order to provide coverage for another module that is being tested. The include directive allows this. Update modules that had previously been added to coverage that only need to be included.
2019-07-26 02:15:06 +02:00
include:
- storage/read
- storage/write
Add S3 storage driver. Only the storageNewRead() and storageList() functions are currently implemented, but this is enough to enable S3 for the archive-get command.
2018-11-22 02:32:49 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: s3
Simplify S3 configuration tests and add security token tests. Rather than calling storageS3New() directly, create the storage by loading a configuration and calling repoStorageGet(). This is a better end-to-end test and cuts down on a lot of redundant tests. Add tests that include security tokens in error messages to ensure they are redacted.
2020-08-08 21:52:33 +02:00
total: 2
Add S3 storage driver. Only the storageNewRead() and storageList() functions are currently implemented, but this is enough to enable S3 for the archive-get command.
2018-11-22 02:32:49 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- storage/s3/read
- storage/s3/storage
- storage/s3/write
- storage/helper
- storage/storage
Add S3 storage driver. Only the storageNewRead() and storageList() functions are currently implemented, but this is enough to enable S3 for the archive-get command.
2018-11-22 02:32:49 +02:00
Remove storageRead() and storageWriteDriver(). These functions were only being used in the tests. This usage likely dates to before the include directive was available in define.yaml.
2020-04-03 14:38:28 +02:00
include:
- storage/write
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
Partial migration of config code generation to C. Parse enough of config.yaml to auto-generate config.auto.h and config.auto.c. This commit implements most of the infrastructure needed to migrate the rest of the build code to C, but each set of auto-generated files will present its own challenges. The build is now dependent on libyaml. At this point there is no need for a hard requirement, but that will come soon so it seems better to add the dependency now.
2021-07-19 01:02:01 +02:00
- name: build
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: common
Move bldStrId() into a C file. This function was included in a header but not declared inline, so linker errors happened when the header was included into more than one file. Because of the setjmp() in TRY_BEGIN() it can't be inlined so put it in a C file. Also add some missing headers.
2021-08-02 23:49:05 +02:00
total: 2
Partial migration of config code generation to C. Parse enough of config.yaml to auto-generate config.auto.h and config.auto.c. This commit implements most of the infrastructure needed to migrate the rest of the build code to C, but each set of auto-generated files will present its own challenges. The build is now dependent on libyaml. At this point there is no need for a hard requirement, but that will come soon so it seems better to add the dependency now.
2021-07-19 01:02:01 +02:00
coverage:
Move bldStrId() into a C file. This function was included in a header but not declared inline, so linker errors happened when the header was included into more than one file. Because of the setjmp() in TRY_BEGIN() it can't be inlined so put it in a C file. Also add some missing headers.
2021-08-02 23:49:05 +02:00
- build/common/render
Partial migration of config code generation to C. Parse enough of config.yaml to auto-generate config.auto.h and config.auto.c. This commit implements most of the infrastructure needed to migrate the rest of the build code to C, but each set of auto-generated files will present its own challenges. The build is now dependent on libyaml. At this point there is no need for a hard requirement, but that will come soon so it seems better to add the dependency now.
2021-07-19 01:02:01 +02:00
- build/common/yaml
# ----------------------------------------------------------------------------------------------------------------------------
- name: config
total: 1
coverage:
- build/config/parse
- build/config/render
Migrate error code generation to C. Parse src/build/error.yaml and write to src/config/error.auto.h and src/config/error.auto.c.
2021-08-03 00:32:11 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: error
total: 1
coverage:
- build/error/parse
- build/error/render
Migrate command-line help generation to C. Command-line help is now generated at build time so it does not need to be committed. This reduces churn on commits that add configuration and/or update the help. Since churn is no longer an issue, help.auto.c is bzip2 compressed to save space in the binary. The Perl config parser (Data.pm) has been moved to doc/lib since the Perl build path is no longer required. Likewise doc/xml/reference.xml has been moved to src/build/help/help.xml since it is required at build time.
2021-09-09 00:16:06 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: help
total: 2
coverage:
- build/help/parse
- build/help/render
Partial migration of config code generation to C. Parse enough of config.yaml to auto-generate config.auto.h and config.auto.c. This commit implements most of the infrastructure needed to migrate the rest of the build code to C, but each set of auto-generated files will present its own challenges. The build is now dependent on libyaml. At this point there is no need for a hard requirement, but that will come soon so it seems better to add the dependency now.
2021-07-19 01:02:01 +02:00
# ********************************************************************************************************************************
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
- name: info
test:
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: info
Allow Info* objects to be created from scratch in C. Previously, info files (e.g. archive.info, backup.info) were created in Perl and only loaded in C. The upcoming stanza commands in C need to create these files so refactor the Info* objects to allow new, empty objects to be created. Also, add functions needed to initialize each Info* object to a valid state. Contributed by Cynthia Shang.
2019-08-21 21:12:00 +02:00
total: 3
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
harness: info
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- info/info
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: info-pg
Allow Info* objects to be created from scratch in C. Previously, info files (e.g. archive.info, backup.info) were created in Perl and only loaded in C. The upcoming stanza commands in C need to create these files so refactor the Info* objects to allow new, empty objects to be created. Also, add functions needed to initialize each Info* object to a valid state. Contributed by Cynthia Shang.
2019-08-21 21:12:00 +02:00
total: 2
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- info/infoPg
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: info-archive
Add infoArchiveIdHistoryMatch() to the InfoArchive object. Match a PostgreSQL system identifier and version to a pgBackRest archive id. Contributed by Cynthia Shang.
2018-12-11 01:45:57 +02:00
total: 2
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- info/infoArchive
Migrate minimum set of code for reading archive.info files from Perl to C. Contributed by Cynthia Shang.
2018-08-09 14:57:21 +02:00
Migrate control functions to detect stop files to C from Perl. Basic functions to detect the presence of stanza or all stop files and error when they are present. The functionality to detect stop files without error was not migrated. This functionality is only used by stanza-delete and will be migrated with that command.
2018-09-07 17:03:05 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: manifest
total: 6
Migrate control functions to detect stop files to C from Perl. Basic functions to detect the presence of stanza or all stop files and error when they are present. The functionality to detect stop files without error was not migrated. This functionality is only used by stanza-delete and will be migrated with that command.
2018-09-07 17:03:05 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- info/manifest
depend:
- command/backup/common
Migrate control functions to detect stop files to C from Perl. Basic functions to detect the presence of stanza or all stop files and error when they are present. The functionality to detect stop files without error was not migrated. This functionality is only used by stanza-delete and will be migrated with that command.
2018-09-07 17:03:05 +02:00
Migrate backup manifest load/save to C. The backup manifest stores a complete list of all files, links, and paths in a backup along with metadata such as checksums, sizes, timestamps, etc. A list of databases is also included for selective restore. The purpose of the manifest is to allow the restore command to confidently reconstruct the PostgreSQL data directory and ensure that nothing is missing or corrupt. It is also useful for reporting, e.g. size of backup, backup time, etc. For now, migrate enough functionality to implement the restore command. Reviewed by Cynthia Shang.
2019-09-23 19:50:46 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: info-backup
total: 3
Migrate backup manifest load/save to C. The backup manifest stores a complete list of all files, links, and paths in a backup along with metadata such as checksums, sizes, timestamps, etc. A list of databases is also included for selective restore. The purpose of the manifest is to allow the restore command to confidently reconstruct the PostgreSQL data directory and ensure that nothing is missing or corrupt. It is also useful for reporting, e.g. size of backup, backup time, etc. For now, migrate enough functionality to implement the restore command. Reviewed by Cynthia Shang.
2019-09-23 19:50:46 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- info/infoBackup
Migrate backup manifest load/save to C. The backup manifest stores a complete list of all files, links, and paths in a backup along with metadata such as checksums, sizes, timestamps, etc. A list of databases is also included for selective restore. The purpose of the manifest is to allow the restore command to confidently reconstruct the PostgreSQL data directory and ensure that nothing is missing or corrupt. It is also useful for reporting, e.g. size of backup, backup time, etc. For now, migrate enough functionality to implement the restore command. Reviewed by Cynthia Shang.
2019-09-23 19:50:46 +02:00
Add Db object to encapsulate PostgreSQL queries and commands. Migrate functionality from the Perl Db module to C. For now this is just enough to implement the WAL switch check. Add the dbGet() helper function to get Db objects easily. Create macros in harnessPq to make writing pq scripts easier by grouping commonly used functions together. Reviewed by Cynthia Shang.
2019-08-01 21:38:27 +02:00
# ********************************************************************************************************************************
- name: db
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: db
Add backup functions to Db object. These functions implement the database backup functionality for all supported versions.
2019-12-08 01:44:06 +02:00
total: 3
Allow most unit tests to run outside of a container. Three major changes were required to get this working: 1) Provide the path to pgbackrest in the build directory when running outside a container. Tests in a container will continue to install and run against /usr/bin/pgbackrest. 1) Set a per-test lock path so tests don't conflict on the default /tmp/pgbackrest path. Also set a per-test log-path while we are at it. 2) Use localhost instead of a custom host for TLS test connections. Tests in containers will continue to update /etc/hosts and use the custom host. Add infrastructure and update harnessCfgLoad*() to get the correct exe and paths loaded for testing. Since new tests are required to verify that running outside a container works, also rework the tests in Travis CI to provide coverage within a reasonable amount of time. Mainly, break up to doc tests by VM and run an abbreviated unit test suite on co6 and co7.
2019-10-08 18:06:30 +02:00
containerReq: true
pgBackRest is now pure C. Remove embedded Perl from the distributed binary. This includes code, configure, Makefile, and packages. The distributed binary is now pure C. Remove storagePathEnforceSet() from the C Storage object which allowed Perl to write outside of the storage base directory. Update mock/all and real/all integration tests to use storageLocal() where they were violating this rule. Remove "c" option that allowed the remote to tell if it was being called from C or Perl. Code to convert options to JSON for passing to Perl (perl/config.c) has been moved to LibC since it is still required for Perl integration tests. Update build and installation instructions in the user guide. Remove all Perl unit tests. Remove obsolete Perl code. In particular this included all the Perl protocol code which required modifications to the Perl storage, manifest, and db objects that are still required for integration testing but only run locally. Any remaining Perl code is required for testing, documentation, or code generation. Rename perlReq to binReq in define.yaml to indicate that the binary is required for a test. This had been the actual meaning for quite some time but the key was never renamed.
2019-12-14 00:55:41 +02:00
binReq: true
Add Db object to encapsulate PostgreSQL queries and commands. Migrate functionality from the Perl Db module to C. For now this is just enough to implement the WAL switch check. Add the dbGet() helper function to get Db objects easily. Create macros in harnessPq to make writing pq scripts easier by grouping commonly used functions together. Reviewed by Cynthia Shang.
2019-08-01 21:38:27 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- db/db
- db/helper
- db/protocol
Add Db object to encapsulate PostgreSQL queries and commands. Migrate functionality from the Perl Db module to C. For now this is just enough to implement the WAL switch check. Add the dbGet() helper function to get Db objects easily. Create macros in harnessPq to make writing pq scripts easier by grouping commonly used functions together. Reviewed by Cynthia Shang.
2019-08-01 21:38:27 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
- name: command
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
test:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: control
total: 3
coverage:
- command/control/common
- command/control/start
- command/control/stop
Refactor archive common functions in preparation for parallel async archive-get.
2018-04-29 16:16:59 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
- name: archive-common
Move archiveIdComparator() to archive/common module.
2020-09-08 18:28:56 +02:00
total: 9
Refactor archive common functions in preparation for parallel async archive-get.
2018-04-29 16:16:59 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/archive/common
Refactor archive common functions in preparation for parallel async archive-get.
2018-04-29 16:16:59 +02:00
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
- name: archive-get
Improve archive-get performance. Check that archive files exist in the main process instead of the local process. This means that the archive.info file only needs to be loaded once per execution rather than once per file to get. Stop looking when a file is missing or in error. PostgreSQL will never request anything past the missing file so there is no point in getting them. This also reduces "unable to find" logging in the async process. Cache results of storageList() when looking for multiple files to reduce storage I/O. Look for all requested archive files in the archive-id where the first file is found. They may not all be there, but this reduces the number of list calls. If subsequent files are in another archive id they will be found on the next archive-get call.
2021-01-15 17:15:52 +02:00
total: 3
pgBackRest is now pure C. Remove embedded Perl from the distributed binary. This includes code, configure, Makefile, and packages. The distributed binary is now pure C. Remove storagePathEnforceSet() from the C Storage object which allowed Perl to write outside of the storage base directory. Update mock/all and real/all integration tests to use storageLocal() where they were violating this rule. Remove "c" option that allowed the remote to tell if it was being called from C or Perl. Code to convert options to JSON for passing to Perl (perl/config.c) has been moved to LibC since it is still required for Perl integration tests. Update build and installation instructions in the user guide. Remove all Perl unit tests. Remove obsolete Perl code. In particular this included all the Perl protocol code which required modifications to the Perl storage, manifest, and db objects that are still required for integration testing but only run locally. Any remaining Perl code is required for testing, documentation, or code generation. Rename perlReq to binReq in define.yaml to indicate that the binary is required for a test. This had been the actual meaning for quite some time but the key was never renamed.
2019-12-14 00:55:41 +02:00
binReq: true
Add asynchronous, parallel archive-get. This feature maintains a queue of WAL segments to help reduce latency when PostgreSQL requests a WAL segment with restore_command.
2018-04-30 23:27:39 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/archive/common
- command/archive/get/file
- command/archive/get/get
- command/archive/get/protocol
Disable flapping archive/get unit on CentOS 6. This test has been flapping since 9b9396c7. It seems to be some kind of timing issue since all integration tests pass and this unit passes on all other VMs. It only happens on Travis and is not reproducible in any development environment that we have tried. For now, disable the test since the constant flapping is causing major delays in testing and quite a bit of time has been spent trying to identify the root cause. We are actively developing these tests and hope the issue will be identified during the course of normal development. A number of improvements were made to the tests while searching for this issue. While none of them helped, it makes sense to keep the improvements.
2018-10-02 18:54:43 +02:00
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: archive-push
The archive-push command is implemented entirely in C. This new implementation should behave exactly like the old Perl code with the exception of updated log messages. Remove as much of the Perl code as possible without breaking other commands.
2019-03-29 15:26:33 +02:00
total: 4
pgBackRest is now pure C. Remove embedded Perl from the distributed binary. This includes code, configure, Makefile, and packages. The distributed binary is now pure C. Remove storagePathEnforceSet() from the C Storage object which allowed Perl to write outside of the storage base directory. Update mock/all and real/all integration tests to use storageLocal() where they were violating this rule. Remove "c" option that allowed the remote to tell if it was being called from C or Perl. Code to convert options to JSON for passing to Perl (perl/config.c) has been moved to LibC since it is still required for Perl integration tests. Update build and installation instructions in the user guide. Remove all Perl unit tests. Remove obsolete Perl code. In particular this included all the Perl protocol code which required modifications to the Perl storage, manifest, and db objects that are still required for integration testing but only run locally. Any remaining Perl code is required for testing, documentation, or code generation. Rename perlReq to binReq in define.yaml to indicate that the binary is required for a test. This had been the actual meaning for quite some time but the key was never renamed.
2019-12-14 00:55:41 +02:00
binReq: true
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/archive/common
- command/archive/push/file
- command/archive/push/protocol
- command/archive/push/push
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
Migrate backupRegExp() to C. Removed the "anchor" parameter because it was never used in any calls in the Perl code so it was just a dead parameter that always defaulted to true. Contributed by Cynthia Shang.
2019-04-15 14:29:25 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: stanza
total: 4
The local command for backup is implemented entirely in C. The local process is now entirely migrated to C. Since all major I/O operations are performed in the local process, the vast majority of I/O is now performed in C. Contributed by David Steele, Cynthia Shang.
2019-07-25 20:34:16 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- command/stanza/common
- command/stanza/create
- command/stanza/upgrade
- command/stanza/delete
Allow modules to be included for testing without requiring coverage. Sometimes it is useful to get at the internals of a module that is not being tested for coverage in order to provide coverage for another module that is being tested. The include directive allows this. Update modules that had previously been added to coverage that only need to be included.
2019-07-26 02:15:06 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
depend:
- command/check/common
The local command for backup is implemented entirely in C. The local process is now entirely migrated to C. Since all major I/O operations are performed in the local process, the vast majority of I/O is now performed in C. Contributed by David Steele, Cynthia Shang.
2019-07-25 20:34:16 +02:00
The check command is implemented partly in C. Implement switch WAL and archive check in C but leave the rest in Perl for now. The main idea was to have some real integration tests for the new database code so the rest of the migration can wait. Reviewed by Cynthia Shang.
2019-08-02 02:35:01 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: check
The check command is implemented entirely in C. Note that building the manifest on each host has been temporarily removed. This feature will likely be brought back as a non-default option (after the manifest code has been fully migrated to C) since it can be fairly expensive.
2019-10-09 00:04:09 +02:00
total: 4
containerReq: true
The check command is implemented partly in C. Implement switch WAL and archive check in C but leave the rest in Perl for now. The main idea was to have some real integration tests for the new database code so the rest of the migration can wait. Reviewed by Cynthia Shang.
2019-08-02 02:35:01 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/check/common
- command/check/check
The check command is implemented partly in C. Implement switch WAL and archive check in C but leave the rest in Perl for now. The main idea was to have some real integration tests for the new database code so the rest of the migration can wait. Reviewed by Cynthia Shang.
2019-08-02 02:35:01 +02:00
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: command
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/command
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
The expire command is implemented entirely in C. This implementation duplicates the functionality of the Perl code but does so with different logic and includes full unit tests. Along the way at least one bug was fixed, see issue #748. Contributed by Cynthia Shang.
2019-06-18 21:19:20 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: expire
Move archiveIdComparator() to archive/common module.
2020-09-08 18:28:56 +02:00
total: 8
The expire command is implemented entirely in C. This implementation duplicates the functionality of the Perl code but does so with different logic and includes full unit tests. Along the way at least one bug was fixed, see issue #748. Contributed by Cynthia Shang.
2019-06-18 21:19:20 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/expire/expire
The expire command is implemented entirely in C. This implementation duplicates the functionality of the Perl code but does so with different logic and includes full unit tests. Along the way at least one bug was fixed, see issue #748. Contributed by Cynthia Shang.
2019-06-18 21:19:20 +02:00
Refactor command/expire unit test module. Add titles and use a Buffer to store backup.info instead of a String.
2020-03-23 20:31:04 +02:00
include:
- info/infoBackup
Move help/help test module to command/help.
2019-03-10 11:55:01 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: help
Refactor List, StringList, and VariantList for performance. Introduce a standard pattern for exposing public struct members (as documented in CODING.md) and use it to inline lstSize() which should improve the performance of iterating large lists. Since many functions in these modules are just thin wrappers of other functions, inline where appropriate. Remove strLstExistsZ() and strLstInsertZ() since they were only used in tests, where the String version of the function is sufficient. Move strLstNewSplitSizeZ() to command/help/help.c and remove strLstNewSplitSize(). This function has only ever been used by help and does not seem widely applicable.
2021-04-07 18:50:33 +02:00
total: 5
Move help/help test module to command/help.
2019-03-10 11:55:01 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/help/help
- command/help/help.auto: noCode
Move help/help test module to command/help.
2019-03-10 11:55:01 +02:00
Migrate command-line help generation to C. Command-line help is now generated at build time so it does not need to be committed. This reduces churn on commits that add configuration and/or update the help. Since churn is no longer an issue, help.auto.c is bzip2 compressed to save space in the binary. The Perl config parser (Data.pm) has been moved to doc/lib since the Perl build path is no longer required. Likewise doc/xml/reference.xml has been moved to src/build/help/help.xml since it is required at build time.
2021-09-09 00:16:06 +02:00
include:
- build/help/render
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: info
total: 3
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/info/info
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: remote
total: 1
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/remote/remote
Rename test modules for consistency. The conventions for command and info tests have shifted in the C modules, though not even all the C modules got the message.
2019-02-23 18:51:52 +02:00
The local command for restore is implemented entirely in C. This is just the part of restore run by the local helper processes, not the entire command. Even so, various optimizations in the code (like pipelining and optimizations for zero-length files) should make the restore command faster on object stores.
2019-05-20 23:07:37 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: restore
Auto-select backup set on restore when time target is specified. Auto-selection is performed only when --set is not specified. If a backup set for the given target time cannot not be found, the latest (default) backup set will be used. Currently a limited number of date formats are recognized and timezone names are not allowed, only timezone offsets.
2020-01-30 23:38:05 +02:00
total: 12
The local command for restore is implemented entirely in C. This is just the part of restore run by the local helper processes, not the entire command. Even so, various optimizations in the code (like pipelining and optimizations for zero-length files) should make the restore command faster on object stores.
2019-05-20 23:07:37 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/restore/file
- command/restore/protocol
- command/restore/restore
The restore command is implemented entirely in C. For the most part this is a direct migration of the Perl code into C. There is one important behavioral change with regard to how file permissions are handled. The Perl code tried to set ownership as it was in the manifest even when running as an unprivileged user. This usually just led to errors and frustration. The C code works like this: If a restore is run as a non-root user (the typical scenario) then all files restored will belong to the user/group executing pgBackRest. If existing files are not owned by the executing user/group then an error will result if the ownership cannot be updated to the executing user/group. In that case the file ownership will need to be updated by a privileged user before the restore can be retried. If a restore is run as the root user then pgBackRest will attempt to recreate the ownership recorded in the manifest when the backup was made. Only user/group names are stored in the manifest so the same names must exist on the restore host for this to work. If the user/group name cannot be found locally then the user/group of the PostgreSQL data directory will be used and finally root if the data directory user/group cannot be mapped to a name. Reviewed by Cynthia Shang.
2019-09-26 13:52:02 +02:00
include:
- common/user
- info/infoBackup
- info/manifest
The local command for restore is implemented entirely in C. This is just the part of restore run by the local helper processes, not the entire command. Even so, various optimizations in the code (like pipelining and optimizations for zero-length files) should make the restore command faster on object stores.
2019-05-20 23:07:37 +02:00
The stanza-create/update/delete commands are implemented entirely in C. Contributed by Cynthia Shang.
2019-08-21 22:26:28 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- name: backup-common
Convert BackupType enum to StringId. Allows removal of backupType()/backupTypeStr() and improves debug logging of the enum. Move BackupType enum and string constants to info/infoBackup.h so they are available to more modules. Also convert InfoBackup to use BackupType instead of a String.
2021-05-03 18:15:39 +02:00
total: 2
The stanza-create/update/delete commands are implemented entirely in C. Contributed by Cynthia Shang.
2019-08-21 22:26:28 +02:00
coverage:
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
- command/backup/common
- command/backup/pageChecksum
# ----------------------------------------------------------------------------------------------------------------------------
- name: backup
total: 10
coverage:
- command/backup/backup
- command/backup/common
- command/backup/file
- command/backup/protocol
include:
- info/info
- info/manifest
- storage/storage
The stanza-create/update/delete commands are implemented entirely in C. Contributed by Cynthia Shang.
2019-08-21 22:26:28 +02:00
Add ls command. Allows listing repo paths/files from the command-line, to be used primarily for testing and debugging. This command is internal-only so the interface may change at any time without notice.
2019-05-28 16:03:48 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Rename ls command to repo-ls. This command only makes sense for the repository storage since other storage (e.g. pg and spool) must be located on a local Posix filesystem and can be listed using standard unix commands. Since the repo storage can be located lots of places having a common way to list it makes sense. Prefix with repo- to make the scope of this command clear. Update documentation to reflect this change.
2020-03-09 22:41:04 +02:00
- name: repo
Add repo-create, repo-get, repo-put, and repo-rm commands. These commands are generally useful but more importantly they allow removing LibC by providing the Perl integration tests an alternate way to work with repository storage. All the commands are currently internal only and should not be used on production repositories.
2020-03-09 23:15:03 +02:00
total: 4
Add ls command. Allows listing repo paths/files from the command-line, to be used primarily for testing and debugging. This command is internal-only so the interface may change at any time without notice.
2019-05-28 16:03:48 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/repo/get
- command/repo/ls
- command/repo/put
- command/repo/rm
Add repo-create, repo-get, repo-put, and repo-rm commands. These commands are generally useful but more importantly they allow removing LibC by providing the Perl integration tests an alternate way to work with repository storage. All the commands are currently internal only and should not be used on production repositories.
2020-03-09 23:15:03 +02:00
include:
# command/repo/create is currently for testing purposes only so coverage is not provided except in integration. In the
# future this will probably be rolled into a custom object store server implementation.
- command/repo/create
Add ls command. Allows listing repo paths/files from the command-line, to be used primarily for testing and debugging. This command is internal-only so the interface may change at any time without notice.
2019-05-28 16:03:48 +02:00
Add internal verify command. Scan the WAL archive for missing or invalid files and build up ranges of WAL that will be used to verify backup integrity. A number of errors and warnings are currently emitted but they should not be considered authoritative (yet). The command is incomplete so is marked internal.
2020-09-22 17:57:38 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: verify
Add backup verification to internal verify command. This is phase 2 of verify command development (phase 1 was processing the archives and phase 3 will be reconciling the archives and backups). In this phase the backups are verified by verifying each file listed in the manifest for the backup and creating a result set with the list of invalid files, if any. A summary is then rendered. Unit tests have been added and duplicate tests have been removed.
2021-01-26 18:21:36 +02:00
total: 8
Add internal verify command. Scan the WAL archive for missing or invalid files and build up ranges of WAL that will be used to verify backup integrity. A number of errors and warnings are currently emitted but they should not be considered authoritative (yet). The command is incomplete so is marked internal.
2020-09-22 17:57:38 +02:00
coverage:
Improve test coverage list handling. All unit tests now require full coverage so the "full" keyword is obsolete and has been removed. The covered code modules are simply listed, with only "no code" modules annotated.
2021-01-15 17:56:51 +02:00
- command/verify/file
- command/verify/protocol
- command/verify/verify
Add internal verify command. Scan the WAL archive for missing or invalid files and build up ranges of WAL that will be used to verify backup integrity. A number of errors and warnings are currently emitted but they should not be considered authoritative (yet). The command is incomplete so is marked internal.
2020-09-22 17:57:38 +02:00
Make unit test builds incremental based on coverage in prior tests. When building tests only include files covered by the current test or by prior tests. This increases performance (less compilation and linking) and also helps detect cross-dependencies in the code. Since there are currently cross-dependencies the depend option is used to document them and allow compilation. The idea is to resolve them incrementally over time. Add the harness option to include harness modules when the minimum requirements for compilation are met. Add the feature option to indicate which features are now available in the harness (based on source modules already tested). This allows conditional compilation in harness modules when some features are not yet available.
2021-01-27 17:57:42 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: local
total: 1
coverage:
- command/local/local
Divide tests into three types (unit, integration, performance). Many options that were set per test can instead be inferred from the types, i.e. container, c, expect, and individual. Also finish renaming Perl unit tests with the -perl suffix.
2018-04-24 15:12:25 +02:00
# **********************************************************************************************************************************
# Integration tests
#
# Integration tests are not run in a container. They are expected to create their own containers since most integration runs will
# create more than one. For this reason each run is executed individually.
# **********************************************************************************************************************************
integration:
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: mock
test:
# ----------------------------------------------------------------------------------------------------------------------------
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
- name: stanza
Create test matrix for mock/stanza to increase coverage and reduce tests. The same test configurations are run on all four test VMs, which seems a real waste of resources. Vary the tests per VM to increase coverage while reducing the total number of tests. Be sure to include each major feature (remote, s3, encryption) in each VM at least once.
2019-02-24 07:42:41 +02:00
total: 2
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
- name: expire
Create test matrix for mock/expire to increase coverage and reduce tests. The same test configurations are run on all four test VMs, which seems a real waste of resources. Vary the tests per VM to increase coverage while reducing the total number of tests.
2019-03-01 19:04:26 +02:00
total: 2
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: archive
Create test matrix for mock/archive to increase coverage and reduce tests. The same test configurations are run on all four test VMs, which seems a real waste of resources. Vary the tests per VM to increase coverage while reducing the total number of tests. Be sure to include each major feature (remote, s3, encryption) in each VM at least once.
2019-02-23 15:59:39 +02:00
total: 2
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
- name: archive-stop
Create test matrix for mock/archive-stop to increase coverage and reduce tests. The same test configurations are run on all four test VMs, which seems a real waste of resources. Vary the tests per VM to increase coverage while reducing the total number of tests. Be sure to include each major feature (remote, s3, encryption) in each VM at least once.
2019-03-01 17:12:41 +02:00
total: 2
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: all
Create test matrix for mock/all to increase coverage and reduce tests. The same test configurations are run on all four test VMs, which seems a real waste of resources. Vary the tests per VM to increase coverage while reducing the total number of tests. Be sure to include each major feature (remote, s3, encryption) in each VM at least once.
2019-03-02 15:01:02 +02:00
total: 2
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: real
Move archive-stop and expire tests to the mock module. These are mock integration tests so they should be grouped with the other mock integration tests.
2018-04-08 18:57:02 +02:00
db: true
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: all
Simplify test matrix for real/all tests. Test matrices were previously simplified for the mock/* tests (e.g. d4410611, d489eb87) but not for real/all since the rules for which tests would run with which options was extremely complex. This only got more complex when new compression formats were added. Because the loop-generated matrix was so large, mosts tests were skipped for most option combinations following arcane logic which was nearly impossible to decipher even when reading the code, and completely impossible from the test.pl interface. As a consequence, important tests got excluded. For example, backup from standby was excluded for most versions of PostgreSQL because it was only run once per distro, against the latest version to be included in that distro. Simplify the tests by having a single run per PostgreSQL version and vary test parameters according to the capabilities of each version and the underlying distro. So, ZST testing is based on whether the distro supports ZST. Every test is run for each set of parameters based on the capabilities of the PostgreSQL version, e.g. backup from standby is not attempted on versions that don't support it. Note that since more tests are running the overall time to run the mock/all tests has increased by about 20-25%. Some time may be saved my removing tests that are adequately covered by unit tests but that should the subject of another commit. Another option would be to limit some non version-specific tests to a single, well defined version of PostgreSQL, .e.g the version that is run by expect tests, currently 9.6. The motivation for this refactor is that new storage drivers are coming and the loop-generated test matrix simply was not up to the task of adding them. The following is an example of the new test log (note longer runtime of each test): module=real, test=all, run=1, pg-version=10 (106.91s) module=real, test=all, run=1, pg-version=9.5 (151.09s) module=real, test=all, run=1, pg-version=9.2 (123.11s) module=real, test=all, run=1, pg-version=9.1 (129s) vs. the old test log (sub-second tests were skipped entirely): module=real, test=all, run=2, pg-version=10 (0.31s) module=real, test=all, run=3, pg-version=10 (0.26s) module=real, test=all, run=4, pg-version=10 (60.39s) module=real, test=all, run=1, pg-version=10 (69.12s) module=real, test=all, run=6, pg-version=10 (34s) module=real, test=all, run=5, pg-version=10 (42.75s) module=real, test=all, run=2, pg-version=9.5 (0.21s) module=real, test=all, run=3, pg-version=9.5 (0.21s) module=real, test=all, run=4, pg-version=9.5 (0.21s) module=real, test=all, run=5, pg-version=9.5 (0.26s) module=real, test=all, run=6, pg-version=9.5 (0.21s) module=real, test=all, run=1, pg-version=9.2 (72.78s) module=real, test=all, run=2, pg-version=9.2 (0.26s) module=real, test=all, run=3, pg-version=9.2 (0.31s) module=real, test=all, run=4, pg-version=9.2 (0.21s) module=real, test=all, run=5, pg-version=9.2 (0.21s) module=real, test=all, run=6, pg-version=9.2 (0.21s) module=real, test=all, run=1, pg-version=9.5 (88.41s) module=real, test=all, run=2, pg-version=9.1 (0.21s) module=real, test=all, run=3, pg-version=9.1 (0.26s) module=real, test=all, run=4, pg-version=9.1 (0.21s) module=real, test=all, run=5, pg-version=9.1 (0.31s) module=real, test=all, run=6, pg-version=9.1 (0.26s) module=real, test=all, run=1, pg-version=9.1 (72.4s)
2020-06-23 19:44:29 +02:00
total: 1
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
Divide tests into three types (unit, integration, performance). Many options that were set per test can instead be inferred from the types, i.e. container, c, expect, and individual. Also finish renaming Perl unit tests with the -perl suffix.
2018-04-24 15:12:25 +02:00
# **********************************************************************************************************************************
# Performance tests
#
# Performance tests run in a single container but are more like integration tests than unit tests since they call the pgbackrest
# executable directly.
# **********************************************************************************************************************************
performance:
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
# ********************************************************************************************************************************
- name: performance
test:
# ----------------------------------------------------------------------------------------------------------------------------
Identify Perl performance test by appending -perl. This is intended to differentiate the upcoming C performance tests from the Perl performance tests that will eventually be migrated.
2019-09-28 19:17:21 +02:00
- name: archive-perl
Move test definitions to test/define.yaml. The location is better because it is no longer buried in the Perl test libs. Also, the data can be easily accessed from C.
2018-04-08 16:19:24 +02:00
total: 1
Move C performance tests out of unit tests. Performance tests were being done in unit tests until there was a better place to put them. Now there is, so move them there.
2019-09-28 20:24:27 +02:00
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: type
Improve performance of large file lists in backup/restore commands. lstRemoveIdx(list, 0) resulted in the entire list being moved down to the first position which could take a long time for big lists. This is a common pattern in backup/restore when processing file queues. Instead simply move the list pointer up when first item is removed. Then on insert check if there is space at the beginning when there is no longer space at the end and do the move then. This way if a list is built and then drained without any new inserts then no move is required.
2020-10-26 18:18:45 +02:00
total: 5
Add performance/storage test. The primary purpose of this test (currently) is to measure the performance of storageRemoteInfoList(), which is critical for building a manifest when the PostgreSQL host is remote. The starting baseline of 1 million files is perhaps a bit aggressive but it seems very likely to blow up if there are performance regressions.
2020-03-27 03:05:36 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: storage
Add storage filter performance test. This test allows the important storage filters to be benchmarked by MiB/s.
2020-03-30 03:25:48 +02:00
total: 2
Add performance/storage test. The primary purpose of this test (currently) is to measure the performance of storageRemoteInfoList(), which is critical for building a manifest when the PostgreSQL host is remote. The starting baseline of 1 million files is perhaps a bit aggressive but it seems very likely to blow up if there are performance regressions.
2020-03-27 03:05:36 +02:00
include:
- storage/helper
Reference in New Issue Copy Permalink