A Dynamic test tool for Splunk Apps and Add-ons
Project description
A Dynamic test tool for Splunk Apps and Add-ons
Documentation
The detailed documentation for pytest-splunk-addon can be found here : https://pytest-splunk-addon.readthedocs.io/
Features
Generate tests for Splunk Knowledge objects in your Splunk Technology Add-ons
Validate your add-ons using Splunk + Docker and this test tool
Requirements
Docker or an external single instance Splunk deployment
Installation
You can install “pytest-splunk-addon” via pip from PyPI:
$ pip install pytest-splunk-addon
Developing
Note: Must install docker desktop, vscode or pycharm pro optional
Note2: Appinspect requires libmagic verify this has been installed correctly each time a new workstation/vm is used https://dev.splunk.com/enterprise/docs/releaseapps/appinspect/splunkappinspectclitool/installappinspect
$ git clone --recurse-submodules -j8 git@github.com:splunk/pytest-splunk-addon.git
$ #setup python venv must be 3.7
$ /Library/Frameworks/Python.framework/Versions/3.7/bin/python3 -m venv .venv
$ source .venv/bin/activate
$ pip3 install -r requirements_dev.txt
$ pip3 install https://download.splunk.com/misc/appinspect/splunk-appinspect-latest.tar.gz
$ python setup.py develop
Usage
Installation for external Splunk
pip install pytest-splunk-addon
Installation with built in docker orchestration
pip install pytest-splunk-addon[docker]
Basic project structure
The tool assumes the Splunk Add-on is located in a folder “package” in the project root
Triggering the tool:
Create a test file in the tests folder
from pytest_splunk_addon.standard_lib.addon_basic import Basic
class Test_App(Basic):
def empty_method():
pass
Create a Dockerfile-splunk file
ARG SPLUNK_VERSION=latest
FROM splunk/splunk:$SPLUNK_VERSION
ARG SPLUNK_APP=TA_UNKNOWN
ARG SPLUNK_APP_PACKAGE=package
COPY deps/apps /opt/splunk/etc/apps/
COPY $SPLUNK_APP_PACKAGE /opt/splunk/etc/apps/$SPLUNK_APP
Create a docker-compose.yml update the value of SPLUNK_APP
version: "3.7"
services:
splunk:
build:
context: .
dockerfile: Dockerfile-splunk
args:
- SPLUNK_APP=xxxxxxx
ports:
- "8000"
- "8089"
environment:
- SPLUNK_PASSWORD=Changed@11
- SPLUNK_START_ARGS=--accept-license
Run pytest with the add-on and SA-eventgen installed and enabled in an external Splunk deployment
Run pytest with the add-on and SA-eventgen installed and enabled in docker
For full usage instructions, please visit the pytest-splunk-addon documentation pages over at readthedocs.
Contributing
Contributions are very welcome. Tests can be run with pytest, please ensure the coverage at least stays the same before you submit a pull request.
License
Distributed under the terms of the Apache Software License 2.0 license, “pytest-splunk-addon” is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest-splunk-addon-1.2.4b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69b3ac77091bcf6eb2e6a679017a698ce66ffc8b8670601bb3f7b1b6a26a0c87 |
|
MD5 | 359c2a321b755e2e6eddf10d317a1b21 |
|
BLAKE2b-256 | 934fea58b564ac5282d78f82cab07e0c6ffab96123a5e20090f5a62957e35375 |
Hashes for pytest_splunk_addon-1.2.4b1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da30d1dae42d7e23ea1608742df624462a62ad3b0e8ce6e48302e815ca5539aa |
|
MD5 | 121f22e857e36fa5686eefb7c23bebcd |
|
BLAKE2b-256 | 066d041c0b6e8702b68c99efd8ef3cc48796fb9c9d657d42601860ee329838bb |