Add ability to return application version from new admin endpoint and wiremock standalone cli #2453
Conversation
This file contains 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
…dd a new version properties file to the resources so we can use this in the app to return the version.
…ion numbers via the build tasks. Test version stays the same so we can continue to validate the version number in our tests
…e and returns the version as a String
… to be made to return the version. The response defaults to json but a simple text/plain response can be sent if the client adds the Accept header of 'text/plain'
oleg-nenashev
approved these changes
Oct 28, 2023
| import java.util.Properties; | ||
|
|
||
| public class Version { | ||
| public static String getCurrentVersion() { |
There was a problem hiding this comment.
How about caching it in a static variable? Java resource loading is heavy, and such unprotected endpoint may be exploited for various kinds of DDoS attempts
There was a problem hiding this comment.
Sounds great. Thank you for the suggestion. I have added simple caching of the version as suggested. If we add any other version information to the Version class we can add more sophisticated caching but for now this should do
There was a problem hiding this comment.
I've just merged a change with a Lazy utility class. This might be a nice way to do this (and is thread safe FWIW).
There was a problem hiding this comment.
Nice, I'll take a look at that and update the PR
There was a problem hiding this comment.
I have updated to the Lazy class. Nice little utility class 👍
…rn-application-version
… from the classpath. If we add any other version information to the Version class we can add more sophisticated caching but for now this should do
oleg-nenashev
approved these changes
Oct 31, 2023
…rn-application-version
…load the properties in a thread safe way.
tomakehurst
approved these changes
Nov 6, 2023
Marvin9
pushed a commit
to Marvin9/wiremock
that referenced
this pull request
Nov 20, 2023
… wiremock standalone cli (wiremock#2453) * Add the Implementation name and version to the manifest files. Also add a new version properties file to the resources so we can use this in the app to return the version. * New version properties files that are updated with all the other version numbers via the build tasks. Test version stays the same so we can continue to validate the version number in our tests * Version class that reads in the value from the version.properties file and returns the version as a String * Add a new version route to the admin interface to allow a GET request to be made to return the version. The response defaults to json but a simple text/plain response can be sent if the client adds the Accept header of 'text/plain' * Formatting fix * Adds the version cli option to the standalone version of wiremock * If the version cli option is set, output the current wiremock version and then exit. * Use constants and enums instead of strings for content type and mime type * Add the Accept header to the static types for future use * Run spotless apply * Add simple caching of the version so we don't have to keep pulling it from the classpath. If we add any other version information to the Version class we can add more sophisticated caching but for now this should do * Update the version number so it matches the latest releases * Update the Version class to use the new Lazy utility class to lazily load the properties in a thread safe way.
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR provides the ability for the application to read the current version and return this version from a new admin endpoint and the cli for wiremock standalone.
The current version is copied to a file in the
resourcesfolder using the samefilesWithVersionmechanism as other files referenced in the build script. The version is also added to the jar manifest files via the build script.The PR adds a new
GETadmin endpoint at the following url -__admin/version. By default this returns a simple json payload with the version information. If the caller sends anAcceptheader withtext/plainthe version information is returned as a text response.If used on the cli via
java -jar wiremock-standalone-3.2.0.jar --versionthe version information will be output and the application will then exit.One area that I am not sure about is how the open api files are updated so at the moment the new
versionadmin endpoint is not referenced in there.Submitter checklist
#help-contributingor a project-specific channel like#wiremock-java