honeycomb package

Subpackages

• honeycomb.commands.service package
  • Submodules
  • honeycomb.commands.service.install module
  • honeycomb.commands.service.list module
  • honeycomb.commands.service.logs module
  • honeycomb.commands.service.run module
  • honeycomb.commands.service.show module
  • honeycomb.commands.service.status module
  • honeycomb.commands.service.stop module
  • honeycomb.commands.service.test module
  • honeycomb.commands.service.uninstall module
• honeycomb.commands.integration package
  • Submodules
  • honeycomb.commands.integration.configure module
  • honeycomb.commands.integration.install module
  • honeycomb.commands.integration.list module
  • honeycomb.commands.integration.show module
  • honeycomb.commands.integration.test module
  • honeycomb.commands.integration.uninstall module
• honeycomb.decoymanager package
  • Submodules
  • honeycomb.decoymanager.models module
  • Module contents
• honeycomb.integrationmanager package
  • Submodules
  • honeycomb.integrationmanager.defs module
  • honeycomb.integrationmanager.error_messages module
  • honeycomb.integrationmanager.exceptions module
  • honeycomb.integrationmanager.integration_utils module
  • honeycomb.integrationmanager.models module
  • honeycomb.integrationmanager.registration module
  • honeycomb.integrationmanager.tasks module
  • Module contents
• honeycomb.servicemanager package
  • Submodules
  • honeycomb.servicemanager.base_service module
  • honeycomb.servicemanager.defs module
  • honeycomb.servicemanager.error_messages module
  • honeycomb.servicemanager.exceptions module
  • honeycomb.servicemanager.models module
  • honeycomb.servicemanager.registration module
  • Module contents
• honeycomb.utils package
  • Submodules
  • honeycomb.utils.config_utils module
  • honeycomb.utils.daemon module
  • honeycomb.utils.plugin_utils module
  • honeycomb.utils.tailer module
  • honeycomb.utils.wait module
  • Module contents

Submodules

honeycomb.cli module

Honeycomb Command Line Interface.

class honeycomb.cli.MyLogger(name, level=0)

Bases: logging.Logger

Custom Logger.

Initialize the logger with a name and an optional level.

makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

Override default logger to allow overriding of internal attributes.

honeycomb.cli.setup_logging(home, verbose)

Configure logging for honeycomb.

honeycomb.defs module

Honeycomb defs and constants.

class honeycomb.defs.BaseCollection

Bases: object

Abstract type collection mixin, should hold BaseNameLabel attributes.

class honeycomb.defs.BaseNameLabel(name, label)

Bases: object

Generic name/label class.

honeycomb.defs.CONFIG_FILE_NAME = 'config.json'

Parameters constants.

class honeycomb.defs.ConfigField(validator_func, get_error_message)

Bases: object

Config Validator.

error_message is also a function to calculate the error when we ran the validator_func

honeycomb.defs.GITHUB_RAW_URL = 'https://raw.githubusercontent.com/Cymmetria/honeycomb_plugins/master/{plugin_type}/{plugin}/{filename}'

Config constants.

class honeycomb.defs.IBaseType

Bases: object

Abstract type interface, provides BaseNameLabel collection methods.

classmethod all_labels()

Return list of all property labels.

classmethod all_names()

Return list of all property names.

honeycomb.error_messages module

Honeycomb generic error messages.

honeycomb.exceptions module

Honeycomb Exceptions.

exception honeycomb.exceptions.BaseHoneycombException(*args, **kwargs)

Bases: click.exceptions.ClickException

Base Exception.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = None

exception honeycomb.exceptions.ConfigFieldMissing(*args, **kwargs)

Bases: honeycomb.exceptions.ConfigValidationError

Field is missing from config file.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'field {} is missing from config file'

exception honeycomb.exceptions.ConfigFieldTypeMismatch(*args, **kwargs)

Bases: honeycomb.exceptions.ConfigValidationError

Config field does not match specified type.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Parameters: Bad value for {}={} (must be {})'

exception honeycomb.exceptions.ConfigFieldValidationError(*args, **kwargs)

Bases: honeycomb.exceptions.ConfigValidationError

Error validating config field.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Failed to import config. error in field {} with value {}: {}'

exception honeycomb.exceptions.ConfigFileNotFound(*args, **kwargs)

Bases: honeycomb.exceptions.PluginError

Config file not found.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Missing file {}'

exception honeycomb.exceptions.ConfigValidationError(*args, **kwargs)

Bases: honeycomb.exceptions.BaseHoneycombException

Base config validation error.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

exception honeycomb.exceptions.ParametersFieldError(*args, **kwargs)

Bases: honeycomb.exceptions.ConfigValidationError

Error validating parameter.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = "Parameters: '{}' is not a valid {}"

exception honeycomb.exceptions.PathNotFound(*args, **kwargs)

Bases: honeycomb.exceptions.BaseHoneycombException

Specified path was not found.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Cannot find path {}'

exception honeycomb.exceptions.PluginAlreadyInstalled(*args, **kwargs)

Bases: honeycomb.exceptions.PluginError

Plugin already installed.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = '{} is already installed'

exception honeycomb.exceptions.PluginError(*args, **kwargs)

Bases: honeycomb.exceptions.BaseHoneycombException

Base Plugin Exception.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

exception honeycomb.exceptions.PluginNotFoundInOnlineRepo(*args, **kwargs)

Bases: honeycomb.exceptions.PluginError

Plugin not found in online repo.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Cannot find {} in online repository'

exception honeycomb.exceptions.PluginRepoConnectionError(*args, **kwargs)

Bases: honeycomb.exceptions.PluginError

Connection error when trying to connect to plugin repo.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = 'Unable to access online repository (check debug logs for detailed info)'

exception honeycomb.exceptions.RequiredFieldMissing(*args, **kwargs)

Bases: honeycomb.exceptions.PluginError

Required parameter is missing.

Raise ClickException and log msg with relevant debugging info from the frame that raised the exception.

msg_format = "Parameters: '{}' is missing (use --show_args to see all parameters)"