Get Started
Requirements
Requirements for Tusk to generate tests
Checklist
Please go through the following checklist of requirements to see if your team or repo is ready to onboard Tusk.PR/MR Check
- GitHub or GitLab for version control
- Testing framework(s) already set up in your repo
- At least 5 existing unit tests in your repo
- Unit tests running in CI (e.g., via GitHub Actions, GitLab CI/CD, Jenkins, or similar)
- Habit of raising PRs/MRs for code changes
- Languages (and associated testing frameworks) supported
- JavaScript
- TypeScript
- Python
- Ruby
- Golang
- Java
- C/C++
- C#
- Rust
- PHP
CoverBot
- All “PR Check” requirements except languages supported (superseded by below requirement)
- Testing frameworks supported
- pytest
- Jest
- Mocha
- Vitest
- Bun
- Minitest
- RSpec
Helpful but optional
These following items are recommended but not required. They allow you to optimize the quality of the unit/integration tests generated by Tusk.- Linear or Jira for project management (and respective integrations with GitHub or GitLab)
- Mature testing utils and infra (e.g., examples of mocks, utils for set-up/tear-down as necessary)
- Code coverage tracking
- Documented testing guidelines
FAQs
What testing frameworks do you support?
What testing frameworks do you support?
We support all testing frameworks associated with the languages that we support (see checklist above). The most common test frameworks that Tusk is used for are:
- Vitest
- Jest
- pytest
- RSpec
- JUnit
- PHPUnit
- React Testing Library
- Golang testing library
I haven't set up a testing framework in my repo. Can Tusk do that for me?
I haven't set up a testing framework in my repo. Can Tusk do that for me?
No. Tusk doesn’t yet automate the setup of testing frameworks in your repo. You should do the initial setup before implementing Tusk.
Why do I need to have unit tests running in CI already?
Why do I need to have unit tests running in CI already?
Tusk uses your existing CI/CD workflow as a reference for running the unit tests that it generates. The agent also surfaces any dependencies required to run the tests, which helps with one-time setup during onboarding.
Do you have resources for setting up a CI workflow to run unit tests?
Do you have resources for setting up a CI workflow to run unit tests?
Yes. Here are helpful resources for setting up a GitHub Actions workflow and GitLab CI/CD pipeline.