Skip to content

Latest commit

 

History

History
76 lines (44 loc) · 3.8 KB

README.md

File metadata and controls

76 lines (44 loc) · 3.8 KB
Raw

Integration Test and Code Generator by UP9

Save time with automatically generated tests, code snippets and OpenAPI specs that can help you speed up development and testing. Integration code, tests and OpenAPI specs are inferred from API traffic.

This comes in the form of an Integrated Developer Environment (IDE) as a VS Code extension.

overview screenshot

The UP9 Advantage

UP9 unpacks and analyzes API payloads of modern protocols, resulting in automatic generation of artifacts that can help speed up development and testing.

Artifacts include:

  • OpenAPI specs
  • API Mocks
  • Integration tests and code

Features

Artifacts (OpenAPI specs, code, test, assertions) are automatically generated and are inferred from API traffic.

  • Complete and ready-to-run integration code snippets available for all APIs
  • Each API test includes a variety of assertions
  • Each API includes reconstructed OpenAPI specs

Install the Extension

You can find the UP9 Extension in the Visual Studio Code Marketplace. To install either:

  • Navigate to the UP9 extension in the Visual Studio Marketplace and follow the instructions
  • Browse for the extension in as advised here, search for UP9 and then install
  • Download VSIX extension package from UP9 artifact store on GitHub, and install as guided here

Quick Start

  • Press Command-Shift-P to access VS Code command launcher and select UP9: Code Browser from the list. This will open a right-pane window offering you to sign in to your UP9 account:

The right-pane upon opening the code browser

  • Complete the required fields and select Connect - this connects your UP9 account to the IDE. Once connected, you can begin using the UP9 extension.

Connecting the extension to your UP9 account

Using the UP9 Extension in VS Code IDE

  1. Select your UP9 workspace and the endpoints from the drop-down lists.

  2. Now you can view sample test code for selected endpoints on the screen. You can also view a basic schema, including parameters and request/response bodies.

  • You can see the sample integration code for the selected API endpoint
    Select UP9 workspace and endpoint -- see the integration code sample

  • Or you can view the API request parameters, request or response body schema, parameters, etc. View API endpoint parameters and request/response body schema

  1. You can use COPY button to copy the sample code into clipboard, or use INSERT button to include sample code into the file edited in the left-pane. If the edited file is empty, the entire code will be included, otherwise - code will be inserted as function at the cursor location.
  • NOTE: You may notice some assertions that are commented out at the bottom of the code sample. These are there to help you create API tests easily and efficiently. Uncomment those to use them in your tests.

Running your code using UP9

  1. Select UP9: Run Code with UP9 in right-click menu of your Python code browser to run code via UP9 agent configured in your Kubernetes cluster.

Select "UP9: Run code with UP9" in the menu

  1. Test run output is shown in the bottom pane after the execution.

Test run output is shown in the bottom pane

More Details

Visit here for more details.

For support, follow these processes: