Home

Awesome

<p align="center"> <img src="img/protostar-logo-light.png" width="100"/> </p> <div align="center"> <h1 align="center">Protostar Test Explorer</h1> <p align="center"> <a href="https://discord.gg/onlydust"> <img src="https://img.shields.io/badge/Discord-6666FF?style=for-the-badge&logo=discord&logoColor=white"/> </a> <a href="https://twitter.com/intent/follow?screen_name=onlydust_xyz"> <img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white"/> </a> <a href="https://contributions.onlydust.xyz/"> <img src="https://img.shields.io/badge/Contribute-6A1B9A?style=for-the-badge&logo=notion&logoColor=white"/> </a> </p> <h3 align="center">vscode extension to view protostar tests in the Test Explorer.</h3> </div>

⚠️ WARNING! ⚠️

This repo contains highly experimental code. Expect rapid iteration.

🎟️ Description

vscode extension to view protostar tests in the Test Explorer.

This extension uses vscode native Test API

🎗️ Prerequisites

Minimum protostar version required: 0.2.1

Install or upgrade protostar using the command below:

curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash

For this extension to work properly, you need to create a dedicated profile named ci. This profile should be configured to:

Here is an example of the corresponding section in protostar.toml file:

[profile.ci.protostar.shared_command_configs]
no_color=true
cairo_path = ["./lib/cairo_contracts/src"]
target = "contracts"

you can test your setup by running the following command:

protostar -p ci test

📦 Installation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install abuisset.vscode-protostar-test-adapter

🔬 Usage

Click on the Test icon <img src="img/test-explorer-icon.png" width="30"/>, you should see the list of protostar tests.

test view

Then interact with your tests as any other Test extension.

Test results will be displayed in the test output console.

test view

This extension detects Protostar projects using the protostar.toml file and/or test files like *test*.cairo. If the automatic activation does not work, it is possible to manually launch the extension using the "Launch Protostar Test Explorer" command accessible from the vscode menu (Ctrl-Shift-P).

🫶 Contributing

Contribution guidelines are specified in CONTRIBUTING.md. For contribution ideas, please refer to the contribution page.

Here are the steps for local deployment:

You should now see a second VS Code window, the Extension Development Host. Open a folder in this window and click the "Test" icon in the Activity bar. Now you should see your test suite in the side panel:

test view

🌡️ Testing

Unit tests are using jest framework. To run the tests, simply run the following command:

yarn test

To check code coverage, run:

yarn coverage

To check code formatting, run:

yarn lint

You can also format your code by using the following command:

yarn lint:fix

📄 License

Protostar Test Explorer is released under MIT.

❓ Reference