Separate .PHONY-ies as they look better; Update README.md

Author: Ickerday

Makefile

@@ -3,44 +3,54 @@ GREEN_COLOR=\033[32;01m
 
 CONTAINER_NAME := 'splunk'
 
-.PHONY: docs test test-unit test-integration up wait_up remove down refresh start restart finish
+.PHONY: docs
 docs:
 	@echo "$(GREEN_COLOR)==> docs $(RESET_COLOR)"
 	@rm -rf ./docs/_build
 	@make -C ./docs html
 	@echo "$(GREEN_COLOR)==> Docs pages can be found at docs/_build/html"
 	@echo "$(GREEN_COLOR)==> Docs bundle available at docs/_build/docs_html.zip"
 
+.PHONY: test
 test:
 	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
 	@python -m pytest ./tests
 
-test:
+.PHONY: test-unit
+test-unit:
 	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
 	@python -m pytest ./tests/unit
 
-test:
+.PHONY: test-integration
+test-integration:
 	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
 	@python -m pytest ./tests/integration ./tests/system
 
-up:
+.PHONY: docker-up
+docker-up:
 	@echo "$(GREEN_COLOR)==> up $(RESET_COLOR)"
 	@docker-compose up -d
 
-remove:
+.PHONY: docker-remove
+docker-remove:
 	@echo "$(GREEN_COLOR)==> rm $(RESET_COLOR)"
 	@docker-compose rm -f -s
 
-wait_up:
-	@echo "$(GREEN_COLOR)==> wait_up $(RESET_COLOR)"
+.PHONY: docker-ensure-up
+docker-ensure-up:
+	@echo "$(GREEN_COLOR)==> wait-up $(RESET_COLOR)"
 	@for i in `seq 0 180`; do if docker exec -it $(CONTAINER_NAME) /sbin/checkstate.sh &> /dev/null; then break; fi; printf "\rWaiting for Splunk for %s seconds..." $$i; sleep 1; done
 
-down:
+.PHONY: docker-down
+docker-down:
 	@echo "$(GREEN_COLOR)==> down $(RESET_COLOR)"
 	@docker-compose stop
 
-start: up wait_up
+.PHONY: docker-start
+docker-start: docker-up docker-ensure-up
 
-restart: down start
+.PHONY: docker-restart
+docker-restart: docker-down docker-start
 
-refresh: remove start
+.PHONY: docker-refresh
+docker-refresh: docker-remove docker-start

README.md

@@ -190,7 +190,7 @@ This repo contains a collection of unit and integration tests.
 To run both unit and integration tests:
 
 ```sh
-make test
+make test-unit
 ```
 
 #### Integration tests
@@ -202,10 +202,9 @@ Do not run the test suite against a production instance of Splunk! It will run j
 ##### Prerequisites
 
 - `docker`/`podman`
-- `tox`
 
 ```sh
-SPLUNK_VERSION=latest && make start
+SPLUNK_VERSION=latest && make docker-start
 ```
 
 ### Optional: Set up logging for splunklib