Typhoon Test is an extension that is used to write, run python tests and display the result and log of each test, using appropriate Typhoon API libraries.

When you install Typhoon Test, you get two main features:

• API Wizard: A tool which provides an easy way to add API commands

• Pytest Monitor: A tool which provides an easy way to run tests and monitor the results

API Wizard

The API Wizard is a panel available in TyphoonTest IDE which provides a list of functions defined in any python-importable module or class, and for any selected function users have quick access to a formatted docstring and can easily add the function call with proper arguments

The API Wizard panel is divided in 3 main parts

Function List

Contains all the found functions/methods in the selected library in a searchable list. The list also provides commands for importing python modules and classes (typhoon-test.addPythonEntity), as well as saving the current workspace for future use (typhoon-test.saveApiWizardWorkspace).

Function Documentation

The extension provides an HTML-rendered view of the selected function's docstring, offering quick access to key information such as function arguments and descriptions. This feature eliminates the need to open external documentation, streamlining the development workflow.

Additionally, the panel applies custom styling specifically tailored to methods and classes from the Typhoon HIL modules, ensuring that relevant documentation is presented in a clear and concise manner.

Function Arguments

Provides an easy way of defining the function arguments and inserting them into your test code in the editor. The unchanged default arguments can be omitted for a more concise test code and the function call can also be copied to the clipboard and pasted in another editor/program.

Pytest Monitor

Pytest Monitor provides a way to run tests and monitor the results in real-time. The panel shows the test results in a tree view, where each test is represented by a node with a status icon. The extension also provides a way to quick run a tests by executing the typhoon-test.runTest command.

Pytest Monitor creates a new output channel, Pytest Output, in the Output panel, where the test results are printed. If the typhoon-test.testRun.openReport setting is enabled, the extension will create a new terminal, Allure Report, where the Allure server will be started and the test results will be displayed in a web browser. If the typhoon-test.testRun.pdfReport will also generate a PDF report of the test results in the workspace directory. Execution results will be stored in the report directory. If the typhoon-test.testRun.cleanOldResults setting is enabled, the extension will clean the old results before new tests are run.

Additional Options

Run Tests from Active File or Specific Test

Quickly execute all tests in the active Python file or run a specific test by placing the cursor on the test name.

Stop Running Tests

Easily terminate ongoing test executions with a dedicated stop command.

Extension Configuration

The extension needs to be configured in order to work properly. The configuration can be accessed by executing the typhoon-test.openTestRunConfiguration command.

For new users, the extension provides an easier way to configure test settings through the following WebViews:

• PDF Configuration WebView: Easily customize PDF settings in an intuitive WebView interface.

  

• Test Run Configuration WebView: Simplify the setup of test run options directly within the WebView.

  

Requirements

• Visual Studio Code v1.91.1 or higher
• Python 3.6 or higher (for running Python scripts)
• pytest 6.2.4 or higher (for running tests)
• Typhoon HIL (recommended for full usage of the extension)

What's New

• Enhanced Test Collection with Pytest: Support for the --collect-only flag has been added, allowing test discovery to run and display the collected test hierarchy directly in the Pytest Monitor view. The test structure can now be inspected before execution.

  

• Run Tests Directly from the Test Tree: Tests can now be run with a single click from the test tree in Pytest Monitor. Whether it's for the entire workspace, a specific file, or an individual function, test execution can be triggered directly from the corresponding tree node.

  

• Typhoon Test Submenu: Simplifies searching for the Typhoon Test specific commands by grouping all available commands under one submenu

  

• Run Selected Python Entity: Using the code lens, users can easily run specific class, method or function, without need to search for the commands and positioning cursor above their target

  

• View In Code: Users can now view tests directly in the editor by clicking on the test node with the execution result.