pl-errormessage

Table of Contents

• Abstract
• Synopsis
• Run
  • Using PyPI
  • Using docker run
• Examples
  • Raise a Built-In Error
  • Raise a Built-In Error with a message
  • Raise a Built-In Error with a Delay

Abstract

errorgenerator is a simple app that raises an error message of errorType. If called with an optional --customErrorMessage the plugin will append the message to the error.

Synopsis

python errorgenerator.py                                        \
    [-v <level>] [--verbosity <level>]                          \
    [--errorType <typeError>]                                   \
    [--customErrorMessage <message>]                            \
    [--delayTime <secondsDelay>]                                \
    [--version]                                                 \
    [--man]                                                     \
    [--meta]                                                    \
    /tmp

Run

This plugin can be run in two modes: natively as a python package or as a containerized docker image.

Using PyPI

To run from PyPI, simply do a

pip install errorgenerator

and run with

errorgenerator.py --errorType Exception /tmp

to attach a message to the error, simply do

errorgenerator.py --errorType Exception             \
                  --customErrorMessage Errored      \
                  /tmp

Using docker run

To run using docker, prefix all calls with

docker run --rm                                     \
    fnndsc/pl-errorgenerator errorgenerator.py

Examples

Raise a Built-In Error

docker run --rm                                     \
    fnndsc/pl-errorgenerator errorgenerator.py      \
    --errorType UnboundLocalError                   \
    /tmp

Raise a Built-In Error with a message

docker run --rm                                     \
    fnndsc/pl-errorgenerator errorgenerator.py      \
    --errorType UnboundLocalError                   \
    --customErrorMessage ErrorOccured               \
    /tmp

Raise a Built-In Error with a Delay

docker run --rm                                     \
    fnndsc/pl-errorgenerator errorgenerator.py      \
    --errorType UnboundLocalError                   \
    --delayTime 5                                   \
    /tmp