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

clean up integ test documentation, error-handling #400

Merged
merged 1 commit into from
Oct 21, 2024
Merged

clean up integ test documentation, error-handling #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 5 additions & 11 deletions fsl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,9 @@ In the below steps, using the default endpoint path will test out the local dev
Using the provided secret path will test out how schema updates will work in a pipeline, with a direct secret provided.

To run them against your local changes you need to do the following:
1. create a database called FaunaCLITest
2. Do one of the following:
1. Setup a default endpoint called cli_test-us via fauna cloud-login
2. Obtain a secret for the FaunaCLITest database
3. build your version of the shell with `yarn build` in the root repo directory
4. Run the test script with one of the following:
1. If you have the default endpoint setup,
1. `./test-script.mjs ~/fauna/fauna-shell/bin/run`
2. If using the database secret,
1. `FAUNA_SECRET=[INSERT SECRET] ./test-script.mjs ~/fauna/fauna-shell/bin/run`

1. Obtain the secret the pipeline uses.
2. Run `fauna endpoint add cli_test-us --secret $SECRET --no-input`.
3. Build your version of the shell with `yarn build` in the root repo directory
4. Run the test script: `./test-script.mjs ~/fauna/fauna-shell/bin/run`

To run ad-hoc commands against the test database, you will need to provide the `--secret` flag (since a db key does not work with the `./fauna-project` file in this directory). For example: `fauna schema status --endpoint cli_test-us --secret $SECRET`.
7 changes: 7 additions & 0 deletions fsl/test-script.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,12 @@ async function execFQL(fql) {
? await $`${faunaCmd} eval ${fql} --format=json --secret ${secretFlag}`
: await $`${faunaCmd} eval ${fql} --format=json`;
const respParsed = JSON.parse(resp._stdout);
throwIfError(respParsed);
return respParsed;
}

function throwIfError(networkResult) {
if (networkResult && networkResult.error)
throw new Error(`${networkResult.error.code || 'unknown'}: ${networkResult.error.message || 'unknown'}`);
return networkResult
}