[OSCI][DEV]ingest feature flags from .env file

[kohinoor98]

Description

Reads the .env file and then applies the necessary flags to the system instead of passing in flags in the commandline.

Related Issues

Resolves #594

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)
• Public documentation issue/PR created

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27527/
• CommitID: 8f78f46
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27529/
• CommitID: fd6f8ee
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27530/
• CommitID: c20a8bc
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/28199/
• CommitID: fbaef78
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[dblock]

Ideally, I'd like to be able to do both OPENSEARCH_XYZ=123 or dotenv gradle run .... This change does allow me to do (2) - is it good enough? Maybe others have some thoughts? @peternied WDYT?

@kohinoor98

1. You should iterate to green either way.
2. Is (1) somehow possible?

[kohinoor98]

Hi @dblock

1. Please could you help me understand how I could achieve:
   You should iterate to green either way

2. For the command:

dotenv ./gradlew run

dotenv-cli would need to be installed on the users system.

This tool helps manage the environment variables by loading them from a .env file into the ENV of your script's process. However, in the context of the changes, whether or not dotenv is used explicitly to override flags doesn't make a difference. This is because, during the startup script execution, environment variables will be picked up directly, making the commands dotenv ./gradlew run and ./gradlew run effectively identical in behavior. The system inherently reads env variables, ensuring no disparity in the execution process resulting from how they were initiated.

Therefore, while dotenv-cli aids in the initial loading of your custom environment variables, the actual running script initiated by gradlew remains unaffected by this intermediary.

3. (1) should be possible(could impact multiple points throughout; would need to experiment to know more) but I believe it is already in use as snakeyaml is being used and the flags from yaml are being ingested throughout the project like in this PR. Please advise on next steps on this.

Thanks,
KC

[dblock]

dotenv-cli would need to be installed on the users system.

This is totally normal, typical use of dotenv.

[peternied]

I am not sure what the value of having a .env file is vs opensearch.yml, but maybe I am not the developer targeted by this effort 🤷

I develop on my less-than-beefy windows laptop by using VSCode's remote plugin to an EC2 instance does the heavy lifting, maybe I am part of the audience but have been worked around these issues addressed with .env?

PS: I rarely use ./gradlew run opting to use test cases to validate what I'm build most of the time.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/29457/
• CommitID: df7f859
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[kohinoor98]

Hi @dblock

Gradle Check is failing due to a known flaky-test addressed here #7396.

I think rest is good to go. Please let me know if anything else has to be done for this PR.

Thanks a lot,
KC

[dblock]

@kohinoor98 Please do rebase/force push an update to re-trigger tests until they pass. Appreciate any time you can spend fixing flaky tests while you wait on retries, too.

[github-actions]

❌ Gradle check result for 79150da: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 3fea373: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[opensearch-trigger-bot]

This PR is stalled because it has been open for 30 days with no activity.

[stephen-crawford]

I suggest we close this. @kohinoor98 you are more than welcome to open a new PR for this change in the future.

[kohinoor98]

I suggest we close this. @kohinoor98 you are more than welcome to open a new PR for this change in the future.

I am facing some issues with hitting all green due to some configurations. I will create a new PR for the same.