 |
VOOZH | about |
|
VOOZH | about |
The RudderStack PHP SDK utilizes a standard Makefile to orchestrate its build, test, and release lifecycles. This system manages Composer-based dependencies, enforces coding standards through linting, executes the PHPUnit test suite, and automates version synchronization across the codebase.
The SDK manages its dependencies via Composer. The build system is designed to be self-contained, downloading composer.phar locally if it is not already present in the environment.
The following diagram illustrates how the Makefile interacts with the filesystem and Composer to establish the development environment.
Build System Dependency Flow
Implementation Details:
composer.phar target uses curl to fetch the installer from the official source Makefile12-13vendor target executes the installation and explicitly ensures that development tools like phplint and php_codesniffer are present Makefile6-11Rudder\ namespace to the lib/ directory and Rudder\Test\ to the test/ directory composer.json39-44Sources:
The Makefile defines several high-level targets for development, testing, and CI/CD integration.
| Target | Description | Implementation |
|---|---|---|
bootstrap | Sets up the local environment (macOS/Homebrew focus). | Executes scripts/bootstrap.sh Makefile1-2 |
dependencies | Ensures vendor/ is populated. | Depends on the vendor target Makefile4 |
tests | Runs the full PHPUnit suite with coverage. | Generates Clover XML and JUnit logs in build/logs/ Makefile15-19 |
lint | Runs local code style checks. | Executes phplint and phpcs Makefile20-23 |
lint-ci | Runs linting with machine-readable output. | Generates JUnit and Checkstyle reports for CI pipelines Makefile24-28 |
release | Synchronizes version numbers. | Updates lib/Version.php and composer.json Makefile29-33 |
example | Runs the main demonstration app. | Executes php -f examples/App.php Makefile34-35 |
smoke-test | Runs a basic sanity integration test. | Executes php -f examples/sanity-test/Sanity.php Makefile37-38 |
clean | Resets the repository state. | Removes composer.phar, vendor/, composer.lock, and build/ Makefile40-45 |
The bootstrap target is primarily intended for macOS users. It checks for Homebrew, installs PHP if missing, and installs the pcov extension via PECL to enable high-performance code coverage scripts/bootstrap.sh1-21
Sources:
The release target is a critical utility for maintainers to ensure version consistency across different metadata files. It requires a VERSION environment variable (e.g., VERSION=2.1.0 make release).
Release Data Flow
Logic Breakdown:
printf to overwrite ./lib/Version.php, declaring a global variable $RUDDER_VERSION containing the new version string Makefile31node one-liner to parse composer.json, update the version key, and write the formatted JSON back to disk Makefile32 This ensures that when the package is published to Packagist, the metadata matches the internal SDK version.Sources:
The SDK enforces PSR-12 coding standards and performs syntax linting to ensure compatibility across supported PHP versions (7.4 and 8.0+).
overtrue/phplint. It is configured via .phplint.yml to exclude the vendor directory and process 10 jobs in parallel Makefile21 .phplint.yml1-7squizlabs/php_codesniffer (phpcs). The lint-ci target specifically formats these results into checkstyle format for integration with CI tools like SonarCloud Makefile27tests target also executes composer validate to ensure the composer.json file remains valid and follows schema requirements Makefile18Sources: