Giters

open-telemetry / opentelemetry-php

The OpenTelemetry PHP Library

Home Page:https://opentelemetry.io/docs/instrumentation/php/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Upgrade to phpunit 11

bobstrecansky opened this issue · comments

commented

Before opening a feature request against this repo, consider whether the feature should/could be implemented in the other OpenTelemetry client libraries. If so, please open an issue in opentelemetry-specification first.

Is your feature request related to a problem?
We are currently using phpunit 9.6 in ourcodebase. We should upgrade to PHP 11.0. We will need to do this after we upgrade to PHP 8.2, as that is a required dependency

Describe the solution you'd like
What do you want to happen instead? What is the expected behavior?
PHPUnit tests running on PHPUnit 11.0

Describe alternatives you've considered
Which alternative solutions or features have you considered?
None

Additional context
Add any other context about the feature request here.

commented

Progress update: dropping PHP 8.0 support allowed an upgrade to phpunit 10 in #1258

commented

Going from PHPUnit 10 to 11 is simple assuming you don't have any deprecations, for example you need to actually make all data providers static, in 10 they trigger a deprecation.

commented

Upgrading tests to phpunit 11 probably is simple. Upgrading our dependencies to phpunit 11 not so much:

  • phpunit 11 requires phpunit/php-code-coverage ^11
  • phpunit/php-code-coverage requires nikic/php-parser ^5
  • vimeo/psalm latest required nikic/php-parser ^4.16

So, until psalm starts supporting nikic/php-parser ^5, we're blocked. Both psalm and phpunit are important parts of out CI pipeline, and we do need and want both.

Once that puzzle is solved, our tests do pass under phpunit11, but there are deprecation warnings for phpunit 12!

edit: we could also try installing phpunit as a phar, which would remove some dependency issues, I think.

commented

Installing PHPUnit as PHAR makes running static analysis on your tests more difficult since your code (in tests) is using PHPUnit directly.

What you can do is install Psalm separately. We use a Docker image with Psalm baked in which des this for us: https://github.com/sigwinhq/infra

A more conventional way to do this (which the above Docker image uses internally) is to use https://github.com/bamarni/composer-bin-plugin

It allows you to install your tools using a separate composer.json which then doesn't need to be aligned with your project one since you're not using Psalm as a dependency, you're just using Psalm the tool.

commented

@dkarlovi using composer-bin-plugin was fairly straightforward. Thanks for the advice on not doing anything clever with phpunit, I've left it as-is.
I can now upgrade to phpunit 11, but I'll leave that as a separate PR since it will involve fixing lots of deprecations.