EnvironmentCommandlet can log warnings into the middle of environment variables

[hohwille]

Expected behavior

As a IDEasy user, I want to setup my project environment in any shell anywhere with just the command ide so that I can start working seamlessly from there.

Actual behavior

Setting up the environment variables with ide commandlet can cause errors and even potentially security risks.
If variables cannot be evaluated, that should normally be logged as warning to notify the user about a problem.
However, the problem with EnvironmentCommandlet (ide env) is that here we are using the "log" as an "API" to the shell (bash or CMD) and send some kind of "code for execution".
Now, if some log message like Undefined variable ${UNDEFINED} in 'SOME' gets logged into this "code", that breaks the "API".
So most likely we have to control the log for this commandlet like we do in CompleteCommandlet.

Steps to reproduce (bug)

1. add something like FOO=${BAR} ${SOME} ${UNDEFINED} to your ide.properties
2. run ide command in that project.

I then get errors like this in bash:

bash: $'\E[93mUndefined': command not found
bash: $'\E[93mUndefined': command not found
bash: $'\E[93mUndefined': command not found

Comments/Hints:

See

IDEasy/cli/src/main/java/com/devonfw/tools/ide/commandlet/CompleteCommandlet.java

Line 55 in 752f41e

System.out.print(candidate.text()); // enforce output via System.out even if logging is disabled

In EnvironmentCommandletTest we also have a lot of redundancy now for windows and non-windows case in case of info-logging and also I had to comment out the assertion method like this: log().hasEntries/*WithNothingElseInBetween*/(...).
To avoid the redundancies, we should manually build the expected VariableLine instances and then have an advanced assertion method that can take flags like boolean quoteValue and boolean omitExport.

Affected version:

• OS: Windows (also Linux/Mac)
• IDEasy: 2024.08.001-beta-SNAPSHOT

[hohwille]

Still not fix by PR #541.
@hohwille what are you doing 😵😆

$ ideasy env
Variable IDE_ROOT is set to 'D:\projects\_ide' but for your project 'IDEasy' the path 'D:\projects' would have been expected.
AWS_CONFIG_FILE=D:\projects\IDEasy\conf\aws\config
...

So this is what I predicted that still logs can be produced in the constructor of IdeContext causing this problem.
Hence, this is still not fixed.
Further, I made another bug here:

$ ideasy -d env
Variable IDE_ROOT is set to 'D:\projects\_ide' but for your project 'IDEasy' the path 'D:\projects' would have been expected.
Configuration directory C:\Users\hohwille\.ide does not exist.
Running commandlet EnvironmentCommandlet[env]
AWS_CONFIG_FILE=D:\projects\IDEasy\conf\aws\config
... env variables but no more debug logging here ...

So PR #541 now disables debug logging even if -d or --debug was present.