Makefile

.PHONY: tests

build: cs tests phpstan

tests: install-paratest
	XDEBUG_MODE=off php tests/vendor/bin/paratest --runner WrapperRunner --no-coverage

tests-integration: install-paratest
	php tests/vendor/bin/paratest --runner WrapperRunner --no-coverage --group exec

tests-golden-reflection:
	php vendor/bin/phpunit tests/PHPStan/Reflection/ReflectionProviderGoldenTest.php

lint:
	XDEBUG_MODE=off php vendor/bin/parallel-lint --colors \
		--exclude tests/PHPStan/Analyser/data \
		--exclude tests/bench/data \
		--exclude tests/PHPStan/Analyser/nsrt \
		--exclude tests/PHPStan/Rules/Methods/data \
		--exclude tests/PHPStan/Rules/Functions/data \
		--exclude tests/PHPStan/Rules/Names/data \
		--exclude tests/PHPStan/Rules/Operators/data/invalid-inc-dec.php \
		--exclude tests/PHPStan/Rules/Arrays/data/offset-access-without-dim-for-reading.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-11891.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-13768.php \
		--exclude tests/PHPStan/Rules/Classes/data/duplicate-declarations.php \
		--exclude tests/PHPStan/Rules/Classes/data/duplicate-enum-cases.php \
		--exclude tests/PHPStan/Rules/Classes/data/enum-sanity.php \
		--exclude tests/PHPStan/Rules/Classes/data/extends-error.php \
		--exclude tests/PHPStan/Rules/Classes/data/implements-error.php \
		--exclude tests/PHPStan/Rules/Classes/data/interface-extends-error.php \
		--exclude tests/PHPStan/Rules/Classes/data/trait-use-error.php \
		--exclude tests/PHPStan/Rules/Methods/data/method-in-enum-without-body.php \
		--exclude tests/PHPStan/Rules/Properties/data/default-value-for-native-property-type.php \
		--exclude tests/PHPStan/Rules/Arrays/data/empty-array-item.php \
		--exclude tests/PHPStan/Rules/Classes/data/invalid-promoted-properties.php \
		--exclude tests/PHPStan/Rules/Classes/data/duplicate-promoted-property.php \
		--exclude tests/PHPStan/Rules/Properties/data/default-value-for-promoted-property.php \
		--exclude tests/PHPStan/Rules/Operators/data/invalid-assign-var.php \
		--exclude tests/PHPStan/Rules/Functions/data/arrow-function-nullsafe-by-ref.php \
		--exclude tests/PHPStan/Levels/data/namedArguments.php \
		--exclude tests/PHPStan/Rules/Keywords/data/continue-break.php \
		--exclude tests/PHPStan/Rules/Keywords/data/continue-break-property-hook.php \
		--exclude tests/PHPStan/Rules/Keywords/data/goto-undefined-label.php \
		--exclude tests/PHPStan/Rules/Keywords/data/goto-undefined-label-property-hook.php \
		--exclude tests/PHPStan/Rules/Keywords/data/unused-label-property-hook.php \
		--exclude tests/PHPStan/Rules/Keywords/data/bug-13790-break.php \
		--exclude tests/PHPStan/Rules/Keywords/data/bug-13790-continue.php \
		--exclude tests/PHPStan/Rules/Properties/data/invalid-callable-property-type.php \
		--exclude tests/PHPStan/Rules/Properties/data/properties-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/read-only-property.php \
		--exclude tests/PHPStan/Rules/Properties/data/read-only-property-phpdoc-and-native.php   \
		--exclude tests/PHPStan/Rules/Properties/data/read-only-property-readonly-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/overriding-property.php \
		--exclude tests/PHPStan/Rules/Constants/data/overriding-final-constant.php \
		--exclude tests/PHPStan/Rules/Properties/data/intersection-types.php \
		--exclude tests/PHPStan/Rules/Classes/data/first-class-instantiation-callable.php \
		--exclude tests/PHPStan/Rules/Classes/data/instantiation-callable.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-9402.php \
		--exclude tests/PHPStan/Rules/Constants/data/class-as-class-constant.php \
		--exclude tests/PHPStan/Rules/Constants/data/value-assigned-to-class-constant-native-type.php \
		--exclude tests/PHPStan/Rules/Constants/data/overriding-constant-native-types.php \
		--exclude tests/PHPStan/Rules/Methods/data/bug-10043.php \
		--exclude tests/PHPStan/Rules/Methods/data/bug-7859.php \
		--exclude tests/PHPStan/Rules/Methods/data/bug-8081.php \
		--exclude tests/PHPStan/Rules/Methods/data/bug-9014.php \
		--exclude tests/PHPStan/Rules/Methods/data/bug-10101.php \
		--exclude tests/PHPStan/Rules/Methods/data/final-method-by-phpdoc.php \
		--exclude tests/PHPStan/Rules/Traits/data/conflicting-trait-constants-types.php \
		--exclude tests/PHPStan/Rules/Types/data/invalid-union-with-mixed.php \
		--exclude tests/PHPStan/Rules/Types/data/invalid-union-with-never.php \
		--exclude tests/PHPStan/Rules/Types/data/invalid-union-with-void.php \
		--exclude tests/PHPStan/Rules/Constants/data/dynamic-class-constant-fetch.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-position.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-position2.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-position-nested.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-strict-nonsense.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-strict-nonsense-bool.php \
		--exclude tests/PHPStan/Rules/Keywords/data/declare-inline-html.php \
		--exclude tests/PHPStan/Rules/Classes/data/extends-readonly-class.php \
		--exclude tests/PHPStan/Rules/Classes/data/instantiation-promoted-properties.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-11592.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-hooks-bodies-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-hooks-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-hooks-visibility-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-hooked-properties-in-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-hooked-properties-with-bodies.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-non-hooked-properties-in-abstract-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/non-abstract-hooked-properties-in-abstract-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/non-abstract-hooked-properties-in-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/hooked-properties-in-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/hooked-properties-without-bodies-in-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/readonly-property-hooks.php \
		--exclude tests/PHPStan/Rules/Properties/data/readonly-property-hooks-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/static-hooked-properties.php \
		--exclude tests/PHPStan/Rules/Properties/data/static-hooked-property-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/virtual-hooked-properties.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-12281.php \
		--exclude tests/PHPStan/Rules/Traits/data/bug-12281.php \
		--exclude tests/PHPStan/Rules/Classes/data/invalid-hooked-properties.php \
		--exclude tests/PHPStan/Parser/data/cleaning-property-hooks-before.php \
		--exclude tests/PHPStan/Parser/data/cleaning-property-hooks-after.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-private-property-hook.php \
		--exclude tests/PHPStan/Rules/Properties/data/existing-classes-property-hooks.php \
		--exclude tests/PHPStan/Rules/Properties/data/set-property-hook-parameter.php \
		--exclude tests/PHPStan/Rules/Properties/data/overriding-final-property.php \
		--exclude tests/PHPStan/Rules/Properties/data/private-final-property-hooks.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-final-property-hook.php \
		--exclude tests/PHPStan/Rules/Properties/data/final-property-hooks-in-interface.php \
		--exclude tests/PHPStan/Rules/Properties/data/final-property-hooks.php \
		--exclude tests/PHPStan/Rules/Properties/data/final-properties.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-in-interface-explicit-abstract.php \
		--exclude tests/PHPStan/Rules/Constants/data/final-private-const.php \
		--exclude tests/PHPStan/Rules/Properties/data/abstract-final-property-hook-parse-error.php \
		--exclude tests/PHPStan/Rules/Playground/data/promote-missing-override.php \
		--exclude tests/PHPStan/Rules/Traits/data/trait-attributes.php \
		--exclude tests/PHPStan/Rules/Classes/data/non-class-attribute-class.php \
		--exclude tests/PHPStan/Rules/Classes/data/enum-cannot-be-attribute.php \
		--exclude tests/PHPStan/Rules/Classes/data/class-attributes.php \
		--exclude tests/PHPStan/Rules/Classes/data/enum-attributes.php \
		--exclude tests/PHPStan/Rules/Cast/data/void-cast.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-hook-attributes-nodiscard.php \
		--exclude tests/PHPStan/Rules/Functions/data/arrow-function-typehints-nodiscard.php \
		--exclude tests/PHPStan/Rules/Functions/data/closure-typehints-nodiscard.php \
		--exclude tests/PHPStan/Reflection/data/ClassWithConstants.php \
		--exclude tests/PHPStan/Rules/Functions/data/typehints-nodiscard.php \
		--exclude tests/PHPStan/Rules/Methods/data/typehints-nodiscard.php \
		--exclude tests/PHPStan/Rules/Cast/data/deprecated-cast.php \
		--exclude tests/PHPStan/Rules/Classes/data/deprecated-attr-on-class.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-override-attr-missing.php \
		--exclude tests/PHPStan/Rules/Properties/data/override-attr-on-property.php \
		--exclude tests/PHPStan/Rules/Properties/data/property-override-attr.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-14250.php \
		--exclude tests/PHPStan/Rules/Classes/data/bug-14250-promoted-properties.php \
		--exclude tests/PHPStan/Rules/Operators/data/bug-3585.php \
		--exclude tests/PHPStan/Rules/EnumCases/data/bug-14252.php \
		--exclude tests/PHPStan/Rules/Functions/data/bug-14241.php \
		--exclude tests/PHPStan/Rules/Variables/data/bug-14349.php \
		--exclude tests/PHPStan/Rules/Variables/data/bug-14352.php \
		--exclude tests/PHPStan/Rules/Variables/data/bug-14351.php \
		--exclude tests/PHPStan/Rules/Properties/data/bug-14457.php \
		src tests

install-paratest:
	composer install --working-dir tests

.PHONY: cs-install
cs-install:
	git clone https://github.com/phpstan/build-cs.git || true
	git -C build-cs fetch origin && git -C build-cs reset --hard origin/2.x
	composer install --working-dir build-cs

.PHONY: cs
cs: cs-install
	XDEBUG_MODE=off php build-cs/vendor/bin/phpcs

.PHONY: cs-fix
cs-fix: cs-install
	XDEBUG_MODE=off php build-cs/vendor/bin/phpcbf

phpstan:
	php bin/phpstan clear-result-cache -q && php -d memory_limit=450M bin/phpstan -v

phpstan-result-cache:
	php -d memory_limit=450M bin/phpstan

phpstan-fix:
	php -d memory_limit=450M bin/phpstan --fix

phpstan-generate-baseline:
	php -d memory_limit=450M bin/phpstan --generate-baseline

phpstan-generate-baseline-php:
	php -d memory_limit=450M bin/phpstan analyse --generate-baseline phpstan-baseline.php

phpstan-pro:
	php -d memory_limit=450M bin/phpstan --pro

name-collision:
	php vendor/bin/detect-collisions --configuration build/collision-detector.json

composer-dependency-analyser:
	php vendor/bin/composer-dependency-analyser --config build/composer-dependency-analyser.php

.PHONY: infection
infection:
	git -C build-infection pull || git clone https://github.com/phpstan/build-infection.git
	git -C build-infection fetch origin && git -C build-infection reset --hard origin/1.x
	composer install --working-dir build-infection --no-interaction --no-progress
	php build-infection/bin/infection-config.php --source-directory='build/PHPStan/Build'> infection.json5
	XDEBUG_MODE=coverage php tests/vendor/bin/paratest \
		--coverage-xml=tmp/coverage/coverage-xml \
		--log-junit=tmp/coverage/junit.xml
	php build-infection/vendor/bin/infection \
		--configuration=infection.json5 \
		--git-diff-base=origin/HEAD \
		--git-diff-lines \
		--coverage=tmp/coverage \
		--skip-initial-tests \
		--ignore-msi-with-no-mutations \
		--logger-text=php://stdout

.PHONY: phpbench
phpbench:
	@find tests/bench/storage/local-baseline.xml -mtime -60m | grep . || (echo "PHPBench baseline file does not exist or is too old. Regenerate it using 'make phpbench-baseline'." && exit 1)
	XDEBUG_MODE=off tests/vendor/bin/phpbench run --file=tests/bench/storage/local-baseline.xml --report=my-report

.PHONY: phpbench-baseline
phpbench-baseline:
	XDEBUG_MODE=off tests/vendor/bin/phpbench run --dump-file=tests/bench/storage/local-baseline.xml

download-coverage:
	rm -rf tmp/coverage-download
	mkdir tmp/coverage-download
	(cd tmp/coverage-download; gh run download `gh run ls --repo=phpstan/phpstan-src --branch=\`git for-each-ref --format='%(upstream:short)' $$(git symbolic-ref -q HEAD) | cut -d/ -f2- \` --workflow=tests.yml --limit=1 --json=databaseId --jq '.[].databaseId'` --repo=phpstan/phpstan-src --name=coverage-reports)
	sed -i '' -e 's,/home/runner/work/phpstan-src/phpstan-src/,'"$$PWD"/',g' tmp/coverage-download/clover.xml
	cp tmp/coverage-download/clover.xml tmp/coverage/clover.xml


# Builds turbo-ext/phpstan_turbo.so for the machine and the PHP this runs on,
# in parallel over the local cores — plain `make -C turbo-ext` builds one
# translation unit at a time, and there are ~170 of them. The interpreter it
# builds against is whatever `php-config` is on PATH; point it elsewhere with
# `make build-turbo PHP_CONFIG=/path/to/php-config` (command-line variables
# reach the sub-make through MAKEFLAGS). Nothing is installed: load the
# result with `php -d extension=...`, or from the ini scan dir when the run
# re-executes itself (TurboProcessRestarter drops a -d extension).
TURBO_JOBS ?= $(shell getconf _NPROCESSORS_ONLN 2>/dev/null || echo 4)

.PHONY: build-turbo
build-turbo:
	$(MAKE) -C turbo-ext -j$(TURBO_JOBS)
	@# The binary bakes its version from `git log -- turbo-ext/src`, and
	@# TurboExtensionEnabler activates only the version it expects — a build
	@# from a shallow clone ("dev"), or one made between a turbo-ext/src
	@# commit and its `make bump-turbo`, loads but stays inactive, which
	@# otherwise only shows up as "nothing got faster".
	@# -n: the machine's php.ini usually loads the extension already, and
	@# the "Module is already loaded" warning that a second -d then prints
	@# goes to stdout, i.e. into the version being read. An ini-less probe
	@# also guarantees the version reported is the binary just built.
	@BUILT="$$(php -n -d display_errors=stderr -d extension="$(CURDIR)/turbo-ext/phpstan_turbo.so" -r 'echo phpversion("phpstan_turbo");' 2>/dev/null)"; \
	EXPECTED="$$(sed -n "s/.*EXPECTED_EXTENSION_VERSION = '\([^']*\)'.*/\1/p" src/Turbo/TurboExtensionEnabler.php)"; \
	echo "built $(CURDIR)/turbo-ext/phpstan_turbo.so$${BUILT:+ (version $$BUILT)}"; \
	if [ -n "$$BUILT" ] && [ "$$BUILT" != "$$EXPECTED" ]; then \
		echo "warning: TurboExtensionEnabler expects $$EXPECTED, so this build would load but stay inactive (run 'make bump-turbo' once the turbo-ext/src commit is in)"; \
	fi

# The expected turbo version is the short SHA of the last commit touching
# turbo-ext/src (enforced by the phar.yml turbo-version job), so the bump can
# never be part of the commit it points at. Refreshes an unpushed bump commit
# in place — after a rebase gives the watched commit a new SHA, rerunning
# this amends instead of stacking a second bump commit.
.PHONY: bump-turbo
bump-turbo:
	@if [ -n "$$(git status --porcelain -- turbo-ext/src)" ]; then \
		echo "turbo-ext/src has uncommitted changes — commit them first, the expected version is the short SHA of the last commit touching turbo-ext/src"; \
		exit 1; \
	fi; \
	if ! git diff --quiet HEAD -- src/Turbo/TurboExtensionEnabler.php; then \
		echo "src/Turbo/TurboExtensionEnabler.php has uncommitted changes — commit or stash them first"; \
		exit 1; \
	fi; \
	EXPECTED="$$(git log -1 --format=%H -- turbo-ext/src | cut -c1-7)"; \
	CURRENT="$$(sed -n "s/.*EXPECTED_EXTENSION_VERSION = '\([^']*\)'.*/\1/p" src/Turbo/TurboExtensionEnabler.php)"; \
	if [ "$$EXPECTED" = "$$CURRENT" ]; then \
		echo "TurboExtensionEnabler::EXPECTED_EXTENSION_VERSION is already $$EXPECTED"; \
		exit 0; \
	fi; \
	sed -i '' -e "s/EXPECTED_EXTENSION_VERSION = '$$CURRENT'/EXPECTED_EXTENSION_VERSION = '$$EXPECTED'/" src/Turbo/TurboExtensionEnabler.php; \
	if [ "$$(git log -1 --format=%s)" = "Bump expected turbo version" ] && [ -z "$$(git branch -r --contains HEAD)" ]; then \
		git commit --amend --no-edit -- src/Turbo/TurboExtensionEnabler.php; \
		echo "amended the unpushed bump commit: $$CURRENT -> $$EXPECTED"; \
	else \
		git commit -m "Bump expected turbo version" -- src/Turbo/TurboExtensionEnabler.php; \
		echo "bumped: $$CURRENT -> $$EXPECTED"; \
	fi

# Static analysis of the native extension's hand-written C++ sources. The
# enabled checks and the measured reason for every exclusion are in
# turbo-ext/.clang-tidy; a finding fails the target rather than being
# baselined.
.PHONY: lint-turbo
lint-turbo:
	$(MAKE) -C turbo-ext lint

# Builds the extension with UndefinedBehaviorSanitizer and runs the
# differential tests under it: the native results must still equal the PHP
# twins' with no sanitizer diagnostic. This is the memory-safety half of the
# checks — the static ones cannot see zval lifetimes.
.PHONY: sanitize-turbo
sanitize-turbo:
	$(MAKE) -C turbo-ext sanitize