Skip to content

Commit

Permalink
chore(agoric-cli): Document external consumption of gettingStartedWor…
Browse files Browse the repository at this point in the history
…kflowTest (#10475)

## Description
Without this, packages/agoric-cli/integration-tests/workflow.test.js is an essentially empty wrapper.

### Security Considerations
n/a

### Scaling Considerations
n/a

### Documentation Considerations
n/a

### Testing Considerations
n/a

### Upgrade Considerations
n/a
  • Loading branch information
gibson042 authored Nov 14, 2024
1 parent e96ff82 commit ff8c142
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
3 changes: 1 addition & 2 deletions packages/agoric-cli/integration-tests/workflow.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@ import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';

import { gettingStartedWorkflowTest } from '../tools/getting-started.js';

test('workflow', t =>
gettingStartedWorkflowTest(t, { testUnsafePlugins: true }));
test('"getting started" workflow', t => gettingStartedWorkflowTest(t));
7 changes: 7 additions & 0 deletions packages/agoric-cli/tools/getting-started.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ const getLatestBlockHeight = url =>
req.end();
});

/**
* Test the "getting started" workflow. Note that this function may be imported
* by external repositories.
*
* @param {import('ava').ExecutionContext} t
* @param {{ init?: string[], install?: string[] }} [options]
*/
export const gettingStartedWorkflowTest = async (t, options = {}) => {
const { init: initOptions = [], install: installOptions = [] } = options;
const pspawn = makePspawn({ spawn });
Expand Down

0 comments on commit ff8c142

Please sign in to comment.