fix: make gator output relative paths

[acpana]

Signed-off-by: Alex Pana 8968914+acpana@users.noreply.github.com

fixes #1640

This patch attaches the InputPath / OriginalPath to a Suite. We still use the absolute path for file lookups at run time (runTest).

Examples of how this works now in practice:

# relative dirs expand as expected
$ gator verify ./test/gator/verify/...

ok      ./test/gator/verify/more_suites/even_more/suite copy 2.yaml     0.007s
ok      ./test/gator/verify/more_suites/even_more/suite copy 3.yaml     0.010s
ok      ./test/gator/verify/more_suites/even_more/suite copy.yaml       0.007s
ok      ./test/gator/verify/more_suites/even_more/suite.yaml    0.009s
ok      ./test/gator/verify/more_suites/suite copy 2.yaml       0.006s
ok      ./test/gator/verify/more_suites/suite copy 3.yaml       0.009s
ok      ./test/gator/verify/more_suites/suite copy.yaml 0.008s
ok      ./test/gator/verify/more_suites/suite.yaml      0.010s
ok      ./test/gator/verify/suite.yaml  0.007s
PASS

# notice change for output without `./`
$ gator verify test/gator/verify/... 

ok      test/gator/verify/more_suites/even_more/suite copy 2.yaml       0.013s
ok      test/gator/verify/more_suites/even_more/suite copy 3.yaml       0.007s
ok      test/gator/verify/more_suites/even_more/suite copy.yaml 0.008s
ok      test/gator/verify/more_suites/even_more/suite.yaml      0.009s
ok      test/gator/verify/more_suites/suite copy 2.yaml 0.007s
ok      test/gator/verify/more_suites/suite copy 3.yaml 0.009s
ok      test/gator/verify/more_suites/suite copy.yaml   0.007s
ok      test/gator/verify/more_suites/suite.yaml        0.010s
ok      test/gator/verify/suite.yaml    0.007s
PASS

# yaml file
$ gator verify test/gator/verify/suite.yaml

ok      test/gator/verify/suite.yaml    0.010s
PASS

# pass absolute path as input, get absolute path
$ gator verify /pwd/gatekeeper/test/gator/verify/suite.yaml

ok      /pwd/gatekeeper/test/gator/verify/suite.yaml   0.007s
PASS

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 85.71429% with 3 lines in your changes missing coverage. Please review.

Project coverage is 53.60%. Comparing base (febba65) to head (e3243c1).
Report is 742 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/gator/read_suites.go	83.33%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2443      +/-   ##
==========================================
- Coverage   53.63%   53.60%   -0.03%     
==========================================
  Files         117      117              
  Lines       10281    10293      +12     
==========================================
+ Hits         5514     5518       +4     
- Misses       4346     4352       +6     
- Partials      421      423       +2     

Flag	Coverage Δ
unittests	53.60% <85.71%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[acpana]

in this file, right above lines 68-79 see how we create a fileSystem .

Since we pass that in and the absolute path, it's hard to print the results with the input path, given that we can traverse a directory.

Another way to tackle this problem, where we don't pass in the InputPath would be to push down the fileSystem/ absolute path creation to the point where we walk the directory or where we try to read a file. But I think that approach would require a more sweeping refactor.

[maxsmythe]

LGTM, thanks for doing this!

[ritazh]

LGTM
Thanks for the PR! @acpana!