31.1. Выполнение тестов #

Регрессионное тестирование можно выполнять как на уже установленном и работающем сервере, так и используя временную инсталляцию внутри дерева сборки. Более того, существуют «параллельный» и «последовательный» режимы тестирования. Последовательный метод выполняет каждый сценарий теста отдельно, тогда как параллельный метод запускает несколько процессов на сервере, чтобы выполнить определённый набор тестов параллельно. Параллельное тестирование позволяет с уверенностью утверждать, что межпроцессное взаимодействие и блокировки работают корректно. Некоторые тесты могут выполняться последовательно даже в «параллельном» режиме, если это требуется для выполнения тестирования.

31.1.1. Запуск тестов на временной инсталляции #

Чтобы запустить параллельное регрессионное тестирование после сборки, но до инсталляции, наберите:

make check

в каталоге верхнего уровня. (Или перейдите в src/test/regress и выполните команду там.) Для тестов, выполняющихся в параллельном режиме, добавляется префикс «+», для тестов в последовательном режиме используется префикс «-». По завершении процесса вы должны увидеть нечто вроде:


# All 213 tests passed.

или список тестов, не пройденных успешно. Прочитайте Раздел 31.2, прежде чем делать вывод о серьёзности выявленных «проблем».

Поскольку данный метод тестирования выполняется на временном сервере, он не будет работать, если вы выполняете сборку под пользователем root, сервер просто не запустится из под root. Рекомендуется не делать сборку под пользователем root, если только вы не собираетесь проводить тестирование после завершения инсталляции.

Если вы сконфигурировали PostgreSQL для инсталляции там, где уже установлена предыдущая версия PostgreSQL, и выполняете make check до инсталляции новой версии, вы можете столкнуться с тем, что тестирование завершится сбоем, поскольку новая программа будет пытаться использовать уже установленные общие библиотеки. (Типичные признаки — предупреждения о неопределённых символах.) Если вы хотите провести тестирование до перезаписи старой инсталляции, выполните сборку с configure --disable-rpath. Однако этот вариант не рекомендуется для окончательной инсталляции.

Параллельное регрессионное тестирование запускает довольно много процессов под вашим именем пользователя. В настоящее время возможный максимум параллельной обработки составляет двадцать параллельных тестовых сценариев, а это означает сорок процессов: это и серверный процесс, и psql процесс для каждого тестового сценария. Поэтому если ваша система устанавливает ограничения на количество процессов для каждого пользователя, имеет смысл уточнить, что ваш лимит составляет не меньше пятидесяти процессов или около того. В противном случае вы столкнетесь с кажущимися случайными сбоями в параллельном тестировании. Если же вы не имеете права увеличить свой лимит процессов, вы можете снизить степень распараллеливания установкой параметра MAX_CONNECTIONS. Например:

make MAX_CONNECTIONS=10 check

выполняет не больше десяти тестов параллельно.

31.1.2. Запуск тестов для существующей инсталляции #

Чтобы запустить тестирование после инсталляции (см. Главу 17), инициализируйте каталог данных и запустите сервер, как показано в Главе 18, потом введите:

make installcheck

или для параллельного тестирования:

make installcheck-parallel

Тестовые сценарии будут соединяться с сервером на локальном компьютере с номером порта по умолчанию, если иное не задано переменными среды PGHOST и PGPORT. Тестирование будет проведено в базе данных regression; любая существующая база с таким именем будет удалена.

Также тесты будут создавать для временного пользования объекты, общие для кластера, такие как роли, табличные пространства и подписки. Имена этих объектов будут начинаться с regress_. Остерегайтесь использования режима installcheck там, где такие имена могут иметь существующие глобальные объекты.

31.1.3. Дополнительные пакеты тестов #

Команды make check и make installcheck запускают только «основные» регрессионные тесты, которые проверяют встроенную функциональность сервера PostgreSQL. Исходный дистрибутив содержит множество других пакетов тестов, большая часть которых имеет дело с дополнительной функциональностью такой как, например, дополнительные процедурные языки.

Чтобы запустить пакет тестов (включая основные) применительно к модулям, выбранным для построения, наберите одну из этих команд в каталоге верхнего уровня дерева сборки:

make check-world
make installcheck-world

Эти команды запускают тестирование, используя временный или уже установленный сервер, в соответствии с данным выше описанием для команд make check и make installcheck. Остальные детали соответствуют ранее изложенным объяснениям для каждого метода. Необходимо иметь в виду, что команда make check-world создаёт экземпляр кластера (временный каталог данных) для каждого тестировочного модуля, а это требует гораздо больше времени и дискового пространства, нежели команда make installcheck-world.

На современном компьютере с множеством процессорных ядер и операционной системой без жёстких ограничений тестирование можно многократно ускорить за счёт распараллеливания. Рецепт, которым на практике пользуются большинство разработчиков для ускоренного выполнения всех тестов, выглядит примерно так:

make check-world -j8 >/dev/null

Значение для -j обычно ограничивается количеством ядер или может быть немного больше. Подавление вывода в stdout избавляет от большого объёма сообщений, не представляющих интереса, когда нужно просто убедиться в успешности проверки. (В случае ошибки выводимые в stderr сообщения обычно дают достаточно информации для диагностики проблемы.)

В качестве альтернативного пути можно запустить индивидуальный пакет тестов, набрав make check или make installcheck в подходящем подкаталоге дерева сборки. Имейте в виду, что make installcheck предполагает, что вы уже установили соответствующие модули, а не только основной сервер.

Дополнительные тесты, которые можно активизировать таким способом:

  • Регрессионные тесты для дополнительных процедурных языков. Эти тесты расположены в каталоге src/pl.

  • Регрессионные тесты для модулей contrib, расположенные в каталоге contrib. Не для всех модулей из contrib существуют тесты.

  • Регрессионные тесты для интерфейсных библиотек, расположенные в src/interfaces/libpq/test и src/interfaces/ecpg/test.

  • Тесты для проверки встроенных в ядро методов проверки подлинности, расположенные в src/test/authentication. (Ниже описываются дополнительные тесты, связанные с проверкой подлинности.)

  • Тесты для нагрузочного тестирования параллельных сеансов, расположенные в src/test/isolation.

  • Тесты для проверки физической репликации и восстановления после сбоев, расположенные в src/test/recovery.

  • Тесты для проверки логической репликации, расположенные в src/test/subscription.

  • Тесты клиентских программ, расположенные в src/bin.

При использовании режима installcheck эти тесты будут создавать и удалять базы данных с именами, включающими слово regression, например pl_regression или contrib_regression. Остерегайтесь использования этого режима там, где имеются базы с такими именами, не предназначенные для тестирования.

Некоторые из этих дополнительных пакет тестов используют инфраструктуру TAP, описанную в Разделе 31.4. TAP-тесты выполняются, только когда PostgreSQL конфигурируется с ключом --enable-tap-tests. Этот ключ рекомендуется для разработки, но если подходящей инсталляции Perl нет, его можно опустить.

Некоторые пакеты не запускаются по умолчанию — одни потому, что выполнять их в многопользовательской системе небезопасно, другие потому, что им требуется специальное программное обеспечение, а некоторые из-за своей ресурсоёмкости. Эти пакеты тестов можно включить дополнительно, присвоив переменной PG_TEST_EXTRA (это может быть переменная окружения или скрипта make) строку с их списком через пробел, например:

make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'

В настоящее время поддерживаются следующие значения:

kerberos

Запускает пакет тестов в подкаталоге src/test/kerberos. Эти тесты требуют наличия инсталляции MIT Kerberos и открывают сокеты TCP/IP для приёма соединений.

ldap

Запускает пакет тестов в подкаталоге src/test/ldap. Эти тесты требуют наличия инсталляции OpenLDAP и открывают сокеты TCP/IP для приёма соединений.

ssl

Запускает пакет тестов в подкаталоге src/test/ssl. Эти тесты открывают сокеты TCP/IP для приёма соединений.

load_balance

Запускает тест src/interfaces/libpq/t/004_load_balance_dns.pl. Этот тест требует наличия соответствующих записей в системном файле hosts и открывает сокеты TCP/IP для приёма соединений.

libpq_encryption

Запускает тест src/interfaces/libpq/t/005_negotiate_encryption.pl. Этот тест открывает сокеты TCP/IP для приёма соединений. Если переменная окружения PG_TEST_EXTRA также содержит kerberos, запускаются дополнительные тесты, требующие наличия инсталляции MIT Kerberos.

wal_consistency_checking

Включает проверку wal_consistency_checking=all при выполнении определённых тестов в подкаталоге src/test/recovery. По умолчанию эта проверка не производится, так как она создаёт значительную нагрузку.

xid_wraparound

Запускает пакет тестов в подкаталоге src/test/modules/xid_wraparound. По умолчанию отключён из-за своей ресурсоёмкости.

Тесты функциональности, которая не поддерживается в текущей конфигурации сборки, не запускаются, даже если они указаны в PG_TEST_EXTRA.

Кроме того, в каталоге src/test/modules есть тесты, которые будут запускаться в режиме make check-world, но не в make installcheck-world. Это объясняется тем, что они имеют побочные эффекты или устанавливают расширения, неподходящие для производственной среды. По желанию вы можете выполнить make install или make installcheck в одном из его подкаталогов, но делать это с сервером, не предназначенным для тестирования, не рекомендуется.

31.1.4. Локаль и кодировка #

По умолчанию, тесты, работающие на временной инсталляции, используют локаль, определённую в текущей среде и кодировку базы данных, заданную при выполнении initdb. Для тестирования различных локалей может оказаться полезным установить подходящие переменные среды, например:

make check LANG=C
make check LC_COLLATE=en_US.utf8 LC_CTYPE=ru_RU.utf8

Поддержка переменной LC_ALL в этом случае не реализована; все остальные переменные среды, относящиеся к локали, работают.

При тестировании на существующей инсталляции, локаль определяется имеющимся кластером базы данных и не может быть изменена для выполнения теста.

Вы можете задать кодировку базы данных в переменной ENCODING, например:

make check LANG=C ENCODING=EUC_JP

Установка кодировки базы данных таким образом имеет смысл только для локали C; в противном случае кодировка определяется автоматически из локали, и установка кодировки, не соответствующей локали, приведёт к ошибке.

Кодировка базы данных может быть установлена как для тестирования на временной, так и на существующей инсталляции, хотя в последнем случае она должна быть совместимой с локалью этой инсталляции.

31.1.5. Пользовательские параметры сервера #

Существует несколько вариантов использования пользовательских параметров сервера при запуске пакета тестов. Такие параметры полезно задать для изменения детализации сообщений в журнале, изменения ограничений ресурсов или включения дополнительных проверок во время выполнения, например debug_discard_caches. Однако обратите внимание, что не все тесты могут проходить без ошибок с произвольными настройками.

Разным командам initdb, выполняемым во время настройки теста, могут передаваться дополнительные параметры через переменную окружения PG_TEST_INITDB_EXTRA_OPTS. Например, чтобы запустить тест с включёнными контрольными суммами, нестандартным размером сегментов WAL и заданным параметром work_mem, воспользуйтесь следующей командой:

make check PG_TEST_INITDB_EXTRA_OPTS='-k --wal-segsize=4 -c work_mem=50MB'

Для основных регрессионных тестов и прочих тестов, запускаемых pg_regress, пользовательские параметры сервера, связанные со временем выполнения, можно также задать в переменной окружения PGOPTIONS (если это возможно), например:

make check PGOPTIONS="-c debug_parallel_query=regress -c work_mem=50MB"

(В этом случае используется функциональность libpq; за подробностями обратитесь к options.)

Когда тесты проводятся с временной инсталляцией, пользовательские параметры также можно задать в предварительно написанном postgresql.conf:

echo 'log_checkpoints = on' > test_postgresql.conf
echo 'work_mem = 50MB' >> test_postgresql.conf
make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"

31.1.6. Специальные тесты #

Пакет основных регрессионных тестов содержит несколько тестовых файлов, которые не запускаются по умолчанию, поскольку они могут зависеть от платформы или выполняться слишком долго. Вы можете запустить те или иные дополнительные тесты, задав переменную EXTRA_TESTS. Например, запустить тест numeric_big:

make check EXTRA_TESTS=numeric_big

31.1. Running the Tests #

The regression tests can be run against an already installed and running server, or using a temporary installation within the build tree. Furthermore, there is a parallel and a sequential mode for running the tests. The sequential method runs each test script alone, while the parallel method starts up multiple server processes to run groups of tests in parallel. Parallel testing adds confidence that interprocess communication and locking are working correctly. Some tests may run sequentially even in the parallel mode in case this is required by the test.

31.1.1. Running the Tests Against a Temporary Installation #

To run the parallel regression tests after building but before installation, type:

make check

in the top-level directory. (Or you can change to src/test/regress and run the command there.) Tests which are run in parallel are prefixed with +, and tests which run sequentially are prefixed with -. At the end you should see something like:


# All 213 tests passed.

or otherwise a note about which tests failed. See Section 31.2 below before assuming that a failure represents a serious problem.

Because this test method runs a temporary server, it will not work if you did the build as the root user, since the server will not start as root. Recommended procedure is not to do the build as root, or else to perform testing after completing the installation.

If you have configured PostgreSQL to install into a location where an older PostgreSQL installation already exists, and you perform make check before installing the new version, you might find that the tests fail because the new programs try to use the already-installed shared libraries. (Typical symptoms are complaints about undefined symbols.) If you wish to run the tests before overwriting the old installation, you'll need to build with configure --disable-rpath. It is not recommended that you use this option for the final installation, however.

The parallel regression test starts quite a few processes under your user ID. Presently, the maximum concurrency is twenty parallel test scripts, which means forty processes: there's a server process and a psql process for each test script. So if your system enforces a per-user limit on the number of processes, make sure this limit is at least fifty or so, else you might get random-seeming failures in the parallel test. If you are not in a position to raise the limit, you can cut down the degree of parallelism by setting the MAX_CONNECTIONS parameter. For example:

make MAX_CONNECTIONS=10 check

runs no more than ten tests concurrently.

31.1.2. Running the Tests Against an Existing Installation #

To run the tests after installation (see Chapter 17), initialize a data directory and start the server as explained in Chapter 18, then type:

make installcheck

or for a parallel test:

make installcheck-parallel

The tests will expect to contact the server at the local host and the default port number, unless directed otherwise by PGHOST and PGPORT environment variables. The tests will be run in a database named regression; any existing database by this name will be dropped.

The tests will also transiently create some cluster-wide objects, such as roles, tablespaces, and subscriptions. These objects will have names beginning with regress_. Beware of using installcheck mode with an installation that has any actual global objects named that way.

31.1.3. Additional Test Suites #

The make check and make installcheck commands run only the core regression tests, which test built-in functionality of the PostgreSQL server. The source distribution contains many additional test suites, most of them having to do with add-on functionality such as optional procedural languages.

To run all test suites applicable to the modules that have been selected to be built, including the core tests, type one of these commands at the top of the build tree:

make check-world
make installcheck-world

These commands run the tests using temporary servers or an already-installed server, respectively, just as previously explained for make check and make installcheck. Other considerations are the same as previously explained for each method. Note that make check-world builds a separate instance (temporary data directory) for each tested module, so it requires more time and disk space than make installcheck-world.

On a modern machine with multiple CPU cores and no tight operating-system limits, you can make things go substantially faster with parallelism. The recipe that most PostgreSQL developers actually use for running all tests is something like

make check-world -j8 >/dev/null

with a -j limit near to or a bit more than the number of available cores. Discarding stdout eliminates chatter that's not interesting when you just want to verify success. (In case of failure, the stderr messages are usually enough to determine where to look closer.)

Alternatively, you can run individual test suites by typing make check or make installcheck in the appropriate subdirectory of the build tree. Keep in mind that make installcheck assumes you've installed the relevant module(s), not only the core server.

The additional tests that can be invoked this way include:

  • Regression tests for optional procedural languages. These are located under src/pl.

  • Regression tests for contrib modules, located under contrib. Not all contrib modules have tests.

  • Regression tests for the interface libraries, located in src/interfaces/libpq/test and src/interfaces/ecpg/test.

  • Tests for core-supported authentication methods, located in src/test/authentication. (See below for additional authentication-related tests.)

  • Tests stressing behavior of concurrent sessions, located in src/test/isolation.

  • Tests for crash recovery and physical replication, located in src/test/recovery.

  • Tests for logical replication, located in src/test/subscription.

  • Tests of client programs, located under src/bin.

When using installcheck mode, these tests will create and destroy test databases whose names include regression, for example pl_regression or contrib_regression. Beware of using installcheck mode with an installation that has any non-test databases named that way.

Some of these auxiliary test suites use the TAP infrastructure explained in Section 31.4. The TAP-based tests are run only when PostgreSQL was configured with the option --enable-tap-tests. This is recommended for development, but can be omitted if there is no suitable Perl installation.

Some test suites are not run by default, either because they are not secure to run on a multiuser system, because they require special software or because they are resource intensive. You can decide which test suites to run additionally by setting the make or environment variable PG_TEST_EXTRA to a whitespace-separated list, for example:

make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'

The following values are currently supported:

kerberos

Runs the test suite under src/test/kerberos. This requires an MIT Kerberos installation and opens TCP/IP listen sockets.

ldap

Runs the test suite under src/test/ldap. This requires an OpenLDAP installation and opens TCP/IP listen sockets.

ssl

Runs the test suite under src/test/ssl. This opens TCP/IP listen sockets.

load_balance

Runs the test src/interfaces/libpq/t/004_load_balance_dns.pl. This requires editing the system hosts file and opens TCP/IP listen sockets.

libpq_encryption

Runs the test src/interfaces/libpq/t/005_negotiate_encryption.pl. This opens TCP/IP listen sockets. If PG_TEST_EXTRA also includes kerberos, additional tests that require an MIT Kerberos installation are enabled.

wal_consistency_checking

Uses wal_consistency_checking=all while running certain tests under src/test/recovery. Not enabled by default because it is resource intensive.

xid_wraparound

Runs the test suite under src/test/modules/xid_wraparound. Not enabled by default because it is resource intensive.

Tests for features that are not supported by the current build configuration are not run even if they are mentioned in PG_TEST_EXTRA.

In addition, there are tests in src/test/modules which will be run by make check-world but not by make installcheck-world. This is because they install non-production extensions or have other side-effects that are considered undesirable for a production installation. You can use make install and make installcheck in one of those subdirectories if you wish, but it's not recommended to do so with a non-test server.

31.1.4. Locale and Encoding #

By default, tests using a temporary installation use the locale defined in the current environment and the corresponding database encoding as determined by initdb. It can be useful to test different locales by setting the appropriate environment variables, for example:

make check LANG=C
make check LC_COLLATE=en_US.utf8 LC_CTYPE=fr_CA.utf8

For implementation reasons, setting LC_ALL does not work for this purpose; all the other locale-related environment variables do work.

When testing against an existing installation, the locale is determined by the existing database cluster and cannot be set separately for the test run.

You can also choose the database encoding explicitly by setting the variable ENCODING, for example:

make check LANG=C ENCODING=EUC_JP

Setting the database encoding this way typically only makes sense if the locale is C; otherwise the encoding is chosen automatically from the locale, and specifying an encoding that does not match the locale will result in an error.

The database encoding can be set for tests against either a temporary or an existing installation, though in the latter case it must be compatible with the installation's locale.

31.1.5. Custom Server Settings #

There are several ways to use custom server settings when running a test suite. This can be useful to enable additional logging, adjust resource limits, or enable extra run-time checks such as debug_discard_caches. But note that not all tests can be expected to pass cleanly with arbitrary settings.

Extra options can be passed to the various initdb commands that are run internally during test setup using the environment variable PG_TEST_INITDB_EXTRA_OPTS. For example, to run a test with checksums enabled and a custom WAL segment size and work_mem setting, use:

make check PG_TEST_INITDB_EXTRA_OPTS='-k --wal-segsize=4 -c work_mem=50MB'

For the core regression test suite and other tests driven by pg_regress, custom run-time server settings can also be set in the PGOPTIONS environment variable (for settings that allow this), for example:

make check PGOPTIONS="-c debug_parallel_query=regress -c work_mem=50MB"

(This makes use of functionality provided by libpq; see options for details.)

When running against a temporary installation, custom settings can also be set by supplying a pre-written postgresql.conf:

echo 'log_checkpoints = on' > test_postgresql.conf
echo 'work_mem = 50MB' >> test_postgresql.conf
make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"

31.1.6. Extra Tests #

The core regression test suite contains a few test files that are not run by default, because they might be platform-dependent or take a very long time to run. You can run these or other extra test files by setting the variable EXTRA_TESTS. For example, to run the numeric_big test:

make check EXTRA_TESTS=numeric_big

FAQ