Movatterモバイル変換

Skip to content

postgrespro/postgresPublic

forked frompostgres/postgres

NotificationsYou must be signed in to change notification settings
Fork6
Star31

Commitb214155

tglsfdc

committed

Doc: improve README files associated with TAP tests.

Rearrange src/test/perl/README so that the first section is moreclearly "how to run these tests", and the rest "how to write newtests". Add some basic info there about debugging test failures.Then, add cross-refs to that READNE from other READMEs thatdescribe how to run TAP tests.Per suggestion from Kevin Burke, though this is not his originalpatch.Discussion:https://postgr.es/m/CAKcy5eiSbwiQnmCfnOnDCVC7B8fYyev3E=6pvvECP9pLE-Fcuw@mail.gmail.com

1 parent6301c3a commitb214155Copy full SHA for b214155

File tree

8 files changed

+35

-12

lines changed

src
- bin/pg_amcheck
  - README
- test
  - authentication
    - README
  - kerberos
    - README
  - ldap
    - README
  - perl
    - README
  - recovery
    - README
  - ssl
    - README
  - subscription
    - README

8 files changed

+35

-12

lines changed

`‎src/bin/pg_amcheck/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,3 +17,5 @@ You can use "make installcheck" if you previously did "make install".`
`17`	`17`	`In that case, the code in the installation tree is tested. With`
`18`	`18`	`"make check", a temporary installation tree is built from the current`
`19`	`19`	`sources and then tested.`
	`20`	`+`
	`21`	`+See src/test/perl/README for more info about running these tests.`

`‎src/test/authentication/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -24,3 +24,5 @@ sources and then tested.`
`24`	`24`
`25`	`25`	`Either way, this test initializes, starts, and stops a test Postgres`
`26`	`26`	`cluster.`
	`27`	`+`
	`28`	`+See src/test/perl/README for more info about running these tests.`

`‎src/test/kerberos/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@ sources and then tested.`
`32`	`32`	`Either way, this test initializes, starts, and stops a test Postgres`
`33`	`33`	`cluster, as well as a test KDC server.`
`34`	`34`
	`35`	`+See src/test/perl/README for more info about running these tests.`
	`36`	`+`
`35`	`37`	`Requirements`
`36`	`38`	`============`
`37`	`39`

`‎src/test/ldap/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ sources and then tested.`
`31`	`31`	`Either way, this test initializes, starts, and stops a test Postgres`
`32`	`32`	`cluster, as well as a test LDAP server.`
`33`	`33`
	`34`	`+See src/test/perl/README for more info about running these tests.`
	`35`	`+`
`34`	`36`	`Requirements`
`35`	`37`	`============`
`36`	`38`

`‎src/test/perl/README`

Lines changed: 15 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,22 +12,29 @@ $(prove_installcheck) targets in Makefile.global. By default every test in the`
`12`	`12`	`t/ subdirectory is run. Individual test(s) can be run instead by passing`
`13`	`13`	`something like PROVE_TESTS="t/001_testname.pl t/002_othertestname.pl" to make.`
`14`	`14`
`15`		`-You should prefer to write tests using pg_regress in src/test/regress, or`
`16`		`-isolation tester specs in src/test/isolation, if possible. If not, check to`
`17`		`-see if your new tests make sense under an existing tree in src/test, like`
`18`		`-src/test/ssl, or should be added to one of the suites for an existing utility.`
`19`		`-`
`20`		`-Note that all tests and test tools should have perltidy run on them before`
`21`		`-patches are submitted, using perltidy --profile=src/tools/pgindent/perltidyrc`
`22`		`-`
`23`	`15`	`By default, to keep the noise low during runs, we do not set any flags via`
`24`	`16`	`PROVE_FLAGS, but this can be done on the 'make' command line if desired, eg:`
`25`	`17`
`26`	`18`	`make check-world PROVE_FLAGS='--verbose'`
`27`	`19`
	`20`	`+When a test fails, the terminal output from 'prove' is usually not sufficient`
	`21`	`+to diagnose the problem. Look into the log files that are left under`
	`22`	`+tmp_check/log/ to get more info. Files named 'regress_log_XXX' are log`
	`23`	`+output from the perl test scripts themselves, and should be examined first.`
	`24`	`+Other files are postmaster logs, and may be helpful as additional data.`
	`25`	`+`
	`26`	`+`
`28`	`27`	`Writing tests`
`29`	`28`	`-------------`
`30`	`29`
	`30`	`+You should prefer to write tests using pg_regress in src/test/regress, or`
	`31`	`+isolation tester specs in src/test/isolation, if possible. If not, check to`
	`32`	`+see if your new tests make sense under an existing tree in src/test, like`
	`33`	`+src/test/ssl, or should be added to one of the suites for an existing utility.`
	`34`	`+`
	`35`	`+Note that all tests and test tools should have perltidy run on them before`
	`36`	`+patches are submitted, using perltidy --profile=src/tools/pgindent/perltidyrc`
	`37`	`+`
`31`	`38`	`Tests are written using Perl's Test::More with some PostgreSQL-specific`
`32`	`39`	`infrastructure from src/test/perl providing node management, support for`
`33`	`40`	`invoking 'psql' to run queries and get results, etc. You should read the`

`‎src/test/recovery/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,3 +23,5 @@ sources and then tested.`
`23`	`23`
`24`	`24`	`Either way, this test initializes, starts, and stops several test Postgres`
`25`	`25`	`clusters.`
	`26`	`+`
	`27`	`+See src/test/perl/README for more info about running these tests.`

`‎src/test/ssl/README`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ sources and then tested.`
`29`	`29`	`Either way, this test initializes, starts, and stops a test Postgres`
`30`	`30`	`cluster that is accessible to other local users!`
`31`	`31`
	`32`	`+See src/test/perl/README for more info about running these tests.`
	`33`	`+`
`32`	`34`	`Certificates`
`33`	`35`	`============`
`34`	`36`

`‎src/test/subscription/README`

Lines changed: 8 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,19 @@ Running the tests`
`9`	`9`	`=================`
`10`	`10`
`11`	`11`	`NOTE: You must have given the --enable-tap-tests argument to configure.`
	`12`	`+Also, to use "make installcheck", you must have built and installed`
	`13`	`+contrib/hstore in addition to the core code.`
`12`	`14`
`13`	`15`	`Run`
`14`	`16`	`make check`
`15`	`17`	`or`
`16`	`18`	`make installcheck`
`17`		`-You can use "make installcheck" if you previously did "make install"`
`18`		`-(including installingthehstore extension). In that case, the code`
`19`		`-in theinstallation tree istested. With "make check", a temporary`
`20`		`-installation tree is built from the currentsources and then tested.`
	`19`	`+You can use "make installcheck" if you previously did "make install".`
	`20`	`+In that case,thecode in the installation tree is tested. With`
	`21`	`+"make check", a temporaryinstallation tree isbuilt from the current`
	`22`	`+sources and then tested.`
`21`	`23`
`22`	`24`	`Either way, this test initializes, starts, and stops several test Postgres`
`23`	`25`	`clusters.`
	`26`	`+`
	`27`	`+See src/test/perl/README for more info about running these tests.`

0 commit comments

Comments

(0)

[8]ページ先頭

©2009-2025 Movatter.jp