sweepai

Sweep AI Unit Testing Tool

This is a fully locally running dev tool for getting Sweep to improve your unit testing suite. It uses your local machine to execute all unit tests for security and rapid iteration.

Getting Started (10 min)

Step 0: Pre-requisites (3 min)

For most users the following script should work:

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash # For NVM
npm install -g pnpm # For PNPM

But if that doesn't work, the installation for NVM can be found here and PNPM at here.

Step 1: Set up the Environment and Building (3 min)

Clone into the repo and set up the environment.

git clone https://github.com/sweepai/sweep
cd sweep/platform
nvm install
nvm use
pnpm i

This should take a couple minutes to install. In the meantime, move onto the next step.

Step 2: Get your OpenAI key (3 min)

Get an OpenAI key here and add it to your .env.local.

OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Step 3: Run the Tool (1 min)

Now you can build the tool with

pnpm build

This will take about 20s. Then you can start the tool with:

pnpm start

Using Sweep Unit Test Tool

1. Insert the path to your local repositorrey.
   • You can run pwd to use your current working directory.
   • (Optional) Edit the branch name to checkout into a new branch for Sweep to work in (defaults to current branch).
2. Select an existing file for Sweep to add unit tests to.
3. Add meticulous instructions for the unit tests to add, such as the additional edge cases you would like covered.
4. Modify the "Test Script" to write your script for running unit tests, such as python $FILE_PATH. You may use the variable $FILE_PATH to refer to the current path. Click the "Run Tests" button to test the script.
   • Hint: use the $FILE_PATH parameter to only run the unit tests in the current file to reduce noise from the unit tests from other files.
5. Click "Generate Code" to get Sweep to generate additional unit tests.
6. Then click "Refresh" or the check mark to restart or approve the change.