Merge pull request #1629 from consideRatio/pr/add-notes-about-pytest-xdist

Add inline comments about pytest-xdist

Author: mathbunnyru

Makefile

@@ -207,7 +207,7 @@ run-sudo-shell/%: ## run a bash in interactive mode as root in a stack
 
 test/%: ## run tests against a stack (only common tests or common tests + specific tests)
 	@echo "::group::test/$(OWNER)/$(notdir $@)"
-	@if [ ! -d "$(notdir $@)/test" ]; then TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest -n auto -m "not info" test; \
-	else TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest -n auto -m "not info" test $(notdir $@)/test; fi
+	@if [ ! -d "$(notdir $@)/test" ]; then TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest --numprocesses=auto -m "not info" test; \
+	else TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest --numprocesses=auto -m "not info" test $(notdir $@)/test; fi
 	@echo "::endgroup::"
 test-all: $(foreach I, $(ALL_IMAGES), test/$(I)) ## test all stacks

requirements-dev.txt

@@ -3,6 +3,8 @@ packaging
 plumbum
 pre-commit
 pytest
+# pytest-xdist is a plugin that provides the --numprocesses flag, allowing us to
+# run pytest tests in parallel.
 pytest-xdist
 requests
 tabulate