Skip to content

Fix missing absolute path resolving in ParamsLoader #6828

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

Jump to bottom
Merged
merged 1 commit into from
Feb 20, 2025
Merged

Fix missing absolute path resolving in ParamsLoader #6828

merged 1 commit into from
Feb 20, 2025

Conversation

@garvinhicking
Copy link
Contributor

@garvinhicking garvinhicking commented Feb 17, 2025 •
edited
Loading

This is a regression bugfix for release 5.2.0.

With #6767 the ParamsLoader was streamlined, but when previously $paramsFile was passed to the loader methods, now only $paramStorage is passed, which misses getting converted to an absolute path via codecept_absolute_path().

This patch restores utilizing $paramsFile and also uses that to emit warnings when a file cannot be loaded.

This bug caused missing file resolving, because software like TYPO3 for example executes tests from the repo directory typo3/sysext/core/Tests/codeception.yml and uses:

params:
  - parameters.yml
  - env.yml

and expects that the file is found next to the codeception.yml file in the same directory, and thus a breaking change.

Closes #6829

@garvinhicking
Fix missing absolute path resolving in ParamsLoader
5affa1d 
This is a regression bugfix for release 5.2.0.

With Codeception#6767 the ParamsLoader was streamlined, but when previously `$paramsFile` was passed to the loader methods, now only `$paramStorage` is passed, which misses getting converted to an absolute path via `codecept_absolute_path()`.

This patch restores utilizing `$paramsFile` and also uses that to emit warnings when a file cannot be loaded.

This bug caused missing file resolving, because software like TYPO3 for example executes tests from the repo directory `typo3/sysext/core/Tests/codeception.yml` and uses:

```
params:
  - parameters.yml
  - env.yml
```

and expects that the file is found next to the `codeception.yml` file in the same directory, and thus a breaking change.
grossmannmartin added a commit to shopsys/shopsys that referenced this pull request Feb 17, 2025
@grossmannmartin
conflicted codeception/codeception 5.2.0
6d5b858 
- see Codeception/Codeception#6828
@grossmannmartin grossmannmartin mentioned this pull request Feb 17, 2025
Merged
1 task
grossmannmartin added a commit to shopsys/shopsys that referenced this pull request Feb 17, 2025
@grossmannmartin
conflicted codeception/codeception 5.2.0
5bbdad5 
- see Codeception/Codeception#6828
@TavoNiievez TavoNiievez merged commit 7df4ce2 into Codeception:main Feb 20, 2025
@TavoNiievez
Copy link
Member

TavoNiievez commented Feb 20, 2025

@garvinhicking Would there be any way to have tests for this?

We need to verify that it does not change again in the future as our CI did not notice this error.

I will release version 5.2.1 today for this and PHPUnit 12 support. Thank you very much.

@garvinhicking
Copy link
Contributor Author

garvinhicking commented Feb 20, 2025

Thanks for the trust in advance. :) I'll see what I can do for some tests, I haven't yet checked this out, but should be possible. Give me a day or two.

@garvinhicking
Copy link
Contributor Author

garvinhicking commented Feb 20, 2025 •
edited
Loading

@TavoNiievez I tried to get the tests up and running, according to the dockerized README in tests (https://github.com/Codeception/Codeception/blob/main/tests/README.md#dockerized-testing):

git clone ...
cd tests
docker-compose build
docker-compose up -d
docker-composer run --rm codecept run cli

which just yields:

Codeception PHP Testing Framework v5.2.1 https://stand-with-ukraine.pp.ua/
[Seed] 1553456819

In Assert.php line 2286:

  Result code was 1.

  Could not open input file: /repo/codecept

Seems that /repo/ is a mount to my cwd tests but there's no codecept directory and I wonder where it could stem from. What step could I be missing?

I assume that I would add tests with some dummy codeception.yaml files plus configured params: ... files with dummy files too, and then do assertions on non/failure variants, and do that in tests/cli/GlobalCommandOptionCest.php. However I need to get the tests to actually run, and my experience with codeception is just one as a consumer right now. If you have some docs to point me to to get this up and running, I'd be more than happy to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TavoNiievez TavoNiievez TavoNiievez approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ParamsLoader references path of extra configuration files not resolved by their absolute path

2 participants

@garvinhicking @TavoNiievez