fix: support extra_lua_path in test framework #12759
Open
+250
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
the
size:L
Baoyuantop
reviewed
Nov 20, 2025
Contributor
Baoyuantop
left a comment
Baoyuantop
left a comment
There was a problem hiding this comment.
Codes LGTM, please fix the failed CI
Contributor
|
Hi @grapestore, you can merge the latest main branch to make CI pass. |
added 4 commits
November 20, 2025 19:17
Add support for setting custom Lua paths in test files through
two complementary methods:
1. Block definitions (preferred):
--- extra_lua_path: /custom/path/?.lua
--- extra_lua_cpath: /custom/path/?.so
2. YAML configuration parsing:
--- extra_yaml_config
apisix:
extra_lua_path: "/custom/path/?.lua"
The implementation prepends custom paths to lua_package_path and
lua_package_cpath, aligning test behavior with APISIX runtime where
extra_lua_path allows loading custom plugins from specified directories.
Block definitions take precedence when both methods are used, ensuring
explicit test configuration overrides YAML settings.
Added comprehensive test suite (t/admin/extra-lua-path.t) covering:
- Path addition via block definitions
- YAML configuration parsing
- Simultaneous lua_path and lua_cpath configuration
- Correct path prepending behavior
- Precedence rules between methods
This enables testing custom plugins in custom directories without
modifying core APISIX paths.
Fixes apache#12389
grapestore
force-pushed
the
fix/extra-lua-path-in-tests
branch
from
2b64c82 to
9c80b2c
Compare
Author
|
I’ve updated my branch to follow the latest master branch |
Author
|
Could you please take a look? |
membphis
reviewed
Dec 9, 2025
Member
membphis
left a comment
membphis
left a comment
There was a problem hiding this comment.
we need a real case to cover this case
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for setting custom Lua paths (
extra_lua_pathandextra_lua_cpath) in test files, aligning the test framework behavior with APISIX runtime configuration.Previously, while APISIX runtime supported
apisix.extra_lua_pathinconfig.yamlto load custom plugins from specified directories, the test framework (t/APISIX.pm) did not respect this configuration. This made it impossible to write tests for custom plugins located in custom directories.This PR implements two complementary methods for setting custom Lua paths in tests:
Method 1: Block definitions (preferred)
--- extra_lua_path: /custom/path/?.lua
--- extra_lua_cpath: /custom/path/?.soMethod 2: Automatic parsing from extra_yaml_config
--- extra_yaml_config
apisix:
extra_lua_path: "/custom/path/?.lua"
extra_lua_cpath: "/custom/path/?.so"The implementation:
lua_package_pathandlua_package_cpath(matching runtime behavior)Which issue(s) this PR fixes:
Fixes #12389
Checklist
Test Coverage:
Added comprehensive test suite in
t/admin/extra-lua-path.tcovering:Backward Compatibility:
This change is fully backward compatible. It only adds new optional block definitions (
extra_lua_path,extra_lua_cpath) and parsing logic for existingextra_yaml_config. All existing tests continue to work without modification.