splunk-sdk-python/Makefile at develop · splunk/splunk-sdk-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
### Conveniences for splunk-sdk-python development

## VIRTUALENV MANAGEMENT

# https://docs.astral.sh/uv/reference/cli/#uv-run--upgrade
# --no-config skips Splunk's internal PyPI mirror
UV_SYNC_CMD := uv sync --no-config

.PHONY: uv-sync
uv-sync:
	$(UV_SYNC_CMD) --dev

.PHONY: uv-upgrade
uv-upgrade:
	$(UV_SYNC_CMD) --dev --upgrade


# Workaround for make being unable to pass arguments to underlying cmd
# $ SDK_DEPS_GROUP="build" make uv-sync-ci
.PHONY: uv-sync-ci
uv-sync-ci:
	uv sync --locked --group $(SDK_DEPS_GROUP)

.PHONY: clean
clean:
	rm -rf ./build ./dist ./.venv ./.ruff_cache ./.pytest_cache ./splunk_sdk.egg-info ./__pycache__ ./**/__pycache__

.PHONY: docs
docs:
	make -C ./docs html

## TESTING

# --ff lets previously failing tests go first
# -ra prints a report on all failed tests after a run
# -vv shows why a test failed while the rest of the suite is running
PYTHON_CMD := uv run python
PYTEST_CMD := $(PYTHON_CMD) -m pytest --no-header --ff -ra -vv

.PHONY: test
test:
	$(PYTEST_CMD) ./tests

.PHONY: test-unit
test-unit:
	$(PYTEST_CMD) ./tests/unit

.PHONY: test-integration
test-integration:
	$(PYTEST_CMD) --ff ./tests/integration ./tests/system

.PHONY: test-ai
test-ai:
	$(PYTEST_CMD) ./tests/integration/ai ./tests/unit/ai

## DOCKER

CONTAINER_NAME := splunk
SPLUNK_HOME := /opt/splunk

.PHONY: docker-up
docker-up:
	# For podman (at least on macOS) you might need to add DOCKER_BUILDKIT=0
	# --build forces Docker to build a new image instead of using an existing one
	@docker-compose up -d --build

.PHONY: docker-ensure-up
docker-ensure-up:
	@for i in `seq 0 180`; do \
		if docker exec -it $(CONTAINER_NAME) /bin/bash -c "/sbin/checkstate.sh &> /dev/null"; then \
			break; \
		fi; \
		printf "\rWaiting for Splunk for %s seconds..." $$i; \
		sleep 1; \
	done

.PHONY: docker-start
docker-start: docker-up docker-ensure-up

.PHONY: docker-down
docker-down:
	docker-compose stop

.PHONY: docker-restart
docker-restart: docker-down docker-start

.PHONY: docker-remove
docker-remove:
	docker-compose rm -f -s

.PHONY: docker-refresh
docker-refresh: docker-remove docker-start

.PHONY: docker-splunk-restart
docker-splunk-restart:
	docker exec -it $(CONTAINER_NAME) sudo sh -c '$(SPLUNK_HOME)/bin/splunk restart --run-as-root'

.PHONY: docker-tail-python-log
docker-tail-python-log:
	docker exec -it $(CONTAINER_NAME) sudo tail $(SPLUNK_HOME)/var/log/splunk/python.log