Naming, layout and comments: descriptive full-word names, one item per line in wrapped calls and literals, and doc comments on exported names
Short and single-letter names in application code become full words (tests keep theirs). Wrapped calls, signatures and composite literals put one item per line, and one-line function bodies are expanded. Exported names and groups of constants get doc comments, and comments refer to the renamed identifiers.
This commit is contained in:
1 parent
043e307663
commit
465358609a
78 files changed
+2374
-1402
No files matched your search
@@ -19,14 +19,26 @@ func TestMain(m *testing.M) {
|
||||
}
|
||||
|
||||
func TestWorkerRunRejectsBadConfig(t *testing.T) {
|
||||
noop := func(context.Context, time.Time) error { return nil }
|
||||
noop := func(context.Context, time.Time) error {
|
||||
return nil
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
w Worker
|
||||
}{
|
||||
{"no task", Worker{Name: "a", Interval: time.Second}},
|
||||
{"zero interval", Worker{Name: "b", Task: noop}},
|
||||
{"negative interval", Worker{Name: "c", Interval: -time.Second, Task: noop}},
|
||||
{"no task", Worker{
|
||||
Name: "a",
|
||||
Interval: time.Second,
|
||||
}},
|
||||
{"zero interval", Worker{
|
||||
Name: "b",
|
||||
Task: noop,
|
||||
}},
|
||||
{"negative interval", Worker{
|
||||
Name: "c",
|
||||
Interval: -time.Second,
|
||||
Task: noop,
|
||||
}},
|
||||
}
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
@@ -90,7 +102,9 @@ func TestWorkerRunCheckpoints(t *testing.T) {
|
||||
}
|
||||
|
||||
done := make(chan error, 1)
|
||||
go func() { done <- w.Run(ctx, since0) }()
|
||||
go func() {
|
||||
done <- w.Run(ctx, since0)
|
||||
}()
|
||||
select {
|
||||
case err := <-done:
|
||||
if err != nil {
|
||||
@@ -186,7 +200,11 @@ func TestWorkerExecute(t *testing.T) {
|
||||
}
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
w := Worker{Task: func(context.Context, time.Time) error { return tc.err }}
|
||||
w := Worker{
|
||||
Task: func(context.Context, time.Time) error {
|
||||
return tc.err
|
||||
},
|
||||
}
|
||||
before := time.Now()
|
||||
got := w.execute(context.Background(), logger, since)
|
||||
if tc.advance {
|
||||
@@ -202,11 +220,15 @@ func TestWorkerExecute(t *testing.T) {
|
||||
|
||||
func TestAwaitTask(t *testing.T) {
|
||||
errFail := errors.New("boom")
|
||||
v, err := AwaitTask(context.Background(), func() (int, error) { return 42, nil })
|
||||
v, err := AwaitTask(context.Background(), func() (int, error) {
|
||||
return 42, nil
|
||||
})
|
||||
if v != 42 || err != nil {
|
||||
t.Fatalf("got (%d, %v), want (42, nil)", v, err)
|
||||
}
|
||||
v, err = AwaitTask(context.Background(), func() (int, error) { return 7, errFail })
|
||||
v, err = AwaitTask(context.Background(), func() (int, error) {
|
||||
return 7, errFail
|
||||
})
|
||||
if v != 7 || !errors.Is(err, errFail) {
|
||||
t.Fatalf("got (%d, %v), want (7, %v)", v, err, errFail)
|
||||
}
|
||||
@@ -214,8 +236,14 @@ func TestAwaitTask(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
release := make(chan struct{})
|
||||
defer close(release)
|
||||
go func() { time.Sleep(5 * time.Millisecond); cancel() }()
|
||||
v, err = AwaitTask(ctx, func() (int, error) { <-release; return 1, nil })
|
||||
go func() {
|
||||
time.Sleep(5 * time.Millisecond)
|
||||
cancel()
|
||||
}()
|
||||
v, err = AwaitTask(ctx, func() (int, error) {
|
||||
<-release
|
||||
return 1, nil
|
||||
})
|
||||
if v != 0 || !errors.Is(err, context.Canceled) {
|
||||
t.Fatalf("got (%d, %v), want (0, context.Canceled)", v, err)
|
||||
}
|
||||
@@ -223,12 +251,16 @@ func TestAwaitTask(t *testing.T) {
|
||||
|
||||
func TestAwaitTaskE(t *testing.T) {
|
||||
errFail := errors.New("boom")
|
||||
if err := AwaitTaskE(context.Background(), func() error { return nil }); err != nil {
|
||||
if err := AwaitTaskE(context.Background(), func() error {
|
||||
return nil
|
||||
}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := AwaitTaskE(
|
||||
context.Background(),
|
||||
func() error { return errFail },
|
||||
func() error {
|
||||
return errFail
|
||||
},
|
||||
); !errors.Is(
|
||||
err,
|
||||
errFail,
|
||||
@@ -242,7 +274,10 @@ func TestAwaitTaskE(t *testing.T) {
|
||||
defer close(release)
|
||||
if err := AwaitTaskE(
|
||||
ctx,
|
||||
func() error { <-release; return nil },
|
||||
func() error {
|
||||
<-release
|
||||
return nil
|
||||
},
|
||||
); !errors.Is(
|
||||
err,
|
||||
context.DeadlineExceeded,
|
||||
|
||||
Reference in new issue
Block a user