(GH-189) - invalid fact correction for top scope structured fact

[jordanbreen28]

Summary

Prior to this PR, if you had a top scope structured fact like this in your manifest $::my_structured_fact['foo']['test'], lint would return an invalid correction when passed the fix flag.

Now, we have altered the top_scope_facts plugin, to first check if it is a structured fact, and if one is found using regex, apply different logic to fix.

Additional Context

Unstructured top scope fact:

$foo = $::my_structured_fact

when fixed:

bundle exec puppet-lint ./manifest.pp -f
FIXED: top scope fact instead of facts hash on line 1 (check: top_scope_facts)

$foo = $facts['my_structured_fact']

top scope structured fact (& not on allowlist):

$foo = $::my_structured_fact['foo']['test']

when fixed:

bundle exec puppet-lint ./manifest.pp -f
FIXED: top scope fact instead of facts hash on line 1 (check: top_scope_facts)

$foo = $facts['my_structured_fact']['foo']['test']

Related Issues (if any)

Fixes #189

Checklist

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6d5b00e) 93.13% compared to head (e4863b0) 93.15%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #190      +/-   ##
==========================================
+ Coverage   93.13%   93.15%   +0.01%     
==========================================
  Files          54       54              
  Lines        1763     1768       +5     
==========================================
+ Hits         1642     1647       +5     
  Misses        121      121              

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