Support baseline configuration #737

lcobucci · 2023-02-15T22:59:47Z

This allows users to set a list of regexes to filter known BC-breaks from detected changes.

README.md

lcobucci · 2023-02-15T23:06:13Z

@Nyholm although this uses a different name/format, it could be used to simplify https://github.com/Nyholm/roave-bc-check-docker 👍

Ocramius · 2023-02-15T23:12:55Z

I'll need to ponder on this: my preference would be to have either an XSD or a JSON schema, at least, and use those as documentation too 🤔

src/Command/AssertBackwardsCompatible.php

lcobucci · 2023-02-16T06:06:52Z

I'll need to ponder on this: my preference would be to have either an XSD or a JSON schema, at least, and use those as documentation too 🤔

I totally understand. I didn't want to introduce new dependencies to the project (I did implicitly add ext-json, though).

Up to you, mate!

src/Baseline.php

asgrim

@lcobucci I'm loving this change, and it indeed formalises things that @Nyholm had done before (which I've used for a project too!) - really nice feature, looking forward to getting this shaped up ❤️

src/Baseline.php

README.md

src/Command/AssertBackwardsCompatible.php

src/Command/Configuration.php

test/unit/Command/ConfigurationTest.php

Ocramius · 2023-02-26T22:45:56Z

@lcobucci sorry, this is on my plate, didn't get to it though :(

lcobucci · 2023-02-26T23:20:16Z

@lcobucci sorry, this is on my plate, didn't get to it though :(

Wow, the GH ui went crazy there... Just wanted to ask a review from you two (not to spam both).

No worries, we do what we can, whenever we can!

lcobucci · 2023-02-27T08:05:51Z

That segfault seems to be unrelated... let me know if you need help with understanding why it's happening

asgrim

No idea what the segfault is for, but it's happening consistently 😬

README.md

resources/schema.xsd

asgrim

Nice one! ❤️ love this change

README.md

Ocramius

Looking good!

My only last concern is reducing public API as a start, perhaps, but I also don't mind bumping major version, if the API needs to change due to different directions taken in future 💪

README.md

resources/schema.xsd

src/Command/DetermineConfigurationFromFilesystem.php

src/Configuration/Configuration.php

src/Configuration/InvalidConfigurationStructure.php

src/Configuration/ParseXmlConfigurationFile.php

lcobucci · 2023-03-01T21:03:24Z

All done 👍

Some people - like me - have a tweaked/opinionated global Git configuration that forces GPG signatures everywhere, which basically breaks the tests. This standardises the expected configuration for tests, preventing unexpected breakages. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

PHPUnit 10.x only accepts static data providers, so... Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

More info: sebastianbergmann/phpunit#5063 Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Ocramius

Pristine job as usual, thanks @lcobucci! 💎

Ocramius · 2023-03-02T10:50:11Z

Hmm, the segfault part still requires a PHPUnit upgrade: checking that first then.

Given the plans for laminas-continuous-integration-action v2 is to always ship PCOV, we can simply enable it here to allow us to detach the two processes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

This adds (lazy) filtering capabilities to detected changes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

This integrates the changes filter into the backward compatibility check command, parsing the configuration file prior to any process to ease the integration of new properties. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

This moves responsibilities around and introduces abstractions to support different file formats with less effort. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

This ships a parser and the expected schema to ease the validation of XML documents. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

asgrim · 2023-03-14T07:41:39Z

composer.json

@@ -26,9 +29,9 @@
    "require-dev": {
        "doctrine/coding-standard": "^11.0.0",
        "php-standard-library/psalm-plugin": "^2.2.1",
-        "phpunit/phpunit": "^9.5.27",
+        "phpunit/phpunit": "^10.0.14",


Depends on #741 to be merged

azjezz · 2023-03-19T16:18:12Z

test/e2e/Command/AssertBackwardsCompatibleTest.php

+        $output = Shell\execute(__DIR__ . '/../../../bin/roave-backward-compatibility-check', [
+            '--from=' . $this->versions[0],
+            '--to=' . $this->versions[1],
+        ], $this->sourcesRepository, [], Shell\ErrorOutputBehavior::Append);
+
+        self::assertStringContainsString(
+            '.roave-backward-compatibility-check.xml" as configuration file',
+            $output,
+        );


you can use Shell\ErrorOutputBehavior::Packed and [$stdout, $stderr] = Shell\unpack($data) to ensure that the string is in stderr not in stdout.

as of now, if the output goes to stdout instead of stderr, this test will still pass.

lcobucci commented Feb 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

lcobucci commented Feb 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Ocramius added the enhancement label Feb 15, 2023

Ocramius added this to the 8.4.0 milestone Feb 15, 2023

Ocramius reviewed Feb 15, 2023

View reviewed changes

src/Command/AssertBackwardsCompatible.php Outdated Show resolved Hide resolved

lcobucci commented Feb 16, 2023

View reviewed changes

src/Baseline.php Outdated Show resolved Hide resolved

src/Baseline.php Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch from a157044 to 0680f22 Compare February 21, 2023 19:14

lcobucci mentioned this pull request Feb 21, 2023

Do not count "skipped" changes as BC breaking #735

Closed

asgrim reviewed Feb 22, 2023

View reviewed changes

lcobucci force-pushed the support-baseline-configuration branch from 0680f22 to c251f5a Compare February 23, 2023 22:23

lcobucci commented Feb 23, 2023

View reviewed changes

test/unit/Command/ConfigurationTest.php Outdated Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch 2 times, most recently from f208c41 to f9cb116 Compare February 26, 2023 21:08

lcobucci requested review from asgrim and Ocramius and removed request for asgrim and Ocramius February 26, 2023 21:09

Ocramius self-assigned this Feb 26, 2023

asgrim reviewed Feb 27, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

resources/schema.xsd Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch from f9cb116 to c39d76d Compare February 28, 2023 19:34

lcobucci mentioned this pull request Feb 28, 2023

SEGFAULTs consistently happening on CI #740

Open

asgrim approved these changes Mar 1, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Ocramius approved these changes Mar 1, 2023

View reviewed changes

lcobucci force-pushed the support-baseline-configuration branch from c39d76d to aeac38f Compare March 1, 2023 21:03

lcobucci force-pushed the support-baseline-configuration branch 3 times, most recently from 4dab6f3 to e19974d Compare March 1, 2023 22:49

lcobucci added 2 commits March 1, 2023 23:53

Ensure data providers are static

3013c0f

PHPUnit 10.x only accepts static data providers, so... Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

lcobucci mentioned this pull request Mar 2, 2023

Upgrade to PHPUnit v10 #741

Open

lcobucci added 2 commits March 2, 2023 01:27

Move away from deprecated MockObject#withConsecutive()

29ddca2

More info: sebastianbergmann/phpunit#5063 Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Upgrade to PHPUnit v10

d72bef7

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Ocramius approved these changes Mar 2, 2023

View reviewed changes

lcobucci added 7 commits March 2, 2023 23:44

Unblock PHPUnit upgrade by enabling PCOV

d5789e6

Given the plans for laminas-continuous-integration-action v2 is to always ship PCOV, we can simply enable it here to allow us to detach the two processes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Implement regex-based baseline for changes

bb5dd01

This adds (lazy) filtering capabilities to detected changes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Parse and apply baseline from configuration

4898a8e

This integrates the changes filter into the backward compatibility check command, parsing the configuration file prior to any process to ease the integration of new properties. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Make configuration parsing more flexible

3bb70e2

This moves responsibilities around and introduces abstractions to support different file formats with less effort. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Implement XML configuration parser

8765e3d

This ships a parser and the expected schema to ease the validation of XML documents. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Make XML the default configuration format

e1c9698

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Remove unused JSON parser

cdeca27

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

lcobucci force-pushed the support-baseline-configuration branch from e19974d to cdeca27 Compare March 2, 2023 22:50

asgrim reviewed Mar 14, 2023

View reviewed changes

azjezz reviewed Mar 19, 2023

View reviewed changes

Ocramius mentioned this pull request Mar 29, 2023

unrecognized node type PhpParser\Node\Expr\FuncCall #743

Open

Ocramius removed this from the 8.4.0 milestone Nov 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support baseline configuration #737

Support baseline configuration #737

lcobucci commented Feb 15, 2023

lcobucci commented Feb 15, 2023

Ocramius commented Feb 15, 2023

lcobucci commented Feb 16, 2023

asgrim left a comment

Ocramius commented Feb 26, 2023

lcobucci commented Feb 26, 2023

lcobucci commented Feb 27, 2023

asgrim left a comment

asgrim left a comment

Ocramius left a comment

lcobucci commented Mar 1, 2023

Ocramius left a comment

Ocramius commented Mar 2, 2023

asgrim Mar 14, 2023

azjezz Mar 19, 2023

Support baseline configuration #737

Are you sure you want to change the base?

Support baseline configuration #737

Conversation

lcobucci commented Feb 15, 2023

lcobucci commented Feb 15, 2023

Ocramius commented Feb 15, 2023

lcobucci commented Feb 16, 2023

asgrim left a comment

Choose a reason for hiding this comment

Ocramius commented Feb 26, 2023

lcobucci commented Feb 26, 2023

lcobucci commented Feb 27, 2023

asgrim left a comment

Choose a reason for hiding this comment

asgrim left a comment

Choose a reason for hiding this comment

Ocramius left a comment

Choose a reason for hiding this comment

lcobucci commented Mar 1, 2023

Ocramius left a comment

Choose a reason for hiding this comment

Ocramius commented Mar 2, 2023

asgrim Mar 14, 2023

Choose a reason for hiding this comment

azjezz Mar 19, 2023

Choose a reason for hiding this comment