HypoFuzz

https://github.com/zac-hd/hypofuzz
Admin
Adaptive fuzzing backend for Hypothesis property-based tests with coverage-guided exploration and...
Tokens:9,322
Snippets:156
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install HypoFuzz

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/pricing/index.html

Install HypoFuzz using pip. This command is for non-commercial use.

```bash
pip install hypofuzz
```

--------------------------------

### Configure Redis Database for HypoFuzz

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/database.md

Register and load a Redis-backed Hypothesis database profile for HypoFuzz. Ensure the 'hypothesis[redis]' package is installed.

```python
from hypothesis import settings

# pip install hypothesis[redis]
from hypothesis.extra.redis import RedisExampleDatabase

db = RedisExampleDatabase(redis=...)
settings.register_profile("custom_db", database=db)
settings.load_profile("custom_db")
```

--------------------------------

### Run HypoFuzz with Dashboard Only

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/quickstart.md

Start only the local dashboard webserver without executing tests. Use the `--dashboard-only` flag.

```shell
hypothesis fuzz --dashboard-only
```

--------------------------------

### Using hypothesis.event() for Custom Coverage

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/behavior.md

This snippet demonstrates how to use hypothesis.event() to mark specific behaviors, such as URLs with multiple domains, as interesting cases for HypoFuzz. This helps guide the fuzzer towards exploring these areas more thoroughly. Ensure hypothesis is installed and imported.

```python
from hypothesis import event, given, strategies as st


@given(st.urls())
def test_parse_url(url: str):
    if len(url.split(".")) > 2:
        event("multiple_domains")

    parse_url(url)
```

--------------------------------

### Run HypoFuzz with No Dashboard

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/quickstart.md

Execute Hypothesis tests without starting the dashboard webserver. Use the `--no-dashboard` flag.

```shell
hypothesis fuzz --no-dashboard
```

--------------------------------

### Run HypoFuzz

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/quickstart.md

Execute Hypothesis tests with HypoFuzz. This command starts a local dashboard webserver and runs tests across all available cores.

```shell
hypothesis fuzz
```

--------------------------------

### Implement and Configure a Custom Hypothesis Database

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/database.md

Create a custom Hypothesis database by inheriting from ExampleDatabase and implementing fetch, save, and delete methods. Then, register and load this custom database profile.

```python
from hypothesis import settings
from hypothesis.database import ExampleDatabase


class MyDatabase(ExampleDatabase):
    def fetch(self, key: bytes):
        pass

    def save(self, key: bytes, value: bytes):
        pass

    def delete(self, key: bytes, value: bytes):
        pass


db = MyDatabase()
settings.register_profile("custom_db", database=db)
settings.load_profile("custom_db")
```

--------------------------------

### HypoFuzz CLI Help

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/cli.md

Displays the help message for the `hypothesis fuzz` command, outlining available options and usage.

```text
$ hypothesis fuzz --help
Usage: hypothesis fuzz [OPTIONS] [-- PYTEST_ARGS]

  [hypofuzz] runs tests with an adaptive coverage-guided fuzzer.

  Unrecognised arguments are passed through to `pytest` to select the tests to
  run, with the additional constraint that only Hypothesis tests can be
  fuzzed.

  This process will run forever unless stopped with e.g. ctrl-C.

Options:
  -n, --numprocesses NUM        default: all available cores  [x>=1]
  --dashboard / --no-dashboard  serve / don't serve a live dashboard page
  -d, --dashboard-only          serve a live dashboard page without launching
                                associated fuzzing processes
  --host HOST                   Optional host for the dashboard
  --port PORT                   Optional port for the dashboard (if any). 0 to
                                request an arbitrary open port  [0<=x<=65535]
  -h, --help                    Show this message and exit.

```

--------------------------------

### Configure RedisExampleDatabase

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/operating.md

Configures HypoFuzz to use Redis as the Hypothesis database. This is recommended for distributed systems and complex network topologies.

```python
RedisExampleDatabase()
```

--------------------------------

### Configure DirectoryBasedExampleDatabase

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/operating.md

Configures HypoFuzz to use a local directory as the Hypothesis database. This is suitable when you have a shared filesystem with the server.

```python
DirectoryBasedExampleDatabase(".hypothesis")
```

--------------------------------

### HypoFuzz Direct Dependencies

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/compatibility.md

Lists the direct dependencies required for HypoFuzz. Ensure these versions are met for proper functionality.

```python
dependencies = [
    "black>=23.3.0",
    "hypothesis[cli,watchdog]>=6.140.2",
    "libcst>=1.0.0", # for hypothesis.extra._patching
    "psutil>=3.0.0",
    "pytest>=7.0.0",
    "starlette",
    "trio",
    "hypercorn",
]
```

--------------------------------

### Google Analytics Initialization

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/404.html

Initializes the Google Data Layer and configures Google Analytics tracking. This code should be included in the head of the HTML document.

```javascript
window.dataLayer = window.dataLayer || []; function gtag() { dataLayer.push(arguments); } gtag('js', new Date()); gtag('config', 'UA-176879127-1');
```

--------------------------------

### Run HypoFuzz with Specific Number of Processes

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/quickstart.md

Control the number of cores used for executing tests with the `-n` or `--num-processes` flag.

```shell
hypothesis fuzz -n 4
```

--------------------------------

### Google Analytics Configuration

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/pricing/index.html

This snippet configures Google Analytics tracking for the page. It initializes the dataLayer and sets up the gtag configuration with a specific tracking ID.

```javascript
window.dataLayer = window.dataLayer || [];
function gtag() {
  dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-176879127-1');
```

--------------------------------

### Advanced Navbar Toggle with Overlay and Animation

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/404.html

Enhances navbar toggle functionality with animations, an overlay, and event listeners for menu links to close the menu. It also includes responsive behavior for different screen sizes.

```javascript
(function() { var toggle = document.querySelector('.navbar__toggle'); var menu = document.getElementById('navbarMenu'); var overlay = document.getElementById('navbarOverlay'); if (toggle && menu) { toggle.addEventListener('click', function() { if (!menu.classList.contains('navbar__nav--animate')) { menu.classList.add('navbar__nav--animate'); } var isOpen = menu.classList.toggle('navbar__nav--open'); toggle.classList.toggle('navbar__toggle--open', isOpen); toggle.setAttribute('aria-expanded', isOpen ? 'true' : 'false'); if (overlay) overlay.classList.toggle('navbar__overlay--visible', isOpen); }); } if (overlay && menu) { overlay.addEventListener('click', function() { menu.classList.remove('navbar__nav--open'); overlay.classList.remove('navbar__overlay--visible'); if (toggle) { toggle.classList.remove('navbar__toggle--open'); toggle.setAttribute('aria-expanded', 'false'); } }); } Array.prototype.forEach.call(menu ? menu.querySelectorAll('a') : [], function(link) { link.addEventListener('click', function() { menu.classList.remove('navbar__nav--open'); if (overlay) overlay.classList.remove('navbar__overlay--visible'); if (toggle) { toggle.classList.remove('navbar__toggle--open'); toggle.setAttribute('aria-expanded', 'false'); } }); }); var mql = window.matchMedia('(max-width: 720px)'); function resetMobileMenu() { if (menu) { menu.classList.remove('navbar__nav--open'); menu.classList.remove('navbar__nav--animate'); } if (overlay) overlay.classList.remove('navbar__overlay--visible'); if (toggle) { toggle.classList.remove('navbar__toggle--open'); toggle.setAttribute('aria-expanded', 'false'); } } function onMqlChange() { resetMobileMenu(); } if (mql && mql.addEventListener) { mql.addEventListener('change', onMqlChange); } else if (mql && mql.addListener) { mql.addListener(onMqlChange); } })();
```

--------------------------------

### Basic Navbar Toggle Functionality

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/404.html

Adds a click event listener to a navbar toggle button to open and close a navigation menu. It updates ARIA attributes for accessibility.

```javascript
(function() { var toggle = document.querySelector('.navbar__toggle'); var menu = document.getElementById('navbarMenu'); if (toggle && menu) { toggle.addEventListener('click', function() { var isOpen = menu.classList.toggle('navbar__nav--open'); toggle.setAttribute('aria-expanded', isOpen ? 'true' : 'false'); }); } })();
```

--------------------------------

### Mobile Navigation Toggle

Source: https://github.com/zac-hd/hypofuzz/blob/master/docs/pricing/index.html

JavaScript for toggling a mobile navigation menu. It handles click events on the toggle button, menu items, and an overlay to show/hide the menu and manage ARIA attributes.

```javascript
(function() {
  var toggle = document.querySelector('.navbar__toggle');
  var menu = document.getElementById('navbarMenu');
  var overlay = document.getElementById('navbarOverlay');
  if (toggle && menu) {
    toggle.addEventListener('click', function() {
      if (!menu.classList.contains('navbar__nav--animate')) {
        menu.classList.add('navbar__nav--animate');
      }
      var isOpen = menu.classList.toggle('navbar__nav--open');
      toggle.classList.toggle('navbar__toggle--open', isOpen);
      toggle.setAttribute('aria-expanded', isOpen ? 'true' : 'false');
      if (overlay) overlay.classList.toggle('navbar__overlay--visible', isOpen);
    });
  }
  if (overlay && menu) {
    overlay.addEventListener('click', function() {
      menu.classList.remove('navbar__nav--open');
      overlay.classList.remove('navbar__overlay--visible');
      if (toggle) {
        toggle.classList.remove('navbar__toggle--open');
        toggle.setAttribute('aria-expanded', 'false');
      }
    });
  }
  Array.prototype.forEach.call(menu ? menu.querySelectorAll('a') : [], function(link) {
    link.addEventListener('click', function() {
      menu.classList.remove('navbar__nav--open');
      if (overlay) overlay.classList.remove('navbar__overlay--visible');
      if (toggle) {
        toggle.classList.remove('navbar__toggle--open');
        toggle.setAttribute('aria-expanded', 'false');
      }
    });
  });
  // Reset state and disable animation on breakpoint changes
  var mql = window.matchMedia('(max-width: 720px)');
  function resetMobileMenu() {
    if (menu) {
      menu.classList.remove('navbar__nav--open');
      menu.classList.remove('navbar__nav--animate');
    }
    if (overlay) overlay.classList.remove('navbar__overlay--visible');
    if (toggle) {
      toggle.classList.remove('navbar__toggle--open');
      toggle.setAttribute('aria-expanded', 'false');
    }
  }
  function onMqlChange() {
    resetMobileMenu();
  }
  if (mql && mql.addEventListener) {
    mql.addEventListener('change', onMqlChange);
  } else if (mql && mql.addListener) {
    mql.addListener(onMqlChange);
  }
})();
```

--------------------------------

### Conditionally Skip Test Under HypoFuzz

Source: https://github.com/zac-hd/hypofuzz/blob/master/src/hypofuzz/docs/manual/collection.md

Use `pytest.mark.skipif` with `in_hypofuzz_run` to prevent a test from running during HypoFuzz collection while still being part of the regular test suite.

```python
import pytest
from hypothesis import given, strategies as st

from hypofuzz.detection import in_hypofuzz_run


@pytest.mark.skipif(in_hypofuzz_run())
@given(st.integers())
def test_will_not_be_fuzzed(n):
    pass

```
Tokens:
Raw