Skip to content
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

Manual OpenBAS install method as described in docs.openbas.io create a partially broken installation #2202

Open
antoinemzs opened this issue Jan 13, 2025 · 0 comments
Labels
bug use for describing something not working as expected regression Label to identify the bug as a regression of previously working feature
Milestone

Comments

@antoinemzs
Copy link
Contributor

Description

When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will not be able to locate agent binaries.

Environment

Latest OpenBAS as of writing: 1.10.1

Reproducible Steps

Follow steps here: When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will run with unexpanded Maven @..@ placeholder values treated as literals.

Expected Output

All variables should be expanded.

Actual Output

When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will run with unexpanded Maven @..@ placeholder values treated as literals. This will for example lead OpenBAS to think it is running version literal @project.version@.

Additional information

Current workaround

Deleting variables from the application.properties file provided as a release artifact (e.g. in the archive in the github release) will force Spring to load values for the redacted variables that were expanded at build time.
Example:

# Global configuration
# suppress inspection "SpringBootApplicationProperties"
[email protected]@
- # suppress inspection "SpringBootApplicationProperties"
- [email protected]@

# OpenBAS configuration
[email protected]@
[email protected]@

will cause Spring to load the build-time value, for example 1.10.1 .

Suggested path to resolution

Remove @..@ placeholders from application.properties, or alternatively expand them in the file itself if the intention is to keep providing this file as part of the release artifacts. It is useful to have this file provided as it helps a user discover configuration keys, so we need to be wary that it works out of the box.

Screenshots (optional)

$ java -jar openbas-api.jar 
Standard Commons Logging discovery in action with spring-jcl: please remove commons-logging.jar from classpath in order to avoid potential conflicts
 #######  ########  ######## ##    ## ########     ###     ######
##     ## ##     ## ##       ###   ## ##     ##   ## ##   ##    ##
##     ## ##     ## ##       ####  ## ##     ##  ##   ##  ##
##     ## ########  ######   ## ## ## ########  ##     ##  ######
##     ## ##        ##       ##  #### ##     ## #########       ##
##     ## ##        ##       ##   ### ##     ## ##     ## ##    ##
 #######  ##        ######## ##    ## ########  ##     ##  ######
@project.version@
@antoinemzs antoinemzs added bug use for describing something not working as expected needs triage use to identify issue needing triage from Filigran Product team regression Label to identify the bug as a regression of previously working feature labels Jan 13, 2025
@jborozco jborozco removed the needs triage use to identify issue needing triage from Filigran Product team label Jan 14, 2025
@EllynBsc EllynBsc added this to the Bugs backlog milestone Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug use for describing something not working as expected regression Label to identify the bug as a regression of previously working feature
Projects
None yet
Development

No branches or pull requests

3 participants