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.

Sign up for GitHub

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

Some small improvements to docs and tools around running tests locally against real services #23387

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Some small improvements to docs and tools around running tests locally against real services #23387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
405e9fe
Add inputs for providing secrets when running e2e tests
markfields Dec 20, 2024
4c5f3c4
getkeys README: Mention which Az sub to use
markfields Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions packages/test/test-end-to-end-tests/.vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"env": {
"fluid__test__driver": "local",
"fluid__test__backCompat": "${input:backCompat}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutputt}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutput}",
},
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/mocha",
"windows": {
Expand Down Expand Up @@ -55,7 +55,7 @@
"env": {
"fluid__test__driver": "t9s",
"fluid__test__backCompat": "${input:backCompat}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutputt}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutput}",
},
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/mocha",
"windows": {
Expand Down Expand Up @@ -109,8 +109,10 @@
"env": {
"fluid__test__driver": "odsp",
"fluid__test__backCompat": "${input:backCompat}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutputt}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutput}",
"fluid__test__odspEndpointName": "${input:odspEndpoint}",
"login__odsp__test__tenants": "${input:login__odsp__test__tenants}",
"login__microsoft__clientId": "${input:login__microsoft__clientId}",
Comment on lines +114 to +115
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"login__odsp__test__tenants": "${input:login__odsp__test__tenants}",
"login__microsoft__clientId": "${input:login__microsoft__clientId}",
// Normally these environment variables would be populated by getkeys,
// but if that is unfeasible (e.g. due to codespaces), uncomment these lines
// and you can input them at launch time.
// "login__odsp__test__tenants": "${input:login__odsp__test__tenants}",
// "login__microsoft__clientId": "${input:login__microsoft__clientId}",

},
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/mocha",
"windows": {
Expand Down Expand Up @@ -146,7 +148,8 @@
"fluid__test__driver": "r11s",
"fluid__test__backCompat": "${input:backCompat}",
"fluid__test__r11sEndpointName": "${input:r11sEndpoint}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutputt}",
"FLUID_TEST_VERBOSE": "${input:verboseConsoleOutput}",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Abe27342 I guess this will block the fallthrough to the local environment variables, so probably shouldn't merge this as-is. Any ideas on how to organize/implement this to make it quick/easy to plug them in on CodeSpaces or another place where getkeys hasn't been run on the local machine?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think something like https://github.com/microsoft/FluidFramework/pull/23387/files#r1913828487 is probably the best we can do. launch targets aren't super feature-rich.

It's fine to leave around the extra bits you added under "inputs"--as long as they aren't used by any launch targets, they won't be prompted for. You could maybe put a comment there instead explaining they're useful for codespaces workflows.

"fluid__test__driver__frs": "${input:fluid__test__driver__frs}",
},
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/mocha",
"windows": {
Expand Down Expand Up @@ -208,7 +211,7 @@
],
},
{
"id": "verboseConsoleOutputt",
"id": "verboseConsoleOutput",
"description": "Show console output?",
"default": "",
"type": "pickString",
Expand Down Expand Up @@ -245,5 +248,23 @@
},
],
},
{
"id": "fluid__test__driver__frs",
"description": "FRS Tenant info from our team key vault. Check your env vars after running getkeys",
"type": "promptString",
"password": true,
},
{
"id": "login__odsp__test__tenants",
"description": "ODSP Tenant info from our team key vault. Check your env vars after running getkeys",
"type": "promptString",
"password": true,
},
{
"id": "login__microsoft__clientId",
"description": "Client ID for authenticating to test ODSP tenants. Check your env vars after running getkeys",
"type": "promptString",
"password": true,
},
],
}
1 change: 1 addition & 0 deletions tools/getkeys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ prague-secrets or WAC Bohemia security group.

1. Install the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli), run `az login` and authenticate
with your Microsoft corporate account.
- Choose Azure Subscription `Fluid` when prompted.
2. In this folder, run `pnpm install`, then `npm start`.

You should restart the console/shell after running the script (or for bash/zsh run `source ~/.bashrc` or `source ~/.zshrc`)
Expand Down
Loading