syntribos/doc/source/code-docs.rst

2.8 KiB

Syntribos Code Documentation

Configuration

This section describes the configuration specified in your configuration file (second argument to the runner).

syntribos.config

Signals

This section describes Signals (syntribos.signal.SynSignal) and SignalHolders (syntribos.signal.SignalHolder)

syntribos.signal.SynSignal

syntribos.signal.SignalHolder

Checks

syntribos.checks.http.check_http_fail

syntribos.checks.http.check_http_status_code

Tests

This section describes the components involved with writing your own tests with syntribos.

All syntribos tests inherit from syntribos.tests.base.BaseTestCase, either directly, or through a subclass like syntribos.tests.fuzz.base_fuzz.BaseFuzzTestCase.

All tests are aggregated in the syntribos.tests.base.test_table variable

syntribos.tests.base

syntribos.tests.fuzz.config

syntribos.tests.fuzz.datagen

Issues

This section describes the representation of issues that are uncovered by syntribos.

syntribos.issue

Results

This section describes the representation of results (collections of issues) from a given syntribos run.

syntribos.result

HTTP Requests

This section describes the components related to generating, fuzzing, and making HTTP requests.

syntribos.clients.http.client

syntribos.clients.http.models

syntribos.clients.http.parser

Extension

This section describes syntribos' extensions, which are called by the CALL_EXTERNAL field in the request template.

syntribos.extensions.identity.models.base