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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1072 lines
34 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
Add explicit keyword for covered modules included in other modules. This was done by checking the extension but it is possible to include a module that does not have a vendor or auto extension. Instead make it explicit that the module is included in another module. Also change the variable from "include" to "included" to make it clearer what it indicates.
2022-12-31 05:10:44 +02:00
# a code module contains only data it should be marked noCode (e.g. - help/help.auto: noCode). If a code module is included
# in another code module it should be marked as included (e.g. - md5.vendor: included).
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
Allow stack trace to be specified for errorInternalThrow(). This allows the stack trace to be set when an error is received by the protocol, rather than appending it to the message. Now these errors will look no different than any other error and the stack trace will be reported in the same way. One immediate benefit is that test.pl --vm-out --log-level-test=debug will work for tests that check expect log results. Previously, the test would error at the first check because the stack trace included in the message would not match the expected log output.
2021-10-01 21:29:31 +02:00
total: 9
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:
Move error modules to common/error directory. There are already enough files to warrant a separate directory and more are coming. Also remove extraneous includes.
2023-04-06 08:38:49 +02:00
common/error/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:
Move error modules to common/error directory. There are already enough files to warrant a separate directory and more are coming. Also remove extraneous includes.
2023-04-06 08:38:49 +02:00
- common/error/error
- common/error/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
Enhance libbacktrace to handle incomplete stack traces. This fills in backtrace info at the bottom of the call stack when the stack trace is incomplete due to testing. This does not affect release builds, which is why it did not make the first cut, but it turns out to be useful for testing and barely changes the release code (when we do release this). The recursion test in common/error was simplified because it would now return a very large trace.
2023-01-12 05:22:26 +02:00
harness:
name: stackTrace
shim:
common/stackTrace:
function:
- stackTraceBackCallback
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
Refactor logging functions to never allocate memory. Allocating memory made these functions simpler but it meant that memory was leaking into the calling context when logging was enabled. It is not clear that this was an issue but it seems that trace level logging could result it a lot of memory usage depending on the use case. This also makes it possible to audit allocations returned to the calling context, which will be done in a followup commit. Also rename objToLog() to objNameToLog() since it seemed logical to name the new function objToLog().
2023-01-12 12:14:36 +02:00
- common/type/stringStatic
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
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
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
Ensure ASSERT() macro is always available in test modules. Tests that run without DEBUG for performance did not have ASSERT() and were using CHECK() instead. Instead ensure that the ASSERT() macro is always available in tests.
2021-11-24 23:09:45 +02:00
feature: assert
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
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
Audit mem contexts returned from functions into the calling context. It is possible for functions to accidentally leak child contexts into the calling context, which may use a lot of memory depending on the use case and where it happens. Use the function return type to determine what should be returned and error when something else is returned. Add FUNCTION_AUDIT_*() macros to handle exceptions. This checking is only performed during unit tests on the code being covered by the specific unit test. Note that this does not work yet for memory allocations, i.e. memNew(). These are pretty rare so are not as much of an issue and they can be added in the future.
2023-01-12 12:36:57 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-convert
total: 12
coverage:
- common/type/convert
Move getEpoch() to cvtZToTime() and refactor. This function will be needed elsewhere going forward and in any case it makes sense to move this out of the restore module. Refactor to avoid dependency on a regular expression.
2024-08-17 07:58:55 +02:00
depend:
- 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
# ----------------------------------------------------------------------------------------------------------------------------
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
Improve retry error messages. Centralize the code to allow it to be used in more places and update the protocol/server module to use the new code. Since the time measurements make testing difficult, also add time and errorRetry harnesses to allow specific data to be used for testing. In the case of errorRetry, the production behavior is turned off by default during testing and only enabled for the errorRetry test module.
2023-04-06 09:03:46 +02:00
harness:
name: time
shim:
common/time:
function:
- timeMSec
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
Move getEpoch() to cvtZToTime() and refactor. This function will be needed elsewhere going forward and in any case it makes sense to move this out of the restore module. Refactor to avoid dependency on a regular expression.
2024-08-17 07:58:55 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: mem-context
total: 8
feature: memContext
coverage:
- common/memContext
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 hex encode/decoding to decode module. This replaces the bufHex() function and also allows hex to be decoded.
2022-12-11 14:46:48 +02:00
total: 3
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
Create snapshot when listing contents of a path. Previously a callback was used to list path contents and if no sort was specified then a snapshot was not required. When deleting files from the path some filesystems could omit files that still existed, which meant the path could not be removed. Filter . out of lists in the Posix driver since this special entry was only used by test code (and filtered everywhere in the core code). Also remove callbacks from the storage interface and replace with an iterator that should be easier to use and guarantees efficient use of the snapshots.
2022-07-08 23:21:39 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-blob
total: 1
coverage:
- common/type/blob
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
Remove unused functions. These functions were either added with the intention that they would be used or they became obsolete over time.
2022-12-30 11:26:48 +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:
Move strReplace() and strUpper() to build/common/string module. Neither of these functions were used by the core code. strReplace() is only used in the tests but it doesn't hurt to put it in build since the build code is not distributed.
2022-12-31 05:26:11 +02:00
- build/common/string
- common/type/string: included
Add zNewFmt(). This replaces strZ(strNewFmt()), making the code simpler and reducing indentation.
2022-05-06 18:32:49 +02:00
- common/type/stringZ
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
Improve retry error messages. Centralize the code to allow it to be used in more places and update the protocol/server module to use the new code. Since the time measurements make testing difficult, also add time and errorRetry harnesses to allow specific data to be used for testing. In the case of errorRetry, the production behavior is turned off by default during testing and only enabled for the errorRetry test module.
2023-04-06 09:03:46 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: error-retry
total: 1
harness:
name: errorRetry
shim:
common/error/retry:
function:
Aggregate error retries in ErrorRetry output. If there are a lot of retries then the output might be very large and even be truncated by the error module. Either way, it is not good information for the user. When a message is repeated, aggregate so that total retries and time range are output for the message. This provides helpful information about what happened without overwhelming the user with data.
2023-09-09 18:54:55 +02:00
- errRetryMessage
Improve retry error messages. Centralize the code to allow it to be used in more places and update the protocol/server module to use the new code. Since the time measurements make testing difficult, also add time and errorRetry harnesses to allow specific data to be used for testing. In the case of errorRetry, the production behavior is turned off by default during testing and only enabled for the errorRetry test module.
2023-04-06 09:03:46 +02:00
coverage:
- common/error/retry
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
Add hex encode/decoding to decode module. This replaces the bufHex() function and also allows hex to be decoded.
2022-12-11 14:46:48 +02:00
total: 5
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:
Move regExpMatchPtr()/regExpMatchStr() to build/common/regExp module. Similar to b9be4fa5, these functions are not used by the core code so move them to the build module. The new implementation is a little less efficient but that is much less of a worry in the build/test code. Also remove regExpMatchSize() since it was not longer needed.
2022-12-31 07:54:33 +02:00
- build/common/regExp
- common/regExp: included
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
Refactor logging functions to never allocate memory. Allocating memory made these functions simpler but it meant that memory was leaking into the calling context when logging was enabled. It is not clear that this was an issue but it seems that trace level logging could result it a lot of memory usage depending on the use case. This also makes it possible to audit allocations returned to the calling context, which will be done in a followup commit. Also rename objToLog() to objNameToLog() since it seemed logical to name the new function objToLog().
2023-01-12 12:14:36 +02:00
total: 4
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
Refactor logging functions to never allocate memory. Allocating memory made these functions simpler but it meant that memory was leaking into the calling context when logging was enabled. It is not clear that this was an issue but it seems that trace level logging could result it a lot of memory usage depending on the use case. This also makes it possible to audit allocations returned to the calling context, which will be done in a followup commit. Also rename objToLog() to objNameToLog() since it seemed logical to name the new function objToLog().
2023-01-12 12:14:36 +02:00
- common/type/stringStatic
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 basic C JSON parser.
2018-08-09 14:06:23 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: type-json
Improve JSON handling. Previously read/writing JSON required parsing/render via a variant, which add many more memory allocations and loops. Instead allow JSON to be read/written serially to improve performance and simplify the code. This also allows us to get rid of many String and Variant constant which are no longer required. The goal is to be able to read/write very large (e.g. gigabyte manifest) JSON structures, which would not be practical with the current code. Note that external JSON (GCS, S3, etc) is still handled using variants. Converting these will require more consideration about key ordering since it cannot be guaranteed as in our own formats.
2022-04-25 15:06:26 +02:00
total: 2
Add basic C JSON parser.
2018-08-09 14:06:23 +02:00
coverage:
Migrate coverage testing to C and remove dependency on lcov. lcov does not seem to be very well maintained and is often not compatible with the version of gcc it ships with until a few months after a new distro is released. In any case, lcov is that not useful for us because it generates reports on all coverage while we are mainly interested in missing coverage during development. Instead use the JSON output generated by gcov to generate our minimal coverage report and metrics for the documentation. There are some slight differences in the metrics. The difference in the common module was due to a bug in the old code -- build/common was being added into common as well as being reported separately. The source of the two additional branches in the backup module is unknown but almost certainly down to how exclusions are processed with regular expressions. Since there is additional coverage rather than coverage missing this seems fine. Since this was pretty much a rewrite it was also a good time to migrate to C.
2024-05-31 06:52:07 +02:00
- build/common/json
- common/type/json: included
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:
Move xmlNodeAttribute() to build/common/xml module. Similar to b9be4fa5, this function was not used by the core code so move it to the build module.
2022-12-31 06:09:50 +02:00
- build/common/xml
- common/type/xml: included
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
Block-level incremental backup. The primary goal of the block incremental backup is to save space in the repository by only storing changed parts of a file rather than the entire file. This implementation is focused on restore performance more than saving space in the repository, though there may be substantial savings depending on the workload. The repo-block option enables the feature (when repo-bundle is already enabled). The block size is determined based on the file size and age. Very old or very small files will not use block incremental.
2023-01-20 11:48:57 +02:00
total: 6
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
Move fd module shim to io module test. The shim is needed in an earlier test and this is a more logical place for it anyway.
2024-10-09 09:46:45 +02:00
harness:
name: fd
shim:
common/io/fd:
function:
- fdReady
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
Removing chunking and block numbers from incremental block list. These were intended to allow the block list to be scanned without reading the map but were never utilized. They were left in "just in case" and because they did not seem to be doing any harm. In fact, it is better not to have the block numbers because this allows us set the block size at a future time as long as it is a factor of the super block size. One way this could be useful is to store older files without super blocks or a map in the full backup and then build a map for them if the file gets modified in a diff/incr backup. This would require reading the file from the full backup to build the map but it would be more space efficient and we could make more intelligent decisions about block size. It would also be possible to change the block size even if one had already been selected in a prior backup. Omitting the block numbers makes the chunking unnecessary since there is now no way to make sense of the block list without the map. Also, we might want to build maps for unchunked block lists, i.e. files that were copied normally.
2023-04-27 22:29:12 +02:00
- common/io/limitRead
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/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
Move protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: compress
total: 5
coverage:
- 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
depend:
- storage/posix/read
- storage/posix/storage
- storage/posix/write
Create snapshot when listing contents of a path. Previously a callback was used to list path contents and if no sort was specified then a snapshot was not required. When deleting files from the path some filesystems could omit files that still existed, which meant the path could not be removed. Filter . out of lists in the Posix driver since this special entry was only used by test code (and filtered everywhere in the core code). Also remove callbacks from the storage interface and replace with an iterator that should be easier to use and guarantees efficient use of the snapshots.
2022-07-08 23:21:39 +02:00
- storage/iterator
- storage/list
Move protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +02:00
- storage/read
- storage/storage
- storage/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
# ----------------------------------------------------------------------------------------------------------------------------
- name: crypto
Use xxHash instead of SHA-1 for block incremental checksums. xxHash is significantly faster than SHA-1 so this helps reduce the overhead of the feature. A variable number of bytes are used from the xxHash depending on the block size with a minimum of six bytes for the smallest block size. This keeps the maps smaller while still providing enough bits to detect block changes.
2023-03-09 05:02:04 +02:00
total: 4
Move protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +02:00
feature: STORAGE
Use Posix driver to complete dummy storage driver. Instead of stub functions, use the Posix driver to make the dummy storage driver interface more functional.
2024-08-02 10:47:30 +02:00
harness:
name: storage
shim:
storage/posix/storage: ~
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
coverage:
- common/crypto/cipherBlock
- common/crypto/common
- common/crypto/hash
Add explicit keyword for covered modules included in other modules. This was done by checking the extension but it is possible to include a module that does not have a vendor or auto extension. Instead make it explicit that the module is included in another module. Also change the variable from "include" to "included" to make it clearer what it indicates.
2022-12-31 05:10:44 +02:00
- common/crypto/md5.vendor: included
Use xxHash instead of SHA-1 for block incremental checksums. xxHash is significantly faster than SHA-1 so this helps reduce the overhead of the feature. A variable number of bytes are used from the xxHash depending on the block size with a minimum of six bytes for the smallest block size. This keeps the maps smaller while still providing enough bits to detect block changes.
2023-03-09 05:02:04 +02:00
- common/crypto/xxhash
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
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
Refactor address list lookup to include all returned addresses. sckHostLookup() only returned the first address record returned from getaddrinfo(). The new AddressInfo object provides a full list of values returned from getaddrinfo(). Freeing the list is also handled by the object so there is no longer a need for FINALLY blocks to ensure the list is freed. Add the selected address to the client/server names for debugging purposes. This code does not attempt to connect to multiple addresses. It just lays the groundwork for a future commit to do so.
2023-09-10 16:36:58 +02:00
total: 6
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
SFTP support for repository storage.
2023-05-13 18:16:16 +02:00
harness:
name: socket
shim:
common/io/socket/client:
function:
- sckClientOpen
Improved support for dual stack connections. Connections are established using the "happy eyeballs" approach from RFC 8305, i.e. new addresses (if available) are tried if the prior address has already had a reasonable time to connect. This prevents waiting too long on a failed connection but does not try all the addresses at once. Prior connections that are still waiting are rechecked periodically if no subsequent connection is successful. This improves substantially on 39bb8a0, which failed to take into account connection attempts that do not fail (but never connect) and use up all the available time.
2024-03-10 00:36:39 +02:00
- sckClientOpenWait
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
Add TLS Server. The TLS server is an alternative to using SSH for protocol connections to remote hosts. This command is currently experimental and intended only for trial and testing. As such, the new commands and options will not show up in the command-line help unless directly requested.
2021-10-18 20:32:41 +02:00
- common/io/server
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/session
- common/io/tls/client
Add TLS Server. The TLS server is an alternative to using SSH for protocol connections to remote hosts. This command is currently experimental and intended only for trial and testing. As such, the new commands and options will not show up in the command-line help unless directly requested.
2021-10-18 20:32:41 +02:00
- common/io/tls/common
- common/io/tls/server
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/tls/session
Refactor address list lookup to include all returned addresses. sckHostLookup() only returned the first address record returned from getaddrinfo(). The new AddressInfo object provides a full list of values returned from getaddrinfo(). Freeing the list is also handled by the object so there is no longer a need for FINALLY blocks to ensure the list is freed. Add the selected address to the client/server names for debugging purposes. This code does not attempt to connect to multiple addresses. It just lays the groundwork for a future commit to do so.
2023-09-10 16:36:58 +02:00
- common/io/socket/address
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/socket/client
- common/io/socket/common
Add TLS Server. The TLS server is an alternative to using SSH for protocol connections to remote hosts. This command is currently experimental and intended only for trial and testing. As such, the new commands and options will not show up in the command-line help unless directly requested.
2021-10-18 20:32:41 +02:00
- common/io/socket/server
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/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 GCS batch delete support. The GCS driver sent a single file delete request for each file while deleting a path. Depending on latency this could lead to rather long delete times, especially noticeable during expiration. Improve GCS delete to use batches, which require multipart HTTP, so also add multipart HTTP infrastructure.
2024-04-27 07:42:10 +02:00
total: 7
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
Improved support for dual stack connections. Connections are established using the "happy eyeballs" approach from RFC 8305, i.e. new addresses (if available) are tried if the prior address has already had a reasonable time to connect. This prevents waiting too long on a failed connection but does not try all the addresses at once. Prior connections that are still waiting are rechecked periodically if no subsequent connection is successful. This improves substantially on 39bb8a0, which failed to take into account connection attempts that do not fail (but never connect) and use up all the available time.
2024-03-10 00:36:39 +02:00
include:
- common/io/socket/address
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
Add execOne() to simplify exec for build, documentation, and testing. The core Exec object is efficient but geared toward the specific needs of core and not ease-of-use as required for build, documentation, and testing. execOne() works similarly to system() except that it automatically redirects stderr to stdout and captures the output.
2024-02-24 00:22:48 +02:00
total: 2
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
coverage:
Add execOne() to simplify exec for build, documentation, and testing. The core Exec object is efficient but geared toward the specific needs of core and not ease-of-use as required for build, documentation, and testing. execOne() works similarly to system() except that it automatically redirects stderr to stdout and captures the output.
2024-02-24 00:22:48 +02:00
- build/common/exec
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: ini
Refactor common/ini module to remove callbacks and duplicated code. The callbacks in iniLoad() made the downstream code more complicated than it needed to be so use an iterator model instead. Combine the two functions that were used to load the ini data to remove code duplication. In theory it would be nice to use iniValueNext() in the config/parse module rather than loading a KeyValue store but this would mean a big change to the parser, which does not seem worthwhile at this time.
2023-01-12 16:24:28 +02:00
total: 2
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
coverage:
- common/ini
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 protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +02:00
- name: lock
Refactor lock module. Refactor the lock module to split command-specific logic from the basic file locking functionality. Command specific logic is now in command/lock.c. This will make it easier to implement new features such as repository locking and updating lock file contents on remotes. This implementation is essentially a drop-in replacement but there are a few differences. First, the lock names no longer require a path (the path is added in the lock module). Second, the timeout functionality has been removed since it was not being used.
2024-06-18 04:43:54 +02:00
total: 1
Move storageHelperFree() to storageHelper test harness. This function was only used for testing so move into a test harness.
2022-12-31 08:14:27 +02:00
harness:
Multi-stanza check command. Check command now checks multiple stanzas when the stanza option is omitted. The stanza list is extracted from the current configuration rather than scanning the repository like the info command. Scanning the repository is a problem because configuration for each stanza may not be present in the current configuration. Since this functionality is new for check there is no regression. Add a new section to the user guide to cover multi-stanza configuration and provide additional coverage for this feature. Also fix a small issue in the parser when an indexed option has a dependency on a non-indexed option. There were no examples of this case in the previous configuration.
2023-08-07 18:03:09 +02:00
name: config
Move storageHelperFree() to storageHelper test harness. This function was only used for testing so move into a test harness.
2022-12-31 08:14:27 +02:00
shim:
Multi-stanza check command. Check command now checks multiple stanzas when the stanza option is omitted. The stanza list is extracted from the current configuration rather than scanning the repository like the info command. Scanning the repository is a problem because configuration for each stanza may not be present in the current configuration. Since this functionality is new for check there is no regression. Add a new section to the user guide to cover multi-stanza configuration and provide additional coverage for this feature. Also fix a small issue in the parser when an indexed option has a dependency on a non-indexed option. There were no examples of this case in the previous configuration.
2023-08-07 18:03:09 +02:00
config/load: ~
Add lock module initialization. Each call to lockAcquireP() passed enough information to initialize the lock system. This was somewhat inefficient and as locks become more complicated it will lead to more code duplication. Since a process can only take one type of lock it makes sense to do most of the initialization up front. Also reduce the log level of lockRelease() since it is only called at exit and the lock will be released in any case.
2023-03-25 09:07:31 +02:00
harness:
name: lock
shim:
common/lock:
function:
- lockInit
Allow repositories on versioned storage to be read at a target time. This feature allows the archive-get, info, repo-get, repo-ls, restore, and verify commands to operate at a point-in-time on versioned buckets in Azure, GCS, and S3. This allows recovery even if a repository has been accidentally or maliciously deleted or corrupted.
2024-09-17 09:51:21 +02:00
harness:
name: storageHelper
shim:
storage/helper:
function:
- storageRepoGet
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:
Move protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +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
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:
Refactor lock module. Refactor the lock module to split command-specific logic from the basic file locking functionality. Command specific logic is now in command/lock.c. This will make it easier to implement new features such as repository locking and updating lock file contents on remotes. This implementation is essentially a drop-in replacement but there are a few differences. First, the lock names no longer require a path (the path is added in the lock module). Second, the timeout functionality has been removed since it was not being used.
2024-06-18 04:43:54 +02:00
- command/lock
Display size option default and allowed values with appropriate units. Size option default and allowed values were displayed in bytes, which was confusing for the user. This also lays the groundwork for adding units to time options. Move option parsing functions into a common module so they can be used from the build module.
2021-11-03 21:23:08 +02:00
- config/common
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
- config/config
- config/parse
- config/exec
- config/load
- config/protocol
- command/command
- postgres/interface
Retry reads of pg_control until checksum is valid. On certain file systems (e.g. ext4) pg_control may appear torn if there is a concurrent write while reading the file. To prevent an invalid read, retry until the checksum matches the control data. Special handling is required for the pg-version-force feature since the offset of the checksum is not known. In this case, scan from the default position to the end of the data looking for a checksum match. This is a bit imprecise, but better than nothing, and the chance of a random collision in the control data seems very remote considering the ratio of data size (< 512 bytes) to checksum size (4 bytes). This was discovered and a possible solution proposed for PostgreSQL in [1]. The proposed solution may work for backup, but pgBackRest needs to be able to read pg_control reliably outside of backup. So no matter what fix is adopted for PostgreSQL, pgBackRest need retries. Further adjustment may be required as the PostgreSQL fix evolves. [1] https://www.postgresql.org/message-id/20221123014224.xisi44byq3cf5psi%40awork3.anarazel.de
2023-09-10 15:47:49 +02:00
- postgres/interface/crc32
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
- postgres/interface/page
- protocol/client
- protocol/helper
- protocol/server
- storage/helper
- storage/remote/read
- storage/remote/protocol
- storage/remote/storage
- storage/remote/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
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
Add TLS Server. The TLS server is an alternative to using SSH for protocol connections to remote hosts. This command is currently experimental and intended only for trial and testing. As such, the new commands and options will not show up in the command-line help unless directly requested.
2021-10-18 20:32:41 +02:00
total: 8
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/helper
- protocol/parallel
- protocol/parallelJob
- protocol/server
include:
Add execOne() to simplify exec for build, documentation, and testing. The core Exec object is efficient but geared toward the specific needs of core and not ease-of-use as required for build, documentation, and testing. execOne() works similarly to system() except that it automatically redirects stderr to stdout and captures the output.
2024-02-24 00:22:48 +02:00
- build/common/exec
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
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:
Display size option default and allowed values with appropriate units. Size option default and allowed values were displayed in bytes, which was confusing for the user. This also lays the groundwork for adding units to time options. Move option parsing functions into a common module so they can be used from the build module.
2021-11-03 21:23:08 +02:00
- config/common
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
Allow repositories on versioned storage to be read at a target time. This feature allows the archive-get, info, repo-get, repo-ls, restore, and verify commands to operate at a point-in-time on versioned buckets in Azure, GCS, and S3. This allows recovery even if a repository has been accidentally or maliciously deleted or corrupted.
2024-09-17 09:51:21 +02:00
total: 24
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
coverage:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/cifs/helper
- storage/cifs/storage
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/posix/read
- storage/posix/storage
- storage/posix/write
- storage/helper
Create snapshot when listing contents of a path. Previously a callback was used to list path contents and if no sort was specified then a snapshot was not required. When deleting files from the path some filesystems could omit files that still existed, which meant the path could not be removed. Filter . out of lists in the Posix driver since this special entry was only used by test code (and filtered everywhere in the core code). Also remove callbacks from the storage interface and replace with an iterator that should be easier to use and guarantees efficient use of the snapshots.
2022-07-08 23:21:39 +02:00
- storage/iterator
- storage/list
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/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
# ----------------------------------------------------------------------------------------------------------------------------
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- name: remote
Allow repositories on versioned storage to be read at a target time. This feature allows the archive-get, info, repo-get, repo-ls, restore, and verify commands to operate at a point-in-time on versioned buckets in Azure, GCS, and S3. This allows recovery even if a repository has been accidentally or maliciously deleted or corrupted.
2024-09-17 09:51:21 +02:00
total: 11
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
coverage:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/remote/read
- storage/remote/protocol
- storage/remote/storage
- storage/remote/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
- storage/helper
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/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
include:
Protocol command multiplexing. Previously it was not possible to read or write two files at the same time on the same remote because the protocol was entirely taken over by the read or write command. Multiple reads are required to make restores efficient when a list of bundled files is being read but blocks need to be retrieved from a separate file or a different part of the same file. Improve that situation with sessions that allow related commands to be run with shared state. Also break read/write into separate requests (rather than pushing all data at once) so they can be multiplexed. The disadvantage for read/write is that they now require more back and forth to transfer a file. This is mitigated by sending asynchronous read/write requests to keep both server and client as busy as possible. Reads that can fit into a single buffer are optimized to transfer in a single command. Reads that transfer the entire file can also skip the close command since it is implicit on end-of-file. These changes allow the protocol to be simplified to provide one response per request, which makes the data end message obsolete. Any data sent for the request is now added to the parameters so no data needs to be sent separately to the server outside the request parameters. Also update the Db protocol to use the new sessions. Previously this code had tracked its own sessions.
2024-07-22 06:48:32 +02:00
- protocol/client
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/read
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/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:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/azure/helper
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
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:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- 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
- 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 configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- name: gcs
total: 3
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
coverage:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/gcs/helper
- storage/gcs/read
- storage/gcs/storage
- storage/gcs/write
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:
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/helper
- storage/storage
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
- 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:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/s3/helper
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
Add --repo-storage-tag option to create object tags. This new option allows tags to be added to objects in S3, GCS, and Azure repositories. This was fairly straightforward for S3 and Azure, but GCS does not allow tags for a simple upload using the JSON interface. If tags are required then the resumable interface must be used even if the file falls below the limit that usually triggers a resumable upload (i.e. size < repo-storage-upload-chunk-size). This option is structured so that tags must be specified per-repo rather than globally for all repos. This seems logical since the tag keys and values may vary by service, e.g. S3 vs GCS. These storage tags are independent of backup annotations since they are likely to be used for different purposes, e.g. billing, while the backup annotations are primarily intended for monitoring.
2023-09-14 14:22:21 +02:00
- storage/helper
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:
Add configurable storage helpers to create repository storage. Remove the hardcoded storage helpers from storageRepoGet() except for the the built-in Posix helper and the special remote helper. The goal is to make storage driver development a bit easier by isolating as much of the code as possible into the driver module. This also makes coverage reporting much simpler for additional drivers since they do not need to provide coverage for storage/helper. Consolidate the CIFS tests into the Posix tests since CIFS is just a special case of the Posix. Test all storage features in the Posix test so that other storage driver tests do not need to provide coverage for storage/storage. Remove some dead code in the storage/s3 test.
2021-10-07 01:27:04 +02:00
- storage/storage
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
- storage/write
SFTP support for repository storage.
2023-05-13 18:16:16 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: sftp
Improve SFTP error messages. The numbers by themselves weren't very informative and required looking into the libssh2_sftp.h header file for the definition.
2024-10-10 10:17:35 +02:00
total: 20
Migrate integration tests to C. The Perl integration tests were migrated as faithfully as possible, but there was some cruft and a few unit tests that it did not make sense to migrate. Also remove all Perl code made obsolete by this migration. All unit, performance, and integration tests are now written in C but significant parts of the test harness remain to be migrated.
2024-03-06 00:00:09 +02:00
harness:
name: libSsh2
integration: false
SFTP support for repository storage.
2023-05-13 18:16:16 +02:00
coverage:
- storage/sftp/helper
- storage/sftp/read
- storage/sftp/storage
- storage/sftp/write
include:
- storage/helper
- storage/read
- storage/storage
- storage/write
Add HRN_PG_CONTROL_PUT() and HRN_PG_CONTROL_TIME(). These macros simplify management of pg_control test files. Centralize time updates for pg_control in the command/backup module. This caused some time updates in the logs. Finally, move the postgres module after the storage module so it can use storage macros.
2021-11-30 20:23:11 +02:00
# ********************************************************************************************************************************
- name: postgres
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: client
total: 1
Migrate integration tests to C. The Perl integration tests were migrated as faithfully as possible, but there was some cruft and a few unit tests that it did not make sense to migrate. Also remove all Perl code made obsolete by this migration. All unit, performance, and integration tests are now written in C but significant parts of the test harness remain to be migrated.
2024-03-06 00:00:09 +02:00
harness:
name: pq
integration: false
Add HRN_PG_CONTROL_PUT() and HRN_PG_CONTROL_TIME(). These macros simplify management of pg_control test files. Centralize time updates for pg_control in the command/backup module. This caused some time updates in the logs. Finally, move the postgres module after the storage module so it can use storage macros.
2021-11-30 20:23:11 +02:00
coverage:
- postgres/client
# ----------------------------------------------------------------------------------------------------------------------------
- name: interface
Remove dependency on pg_database.datlastsysoid. This column has been removed in PostgreSQL 15. Rather than add a lot of special handling, it seems better just to update all versions to not depend on this column. Add centralized functions to identify the type of database (i.e. system or user) by name and use FirstNormalObjectId when a name is not available. The new query in the db module will still return the prior result for PostgreSQL <= 15, which will be stored in the manifest. This is important to preserve behavior when downgrading pgBackRest. There are no concerns here for PostgreSQL 15 since older versions of pgBackRest won't be able to restore backups for PostgreSQL 15 anyway.
2022-05-04 14:22:45 +02:00
total: 10
Add HRN_PG_CONTROL_PUT() and HRN_PG_CONTROL_TIME(). These macros simplify management of pg_control test files. Centralize time updates for pg_control in the command/backup module. This caused some time updates in the logs. Finally, move the postgres module after the storage module so it can use storage macros.
2021-11-30 20:23:11 +02:00
harness: postgres
coverage:
- postgres/interface
Retry reads of pg_control until checksum is valid. On certain file systems (e.g. ext4) pg_control may appear torn if there is a concurrent write while reading the file. To prevent an invalid read, retry until the checksum matches the control data. Special handling is required for the pg-version-force feature since the offset of the checksum is not known. In this case, scan from the default position to the end of the data looking for a checksum match. This is a bit imprecise, but better than nothing, and the chance of a random collision in the control data seems very remote considering the ratio of data size (< 512 bytes) to checksum size (4 bytes). This was discovered and a possible solution proposed for PostgreSQL in [1]. The proposed solution may work for backup, but pgBackRest needs to be able to read pg_control reliably outside of backup. So no matter what fix is adopted for PostgreSQL, pgBackRest need retries. Further adjustment may be required as the PostgreSQL fix evolves. [1] https://www.postgresql.org/message-id/20221123014224.xisi44byq3cf5psi%40awork3.anarazel.de
2023-09-10 15:47:49 +02:00
- postgres/interface/crc32
Add HRN_PG_CONTROL_PUT() and HRN_PG_CONTROL_TIME(). These macros simplify management of pg_control test files. Centralize time updates for pg_control in the command/backup module. This caused some time updates in the logs. Finally, move the postgres module after the storage module so it can use storage macros.
2021-11-30 20:23:11 +02:00
- 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
# ********************************************************************************************************************************
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
Automatically create PostgreSQL version interfaces. Maintaining the version interfaces was complicated by the fact that each interface needed to be in separate compilation unit to avoid type conflicts. This also meant that various build/test files needed to be updated to add the new interfaces. Solve these problems by auto-generating all the interfaces into a single file. This is made possible by parsing defines and types out of the header files and creating macros to rename the types. At the end of the version interface everything is undef'd. Another benefit is that the auto-generated interfaces can be static and included directly into postgres/interface.c. Since some code generation is now always required for tests, change --no-gen to --min-gen in test.pl. It would also make sense to auto-generate the version defines in postgres/version.h, but that will be left for a future commit.
2022-06-06 19:52:56 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: postgres
total: 1
coverage:
- build/postgres/parse
- build/postgres/render
Add unit tests for the unit test build code. When this code was migrated to C the unit tests were not included because there were more important priorities at the time. This also requires some adjustments to coverage because of the new code location.
2023-01-05 07:59:06 +02:00
# ********************************************************************************************************************************
- name: test
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: test
Add execOne() to simplify exec for build, documentation, and testing. The core Exec object is efficient but geared toward the specific needs of core and not ease-of-use as required for build, documentation, and testing. execOne() works similarly to system() except that it automatically redirects stderr to stdout and captures the output.
2024-02-24 00:22:48 +02:00
total: 2
Add unit tests for the unit test build code. When this code was migrated to C the unit tests were not included because there were more important priorities at the time. This also requires some adjustments to coverage because of the new code location.
2023-01-05 07:59:06 +02:00
coverage:
- test/command/test/build
- test/command/test/define
- test/command/test/test
Migrate coverage testing to C and remove dependency on lcov. lcov does not seem to be very well maintained and is often not compatible with the version of gcc it ships with until a few months after a new distro is released. In any case, lcov is that not useful for us because it generates reports on all coverage while we are mainly interested in missing coverage during development. Instead use the JSON output generated by gcov to generate our minimal coverage report and metrics for the documentation. There are some slight differences in the metrics. The difference in the common module was due to a bug in the old code -- build/common was being added into common as well as being reported separately. The source of the two additional branches in the backup module is unknown but almost certainly down to how exclusions are processed with regular expressions. Since there is additional coverage rather than coverage missing this seems fine. Since this was pretty much a rewrite it was also a good time to migrate to C.
2024-05-31 06:52:07 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: coverage
total: 1
coverage:
- test/command/test/coverage
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
Add manifest test harness. These macros make adding paths/files/etc to a manifest simpler and easier to read.
2023-01-21 09:03:27 +02:00
harness:
name: manifest
shim:
info/manifest: ~
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:
Refactor lock module. Refactor the lock module to split command-specific logic from the basic file locking functionality. Command specific logic is now in command/lock.c. This will make it easier to implement new features such as repository locking and updating lock file contents on remotes. This implementation is essentially a drop-in replacement but there are a few differences. First, the lock names no longer require a path (the path is added in the lock module). Second, the timeout functionality has been removed since it was not being used.
2024-06-18 04:43:54 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: lock
total: 1
coverage:
- command/lock
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
Improve stop command to honor stanza option. Improve the stop command, when force and stanza options are specified, to terminate only processes holding lock files for the given stanza. Prior to these changes, termination of all processes holding lock files regardless of stanza occurred.
2022-03-08 20:18:23 +02:00
total: 4
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
coverage:
- command/control/common
- command/control/start
- command/control/stop
Refactor lock module. Refactor the lock module to split command-specific logic from the basic file locking functionality. Command specific logic is now in command/lock.c. This will make it easier to implement new features such as repository locking and updating lock file contents on remotes. This implementation is essentially a drop-in replacement but there are a few differences. First, the lock names no longer require a path (the path is added in the lock module). Second, the timeout functionality has been removed since it was not being used.
2024-06-18 04:43:54 +02:00
include:
- command/lock
Backup key/value annotations. Allow key/value annotations to be added with the backup command and added/modified/removed with the new annotate command. Annotations can be viewed with the info command in text mode when --set is specified and are always included in JSON output.
2022-08-24 16:52:33 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: annotate
total: 1
coverage:
- command/annotate/annotate
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
Optimize WAL segment check after successful backup. The prior code did one list command against the storage for each WAL segment. This led to a lot of lists and was especially inefficient when the WAL (or the majority of it) was already present. Optimize to keep the contents of a WAL directory and use them on a subsequent search. Leave the optimizations for a single WAL segment since other places still use that mode.
2023-09-10 18:45:58 +02:00
- command/archive/find
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
Add report option to check command. This option is intended to eventually create a comprehensive report about the state of the pgBackRest configuration based on the results of the check command. Implement a detailed report of the configuration options in the environment and configuration files. This should be useful information when debugging configuration errors, since invalid options and configurations are automatically noted. While custom config locations will not be found automatically, it will at least be clear that the config is not in a standard location. For now keep this option internal since there is a lot of work to be done, but commit it so that it can be used when needed and tested in various environments. Note that for now when --report is specified, the check command is not being run at all. Only the config report is generated. This behavior will be improved in the future.
2023-09-15 15:30:40 +02:00
total: 4
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
Add report option to check command. This option is intended to eventually create a comprehensive report about the state of the pgBackRest configuration based on the results of the check command. Implement a detailed report of the configuration options in the environment and configuration files. This should be useful information when debugging configuration errors, since invalid options and configurations are automatically noted. While custom config locations will not be found automatically, it will at least be clear that the config is not in a standard location. For now keep this option internal since there is a lot of work to be done, but commit it so that it can be used when needed and tested in various environments. Note that for now when --report is specified, the check command is not being run at all. Only the config report is generated. This behavior will be improved in the future.
2023-09-15 15:30:40 +02:00
- command/check/report
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
Display size option default and allowed values with appropriate units. Size option default and allowed values were displayed in bytes, which was confusing for the user. This also lays the groundwork for adding units to time options. Move option parsing functions into a common module so they can be used from the build module.
2021-11-03 21:23:08 +02:00
total: 4
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
Refactor lock module. Refactor the lock module to split command-specific logic from the basic file locking functionality. Command specific logic is now in command/lock.c. This will make it easier to implement new features such as repository locking and updating lock file contents on remotes. This implementation is essentially a drop-in replacement but there are a few differences. First, the lock names no longer require a path (the path is added in the lock module). Second, the timeout functionality has been removed since it was not being used.
2024-06-18 04:43:54 +02:00
include:
- command/lock
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
Migrate backupFile() tests in command/backup module. The backupFile() tests were written before the bulk of the backup command had been migrated to C. Some of them have been migrated to the complete backup tests, but others were left because there was no way to make changes to files during a backup. Now that we have the backup script harness introduced in 337da35a it is now possible to migrate all the tests. The new tests are better because they not only test backupFile() but all the functions upstream and downstream of it.
2023-11-24 22:07:49 +02:00
total: 12
Add test to show behavior of bundled files truncated during backup. This behavior violates an assertion but is completely possible with the current implementation. This behavior will be fixed in a future commit, but for now at least test how it works correctly and remove the assertion so the test runs without error. Also add a new harness that allows changes during the backup to be scripted.
2023-11-24 17:25:40 +02:00
harness:
name: backup
Migrate integration tests to C. The Perl integration tests were migrated as faithfully as possible, but there was some cruft and a few unit tests that it did not make sense to migrate. Also remove all Perl code made obsolete by this migration. All unit, performance, and integration tests are now written in C but significant parts of the test harness remain to be migrated.
2024-03-06 00:00:09 +02:00
integration: false
Add test to show behavior of bundled files truncated during backup. This behavior violates an assertion but is completely possible with the current implementation. This behavior will be fixed in a future commit, but for now at least test how it works correctly and remove the assertion so the test runs without error. Also add a new harness that allows changes during the backup to be scripted.
2023-11-24 17:25:40 +02:00
shim:
command/backup/backup:
function:
- backupProcess
Move block testBlockDelta() to harness module. This makes the function available to other test modules. Also rename to hrnBlockDeltaRender().
2023-12-27 02:07:56 +02:00
harness:
name: blockIncr
shim:
command/restore/blockDelta: ~
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
coverage:
- command/backup/backup
Block-level incremental backup. The primary goal of the block incremental backup is to save space in the repository by only storing changed parts of a file rather than the entire file. This implementation is focused on restore performance more than saving space in the repository, though there may be substantial savings depending on the workload. The repo-block option enables the feature (when repo-bundle is already enabled). The block size is determined based on the file size and age. Very old or very small files will not use block incremental.
2023-01-20 11:48:57 +02:00
- command/backup/blockIncr
- command/backup/blockMap
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/file
Move command/backup-common tests in the command/backup module. As much as possible it is better to get coverage with more realistic tests. Merging these modules will allow the page checksum code to be covered with real backups.
2022-02-19 01:50:05 +02:00
- command/backup/pageChecksum
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/protocol
Block-level incremental backup super blocks. Small blocks sizes can lead to reduced compression efficiency, so allow multiple blocks to be compressed together in a super block. The disadvantage is that the super block must be read sequentially to retrieve blocks. However, different super block sizes can be used for different backup types, so the full backup super block sizes are large for compression efficiency and diff/incr are smaller for retrieval efficiency.
2023-03-09 04:39:54 +02:00
- command/restore/blockDelta
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
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
Swap command/backup and command/restore unit tests. Logically restore belongs after backup and in a future commit restore will have a dependency on some backup objects.
2022-10-14 01:08:40 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: restore
Move getEpoch() to cvtZToTime() and refactor. This function will be needed elsewhere going forward and in any case it makes sense to move this out of the restore module. Refactor to avoid dependency on a regular expression.
2024-08-17 07:58:55 +02:00
total: 14
Swap command/backup and command/restore unit tests. Logically restore belongs after backup and in a future commit restore will have a dependency on some backup objects.
2022-10-14 01:08:40 +02:00
coverage:
Rename BlockHash to BlockChecksum. Checksum is the generally used terminology in the code base, even when a hash is being used as a checksum.
2023-03-09 06:04:03 +02:00
- command/restore/blockChecksum
Block-level incremental backup super blocks. Small blocks sizes can lead to reduced compression efficiency, so allow multiple blocks to be compressed together in a super block. The disadvantage is that the super block must be read sequentially to retrieve blocks. However, different super block sizes can be used for different backup types, so the full backup super block sizes are large for compression efficiency and diff/incr are smaller for retrieval efficiency.
2023-03-09 04:39:54 +02:00
- command/restore/blockDelta
Swap command/backup and command/restore unit tests. Logically restore belongs after backup and in a future commit restore will have a dependency on some backup objects.
2022-10-14 01:08:40 +02:00
- command/restore/file
- command/restore/protocol
- command/restore/restore
include:
- common/user
- info/infoBackup
- info/manifest
Prototype manifest command. Output a manifest in text or JSON format. Neither format is complete but they cover the basics. In particular the manifest command outputs the complete block restore when the filter option is specified and the block delta when the pg option is also specified. This is non-destructive so it is safe to execute against a running cluster.
2023-03-14 16:56:05 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: manifest
total: 1
include:
- command/manifest/manifest
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
Remove internal repo-create command. This command was used by the Perl integration tests to create buckets for storage types that required it. Now that the integration tests are written in C they can simply use the same code to create buckets. The command was also used in the documentation but there it seems more appropriate to use the corresponding vendor CLI.
2024-07-22 09:17:47 +02:00
total: 3
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 path validation for repo-* commands. Check for invalid path in repo-* commands. Perform path validation and throw an error when appropriate. Path may not contain '//'. Strip trailing '/' from path. Absolute path must fall under repo path.
2022-03-22 15:50:26 +02:00
- command/repo/common
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
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 verify output and verbose options. These options allow the user to control how the verify results will be output to the console and log.
2022-05-06 17:11:36 +02:00
total: 12
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
Pass filters to remote storage as a handler array. The prior code required coverage in the storage/remote module for all filters that could be used remotely. Now the filter handlers are set at runtime so any filter list can be used with a remote. This is more flexible and makes coverage testing easier. It also resolves a test dependency. Move the command/remote unit test near the end so it will have access to all filters without using depends.
2022-10-18 05:11:35 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: remote
total: 1
coverage:
- command/remote/remote
Move protocol module from common to command. This module has dependencies on command/command so it does not make sense for it to be in the common module. Also move protocolFree() to main() since this is a very large dependency. Adjust the tests so command/exit can be tested later. This is a bit messy but will get adjusted as we improve the test harness.
2022-06-17 17:17:52 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: exit
total: 3
coverage:
- command/exit
Add TLS Server. The TLS server is an alternative to using SSH for protocol connections to remote hosts. This command is currently experimental and intended only for trial and testing. As such, the new commands and options will not show up in the command-line help unless directly requested.
2021-10-18 20:32:41 +02:00
# ----------------------------------------------------------------------------------------------------------------------------
- name: server
total: 2
coverage:
- command/server/ping
- command/server/server
Build command and configuration reference in C. Migrate generation of these files from help.xml to the intermediate documentation format. This allows us to share a lot of code that is already in C and remove duplicated code in Perl. More duplicate code can be removed in Perl once man generation is migrated. Also update the unit test harness to allow testing of modules in the doc directory.
2023-10-09 20:03:43 +02:00
# ********************************************************************************************************************************
- name: doc
test:
# ----------------------------------------------------------------------------------------------------------------------------
- name: build
total: 1
coverage:
- doc/command/build/build
Migrate man page generation to C.
2024-01-23 14:56:26 +02:00
- doc/command/build/man
Build command and configuration reference in C. Migrate generation of these files from help.xml to the intermediate documentation format. This allows us to share a lot of code that is already in C and remove duplicated code in Perl. More duplicate code can be removed in Perl once man generation is migrated. Also update the unit test harness to allow testing of modules in the doc directory.
2023-10-09 20:03:43 +02:00
- doc/command/build/reference
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
# ********************************************************************************************************************************
Migrate integration tests to C. The Perl integration tests were migrated as faithfully as possible, but there was some cruft and a few unit tests that it did not make sense to migrate. Also remove all Perl code made obsolete by this migration. All unit, performance, and integration tests are now written in C but significant parts of the test harness remain to be migrated.
2024-03-06 00:00:09 +02:00
- name: integration
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
Migrate integration tests to C. The Perl integration tests were migrated as faithfully as possible, but there was some cruft and a few unit tests that it did not make sense to migrate. Also remove all Perl code made obsolete by this migration. All unit, performance, and integration tests are now written in C but significant parts of the test harness remain to be migrated.
2024-03-06 00:00:09 +02:00
harness: host
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:
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
# ----------------------------------------------------------------------------------------------------------------------------
- name: type
Fix socket leak on connection retries. This leak was caused by the file descriptor variable getting clobbered after a long jump. Mark it as volatile to fix. Testing this is a bit complex because the issue only happens in optimized builds, if at all. Put the test into the performance suite, which is always optimized, until a better idea presents itself.
2021-12-14 21:53:41 +02:00
total: 6
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