Bug 39319

Summary: xt/author/podcorrectness.t only test POD for perl files within C4 and Koha
Product: Koha Reporter: Jonathan Druart <jonathan.druart>
Component: Test SuiteAssignee: Jonathan Druart <jonathan.druart>
Status: Pushed to main --- QA Contact: Martin Renvoize (ashimema) <martin.renvoize>
Severity: enhancement    
Priority: P5 - low CC: martin.renvoize
Version: unspecified   
Hardware: All   
OS: All   
GIT URL: Change sponsored?: ---
Patch complexity: --- Documentation contact:
Documentation submission: Text to go in the release notes:
Version(s) released in:
25.05.00
Circulation function:
Bug Depends on:    
Bug Blocks: 39325, 39367, 39324    
Attachments: Bug 39319: Make podcorrectness.t test controller and test perl files
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl
Bug 39319: Add test using Pod::Checker
Bug 39319: Fixes for Pod::Checker
Bug 39319: Make podcorrectness.t test controller and test perl files
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl
Bug 39319: Add test using Pod::Checker
Bug 39319: Fixes for Pod::Checker
Bug 39319: Improve pod_checker.t
Bug 39319: Make podcorrectness.t test controller and test perl files
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl
Bug 39319: Add test using Pod::Checker
Bug 39319: Fixes for Pod::Checker
Bug 39319: Improve pod_checker.t

Description Jonathan Druart 2025-03-13 08:46:27 UTC
It should also test controllers and tests.
Comment 1 Jonathan Druart 2025-03-13 08:59:36 UTC
Created attachment 179237 [details] [review]
Bug 39319: Make podcorrectness.t test controller and test perl files

It only tested files within C4 and Koha directories.

Now we test all the perl files that are in the git index.

Test plan:
0. Do not apply those patches
1. prove xt/author/podcorrectness.t
Notice "Tests=1208" meaning that 1208 files are tested
2. Apply this patch (not the second one)
It fails, and more files are being tested (3254)
xt/author/podcorrectness.t .. 1994/3254
xt/author/podcorrectness.t .. 2726/3254 # Looks like you failed 1 test of 3254.
3. Apply the second patch
=> It passes!
Comment 2 Jonathan Druart 2025-03-13 08:59:38 UTC
Created attachment 179238 [details] [review]
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl
Comment 3 Jonathan Druart 2025-03-13 15:30:54 UTC
Created attachment 179274 [details] [review]
Bug 39319: Add test using Pod::Checker

podchecker is used by the QA script and catch more than Test::Pod
Comment 4 Jonathan Druart 2025-03-13 15:30:56 UTC
Created attachment 179275 [details] [review]
Bug 39319: Fixes for Pod::Checker
Comment 5 David Nind 2025-03-16 19:26:48 UTC
Created attachment 179370 [details] [review]
Bug 39319: Make podcorrectness.t test controller and test perl files

It only tested files within C4 and Koha directories.

Now we test all the perl files that are in the git index.

Test plan:
0. Do not apply those patches
1. prove xt/author/podcorrectness.t
Notice "Tests=1208" meaning that 1208 files are tested
2. Apply this patch (not the second one)
It fails, and more files are being tested (3254)
xt/author/podcorrectness.t .. 1994/3254
xt/author/podcorrectness.t .. 2726/3254 # Looks like you failed 1 test of 3254.
3. Apply the second patch
=> It passes!

Signed-off-by: David Nind <david@davidnind.com>
Comment 6 David Nind 2025-03-16 19:26:50 UTC
Created attachment 179371 [details] [review]
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl

Signed-off-by: David Nind <david@davidnind.com>
Comment 7 David Nind 2025-03-16 19:26:53 UTC
Created attachment 179372 [details] [review]
Bug 39319: Add test using Pod::Checker

podchecker is used by the QA script and catch more than Test::Pod

Signed-off-by: David Nind <david@davidnind.com>
Comment 8 David Nind 2025-03-16 19:26:55 UTC
Created attachment 179373 [details] [review]
Bug 39319: Fixes for Pod::Checker

Signed-off-by: David Nind <david@davidnind.com>
Comment 9 Jonathan Druart 2025-03-18 12:43:08 UTC
Created attachment 179450 [details] [review]
Bug 39319: Improve pod_checker.t

It was not failing when warnings were found
Comment 10 Martin Renvoize (ashimema) 2025-03-24 16:15:58 UTC
Created attachment 179664 [details] [review]
Bug 39319: Make podcorrectness.t test controller and test perl files

It only tested files within C4 and Koha directories.

Now we test all the perl files that are in the git index.

Test plan:
0. Do not apply those patches
1. prove xt/author/podcorrectness.t
Notice "Tests=1208" meaning that 1208 files are tested
2. Apply this patch (not the second one)
It fails, and more files are being tested (3254)
xt/author/podcorrectness.t .. 1994/3254
xt/author/podcorrectness.t .. 2726/3254 # Looks like you failed 1 test of 3254.
3. Apply the second patch
=> It passes!

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 11 Martin Renvoize (ashimema) 2025-03-24 16:16:01 UTC
Created attachment 179665 [details] [review]
Bug 39319: Fix POD for misc/migration_tools/koha-svc.pl

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 12 Martin Renvoize (ashimema) 2025-03-24 16:16:04 UTC
Created attachment 179666 [details] [review]
Bug 39319: Add test using Pod::Checker

podchecker is used by the QA script and catch more than Test::Pod

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 13 Martin Renvoize (ashimema) 2025-03-24 16:16:06 UTC
Created attachment 179667 [details] [review]
Bug 39319: Fixes for Pod::Checker

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 14 Martin Renvoize (ashimema) 2025-03-24 16:16:09 UTC
Created attachment 179668 [details] [review]
Bug 39319: Improve pod_checker.t

It was not failing when warnings were found

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 15 Katrin Fischer 2025-04-14 06:52:53 UTC
Pushed for 25.05!

Well done everyone, thank you!