conftest.py

"""
Copyright 2018 Splunk, Inc..

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

import pytest
import time
from common import start_logging_plugin, \
    kill_logging_plugin


def pytest_addoption(parser):
    parser.addoption("--splunkd-url",
                     help="splunkd url used to send test data to. \
                          Eg: https://localhost:8089",
                     default="https://localhost:8089")
    parser.addoption("--splunk-user",
                     help="splunk username",
                     default="admin")
    parser.addoption("--splunk-password",
                     help="splunk user password",
                     default="changeme")
    parser.addoption("--splunk-hec-url",
                     help="splunk hec endpoint used by logging plugin.",
                     default="https://localhost:8088")
    parser.addoption("--splunk-hec-token",
                     help="splunk hec token for authentication.",
                     required=True),
    parser.addoption("--docker-plugin-path",
                     help="docker plugin binary path",
                     required=True)
    parser.addoption("--fifo-path",
                     help="full file path to the fifo",
                     required=True)


@pytest.fixture(scope="function")
def setup(request):
    config = {}
    config["splunkd_url"] = request.config.getoption("--splunkd-url")
    config["splunk_hec_url"] = request.config.getoption("--splunk-hec-url")
    config["splunk_hec_token"] = request.config.getoption("--splunk-hec-token")
    config["splunk_user"] = request.config.getoption("--splunk-user")
    config["splunk_password"] = request.config.getoption("--splunk-password")
    config["plugin_path"] = request.config.getoption("--docker-plugin-path")
    config["fifo_path"] = request.config.getoption("--fifo-path")

    kill_logging_plugin(config["plugin_path"])
    start_logging_plugin(config["plugin_path"])
    time.sleep(2)
    request.addfinalizer(lambda: teardown_method(config["plugin_path"]))

    return config


def teardown_method(plugin_path):
    kill_logging_plugin(plugin_path)