-
Notifications
You must be signed in to change notification settings - Fork 3k
Add a configuration to serve a local directory with a static handler #51186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mathias82
wants to merge
2
commits into
quarkusio:main
Choose a base branch
from
mathias82:feature-static-local-dir
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+175
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
33 changes: 33 additions & 0 deletions
33
...s/vertx-http/deployment/src/test/java/io/quarkus/vertx/http/LocalStaticResourcesTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package io.quarkus.vertx.http; | ||
|
|
||
| import static io.restassured.RestAssured.given; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
|
||
| import io.quarkus.test.QuarkusUnitTest; | ||
|
|
||
| public class LocalStaticResourcesTest { | ||
|
|
||
| @RegisterExtension | ||
| static final QuarkusUnitTest test = new QuarkusUnitTest() | ||
| .withConfigurationResource("application-local-static-resources.properties"); | ||
|
|
||
| @Test | ||
| public void shouldServeLocalStaticResource() { | ||
| given() | ||
| .when().get("/local-static/test.txt") | ||
| .then() | ||
| .statusCode(200) | ||
| .body(equalTo("hello-static")); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldReturn404ForMissingResource() { | ||
| given() | ||
| .when().get("/local-static/does-not-exist.txt") | ||
| .then() | ||
| .statusCode(404); | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
...rtx-http/deployment/src/test/resources/conf/application-local-static-resources.properties
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| quarkus.http.local-static-resources.enabled=true | ||
| quarkus.http.local-static-resources.path=/local-static | ||
| quarkus.http.local-static-resources.directory=src/test/resources/local-static |
1 change: 1 addition & 0 deletions
1
extensions/vertx-http/deployment/src/test/resources/local-static/test.txt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| hello-static |
63 changes: 63 additions & 0 deletions
63
...-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/LocalStaticResourcesConfig.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package io.quarkus.vertx.http.runtime; | ||
|
|
||
| import io.quarkus.runtime.annotations.ConfigGroup; | ||
| import io.smallrye.config.WithDefault; | ||
|
|
||
| @ConfigGroup | ||
| public interface LocalStaticResourcesConfig { | ||
|
|
||
| /** | ||
| * Whether serving local static resources is enabled. | ||
| */ | ||
| @WithDefault("false") | ||
| boolean enabled(); | ||
|
|
||
| /** | ||
| * The URL path under which the local directory is exposed, | ||
| * e.g. {@code /local-static/*}. | ||
| */ | ||
| @WithDefault("/local-static/*") | ||
| String path(); | ||
|
|
||
| /** | ||
| * The local directory to serve files from, relative to the working directory. | ||
| * For example: {@code static/}. | ||
| */ | ||
| @WithDefault("static") | ||
| String directory(); | ||
|
|
||
| /** | ||
| * Normalizes the configured path for serving local static resources. | ||
| * @return a normalized, safe base path for static resources | ||
| * @throws IllegalArgumentException if the path contains {@code *} or {@code ..} | ||
| */ | ||
| default String normalizedPath() { | ||
|
|
||
| String p = path().trim(); | ||
|
|
||
| if (p.contains("*")) { | ||
| throw new IllegalArgumentException( | ||
| "quarkus.http.local-static-resources.path must not contain '*': " + p); | ||
| } | ||
|
|
||
| if (p.contains("..")) { | ||
| throw new IllegalArgumentException( | ||
| "quarkus.http.local-static-resources.path must not contain '..': " + p); | ||
| } | ||
|
|
||
| if (p.isEmpty()) { | ||
| return "/"; | ||
| } | ||
|
|
||
| if (!p.startsWith("/")) { | ||
| p = "/" + p; | ||
| } | ||
|
|
||
| while (p.endsWith("/") && p.length() > 1) { | ||
| p = p.substring(0, p.length() - 1); | ||
| } | ||
|
|
||
| return p; | ||
| } | ||
|
|
||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.