Skip to content

[ci] we do not need to install flex globally anymore #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2022
Merged

[ci] we do not need to install flex globally anymore #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,6 @@ jobs:
- name: "Add PHPUnit matcher"
run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

- name: "Require symfony/flex"
run: composer global require --no-progress --no-scripts --no-plugins symfony/flex
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does the SYMFONY_VERSION env var work?
Wasn't the intend to name it SYMFONY_REQUIRE to let flex restrict the allowed range?

Copy link
Collaborator Author

@jrushlow jrushlow Jul 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We grab the version specified in SYMFONY_VERSION during each test when we are creating the isolated Symfony app for a particular test.

e.g. Run MakeEntityTest against Symfony 5.4

SYMFONY_VERSION=5.4.x-dev

  • the "global" composer install will install MakerBundle on PHP 8.1 against the highest depends (No flex needed). The installed depends for MakerBundle could be say Symfony 6.2.x-dev

  • vendor/bin/simple-phpunit --filter MakeEntityTest creates a "test project" using flex w/ 5.4 dependencies for each of the tests defined in MakeEntityTest under tests/tmp/cache/maker_app_HASH_5.4.x-dev. Then runs the test against that app and its depends (.../cache/maker_app_HASH_5.4.x-dev/vendor).

Wasn't the intend to name it SYMFONY_REQUIRE to let flex restrict the allowed range?

I honestly cant recall.

Back when we were using TravisCI, installing flex globally gave a perf boost in CI. Atleast that was the intent anyway. With Github Actions, the test suites run in about 9 minutes whether we have flex installed globally or not.

Copy link
Member

@nicolas-grekas nicolas-grekas Jul 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you can see in the CI, it's broken: "PHP 8.1 + @5.4.x-dev highest deps" does not run 5.4 but 6.2.
That is true with or without this PR.

I think that instead of removing flex, this PR should fix it's usage by renaming SYMFONY_VERSION to SYMFONY_REQUIRE

Copy link
Collaborator Author

@jrushlow jrushlow Jul 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even when we do that, 8d8a414, our "global" depends are still installing at 6.2 for the PHP 8.1 + @5.4.x-dev highest deps run: https://github.com/symfony/maker-bundle/runs/7211621223?check_suite_focus=true

The versions used in ~/composer.lock ("global") are not so much important. It's the flex projects we create for each "Make*Test" that use their own composer installed dependencies that matter.

When I replace SYMFONY_VERSION w/ SYMFONY_REQUIRE locally, e.g. SYMFONY_REQUIRE=5.4.x-dev vendor/bin/simple-phpunit --filter it_creates_a_new_class_basic - the flex app is no longer created using the 5.4 dependencies.

SYMFONY_REQUIRE:
image

SYMFONY_VERSION:
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, got it, sorry for the noise then!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries - Ryan & I were trying to figure out the reasoning for having flex installed globally yesterday and couldnt come up with anything other than a perf boost from back in the day.

The only time this gets tricky - we have a couple depends (and i cannot think of them off the top of my head) that are indirectly used in the tests from the "global" app will sometimes have a conflict. We generally have to introduce "legacy checks" in those instances to circumvent that. Though if i recall, these instances are limited to 1 or 2 tests.

Anywho, if there are ideas how we can make the tests a bit more DX friendly, I'm all ears...


- name: "Composer install"
uses: "ramsey/composer-install@v1"
with:
Expand Down
1 change: 0 additions & 1 deletion appveyor.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ install:
- del composer.phar
- rename composer-stable.phar composer.phar
- cd C:\projects\maker-bundle
- composer global require --no-progress --no-scripts --no-plugins symfony/flex
- IF %dependencies%==highest appveyor-retry composer update --no-progress --no-suggest --ansi
- composer install --no-interaction --no-progress --ansi --no-scripts --working-dir=tools/twigcs
- composer install --no-interaction --no-progress --ansi --no-scripts --working-dir=tools/php-cs-fixer
Expand Down