Secator docs
  • GETTING STARTED
    • Introduction
    • Installation
    • CLI Usage
    • Library usage
    • Configuration
    • Examples
      • 5 minutes secator session
  • RUNNER OPTIONS
    • Global options
    • Meta options
    • Input formats
    • Output options
  • IN-DEPTH
    • Philosophy & design
    • Distributed runs with Celery
    • Concepts
      • Output types
      • Proxies
      • Exporters
      • Runners
      • Drivers
      • Profiles
    • Deployment
  • For developers
    • Development setup
    • Writing tasks
      • Integrating an external command
        • Parsing JSON lines
        • Parsing raw standard output
        • Parsing output files
        • Example: integrating ls
        • Example: cat hunters
      • Integrate custom Python code [WIP]
      • Advanced options
    • Writing workflows
    • Writing scans [WIP]
Powered by GitBook
On this page
  • Install a development build
  • Running tests
  • Unit tests
  • Integration tests
  • Lint tests

Was this helpful?

  1. For developers

Development setup

... or how to setup a development environment for secator.


Install a development build

To install secator in development mode, first make sure pip and virtualenv are installed, and run the following steps:

git clone https://github.com/freelabz/secator  # clone the repository
cd secator                                     # go to the repository folder
virtualenv .venv                               # create a virtualenv
source .venv/bin/activate                      # load the virtualenv
pip install -e .[dev]                          # install secator and dev dependencies

Usesecator health to verify your installation. You can install addons / tools using the secator install command (choose what to install based on what you want to dev on).


Running tests

Unit tests

secator test unit

If you want to run unit tests to test a specific task only:

secator test unit --test test_task --task <TASK_NAME>

Integration tests

secator test integration

If you want to run integration tests to test a specific task only:

secator test integration --test test_tasks --tasks <TASK_NAME>

Lint tests

secator test lint

PreviousDeploymentNextWriting tasks

Last updated 1 year ago

Was this helpful?