Fix the loading of project configuration before cleanup

[rolandsaven]

I came across an issue with the clean command when multiple applications are set up using the include property in the global codeception.yml.

Content of codeception.yml

include:
  - applications/*/
  - plugins/*/

Before the changes:

# php vendor/bin/codecept clean
Cleaning up output /var/www/html/tests/_output/...
Cleaning up output /var/www/html/tests/_output/...
Cleaning up output /var/www/html/plugins/someRandomPlugin/tests/_output/...

After the changes:

# php vendor/bin/codecept clean
Cleaning up output /var/www/html/tests/_output/...
Cleaning up output /var/www/html/applications/someRandomApplication/tests/_output/...
Cleaning up output /var/www/html/plugins/someRandomPlugin/tests/_output/...

Let me know if that is ok

[Naktibalda]

We have tests of include functionality in https://github.com/Codeception/Codeception/blob/4.1/tests/cli/IncludedCest.php

Could you add another test method to run clean command and verify the output?

[rolandsaven]

hey @Naktibalda, that is fine just submitted it but I wonder what would be your proposal for the failing errors on windows?

It seems like the generated paths on windows are wrong ...\pianist\tests/... - could it be that it's using the string from within the configuration file? Would realpath() help in Configuration::logDir() or somewhere in Configuration::outputDir())?

[Naktibalda]

Yes, it looks like / is coming from included configuration.

Nothing is broken, I think that it would be safer to fix the test by making it check for / instead of {$ds} in appropriate places.

[rolandsaven]

make sense @Naktibalda - fixed

yeah, it's during assign from config where it goes south - here and here

[Naktibalda]

Thanks, I tested your change and it really solves the problem.

I discovered 2 issues while testing it:

1. The test deletes .gitkeep files in _output directories, so it is difficult to rerun it and it makes unwanted changes in working copy when testing locally. I will change doEmptyDir method to leave .gitkeep files.
2. Test passed in 5.0 branch even though it was supposed to fail - test execution stopped on failed assertion but the outcome was PASSED.

IncludedCest: Clean included
Signature: IncludedCest:cleanIncluded
Test: tests/cli/IncludedCest.php:cleanIncluded
Scenario --
  creating dirs
 I am in path "tests/data/included"
  Moved to /.../Codeception/tests/data/included
 I execute command "clean"
  Cleaning up output /.../Codeception/tests/data/included/_log/...
  Cleaning up output /.../Codeception/tests/data/included/_log/...
  Cleaning up output /.../Codeception/tests/data/included/jazz/tests/_log/...
  Cleaning up output /.../Codeception/tests/data/included/jazz/pianist/tests/_log/...
  Done
 I see in shell output "included/_log"
 I see in shell output "included/jazz/tests/_log"
 I see in shell output "included/jazz/pianist/tests/_log"
 I see in shell output "included/shire/tests/_log"
 PASSED

IncludedCest: Clean included
Signature: IncludedCest:cleanIncluded
Test: tests/cli/IncludedCest.php:cleanIncluded
Scenario --
  creating dirs
 I am in path "tests/data/included"
  Moved to /.../Codeception/tests/data/included
 I execute command "clean"
  Cleaning up output /.../Codeception/tests/data/included/_log/...
  Cleaning up output /.../Codeception/tests/data/included/_log/...
  Cleaning up output /.../Codeception/tests/data/included/jazz/tests/_log/...
  Cleaning up output /.../Codeception/tests/data/included/jazz/pianist/tests/_log/...
  Done
 I see in shell output "included/_log"
 I see in shell output "included/foo/tests/_log"
 PASSED

  deleting dirs