https://github.com/mozillasecurity/site-scout

Browser testing via live content
https://github.com/mozillasecurity/site-scout

automation python testing

Last synced: 6 months ago
JSON representation

Browser testing via live content

• Host: GitHub
• URL: https://github.com/mozillasecurity/site-scout
• Owner: MozillaSecurity
• License: mpl-2.0
• Created: 2023-07-29T00:04:16.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-22T20:23:32.000Z (about 1 year ago)
• Last Synced: 2025-04-22T21:28:06.956Z (about 1 year ago)
• Topics: automation, python, testing
• Language: Python
• Homepage: https://bugzilla.mozilla.org/show_bug.cgi?id=1847294
• Size: 194 KB
• Stars: 12
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Site Scout

[![CI](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml/badge.svg)](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml)

[![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 issues that are triggered by visiting live

content. The primary goal is to create a tool that can be used in automation to collect

debugging data for issues such as crashes and assertion failures. A collection of URLs

to visit must be provided.

## Installation

Install the latest version from PyPI:

```bash

pip install site-scout --upgrade

```

## Usage

Visit one or more URLs (typically used to reproduce an issue):

```bash

site-scout  -u  [ ...]

```

Visit a collection of URLs from a file:

```bash

site-scout  -i .yml [.yml ...]

```

## Input Formats

**YML** - 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/

```

**JSONL** - URLs to visits with optional alias:

```jsonl

{"url1.tld": "alias-string-1"}

{"url2.tld/path": "alias-string-2"}

{"sub.url3.tld": null}

```