pkg/report: change report generation

Author: tarasmadan

pkg/report/report.go

@@ -311,8 +311,11 @@ func fixReports(reporter *Reporter, reports []*Report, skipPos []int) []*Report
 			continue
 		}
 		if nextReportPos < rep.EndPos {
-			reports[i] = reporter.ParseFrom(rep.Output[:nextReportPos], skipPos[i])
-			reports[i].Output = rep.Output
+			shorterReport := reporter.ParseFrom(rep.Output[:nextReportPos], skipPos[i])
+			if !shorterReport.Corrupted {
+				reports[i] = reporter.ParseFrom(rep.Output[:nextReportPos], skipPos[i])
+				reports[i].Output = rep.Output
+			}
 		}
 	}
 	return reports
@@ -972,13 +975,15 @@ func TitleToCrashType(title string) crash.Type {
 	return crash.UnknownType
 }
 
-const reportSeparator = "\n<<<<<<<<<<<<<<< tail report >>>>>>>>>>>>>>>\n\n"
+const reportSeparator = "<<<<<<<<<<<<<<< tail report >>>>>>>>>>>>>>>"
 
 func MergeReportBytes(reps []*Report) []byte {
 	var res []byte
-	for _, rep := range reps {
+	for i, rep := range reps {
+		if i > 0 {
+			res = append(res, []byte(reportSeparator)...)
+		}
 		res = append(res, rep.Report...)
-		res = append(res, []byte(reportSeparator)...)
 	}
 	return res
 }

pkg/report/report_test.go

@@ -31,20 +31,21 @@ func TestParse(t *testing.T) {
 }
 
 type ParseTest struct {
-	FileName   string
-	Log        []byte
-	Title      string
-	AltTitles  []string
-	Type       crash.Type
-	Frame      string
-	StartLine  string
-	EndLine    string
-	Corrupted  bool
-	Suppressed bool
-	HasReport  bool
-	Report     []byte
-	Executor   string
-	ContextIDs string
+	FileName    string
+	Log         []byte
+	Title       string
+	AltTitles   []string
+	Type        crash.Type
+	Frame       string
+	StartLine   string
+	EndLine     string
+	Corrupted   bool
+	Suppressed  bool
+	HasReport   bool
+	Report      []byte
+	TailReports [][]byte
+	Executor    string
+	ContextIDs  []string
 	// Only used in report parsing:
 	corruptedReason string
 }
@@ -59,12 +60,18 @@ func (test *ParseTest) Equal(other *ParseTest) bool {
 	if !reflect.DeepEqual(test.AltTitles, other.AltTitles) {
 		return false
 	}
+	// Check frame only if it was present in the test file.
 	if test.Frame != "" && test.Frame != other.Frame {
 		return false
 	}
+	// Check report only if it was present in the test file.
 	if test.HasReport && !bytes.Equal(test.Report, other.Report) {
 		return false
 	}
+	// Check tail reports only if they were present in the test file.
+	if test.HasReport && !reflect.DeepEqual(test.TailReports, other.TailReports) {
+		return false
+	}
 	return test.Executor == other.Executor
 }
 
@@ -91,8 +98,8 @@ func (test *ParseTest) Headers() []byte {
 	if test.Executor != "" {
 		fmt.Fprintf(buf, "EXECUTOR: %s\n", test.Executor)
 	}
-	if test.ContextIDs != "" {
-		fmt.Fprintf(buf, "CONTEXTS: %s\n", test.ContextIDs)
+	if len(test.ContextIDs) != 0 {
+		fmt.Fprintf(buf, "CONTEXTS: %v\n", test.ContextIDs)
 	}
 	return buf.Bytes()
 }
@@ -113,6 +120,7 @@ func parseReport(t *testing.T, reporter *Reporter, testFileName string) *ParseTe
 		phaseHeaders = iota
 		phaseLog
 		phaseReport
+		phaseTailReports
 	)
 	phase := phaseHeaders
 	test := &ParseTest{
@@ -121,6 +129,14 @@ func parseReport(t *testing.T, reporter *Reporter, testFileName string) *ParseTe
 	prevEmptyLine := false
 	s := bufio.NewScanner(bytes.NewReader(data))
 	for s.Scan() {
+
+		if string(s.Bytes()) == "TAIL REPORTS:" {
+			test.HasReport = true // we want both, REPORT and TAIL REPORT to be present
+			test.TailReports = [][]byte{{}}
+			phase = phaseTailReports
+			continue
+		}
+
 		switch phase {
 		case phaseHeaders:
 			ln := s.Text()
@@ -140,11 +156,18 @@ func parseReport(t *testing.T, reporter *Reporter, testFileName string) *ParseTe
 		case phaseReport:
 			test.Report = append(test.Report, s.Bytes()...)
 			test.Report = append(test.Report, '\n')
+		case phaseTailReports:
+			if string(s.Bytes()) == reportSeparator {
+				test.TailReports = append(test.TailReports, []byte{})
+				continue
+			}
+			test.TailReports[len(test.TailReports)-1] = append(test.TailReports[len(test.TailReports)-1], s.Bytes()...)
+			test.TailReports[len(test.TailReports)-1] = append(test.TailReports[len(test.TailReports)-1], []byte{'\n'}...)
 		}
 		prevEmptyLine = len(s.Bytes()) == 0
 	}
 	if s.Err() != nil {
-		t.Fatalf("file scanning error: %v", s.Err())
+		t.Fatalf("file scanningerror: %v", s.Err())
 	}
 	if len(test.Log) == 0 {
 		t.Fatalf("can't find log in input file")
@@ -201,61 +224,87 @@ func parseHeaderLine(t *testing.T, test *ParseTest, ln string) {
 	case strings.HasPrefix(ln, executorPrefix):
 		test.Executor = ln[len(executorPrefix):]
 	case strings.HasPrefix(ln, contextidPrefix):
-		test.ContextIDs = ln[len(contextidPrefix):]
+		test.ContextIDs = strings.Split(ln[len(contextidPrefix):], ", ")
 	default:
 		t.Fatalf("unknown header field %q", ln)
 	}
 }
 
-func testFromReport(rep *Report) *ParseTest {
-	if rep == nil {
+func testFromReports(reps ...*Report) *ParseTest {
+	if reps == nil || len(reps) > 0 && reps[0] == nil {
 		return &ParseTest{}
 	}
 	ret := &ParseTest{
-		Title:           rep.Title,
-		AltTitles:       rep.AltTitles,
-		Corrupted:       rep.Corrupted,
-		corruptedReason: rep.CorruptedReason,
-		Suppressed:      rep.Suppressed,
-		Type:            TitleToCrashType(rep.Title),
-		Frame:           rep.Frame,
-		Report:          rep.Report,
-	}
-	if rep.Executor != nil {
-		ret.Executor = fmt.Sprintf("proc=%d, id=%d", rep.Executor.ProcID, rep.Executor.ExecID)
+		Title:           reps[0].Title,
+		AltTitles:       reps[0].AltTitles,
+		Corrupted:       reps[0].Corrupted,
+		corruptedReason: reps[0].CorruptedReason,
+		Suppressed:      reps[0].Suppressed,
+		Type:            TitleToCrashType(reps[0].Title),
+		Frame:           reps[0].Frame,
+		Report:          reps[0].Report,
+	}
+	if reps[0].Executor != nil {
+		ret.Executor = fmt.Sprintf("proc=%d, id=%d", reps[0].Executor.ProcID, reps[0].Executor.ExecID)
 	}
 	sort.Strings(ret.AltTitles)
+	ret.ContextIDs = append(ret.ContextIDs, reps[0].ContextID)
+	for i := 1; i < len(reps); i++ {
+		ret.TailReports = append(ret.TailReports, reps[i].Report)
+		ret.ContextIDs = append(ret.ContextIDs, reps[i].ContextID)
+	}
 	return ret
 }
 
+/*func testParseAll(t *testing.T, reporter *Reporter, testFileName string) {
+	test := parseReport(t, reporter, testFileName)
+	gotReports := ParseAll(reporter, test.Log, 0)
+	gotIDs := mergeReportContextIDs(gotReports)
+	mergedReport := MergeReportBytes(gotReports)
+	if !bytes.Equal(mergedReport, test.Report) || gotIDs != test.ContextIDs {
+		if *flagUpdate {
+			updateReportTest(t, test, &ParseTest{
+				ContextIDs: gotIDs,
+				Report:     mergedReport})
+		}
+		assert.Equal(t, test.ContextIDs, gotIDs, "extracted wrong Thread or CPU ids")
+		assert.Equal(t, string(test.Report), string(mergedReport), "extracted wrong reports")
+	}
+}*/
+
 func testParseImpl(t *testing.T, reporter *Reporter, test *ParseTest) {
-	rep := reporter.Parse(test.Log)
+	gotReports := ParseAll(reporter, test.Log, 0)
+
+	var firstReport *Report
+	if len(gotReports) > 0 {
+		firstReport = gotReports[0]
+	}
 	containsCrash := reporter.ContainsCrash(test.Log)
 	expectCrash := (test.Title != "")
 	if expectCrash && !containsCrash {
 		t.Fatalf("did not find crash")
 	}
 	if !expectCrash && containsCrash {
-		t.Fatalf("found unexpected crash")
+		t.Fatalf("found unexpected crash: %s", firstReport.Title)
 	}
-	if rep != nil && rep.Title == "" {
+	if firstReport != nil && firstReport.Title == "" {
 		t.Fatalf("found crash, but title is empty")
 	}
-	parsed := testFromReport(rep)
+	parsed := testFromReports(gotReports...)
 	if !test.Equal(parsed) {
 		if *flagUpdate && test.StartLine+test.EndLine == "" {
 			updateReportTest(t, test, parsed)
 		}
 		t.Fatalf("want:\n%s\ngot:\n%sCorrupted reason: %q",
 			test.Headers(), parsed.Headers(), parsed.corruptedReason)
 	}
-	if parsed.Title != "" && len(rep.Report) == 0 {
+	if parsed.Title != "" && len(firstReport.Report) == 0 {
 		t.Fatalf("found crash message but report is empty")
 	}
-	if rep == nil {
+	if firstReport == nil {
 		return
 	}
-	checkReport(t, reporter, rep, test)
+	checkReport(t, reporter, firstReport, test)
 }
 
 func checkReport(t *testing.T, reporter *Reporter, rep *Report, test *ParseTest) {
@@ -292,11 +341,6 @@ func checkReport(t *testing.T, reporter *Reporter, rep *Report, test *ParseTest)
 		if rep1 == nil || rep1.Title != rep.Title || rep1.StartPos != rep.StartPos {
 			t.Fatalf("did not find the same report from rep.StartPos=%v", rep.StartPos)
 		}
-		// If we parse from EndPos, we must not find the same report.
-		rep2 := reporter.ParseFrom(test.Log, rep.EndPos)
-		if rep2 != nil && rep2.Title == rep.Title {
-			t.Fatalf("found the same report after rep.EndPos=%v", rep.EndPos)
-		}
 	}
 }
 
@@ -310,7 +354,13 @@ func updateReportTest(t *testing.T, test, parsed *ParseTest) {
 	fmt.Fprintf(buf, "\n%s", test.Log)
 	if test.HasReport {
 		fmt.Fprintf(buf, "REPORT:\n%s", parsed.Report)
+
+		if len(parsed.TailReports) > 0 {
+			fmt.Fprintf(buf, "TAIL REPORTS:\n")
+			buf.Write(bytes.Join(parsed.TailReports, []byte(reportSeparator+"\n")))
+		}
 	}
+
 	if err := os.WriteFile(test.FileName, buf.Bytes(), 0640); err != nil {
 		t.Logf("failed to update test file: %v", err)
 	}
@@ -402,7 +452,7 @@ func testSymbolizeFile(t *testing.T, reporter *Reporter, fn string) {
 	if err != nil {
 		t.Fatalf("failed to symbolize: %v", err)
 	}
-	parsed := testFromReport(rep)
+	parsed := testFromReports(rep)
 	if !test.Equal(parsed) {
 		if *flagUpdate {
 			updateReportTest(t, test, parsed)
@@ -558,26 +608,3 @@ func TestSplitReportBytes(t *testing.T) {
 		})
 	}
 }
-
-// TestParseAll's focus points are the ability to:
-// 1. parse multiple reports
-// 2. extract correct ThreadID/CpuID.
-func TestParseAll(t *testing.T) {
-	forEachFile(t, "parse_all", testParseAll)
-}
-
-func testParseAll(t *testing.T, reporter *Reporter, testFileName string) {
-	test := parseReport(t, reporter, testFileName)
-	gotReports := ParseAll(reporter, test.Log, 0)
-	gotIDs := mergeReportContextIDs(gotReports)
-	mergedReport := MergeReportBytes(gotReports)
-	if !bytes.Equal(mergedReport, test.Report) || gotIDs != test.ContextIDs {
-		if *flagUpdate {
-			updateReportTest(t, test, &ParseTest{
-				ContextIDs: gotIDs,
-				Report:     mergedReport})
-		}
-		assert.Equal(t, test.ContextIDs, gotIDs, "extracted wrong Thread or CPU ids")
-		assert.Equal(t, string(test.Report), string(mergedReport), "extracted wrong reports")
-	}
-}