Support fixture paths for file fields in mediaExpandEntityFieldsFixtures

[ericgsmith]

After upgrading to lastest version of Drupal Driver a lot of our tests failed due to how we were using creating media entities.

I'm raising this here as I think it can be solved here, or at least iron out a little inconsistency.

Drupal driver 2.5.0 adds a FileHandler - the release notes say that :

The Drupal 8+ FileHandler previously extended EntityReferenceHandler and tried a name-based entity lookup on raw file paths, which never produced a usable file entity

This is not correct - we have been using an entity reference value for by creating the file and then referencing it by filename which the entity reference handler correctly returned.

E.g:

    Given the following managed files:
      | path                               |
      | documents/test.docx |
    And the following media "document" exist:
      | name                      | field_media_document |
      | Test DOCX media | test.docx                          |

I was going to open an issue there, but then I noticed we were doing something completely different for our image test - there we are just passing in the path based from our fixtures, e.g.

    And the following media "image" exist:
      | name                   | field_media_image     |
      | Test PNG media | images/500x200.png |

And these tests are still passing with the new driver.

It looks like mediaExpandEntityFieldsFixtures in MediaTrait is what allows these tests to pass.

The check at https://github.com/drevops/behat-steps/blob/main/src/Drupal/MediaTrait.php#L391 updates images/500x200.png to the fixture path - but as it doesn't run apply to file fields, we can't just use documents/test.docx for field_media_document

I think the simplest is now that the driver properly supports file fields, expand that condition to also apply to image and file fields?

[ericgsmith]

This pattern looks to be the same as followed here https://github.com/drevops/behat-steps/blob/main/tests/behat/features/drupal_media.feature#L8 and https://github.com/drevops/behat-steps/blob/main/tests/behat/features/drupal_media.feature#L25 - haven't check but I'm assuming the tests will then currently fail with the new Driver version.

[ericgsmith]

Added draft change in #630 - tests not running as image failed to pull, in draft as I have not run the tests locally yet, from a scan of the existing drupal_media test we should be able to remove the steps creating the file entities - it looks like even for some images it does this currently, which looks like it would be redundant.

[ericgsmith]

Locally, confirmed issue on main.

Setup fresh build on main branch and confirmed drupal driver is version 2.5.0
Confirmed drupal media feature is failing

ahoy test-bdd tests/behat/features/drupal_media.feature

    And the following media "document" exist:                                # FeatureContext::mediaCreate()
      | name                | field_media_document |
      | Test media document | document.pdf         |
      Warning: file_get_contents(document.pdf): Failed to open stream: No such file or directory in build/vendor/drupal/drupal-driver/src/Drupal/Driver/Fields/Drupal8/FileHandler.php line 18

Results in

--- Failed scenarios:

    tests/behat/features/drupal_media.feature:7 (on line 25)
    tests/behat/features/drupal_media.feature:36 (on line 40)

Checked out expand-file-fields branch - tests now pass.

Added subsequent commit was to remove unnecessary / redundant file entity creation - tests still pass.

[ericgsmith]

Ah - still failures on other parts.

Looks like the file download test does a similar setup for fields on nodes - so this change won't do anything for that scenario.

Perhaps we need a different approach here, maybe something like a Transform that can replace a token with the fixture path - or a fallback in the field handler to entity reference if the provided arg isn't found? In that case, its more a driver / extension issue.

Interested to get maintainer feedback on the issue.