Test: Terminal Shell Environment Proposed API

[anthonykim1]

Refs: #227467

• macOS @jrieken
• linux @karthiknadig
• windows @amunger

Complexity: 5

Create Issue

---

Thanks in advance for testing.
I've rated this as complexity 5 due to having to cover multiple shells, but should not be technically challenging to test.

Background Information

There are times where extensions would like to know user's environment information. Meaning list of user's environment variable from various places (including shell specific init scrip such as .zshrc, etc).
I've been working on adding a proposed API here to expose such information from core => extension.

Last month, we had a TPI to test initial version of this proposed API but only for Powershell: #238896

There has been change to the API shape since then (added an isTrusted field), and addition of support for of zsh, bash, fish as well.

---

Setup

1. Make sure to enable proposed api terminalShellEnv on extension/code of your choice
2. Bring/Create extension of your choice where you can subscribe for terminal.shellIntegration event. (onDidChangeTerminalShellIntegration)
3. Make sure you have shell integration setting enabled: terminal.integrated.shellIntegration.enabled

---

Testing

For MacOS and Linux:

• Test for: pwsh, zsh, bash, fish

For Windows

• Test for: pwsh, gitbash, fish

1. Make sure you are listening to window.onDidChangeTerminalShellIntegration.
2. The new proposed API and env (environment variables object) should be available via terminal.shellIntegration.env. Note there is two field for env, which are:
   • terminal.shellIntegration.env.value should get you all of the environment variables
   • terminal.shellIntegration.env.isTrusted(This should be true for pwsh, bash, zsh, and false for fish)
3. Create terminal, watch environment variables. Try putting some env vars in your shell init scripts and see if they show up in the list of environment variables.
4. Try setting environment variable directly in your terminal. Make sure you are getting updated variable show up
5. Try deleting/unsetting the environment variable. Make sure you are NOT seeing the deleted/unsetted environment variable.
6. This API is enabled by true in default in insiders via setting terminal.integrated.shellIntegration.environmentReporting Try turning this off to see that you dont get the env object.

[amunger]

fyi fish is not listed as supporting shell integration on Windows

[amunger]

Looks like that's just because fish isn't really available for windows except maybe through WSL

[anthonykim1]

Yeah, maybe we could add a WSL section, but not too sure since there are already linux section

[karthiknadig]

Only fish is working for me on linux.