Makefile

VERSION := `grep '^__version__[^"]*"\([0-9.]*\)"' splunk_eventgen/__init__.py | sed -e 's/.*"\([0-9.]*\)".*/\1/'`
EVENTGEN_EGG := "dist/splunk_eventgen-${VERSION}.tar.gz"
EVENTGEN_TAG := "sa-eventgen"
CURTIME ?= $(shell date +%s)
EVENTGEN_TEST_IMAGE = "eventgen-test-container"
TESTS ?= large
TEST_ARGS += ${TESTS}
ENGINE_CONF_SOURCE ?= "https://raw.githubusercontent.com/splunk/eventgen/develop/splunk_eventgen/default/eventgen.conf"
SMALL ?= 'tests/small'
MEDIUM ?= 'tests/medium'
LARGE ?= 'tests/large'
XLARGE ?= 'tests/xlarge'
NEWLY_ADDED_PY_FILES = $(shell git ls-files -o --exclude-standard | grep -E '\.py$$')
CHANGED_ADDED_PY_FILES = $(shell git ls-files -mo --exclude-standard | grep -E '\.py$$')
ALL_PY_FILES = $(shell git ls-files tests splunk_eventgen | grep -E '\.py$$')

.PHONY: tests, lint, format, docs

all: egg

egg: clean
	poetry build

image: setup_eventgen egg
	rm splunk_eventgen/default/eventgen_engine.conf || true
	docker build -f dockerfiles/Dockerfile . -t eventgen

test: image test_helper run_tests test_collection_cleanup

test_helper:
	docker run -d -t --net=host -v /var/run/docker.sock:/var/run/docker.sock --name ${EVENTGEN_TEST_IMAGE} eventgen:latest cat

	@echo 'Install libxml2'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "apk add --no-cache --update libxml2-dev libxslt-dev"

	@echo 'Creating dirs needed for tests'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "mkdir -p $(shell pwd) "

	@echo 'Copying orca tree into the orca container'
	docker cp . ${EVENTGEN_TEST_IMAGE}:$(shell pwd)

	@echo 'Verifying contents of pip.conf'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "cd $(shell pwd); pip3 install dist/splunk_eventgen*.tar.gz"

	@echo 'Installing test dependencies'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "pip3 install poetry;poetry config virtualenvs.create false;poetry install --no-root"

	@echo 'Make simulated app dir and sample for modular input test'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "cd $(shell pwd); cd ../..; mkdir -p modinput_test_app/samples/"
	docker cp tests/large/sample/film.json ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/../../modinput_test_app/samples

	@echo 'Installing docker-compose'
	bash tests/large/provision/install_docker_compose.sh

	@echo 'Build a docker image'
	docker build -t provision_splunk:latest -f tests/large/provision/Dockerfile tests/large/provision

	@echo 'Start container with splunk'
	docker-compose -f tests/large/provision/docker-compose.yml up &

	sleep 120
	@echo 'Provision splunk container'
	docker exec --user splunk provision_splunk_1 sh -c 'cd /opt/splunk;./provision.sh;./add_httpevent_collector.sh;/opt/splunk/bin/splunk enable listen 9997 -auth admin:changeme;/opt/splunk/bin/splunk add index test_0;/opt/splunk/bin/splunk add index test_1;/opt/splunk/bin/splunk restart'

run_tests:
	@echo 'Running the super awesome tests'
	docker exec -i ${EVENTGEN_TEST_IMAGE} /bin/sh -c "cd $(shell pwd); python3 run_tests.py ${SMALL} ${MEDIUM} ${LARGE} ${XLARGE}"


test_collection_cleanup:
	@echo 'Collecting results'
	#TODO: Should be paramaterized or generalized so that we don't need to add this here
	docker cp ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/tests/test-reports/tests_small_results.xml tests/test-reports/tests_small_results.xml || echo "no tests_small_results.xml"
	docker cp ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/tests/test-reports/tests_medium_results.xml tests/test-reports/tests_medium_results.xml || echo "no tests_medium_results.xml"
	docker cp ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/tests/test-reports/tests_large_results.xml tests/test-reports/tests_large_results.xml || echo "no tests_large_results.xml"
	docker cp ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/tests/test-reports/tests_xlarge_results.xml tests/test-reports/tests_xlarge_results.xml || echo "no tests_xlarge_results.xml"

	docker cp ${EVENTGEN_TEST_IMAGE}:$(shell pwd)/htmlcov htmlcov || echo "no htmlcov folder"

	@echo 'Stopping test container'
	docker stop ${EVENTGEN_TEST_IMAGE} || true

	@echo 'Stopping splunk container'
	docker-compose -f tests/large/provision/docker-compose.yml down || true

clean:
	rm *.spl || true
	rm -rf dist *.egg-info *.log *.xml || true
	rm splunk_eventgen/logs/*.log || true
	rm tests/test-reports/*.xml || true
	rm -rf .idea || true
	rm -rf _book || true
	rm -rf docs/_book || true
	rm -rf node_modules || true
	rm -rf docs/node_modules || true
	rm splunk_eventgen/default/eventgen_wsgi.conf || true
	find . -name "*.pyc" -type f -delete || true
	find . -name "*.log" -type f -delete || true
	find . -name "*.pyc" -type f -delete || true
	docker stop ${EVENTGEN_TEST_IMAGE} || true
	docker rm ${EVENTGEN_TEST_IMAGE} || true
	docker network rm eg_network || true
	docker network rm eg_network_test || true

setup_eventgen:
	curl -k -O splunk_eventgen/default/eventgen_engine.conf ${ENGINE_CONF_SOURCE}

eg_network:
	docker network create --attachable --driver bridge eg_network || true

run_server: eg_network
	docker kill eg_server || true
	docker rm eg_server || true
	docker run --network eg_network --name eg_server -e REDIS_HOST=eg_controller -d -p 9501:9500 eventgen:latest server

run_controller: eg_network
	docker kill eg_controller || true
	docker rm eg_controller || true
	docker run --network eg_network --name eg_controller  -d -p 6379:6379 -p 9500:9500 eventgen:latest controller

run_standalone:
	docker kill eg_standalone || true
	docker rm eg_standalone || true
	docker run --name eg_standalone  -d -p 9500:9500 eventgen:latest standalone

run_local_standalone:
	python3 -m splunk_eventgen service -r standalone

docs:
	cd docs/; bundle install; bundle exec jekyll serve

build_spl: clean
	python3 -m splunk_eventgen build --destination ./


lint:
ifeq ($(NEWLY_ADDED_PY_FILES), )
	@echo 'No newly added python files. Skip...'
else
	@flake8 $(NEWLY_ADDED_PY_FILES)
endif
	@git diff -U0 -- '*.py' | flake8 --diff

format:
ifeq ($(CHANGED_ADDED_PY_FILES), )
	@echo 'No changed python files. Skip...'
else
	@isort $(CHANGED_ADDED_PY_FILES)
endif
ifeq ($(NEWLY_ADDED_PY_FILES), )
	@echo 'No newly added python files. Skip...'
else
	@black -t py37 $(NEWLY_ADDED_PY_FILES)
endif

lint-all:
	@echo "lint all py files"
	@flake8 $(ALL_PY_FILES)

format-check:
	@echo 'Checking all py files code format'
	@black --check -t py37 .

format-all:
	@echo "format all py files"
	@isort -rc $(ALL_PY_FILES)
	@black -t py37 $(ALL_PY_FILES)