Test an extension app | Docusign

The Developer Console testing tools enable you to verify that your extension app has been configured correctly. These types of test are available:

Integration tests: Confirm that Docusign can use the values supplied during extension app registration to obtain authorization, send requests to an external API or API proxy, and process the responses.
Functional tests: Confirm that the extension app works as expected when invoked from a Docusign envelope or workflow or from Agreement Manager. This type of test enables you to simulate the end user experience for an extension app.
App Center preview: Displays extension app details and images so that you can review them. This information will appear in the Docusign App Center after you’ve published the extension app. This feature does not exactly replicate the App Center display, but it enables you to confirm that the extension app details you provided in the extension app manifest have been applied correctly.

Test prerequisites

This table lists prerequisites for each type of test.

Prerequisite	Required for integration tests	Required for functional tests	Required for App Center preview
Register an extension app.	Yes	Yes	Yes
Set up an API proxy if necessary.	Yes	Yes	No
Obtain an account with the authorization provider. You’ll need to supply these credentials for testing. The authorization provider is either the external service to which the extension app will send API requests, or an identity provider if you opt to use one for authorization.	Yes	Yes	No
Execute a successful connection test for the extension app.	No	Yes	No
Execute successful extension tests for each of the extension app’s extensions.	No	Yes	No

Test against different environments

While developing an extension app, you may need to test against multiple external service environments, such as a development environment, a test environment, and production.

Currently, extension app registration supports connection properties for a single external service environment. To switch between environments for testing, you can update the extension app registration when you want to switch environments, or you can maintain separate extension app registrations for each environment.

If you plan to make your extension app publicly available on the Docusign App Center, make sure that you have supplied production URLs in your extension app registration before you submit it for review.

Switch test environments by updating the extension app registration

If you want to use the same extension app registration for different test environments, complete these steps to switch environments:

Update the extension app registration and change these environment-specific properties:
- Connection settings
  - If you update these settings using a form, see Update connection settings for steps to modify the Client ID, Client secret, and the authorization settings.
  - If you update these settings using the extension app manifest, see Use a manifest file to update a registration. You’ll need to update clientId, clientSecret, and authorization settings in the customConfig object. See Connection schema for details about these properties.
- Action and capability settings
  - If you update these settings using a form, see Update extension and action settings for steps to modify the Params URI values, which specify the endpoint URLs for each request to the external service.
  - If you update these settings using the extension app manifest, see Use a manifest file to update a registration. You’ll need to update params.uri for each action and capability. See Action schema for details.
After you update the extension app registration, the extension app is automatically reinstalled to your developer account, and you can proceed with running integration tests and functional tests.

Switch test environments by using separate extension app registrations

If you choose to maintain separate extension app registrations for each test environment, Docusign recommends naming each non-production version to reflect the environment with which it’s intended to be used.

To create an environment-specific copy of an extension app registration:

On the Developer Console My Extension Apps page, select Download Manifest from the kebab menu of the extension app for which you want to create an environment-specific registration.
Edit the downloaded file, and change these environment-specific properties:
- Enter a unique value for the name property.
- Connection settings: Update clientId, clientSecret, and authorization settings in the customConfig object. See Connection schema for details about these properties.
- Action and capability settings: Update params.uri for each action and capability, which specifies the endpoint URL for requests to the external service. See Action schema for details.
Select Create App in the upper right corner of the My Extension Apps page, and then select By editing the manifest.
Under Have your own manifest? select the modified manifest file or drag and drop to upload it.
Select Validate and correct any validation errors.
Select Create App to save the registration.
You can proceed with running integration tests and functional tests for the new environment-specific registration.

Next steps

Learn how to run integration tests.
Find out more about functional tests.
See how to use the App Center preview.