Overview

pytest-splunk-addon is an open-source dynamic test plugin for Splunk Apps and Add-ons which allows the user to test knowledge objects, CIM compatibility and index time properties.

Prerequisites

• Splunk App or Add-on package
• Splunk instance with App or Add-on installed (Not required if using Docker)
• Docker (Not required if using external Splunk instance)

Support

• Python: 3.7
• Platforms: Linux, Windows and MacOS

Installation

pytest-splunk-addon can be installed via pip from PyPI:

pip3 install pytest-splunk-addon

Features

The pytest-splunk-addon works by dynamically generating different types of tests for Splunk apps and add-ons by parsing their configuration files. Specifically, it looks at the .conf files in the provided Splunk app/add-on to create:

1. Knowledge Object Tests

2. CIM Compatibility Tests

3. Index-Time Field Tests

4. Requirement Tests

Refer to the How to use section for detailed instructions on running the tests.

Release notes

Find details about all the releases here.