[errors] de-specialize Transient in favor of Tags.

logdog/server/collector/collector_test.go

 // Copyright 2016 The LUCI Authors. All rights reserved.
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
 package collector
 
 import (
         "bytes"
         "fmt"
         "sync/atomic"
         "testing"
 
         "github.com/luci/luci-go/common/clock/testclock"
         "github.com/luci/luci-go/common/errors"
+        "github.com/luci/luci-go/common/retry/transient"
         "github.com/luci/luci-go/logdog/api/logpb"
         "github.com/luci/luci-go/logdog/client/butlerproto"
         "github.com/luci/luci-go/logdog/common/storage/memory"
         "github.com/luci/luci-go/logdog/common/types"
         cc "github.com/luci/luci-go/logdog/server/collector/coordinator"
         "github.com/luci/luci-go/luci_config/common/cfgtypes"
         "golang.org/x/net/context"
 
         . "github.com/luci/luci-go/common/testing/assertions"
         . "github.com/smartystreets/goconvey/convey"
@@ skipping 29 matching lines @@
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/bar", 127)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/bar", indexRange{0, 127})
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/baz", 255)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/baz", indexRange{0, 255})
                 })
 
                 Convey(`Will return a transient error if a transient error happened while registering.`, func() {
-                        tcc.registerCallback = func(cc.LogStreamState) error { return errors.WrapTransient(errors.New("test error")) }
+                        tcc.registerCallback = func(cc.LogStreamState) error { return errors.New("test error", transient.Tag) }
 
                         bb.addFullStream("foo/+/bar", 128)
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeTrue)
+                        So(transient.Tag.In(err), ShouldBeTrue)
                 })
 
                 Convey(`Will return an error if a non-transient error happened while registering.`, func() {
                         tcc.registerCallback = func(cc.LogStreamState) error { return errors.New("test error") }
 
                         bb.addFullStream("foo/+/bar", 128)
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 // This will happen when one registration request registers non-terminal,
                 // and a follow-on registration request registers with a terminal index. The
                 // latter registration request will idempotently succeed, but not accept the
                 // terminal index, so termination is still required.
                 Convey(`Will terminate a stream if a terminal registration returns a non-terminal response.`, func() {
                         terminateCalled := false
                         tcc.terminateCallback = func(cc.TerminateRequest) error {
                                 terminateCalled = true
                                 return nil
                         }
 
                         bb.addStreamEntries("foo/+/bar", -1, 0, 1)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         bb.addStreamEntries("foo/+/bar", 3, 2, 3)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
                         So(terminateCalled, ShouldBeTrue)
                 })
 
                 Convey(`Will return a transient error if a transient error happened while terminating.`, func() {
-                        tcc.terminateCallback = func(cc.TerminateRequest) error { return errors.WrapTransient(errors.New("test error")) }
+                        tcc.terminateCallback = func(cc.TerminateRequest) error { return errors.New("test error", transient.Tag) }
 
                         // Register independently from terminate so we don't bundle RPC.
                         bb.addStreamEntries("foo/+/bar", -1, 0, 1, 2, 3, 4)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         // Add terminal index.
                         bb.addStreamEntries("foo/+/bar", 5, 5)
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeTrue)
+                        So(transient.Tag.In(err), ShouldBeTrue)
                 })
 
                 Convey(`Will return an error if a non-transient error happened while terminating.`, func() {
                         tcc.terminateCallback = func(cc.TerminateRequest) error { return errors.New("test error") }
 
                         // Register independently from terminate so we don't bundle RPC.
                         bb.addStreamEntries("foo/+/bar", -1, 0, 1, 2, 3, 4)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         // Add terminal index.
                         bb.addStreamEntries("foo/+/bar", 5, 5)
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will return a transient error if a transient error happened on storage.`, func() {
                         // Single transient error.
                         count := int32(0)
                         st.err = func() error {
                                 if atomic.AddInt32(&count, 1) == 1 {
-                                        return errors.WrapTransient(errors.New("test error"))
+                                        return errors.New("test error", transient.Tag)
                                 }
                                 return nil
                         }
 
                         bb.addFullStream("foo/+/bar", 128)
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeTrue)
+                        So(transient.Tag.In(err), ShouldBeTrue)
                 })
 
                 Convey(`Will drop invalid LogStreamDescriptor bundle entries and process the valid ones.`, func() {
                         be := bb.genBundleEntry("foo/+/trash", 1337, 4, 5, 6, 7, 8)
                         bb.addBundleEntry(be)
 
                         bb.addStreamEntries("foo/+/trash", 0, 1, 3) // Invalid: non-contiguous
                         bb.addFullStream("foo/+/bar", 32)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldNotBeNil)
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/bar", 32)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/bar", indexRange{0, 31})
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/trash", 1337)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/trash", 4, 5, 6, 7, 8)
                 })
 
                 Convey(`Will drop streams with missing (invalid) secrets.`, func() {
                         b := bb.genBase()
                         b.Secret = nil
                         bb.addFullStream("foo/+/bar", 4)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "invalid prefix secret")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will drop messages with mismatching secrets.`, func() {
                         bb.addStreamEntries("foo/+/bar", -1, 0, 1, 2)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         // Push another bundle with a different secret.
                         b := bb.genBase()
                         b.Secret = bytes.Repeat([]byte{0xAA}, types.PrefixSecretLength)
                         be := bb.genBundleEntry("foo/+/bar", 4, 3, 4)
                         be.TerminalIndex = 1337
                         bb.addBundleEntry(be)
                         bb.addFullStream("foo/+/baz", 3)
                         So(coll.Process(c, bb.bundle()), ShouldBeNil)
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/bar", -1)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/bar", indexRange{0, 2})
 
                         So(tcc, shouldHaveRegisteredStream, "test-project", "foo/+/baz", 2)
                         So(st, shouldHaveStoredStream, "test-project", "foo/+/baz", indexRange{0, 2})
                 })
 
                 Convey(`With an empty project name, will drop the stream.`, func() {
                         b := bb.genBase()
                         b.Project = ""
                         bb.addFullStream("foo/+/baz", 3)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "invalid bundle project name")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will drop streams with invalid project names.`, func() {
                         b := bb.genBase()
                         b.Project = "!!!invalid name!!!"
                         So(cfgtypes.ProjectName(b.Project).Validate(), ShouldNotBeNil)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "invalid bundle project name")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will drop streams with empty bundle prefixes.`, func() {
                         b := bb.genBase()
                         b.Prefix = ""
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "invalid bundle prefix")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will drop streams with invalid bundle prefixes.`, func() {
                         b := bb.genBase()
                         b.Prefix = "!!!invalid prefix!!!"
                         So(types.StreamName(b.Prefix).Validate(), ShouldNotBeNil)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "invalid bundle prefix")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will drop streams whose descriptor prefix doesn't match its bundle's prefix.`, func() {
                         bb.addStreamEntries("baz/+/bar", 3, 0, 1, 2, 3, 4)
 
                         err := coll.Process(c, bb.bundle())
                         So(err, ShouldErrLike, "mismatched bundle and entry prefixes")
-                        So(errors.IsTransient(err), ShouldBeFalse)
+                        So(transient.Tag.In(err), ShouldBeFalse)
                 })
 
                 Convey(`Will return no error if the data has a corrupt bundle header.`, func() {
                         So(coll.Process(c, []byte{0x00}), ShouldBeNil)
                         So(tcc, shouldNotHaveRegisteredStream, "test-project", "foo/+/bar")
                 })
 
                 Convey(`Will drop bundles with unknown ProtoVersion string.`, func() {
                         buf := bytes.Buffer{}
                         w := butlerproto.Writer{ProtoVersion: "!!!invalid!!!"}
@@ skipping 69 matching lines @@
         testCollectorImpl(t, false)
 }
 
 // TestCollectorWithCaching runs through a series of end-to-end Collector
 // workflows and ensures that the Collector behaves appropriately.
 func TestCollectorWithCaching(t *testing.T) {
         t.Parallel()
 
         testCollectorImpl(t, true)
 }