Handle imports with same relative path

[CraigSiemens]

• Including yml files with the same filePath causes the second to be ignored. #1261

Changes

• Identify merged includes using the full path to the file rather than just filePath which can be relative to the basePath and not unique.
• Added comments to the path properties to make it clearer what they contain.
• Other minor cleanup (renaming a parameter and making things private).

[CraigSiemens]

I wouldn't mind some feedback on whether tests should be added to this (I assume they should) and what they would look like. I think it'd either need a new fixture or an existing on to be updated but I don't know the preferred path.

[yonaskolb]

Thanks @CraigSiemens, some great changes. Does #1275 also solve your issue? If so perhaps we can merge that first, and you can add your documentation on top.

In terms of a test case, adding it to Tests/Fixtures/paths_test.yml is probably a good place

[CraigSiemens]

I tried it out and #1275 does fix the issue too.

I'm working on rebasing my branch onto master. I did find some improvements for the cachedSpecFiles that I'll add into this branch.

[CraigSiemens]

This is revering a change from #1275. Internally the init creates the cachedSpecFiles so callers don't have to make it.

[CraigSiemens]

filePath, which is for the current spec, is not the correct key to use when looking for the specFile of an include that has it's own path.

[CraigSiemens]

@yonaskolb I believe I'm done rebasing/fixing so it's free for a re-review when you have a moment.

I've added in tests to paths_test.yml and verified they they failed before any of these changes were added to master.

I also made a couple minor changes to the usage of cachedSpecFiles, I left a reason for some of them above.

[yonaskolb]

Thanks @CraigSiemens, I can hopefully get to this soon.

@ma-oli would you mind casting an eye over this too, as you were recently in this area.

[ma-oli]

I’m off right now until Monday but I’m happy to have a look when I’m back.

[CraigSiemens]

Hey @ma-oli, have you had a chance to take a look at it yet?

[ma-oli]

Hey; sorry about the delay. I'm looking at it now and I'm seeing some issues. I'll keep you posted.

[yonaskolb]

This issue has also come in #1299

[ma-oli]

Using a relative path ( "-r ." for instance) as a project root results in this line throwing an unmatchedAbsolutePath error. We might want to use basePath?.absolute(), either here or in SpecLoader.

[CraigSiemens]

That's interesting, I'll try and take a look at that.

[ma-oli]

I think it's good but this breaks using a relative path as a project root. Shouldn't be a big deal to fix I think.

[CraigSiemens]

@ma-oli @yonaskolb I've added the fix for handling relative project paths.

[CraigSiemens]

@yonaskolb Any chance this could get merged since it's got an approval?

[yonaskolb]

@yonaskolb Any chance this could get merged since it's got an approval?

Yep, could you please add a changelog entry. Also does this fix #1299?

[CraigSiemens]

Yeah, it should fix that issue. I've merged in master and updated the changelog.

[yonaskolb]

Fantastic, thanks for all your work on this @CraigSiemens 🙏