Skip to content

test: Move author tests to xt/ and rename target to test-author#7068

Draft
okurz wants to merge 3 commits intoos-autoinst:masterfrom
okurz:feature/036_move_author_tests_to_xt
Draft

test: Move author tests to xt/ and rename target to test-author#7068
okurz wants to merge 3 commits intoos-autoinst:masterfrom
okurz:feature/036_move_author_tests_to_xt

Conversation

@okurz
Copy link
Copy Markdown
Member

@okurz okurz commented Mar 3, 2026

Motivation:
Following Perl ecosystem best practices, author tests (static analysis,
style checks, POD, etc.) should be separated from functional/dynamic
tests. This allows build environments and package maintainers to focus
exclusively on tests that verify the correctness of the software in its
runtime environment, while avoiding dependencies and runtime overhead
associated with developer-only quality gates.

A similar change was done in os-autoinst in os-autoinst commit 090ad748
in PR os-autoinst/os-autoinst#1596. We already
had a Makefile target called "tidy-compile-style" which sounds like
"author" tests.

Design Choices:

  • Moved 00-tidy.t, 01-compile-check-all.t, 01-style.t, 02-pod.t, and
    45-make-update-deps.t from t/ to xt/.
  • Renamed the Makefile target 'test-tidy-compile-style' to 'test-author'
    to match industry-standard naming and ensure consistency with the
    'os-autoinst-common' sub-module.
  • Updated xt/01-compile-check-all.t to include the new xt/ directory in
    its syntax checks.
  • Updated xt/01-style.t to include xt/ in style checks and correctly
    exclude itself from self-referential style rules.
  • Simplified Makefile targets (test-t, test-ui, test-api) by removing
    GLOBIGNORE exclusions for moved tests, as they are no longer in t/.
  • Updated t/testrules.yml to reflect the new test locations.
  • Simplified dist/rpm/openQA.spec as author tests can be ignored
    completely.

User Benefit:

  • Developers get quick feedback via the generic 'make test-author'.
  • CI and build environments can more easily exclude non-functional
    tests, speeding up build-time verification and reducing dependency
    bloat.
  • Improved project structure consistency with other projects in the
    os-autoinst ecosystem.

@okurz okurz marked this pull request as draft March 3, 2026 16:14
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 2204f43 to 3adee5b Compare March 4, 2026 08:36
@okurz

This comment was marked as resolved.

@perlpunk

This comment was marked as resolved.

@perlpunk

This comment was marked as resolved.

@okurz

This comment was marked as resolved.

@perlpunk

This comment was marked as resolved.

@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 3adee5b to ad8ab9c Compare March 14, 2026 22:34
okurz added a commit to okurz/os-autoinst-common that referenced this pull request Mar 14, 2026
@okurz okurz changed the title PART 2: test: Move author tests to xt/ and rename target to test-author - After #7067 PART 2: test: Move author tests to xt/ and rename target to test-author - Needs https://github.com/os-autoinst/os-autoinst-common/pull/67 Mar 14, 2026
@okurz okurz changed the title PART 2: test: Move author tests to xt/ and rename target to test-author - Needs https://github.com/os-autoinst/os-autoinst-common/pull/67 test: Move author tests to xt/ and rename target to test-author Mar 16, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch 3 times, most recently from 25cc52c to e4644c4 Compare March 17, 2026 10:15
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch 2 times, most recently from 1b00dc0 to 6fbabde Compare March 20, 2026 21:43
@os-autoinst os-autoinst deleted a comment from mergify bot Mar 20, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch 3 times, most recently from 8178437 to 9155e43 Compare March 20, 2026 21:49
@okurz okurz changed the title test: Move author tests to xt/ and rename target to test-author PART 2: test: Move author tests to xt/ and rename target to test-author - After #7098 Mar 20, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 9155e43 to 8f51966 Compare March 20, 2026 21:52
@okurz okurz changed the title PART 2: test: Move author tests to xt/ and rename target to test-author - After #7098 test: Move author tests to xt/ and rename target to test-author Mar 20, 2026
@okurz okurz marked this pull request as ready for review March 20, 2026 21:53
@okurz

This comment was marked as resolved.

@perlpunk

This comment was marked as resolved.

@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 8f51966 to e137ddf Compare March 23, 2026 09:56
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch 2 times, most recently from 8e66d25 to 73fdb8d Compare March 24, 2026 22:29
@okurz okurz marked this pull request as draft March 27, 2026 19:47
@okurz okurz changed the title test: Move author tests to xt/ and rename target to test-author PART 2: test: Move author tests to xt/ and rename target to test-author - After #7197 Mar 27, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 73fdb8d to 261c1b5 Compare March 28, 2026 15:25
@os-autoinst os-autoinst deleted a comment from mergify bot Mar 28, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 261c1b5 to 6919290 Compare March 30, 2026 12:44
@os-autoinst os-autoinst deleted a comment from mergify bot Mar 30, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 6919290 to fa075f6 Compare March 30, 2026 19:59
@os-autoinst os-autoinst deleted a comment from mergify bot Mar 30, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from fa075f6 to 1ccb628 Compare March 30, 2026 20:03
@okurz okurz changed the title PART 2: test: Move author tests to xt/ and rename target to test-author - After #7197 test: Move author tests to xt/ and rename target to test-author Mar 30, 2026
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from 1ccb628 to d95df91 Compare March 31, 2026 21:37
okurz added 3 commits April 1, 2026 13:08
Motivation:
Following Perl ecosystem best practices, author tests (static analysis,
style checks, POD, etc.) should be separated from functional/dynamic
tests. This allows build environments and package maintainers to focus
exclusively on tests that verify the correctness of the software in its
runtime environment, while avoiding dependencies and runtime overhead
associated with developer-only quality gates.

Furthermore, compiling the entire codebase via `01-compile-check-all.t`
takes exceptionally long when running alongside other tests because
it gets instrumented by `Devel::Cover`. Separating it into its own
directory allows us to isolate it and bypass the coverage overhead.

Design Choices:
- Moved 00-tidy.t, 01-style.t, 02-pod.t, and 45-make-update-deps.t from
  t/ to xt/.
- Moved 01-compile-check-all.t from t/ to t/compile/.
- Renamed the Makefile target 'test-tidy-compile-style' to 'test-author'
  to match industry-standard naming and ensure consistency with the
  'os-autoinst-common' sub-module.
- Added a new 'test-compile' Makefile target for the compile checks.
- Set COVEROPT="" on both 'test-author' and 'test-compile' targets to
  bypass Devel::Cover instrumentation, drastically speeding up execution.
- Updated t/01-compile-check-all.t to include the new xt/ directory in
  its syntax checks.
- Updated xt/01-style.t to include xt/ in style checks and correctly
  exclude itself from self-referential style rules.
- Simplified Makefile targets (test-t, test-ui, test-api) by removing
  GLOBIGNORE exclusions for moved tests, as they are naturally isolated.
- Updated t/testrules.yml to reflect the new test locations.
- Simplified dist/rpm/openQA.spec as author tests can be ignored
  completely.
- Updated `prove_wrapper` in CI tools to support new directories.

User Benefit:
- Developers get much faster feedback via 'make test-author' and
  'make test-compile' due to bypassing Devel::Cover.
- CI and build environments can more easily exclude non-functional
  tests, speeding up build-time verification and reducing dependency
  bloat.
- Improved project structure consistency with other projects in the
  os-autoinst ecosystem.
Motivation:
Compiling the entire codebase (`01-compile-check-all.t`) is functionally
a dynamic test that requires all application dependencies to be fully
installed. It logically does not belong with static `checkstyle` tools
(like yamllint, perltidy) which do not execute application code.

Furthermore, isolating it into its own CI job allows it to run
concurrently alongside both static analysis and standard unit testing,
lowering total pipeline execution time.

Design Choices:
- Moved `test-compile` out of the `test-checkstyle` Makefile target.
- Added a dedicated `compile` job to `.circleci/config.yml` workflow.

User Benefits:
- Developers running `make test-checkstyle` get instant feedback on
  linting and style errors without waiting for a full module compile.
- Improved CI execution parallelism.
@okurz okurz force-pushed the feature/036_move_author_tests_to_xt branch from d95df91 to 2bc8fa6 Compare April 1, 2026 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants