Test use cases IRL

Author: olvlvl

.github/workflows/cases.yml

@@ -0,0 +1,31 @@
+on:
+  - push
+
+jobs:
+  case-incompatible-signature:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version:
+          - "8.0"
+          - "8.4"
+        composer-version:
+          - "v2.4.0"
+          - "v2"
+        composer-tweak:
+          - "--prefer-lowest"
+          - ""
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          ini-values: memory_limit=-1
+          tools: composer:${{ matrix.composer-version }}
+      - name: Run case
+        run: |
+          cd cases/incompatible-signature
+          composer --version
+          composer update --no-interaction --no-progress ${{ matrix.composer-tweak }}

cases/incompatible-signature/Dockerfile

@@ -0,0 +1,38 @@
+ARG PHP_TAG=8.0-cli-buster
+FROM php:${PHP_TAG}
+
+RUN <<-EOF
+	apt-get update
+	apt-get install -y autoconf pkg-config
+	pecl channel-update pecl.php.net
+	pecl install xdebug
+	docker-php-ext-enable opcache xdebug
+EOF
+
+RUN <<-EOF
+	cat <<-SHELL >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+	xdebug.client_host=host.docker.internal
+	xdebug.mode=develop
+	xdebug.start_with_request=yes
+	SHELL
+
+	cat <<-SHELL >> /usr/local/etc/php/conf.d/php.ini
+	display_errors=On
+	error_reporting=E_ALL
+	date.timezone=UTC
+	SHELL
+EOF
+
+ENV COMPOSER_ALLOW_SUPERUSER 1
+
+RUN <<-EOF
+	apt-get update
+	apt-get install unzip
+	php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+	php composer-setup.php --version=2.4.0
+	php -r "unlink('composer-setup.php');"
+	mv composer.phar /usr/local/bin/composer
+	cat <<-SHELL >> /root/.bashrc
+	export PATH="$HOME/.composer/vendor/bin:$PATH"
+	SHELL
+EOF

cases/incompatible-signature/Makefile

@@ -0,0 +1,27 @@
+# do not edit the following lines
+
+vendor:
+	@composer install --prefer-lowest
+
+.PHONY: test-container
+test-container: test-container80
+
+.PHONY: test-container80
+test-container80:
+	@-docker compose run --rm app80 bash
+	@docker compose down -v
+
+.PHONY: test-container81
+test-container81:
+	@-docker-compose run --rm app81 bash
+	@docker-compose down -v
+
+.PHONY: test-container82
+test-container82:
+	@-docker compose run --rm app82 bash
+	@docker compose down -v
+
+.PHONY: test-container84
+test-container84:
+	@-docker compose run --rm app84 bash
+	@docker compose down -v

cases/incompatible-signature/README.md

@@ -0,0 +1,16 @@
+# Use case: Incompatible Signature
+
+> [!NOTE]
+> Fixed in [v2.1.0](https://github.com/olvlvl/composer-attribute-collector/releases/tag/v2.1.0)
+
+Running the collector within Composer's realm is causing issues when the interfaces used by Composer
+are incompatible with those used by the codebase, as reported by [#31][] and [#32][]. The issue was
+fixed in [#35][], by running the collector as a command.
+
+```
+Fatal error: Declaration of Acme\MyLogger::emergency(Stringable|string $message, array $context = []): void must be compatible with Psr\Log\LoggerInterface::emergency($message, array $context = []) in /app/src/MyLogger.php on line 23
+```
+
+[#31]: https://github.com/olvlvl/composer-attribute-collector/issues/31
+[#32]: https://github.com/olvlvl/composer-attribute-collector/issues/32
+[#35]: https://github.com/olvlvl/composer-attribute-collector/pull/35

cases/incompatible-signature/composer.json

@@ -0,0 +1,24 @@
+{
+  "require": {
+    "php": ">=8.0",
+    "psr/log": "^3.0",
+    "olvlvl/composer-attribute-collector": "^2.1.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "olvlvl/composer-attribute-collector": true
+    }
+  },
+  "extra": {
+    "composer-attribute-collector": {
+      "include": [
+        "src"
+      ]
+    }
+  },
+  "autoload": {
+    "psr-4": {
+      "Acme\\": "src"
+    }
+  }
+}

cases/incompatible-signature/docker-compose.yaml

@@ -0,0 +1,46 @@
+---
+services:
+  app80:
+    build:
+      context: .
+      args:
+        PHP_TAG: '8.0-cli-buster'
+    environment:
+      PHP_IDE_CONFIG: 'serverName=olvlvl/attribute-collector'
+    volumes:
+      - .:/app:delegated
+      - ~/.composer:/root/.composer:delegated
+    working_dir: /app
+  app81:
+    build:
+      context: .
+      args:
+        PHP_TAG: '8.1-cli-buster'
+    environment:
+      PHP_IDE_CONFIG: 'serverName=olvlvl/attribute-collector'
+    volumes:
+      - .:/app:delegated
+      - ~/.composer:/root/.composer:delegated
+    working_dir: /app
+  app82:
+    build:
+      context: .
+      args:
+        PHP_TAG: '8.2-cli-bookworm'
+    environment:
+      PHP_IDE_CONFIG: 'serverName=olvlvl/attribute-collector'
+    volumes:
+      - .:/app:delegated
+      - ~/.composer:/root/.composer:delegated
+    working_dir: /app
+  app84:
+    build:
+      context: .
+      args:
+        PHP_TAG: '8.4-cli-bookworm'
+    environment:
+      PHP_IDE_CONFIG: 'serverName=olvlvl/attribute-collector'
+    volumes:
+      - .:/app:delegated
+      - ~/.composer:/root/.composer:delegated
+    working_dir: /app

cases/incompatible-signature/src/MyLogger.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Acme;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerTrait;
+
+#[SampleAttribute]
+class MyLogger implements LoggerInterface
+{
+    use LoggerTrait;
+
+    public function log($level, \Stringable|string $message, array $context = []): void
+    {
+    }
+}

cases/incompatible-signature/src/SampleAttribute.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Acme;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class SampleAttribute
+{
+}