Address #137

report shows  `originalPath`, `modifiedPath`, `path`, `rawPath`, and `gitRepoPath` / `gitFilePath`

Author: daveshanley

cmd/loaders.go

@@ -331,3 +331,10 @@ func displayLabelForHTML(raw string) string {
 	}
 	return filepath.Base(raw)
 }
+
+func sourceLabelForReport(raw string) string {
+	if isHTTPURL(raw) {
+		return sanitizeURLLabel(raw)
+	}
+	return raw
+}

cmd/report.go

@@ -70,6 +70,8 @@ func runLeftRightReport(left, right string, opts summaryOpts, breakingConfig *wh
 	defer result.Release()
 	flat := FlattenReportWithParameterNames(createReport(commits[0]), result.Changerator.ParameterNames)
 	flat.Commit = nil
+	flat.OriginalPath = sourceLabelForReport(left)
+	flat.ModifiedPath = sourceLabelForReport(right)
 	return flat, nil
 }
 

cmd/report_test.go

@@ -5,6 +5,8 @@ package cmd
 
 import (
 	"encoding/json"
+	"net/http"
+	"net/http/httptest"
 	"os"
 	"path/filepath"
 	"strings"
@@ -90,11 +92,39 @@ func TestRunLeftRightReport_Success(t *testing.T) {
 	assert.NotEmpty(t, report.Changes)
 	assert.NotEmpty(t, report.DateGenerated)
 	assert.Nil(t, report.Commit)
+	assert.Equal(t, "../sample-specs/petstorev3-original.json", report.OriginalPath)
+	assert.Equal(t, "../sample-specs/petstorev3.json", report.ModifiedPath)
 	assert.Contains(t, report.Summary, "paths")
 	assert.Equal(t, 30, report.Summary["paths"].Total)
 	assert.Equal(t, 16, report.Summary["paths"].Breaking)
 }
 
+func TestRunLeftRightReport_SanitizesURLSourceMetadata(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path == "/left.yaml" {
+			_, _ = w.Write([]byte("openapi: 3.0.3\ninfo:\n  title: Left\n  version: '1.0'\npaths: {}\n"))
+			return
+		}
+		_, _ = w.Write([]byte("openapi: 3.0.3\ninfo:\n  title: Right\n  version: '1.1'\npaths:\n  /pets:\n    get:\n      responses:\n        \"200\":\n          description: ok\n"))
+	}))
+	defer server.Close()
+
+	leftURL := server.URL + "/left.yaml?token=left-secret#frag"
+	rightURL := server.URL + "/right.yaml?token=right-secret#frag"
+
+	report, err := runLeftRightReport(leftURL, rightURL, summaryOpts{noColor: true}, nil)
+
+	require.NoError(t, err)
+	require.NotNil(t, report)
+	assert.Equal(t, server.URL+"/left.yaml", report.OriginalPath)
+	assert.Equal(t, server.URL+"/right.yaml", report.ModifiedPath)
+
+	encoded, err := json.Marshal(report)
+	require.NoError(t, err)
+	assert.NotContains(t, string(encoded), "left-secret")
+	assert.NotContains(t, string(encoded), "right-secret")
+}
+
 func TestRunLeftRightReport_SummaryIncludesDocumentLevelOpenAPIChanges(t *testing.T) {
 	dir := t.TempDir()
 
@@ -222,6 +252,8 @@ func TestReportCommand_GitRefUsesLeftRightMode(t *testing.T) {
 	})
 
 	assert.Contains(t, output, `"changes"`)
+	assert.Contains(t, output, `"originalPath": "HEAD:sample-specs/petstorev3-original.json"`)
+	assert.Contains(t, output, `"modifiedPath": "sample-specs/petstorev3.json"`)
 	assert.Contains(t, output, `"summary"`)
 	assert.NotContains(t, output, `"reports"`)
 }

model/report.go

@@ -77,6 +77,8 @@ type Report struct {
 type FlatReport struct {
 	Summary       map[string]*reports.Changed `json:"reportSummary"`
 	Changes       []*HashedChange             `json:"changes"`
+	OriginalPath  string                      `json:"originalPath,omitempty"`
+	ModifiedPath  string                      `json:"modifiedPath,omitempty"`
 	DateGenerated string                      `json:"dateGenerated,omitempty"`
 	Commit        *Commit                     `gorm:"foreignKey:ID" json:"commitDetails,omitempty"`
 }