(GH-397) - Honour default symlink when additional symlinks delcared

[jordanbreen28]

Summary

Before, declaring a symlink would overwrite the symlink to the current module.
This is not what we would want for testing, and we should be able to declare additional symlinks to the default one.
Now, when extra symlinks declared, we merge into the auto_symlink, and if not, operate as before.

Additional Context

A .fixtures.yml like below will now work:

---
fixtures:
  repositories:
    puppetlabs-firewall:
      repo: https://github.com/puppetlabs/puppetlabs-firewall
      scm: git
    puppetlabs-peadm:
      repo: https://github.com/puppetlabs/puppetlabs-peadm
      scm: git
  symlinks:
      test_module: "#{source_dir}"
      peadm_spec: "#{source_dir}/spec/fixtures/modules/puppetlabs-peadm/spec/acceptance/peadm_spec/"

Console output:

I, [2024-02-01T17:04:02.236471 #84485]  INFO -- : Creating symlink from spec/fixtures/modules/test_module to /Users/jordan.breen/Desktop/repos/test_module
I, [2024-02-01T17:04:02.236812 #84485]  INFO -- : Creating symlink from spec/fixtures/modules/peadm_spec to /Users/jordan.breen/Desktop/repos/test_module/spec/fixtures/modules/puppetlabs-peadm/spec/acceptance/peadm_spec/

Related Issues (if any)

Fixes #397

Checklist

• 🟢 Spec tests.
• 🟢 Acceptance tests.
• Manually verified.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (157ed92) 41.71% compared to head (5745b70) 41.71%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #431   +/-   ##
=======================================
  Coverage   41.71%   41.71%           
=======================================
  Files          10       10           
  Lines         676      676           
=======================================
  Hits          282      282           
  Misses        394      394           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[LukasAud]

LGTM

[TheMeier]

Well this breaks our ancient setup where we used puppetlabs_spec_helper for a control_repository. (yes I know there is better ways like onceover now)
Linking the control repo back into spec/fixtures/modules leads to this error:

     Puppet::ParseError:
       Internal Error: Attempt to redefine loader named '<path of the repo>'

[jordanbreen28]

@TheMeier puppetlabs_spec_helper has the following that can be used for control repos

fixtures:
  repositories:
    firewall: "https://github.com/puppetlabs/puppetlabs-firewall.git"
    stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
    control_repo:
      repo: "https://github.com/puppetlabs/control-repo"
      target: "spec/fixtures/control_repos"

you should be able to alter the target as you see fit. Hope this helps