Metadata-Version: 2.2
Name: site-scout
Version: 2.2.0
Summary: A tool to identify and report browser issues triggered by visiting a list of URLs.
Home-page: https://github.com/MozillaSecurity/site-scout
Author: Tyson Smith
Author-email: twsmith@mozilla.com
Maintainer: Mozilla Fuzzing Team
Maintainer-email: fuzzing@mozilla.com
License: MPL 2.0
Keywords: automation testing
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: ffpuppet>=0.13.1
Requires-Dist: FuzzManager
Requires-Dist: page-explorer>=0.3.0
Requires-Dist: prefpicker>=1.1.0
Requires-Dist: PyYAML
Requires-Dist: tldextract>=5.1.2
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: tox; extra == "dev"

Site Scout
==========
[![Task Status](https://community-tc.services.mozilla.com/api/github/v1/repository/MozillaSecurity/site-scout/main/badge.svg)](https://community-tc.services.mozilla.com/api/github/v1/repository/MozillaSecurity/site-scout/main/latest)
[![codecov](https://codecov.io/gh/MozillaSecurity/site-scout/branch/main/graph/badge.svg)](https://codecov.io/gh/MozillaSecurity/site-scout)
[![Matrix](https://img.shields.io/badge/chat-%23fuzzing-green?logo=matrix)](https://matrix.to/#/#fuzzing:mozilla.org)
[![PyPI](https://img.shields.io/pypi/v/site-scout)](https://pypi.org/project/site-scout)

Site Scout is a tool that can identify and report issues that are triggered in the wild.
A URL or a collection of URLs must be provided. All results are collected and reported.

The primary goal is to find issues such as crashes, assertion failures and other
issues detected by AddressSanitizer, UndefinedBehaviourSanitizer and ThreadSanitizer.

Installation
------------

Install the latest version from PyPI:

```
python3 -m pip install site-scout --upgrade
```

Usage
-----

Visit a collection of URLs:
```
site-scout <firefox-bin> -i <urls>.yml [<urls>.yml ...]
```

-or-

Visit one or more URLs (typically used to reproduce an issue):
```
site-scout <firefox-bin> -u <url> [<url> ...]
```

Input YAML Layout
-----------------

URLs to visit are stored in the following format:
```yml
# subdomain.domain.tld/path
domain.tld:
  subdomain:
  - /path
# '*' is used to omit the subdomain
github.com:
  '*':
  - /MozillaSecurity/site-scout
mozilla.org:
  www:
  - /
  - /firefox/browsers/mobile/
  - /firefox/new/
```
