Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanofuzz/nanofuzz
NaNofuzz is a fast and easy-to-use automatic test suite generator for TypeScript that runs inside VS Code
https://github.com/nanofuzz/nanofuzz
fuzzer fuzzing jest property-based-testing typescript
Last synced: 3 days ago
JSON representation
NaNofuzz is a fast and easy-to-use automatic test suite generator for TypeScript that runs inside VS Code
- Host: GitHub
- URL: https://github.com/nanofuzz/nanofuzz
- Owner: nanofuzz
- License: mit
- Created: 2022-07-07T17:36:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-07T22:21:05.000Z (13 days ago)
- Last Synced: 2025-02-07T22:33:47.933Z (13 days ago)
- Topics: fuzzer, fuzzing, jest, property-based-testing, typescript
- Language: TypeScript
- Homepage:
- Size: 1.54 MB
- Stars: 38
- Watchers: 2
- Forks: 4
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NaNofuzz
NaNofuzz is a fast and easy-to-use Automatic Test sUite Generator (ATUG) for TypeScript that combines human insight, heuristics, and property checking to help you quickly reach working code nirvana. NaNofuzz is intended to be used during testing and development and is available in the [the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=penrose.nanofuzz).
NaNofuzz proposes an initial set of tests with a single button click. You then improve these tests by manually annotating the correctness of specific examples and/or by adding property validator functions that evaluate correctness at scale. NaNofuzz coherently organizes and prioritizes all test results on a single screen so that you can see at a glance what your suite is testing---as well as what it may be missing.
# Tutorial and Playground
Our [NaNofuzz examples](https://github.com/nanofuzz/nanofuzz-examples/) repository, provides a 10-minute NaNofuzz tutorial and several example buggy programs that you can use to get familiar with NaNofuzz. Within the `nanofuzz-examples` repo on GitHub, click `Code`->`Codespaces`->`Create` to immediately get started!
# Getting started
To use NaNofuzz in your own projects:
- **Step 1**: Add the NaNofuzz dev dependency
- **npm**: `npm i @nanofuzz/runtime -D`
- **yarn**: `yarn add @nanofuzz/runtime -D`
- **Step 2**: Add the NaNofuzz extension to your repo's `./.vscode/settings.json` recommendations:
```
{
"recommendations": [
"penrose.nanofuzz"
]
}
```
> **Note:** To run NaNofuzz tests in CI, click the pin button. NaNofuzz exports pinned tests to Jest format for execution in CI.
# Scope and Limitations
NaNofuzz is an **experimental** testing platform developed by the Accelerated Testing Research Program at Carnegie Mellon University's School of Computer Science. Therefore, NaNofuzz is **not** intended for production use; however, contributions are welcome to address the limitations below.
NaNofuzz supports exported standard and arrow functions with any mixture of the following parameter types:
- Numbers (integers and floats, signed and unsigned)
- Strings
- Booleans
- Literal object types
- n-dimension arrays of any of the above
- Optional and mandatory parameters
NaNofuzz automatically generates a test suite in these formats for use in CI:
- Jest
The following are not yet supported:
- Deconstructed types, Tuples, Enums, Generics, Function, and built-in (e.g., Record) types
- Non-finite numeric inputs (`NaN`, `Infinity`), `bigint`, `null`
- Class and object methods
- Compiling to module formats other than CommonJS (see [VS Code issue 130367](https://github.com/microsoft/vscode/issues/130367))
- Support for stateful, flaky, or non-deterministic tests
- Sandboxing external side-effects, mocks, or stubs
- Custom generators and filters
- Test case minimization
If the NaNofuzz button does not appear above your function, that usually indicates that the function is not exported or one of its inputs is comprised of types that are not yet supported (see above).
# Contributing
We welcome outside contributions to address the limitations above and to correct open issues.
Please see our [Contributor's Guide](https://github.com/nanofuzz/nanofuzz/blob/main/CONTRIBUTING.md) for more details about how you can get involved.
# NaNofuzz Research Paper
To reference NaNofuzz in your own research, please cite our ESEC/FSE'23 paper:
> Matthew C. Davis, Sangheon Choi, Sam Estep, Brad A. Myers, and Joshua Sunshine. **[NaNofuzz: A Usable Tool for Automatic Test Generation](https://dl.acm.org/doi/10.1145/3611643.3616327)**. In Proceedings of the 31st ACM Joint European Software Engineering Conference and Symposium on the Foundations of Software Engineering, 2023.
The paper above covers the 0.1.x version of NaNofuzz. A lot has changed since then, and we plan to publish new papers soon!
# The NaNofuzz Mascot
Meet NaNcy, the Silky Anteater! Silky anteaters are wonderfully-adapted, small, fuzzy creatures known to find and consume large quantities of bugs on a daily basis. Therefore, NaNcy is NaNofuzz's beloved mascot on our journey to find and eliminate more bugs.
