Skip to content

Commit

Permalink
Don't run author-only tests during regular test suite execution
Browse files Browse the repository at this point in the history
The following author-only tests are run as part of the standard test
suite:

* t/local/01_pod.t
* t/local/02_pod_coverage.t
* t/local/kwalitee.t

These only need to be run as part of CI jobs and release testing, and
are usually skipped on end-user machines anyway (owing to their stealth
dependency on the non-core Test::Pod, Test::Pod::Coverage and
Test::Kwalitee modules respectively).

Move these tests to the xt/ directory, declare their Test:: dependencies
as development prerequisites, and add an xtest target to the generated
Makefile that runs these tests.

Closes radiator-software#392.
  • Loading branch information
chrisnovakovic committed Apr 2, 2022
1 parent b458fb5 commit 1e08a87
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 47 deletions.
4 changes: 4 additions & 0 deletions Changes
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Revision history for Perl extension Net::SSLeay.
- When building Net-SSLeay, search for the openssl binary in the same directory
in which Perl is installed (i.e. $Config{prefix}/bin/). Thanks to Henrik
Grimler for the patch.
- Move author-only Kwalitee and Pod tests out of the main test suite and into
the xt/ directory; these tests can now be run with "make xtest". This
eliminates the main test suite's soft dependency on the non-core Test::Pod,
Test::Pod::Coverage and Test::Kwalitee modules.

1.93_01 2022-03-20
- LibreSSL 3.5.0 has removed access to internal data
Expand Down
6 changes: 3 additions & 3 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,6 @@ t/external/ocsp.t
t/handle/external/10_destroy.t
t/handle/external/50_external.t
t/handle/local/05_use.t
t/local/01_pod.t
t/local/02_pod_coverage.t
t/local/03_use.t
t/local/04_basic.t
t/local/05_passwd_cb.t
Expand Down Expand Up @@ -229,5 +227,7 @@ t/local/64_ticket_sharing.t
t/local/65_security_level.t
t/local/65_ticket_sharing_2.t
t/local/66_curves.t
t/local/kwalitee.t
typemap
xt/01_kwalitee.t
xt/02_pod.t
xt/02_pod_coverage.t
4 changes: 4 additions & 0 deletions Makefile.PL
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ my %eumm_args = (
prereqs => {
develop => {
requires => {
'Test::Pod' => '1.41',
'Test::Pod::Coverage' => '1.00',
'Test::Kwalitee' => '1.00',
},
Expand Down Expand Up @@ -144,6 +145,9 @@ sub MY::postamble {
<<"MAKE";
SSLeay$Config{'obj_ext'} : constants.c
xtest :
\$(MAKE) test TEST_FILES=xt/*.t
MAKE
}

Expand Down
23 changes: 0 additions & 23 deletions t/local/01_pod.t

This file was deleted.

12 changes: 0 additions & 12 deletions t/local/kwalitee.t

This file was deleted.

11 changes: 11 additions & 0 deletions xt/01_kwalitee.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Ensure module distribution passes Kwalitee checks

use lib 'inc';

use Test::Net::SSLeay;

use Test::Kwalitee qw(kwalitee_ok);

kwalitee_ok();

done_testing();
17 changes: 17 additions & 0 deletions xt/02_pod.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Ensure all pod-formatted documentation is valid

use lib 'inc';

use Test::Net::SSLeay;

use Test::Pod;

all_pod_files_ok(
qw(
blib/lib/Net/SSLeay.pm
blib/lib/Net/SSLeay/Handle.pm
helper_script/generate-test-pki
inc/Test/Net/SSLeay.pm
inc/Test/Net/SSLeay/Socket.pm
)
);
12 changes: 3 additions & 9 deletions t/local/02_pod_coverage.t → xt/02_pod_coverage.t
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,9 @@ use lib 'inc';

use Test::Net::SSLeay;

if (!$ENV{RELEASE_TESTING}) {
plan skip_all => 'These tests are for only for release candidate testing. Enable with RELEASE_TESTING=1';
}
eval "use Test::Pod::Coverage 1.00";
if ($@) {
plan skip_all => 'Test::Pod::Coverage >= 1.00 required for testing pod coverage';
} else {
plan tests => 4;
}
use Test::Pod::Coverage;

plan tests => 4;

pod_coverage_ok('Net::SSLeay');
pod_coverage_ok('Net::SSLeay::Handle');
Expand Down

0 comments on commit 1e08a87

Please sign in to comment.