package packp import ( "bytes" "fmt" "regexp" "testing" "github.com/stretchr/testify/suite" "github.com/go-git/go-git/v6/plumbing" ) type ReportStatusSuite struct { suite.Suite } func TestReportStatusSuite(t *testing.T) { t.Parallel() suite.Run(t, new(ReportStatusSuite)) } func (s *ReportStatusSuite) TestError() { rs := &ReportStatus{} rs.UnpackStatus = "ok" s.Nil(rs.Error()) rs.UnpackStatus = "OK" s.Regexp(regexp.MustCompile("unpack error: OK"), rs.Error()) rs.UnpackStatus = "" s.Regexp(regexp.MustCompile("unpack error: "), rs.Error()) cs := &CommandStatus{ReferenceName: plumbing.ReferenceName("ref")} rs.UnpackStatus = "ok" rs.CommandStatuses = append(rs.CommandStatuses, cs) cs.Status = "ok" s.NoError(rs.Error()) cs.Status = "OK" // According to git protocol, if unpack status is "ok", the overall status // is ok even if some command statuses have errors. However, canonical Git // still errors on the first received command-status error. s.Regexp(regexp.MustCompile("command error on ref: OK"), rs.Error()) cs.Status = "" s.Regexp(regexp.MustCompile("command error on ref: "), rs.Error()) } func (s *ReportStatusSuite) testEncodeDecodeOk(rs *ReportStatus, lines ...string) { s.testDecodeOk(rs, lines...) s.testEncodeOk(rs, lines...) } func (s *ReportStatusSuite) testDecodeOk(expected *ReportStatus, lines ...string) { r := toPktLines(s.T(), lines) rs := &ReportStatus{} s.Nil(rs.Decode(r)) s.Equal(expected, rs) } func (s *ReportStatusSuite) testDecodeError(errorMatch string, lines ...string) { r := toPktLines(s.T(), lines) rs := &ReportStatus{} s.Regexp(regexp.MustCompile(errorMatch), rs.Decode(r)) } func (s *ReportStatusSuite) testEncodeOk(input *ReportStatus, lines ...string) { expected := pktlines(s.T(), lines...) var buf bytes.Buffer s.Nil(input.Encode(&buf)) obtained := buf.Bytes() comment := fmt.Sprintf("\nobtained = %s\nexpected = %s\n", string(obtained), string(expected)) s.Equal(expected, obtained, comment) } func (s *ReportStatusSuite) TestEncodeDecodeOkOneReference() { rs := &ReportStatus{} rs.UnpackStatus = "ok" rs.CommandStatuses = []*CommandStatus{{ ReferenceName: plumbing.ReferenceName("refs/heads/master"), Status: "ok", }} s.testEncodeDecodeOk(rs, "unpack ok\n", "ok refs/heads/master\n", "", ) } func (s *ReportStatusSuite) TestEncodeDecodeOkOneReferenceFailed() { rs := &ReportStatus{} rs.UnpackStatus = "my error" rs.CommandStatuses = []*CommandStatus{{ ReferenceName: plumbing.ReferenceName("refs/heads/master"), Status: "command error", }} s.testEncodeDecodeOk(rs, "unpack my error\n", "ng refs/heads/master command error\n", "", ) } func (s *ReportStatusSuite) TestEncodeDecodeOkMoreReferences() { rs := &ReportStatus{} rs.UnpackStatus = "ok" rs.CommandStatuses = []*CommandStatus{{ ReferenceName: plumbing.ReferenceName("refs/heads/master"), Status: "ok", }, { ReferenceName: plumbing.ReferenceName("refs/heads/a"), Status: "ok", }, { ReferenceName: plumbing.ReferenceName("refs/heads/b"), Status: "ok", }} s.testEncodeDecodeOk(rs, "unpack ok\n", "ok refs/heads/master\n", "ok refs/heads/a\n", "ok refs/heads/b\n", "", ) } func (s *ReportStatusSuite) TestEncodeDecodeOkMoreReferencesFailed() { rs := &ReportStatus{} rs.UnpackStatus = "my error" rs.CommandStatuses = []*CommandStatus{{ ReferenceName: plumbing.ReferenceName("refs/heads/master"), Status: "ok", }, { ReferenceName: plumbing.ReferenceName("refs/heads/a"), Status: "command error", }, { ReferenceName: plumbing.ReferenceName("refs/heads/b"), Status: "ok", }} s.testEncodeDecodeOk(rs, "unpack my error\n", "ok refs/heads/master\n", "ng refs/heads/a command error\n", "ok refs/heads/b\n", "", ) } func (s *ReportStatusSuite) TestEncodeDecodeOkUnpackWithFailedCommands() { rs := &ReportStatus{} rs.UnpackStatus = "ok" rs.CommandStatuses = []*CommandStatus{{ ReferenceName: plumbing.ReferenceName("refs/heads/master"), Status: "ok", }, { ReferenceName: plumbing.ReferenceName("refs/heads/a"), Status: "command error", }, { ReferenceName: plumbing.ReferenceName("refs/heads/b"), Status: "ok", }} s.testEncodeDecodeOk(rs, "unpack ok\n", "ok refs/heads/master\n", "ng refs/heads/a command error\n", "ok refs/heads/b\n", "", ) s.Error(rs.Error()) s.ErrorAs(rs.Error(), &CommandStatusErr{}) } func (s *ReportStatusSuite) TestEncodeDecodeOkNoReferences() { expected := &ReportStatus{} expected.UnpackStatus = "ok" s.testEncodeDecodeOk(expected, "unpack ok\n", "", ) } func (s *ReportStatusSuite) TestEncodeDecodeOkNoReferencesFailed() { rs := &ReportStatus{} rs.UnpackStatus = "my error" s.testEncodeDecodeOk(rs, "unpack my error\n", "", ) } func (s *ReportStatusSuite) TestDecodeErrorOneReferenceNoFlush() { s.testDecodeError("missing flush", "unpack ok\n", "ok refs/heads/master\n", ) } func (s *ReportStatusSuite) TestDecodeErrorEmpty() { s.testDecodeError("unexpected EOF") } func (s *ReportStatusSuite) TestDecodeErrorMalformed() { s.testDecodeError("malformed unpack status: unpackok", "unpackok\n", "", ) } func (s *ReportStatusSuite) TestDecodeErrorMalformed2() { s.testDecodeError("malformed unpack status: UNPACK OK", "UNPACK OK\n", "", ) } func (s *ReportStatusSuite) TestDecodeErrorMalformedCommandStatus() { s.testDecodeError("malformed command status: ko refs/heads/master", "unpack ok\n", "ko refs/heads/master\n", "", ) } func (s *ReportStatusSuite) TestDecodeErrorMalformedCommandStatus2() { s.testDecodeError("malformed command status: ng refs/heads/master", "unpack ok\n", "ng refs/heads/master\n", "", ) } func (s *ReportStatusSuite) TestDecodeErrorPrematureFlush() { s.testDecodeError("premature flush", "", ) } func (s *ReportStatusSuite) TestCommandStatusError() { // Test that individual CommandStatus objects still report errors correctly cs := &CommandStatus{ReferenceName: plumbing.ReferenceName("refs/heads/master")} cs.Status = "ok" s.NoError(cs.Error()) cs.Status = "command error" s.Error(cs.Error()) s.Regexp(regexp.MustCompile("command error on refs/heads/master: command error"), cs.Error()) // Create a ReportStatus with a failed command but ok unpack status rs := &ReportStatus{} rs.UnpackStatus = "ok" rs.CommandStatuses = append(rs.CommandStatuses, cs) // Verify that ReportStatus.Error() returns a [CommandStatusErr] error. s.Error(rs.Error()) s.ErrorAs(rs.Error(), &CommandStatusErr{}) s.Error(cs.Error()) s.ErrorAs(cs.Error(), &CommandStatusErr{}) }