Skip to content

Commit 7b1f5df

Browse files
bryphe-coderbryphe-coder
committed
Round of lint fixes
1 parent f61b2ef commit 7b1f5df

10 files changed

+70
-55
lines changed

‎cli/login_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ package cli_test
33
import (
44
"testing"
55

6+
"github.com/stretchr/testify/require"
7+
68
"github.com/coder/coder/cli/clitest"
79
"github.com/coder/coder/coderd/coderdtest"
8-
"github.com/stretchr/testify/require"
910

1011
"github.com/coder/coder/expect"
1112
)

‎expect/console.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type ExpectObserver func(matchers []Matcher, buf string, err error)
6262
// be called after each Send operation.
6363
// msg is the string that was sent.
6464
// num is the number of bytes actually sent.
65-
// err is the error that might have occured. May be nil.
65+
// err is the error that might have occurred. May be nil.
6666
type SendObserver func(msg string, num int, err error)
6767

6868
// WithStdout adds writers that Console duplicates writes to, similar to the
@@ -137,15 +137,15 @@ func NewConsole(opts ...ConsoleOpt) (*Console, error) {
137137
}
138138
closers = append(closers, passthroughPipe)
139139

140-
c := &Console{
140+
console := &Console{
141141
opts: options,
142142
pty: pty,
143143
passthroughPipe: passthroughPipe,
144144
runeReader: bufio.NewReaderSize(passthroughPipe, utf8.UTFMax),
145145
closers: closers,
146146
}
147147

148-
return c, nil
148+
return console, nil
149149
}
150150

151151
// Tty returns an input Tty for accepting input

‎expect/expect_opt.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type ConsoleCallback func(buf *bytes.Buffer) error
3333

3434
// Then returns an Expect condition to execute a callback if a match is found
3535
// for the chained matcher.
36-
func (eo ExpectOpt) Then(f ConsoleCallback) ExpectOpt {
36+
func (eo ExpectOpt) Then(consoleCallback ConsoleCallback) ExpectOpt {
3737
return func(opts *ExpectOpts) error {
3838
var options ExpectOpts
3939
err := eo(&options)
@@ -43,7 +43,7 @@ func (eo ExpectOpt) Then(f ConsoleCallback) ExpectOpt {
4343

4444
for _, matcher := range options.Matchers {
4545
opts.Matchers = append(opts.Matchers, &callbackMatcher{
46-
f: f,
46+
f: consoleCallback,
4747
matcher: matcher,
4848
})
4949
}
@@ -206,11 +206,11 @@ func (am *allMatcher) Match(v interface{}) bool {
206206
}
207207

208208
func (am *allMatcher) Criteria() interface{} {
209-
var criterias []interface{}
209+
var criteria []interface{}
210210
for _, matcher := range am.options.Matchers {
211-
criterias = append(criterias, matcher.Criteria())
211+
criteria = append(criteria, matcher.Criteria())
212212
}
213-
return criterias
213+
return criteria
214214
}
215215

216216
// All adds an Expect condition to exit if the content read from Console's tty

‎expect/expect_opt_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package expect
15+
package expect_test
1616

1717
import (
1818
"bytes"
@@ -22,6 +22,8 @@ import (
2222
"testing"
2323

2424
"github.com/stretchr/testify/require"
25+
26+
. "github.com/coder/coder/expect"
2527
)
2628

2729
func TestExpectOptString(t *testing.T) {

‎expect/expect_test.go

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -111,23 +111,23 @@ func testCloser(t *testing.T, closer io.Closer) {
111111
func TestExpectf(t *testing.T) {
112112
t.Parallel()
113113

114-
c, err := newTestConsole(t)
114+
console, err := newTestConsole(t)
115115
if err != nil {
116116
t.Errorf("Expected no error but got'%s'", err)
117117
}
118-
defer testCloser(t, c)
118+
defer testCloser(t, console)
119119

120120
var wg sync.WaitGroup
121121
wg.Add(1)
122122
go func() {
123123
defer wg.Done()
124-
c.Expectf("What is 1+%d?", 1)
125-
c.SendLine("2")
126-
c.Expectf("What is %s backwards?", "Netflix")
127-
c.SendLine("xilfteN")
124+
console.Expectf("What is 1+%d?", 1)
125+
console.SendLine("2")
126+
console.Expectf("What is %s backwards?", "Netflix")
127+
console.SendLine("xilfteN")
128128
}()
129129

130-
err = Prompt(c.InTty(), c.OutTty())
130+
err = Prompt(console.InTty(), console.OutTty())
131131
if err != nil {
132132
t.Errorf("Expected no error but got '%s'", err)
133133
}
@@ -137,23 +137,23 @@ func TestExpectf(t *testing.T) {
137137
func TestExpect(t *testing.T) {
138138
t.Parallel()
139139

140-
c, err := newTestConsole(t)
140+
console, err := newTestConsole(t)
141141
if err != nil {
142142
t.Errorf("Expected no error but got'%s'", err)
143143
}
144-
defer testCloser(t, c)
144+
defer testCloser(t, console)
145145

146146
var wg sync.WaitGroup
147147
wg.Add(1)
148148
go func() {
149149
defer wg.Done()
150-
c.ExpectString("What is 1+1?")
151-
c.SendLine("2")
152-
c.ExpectString("What is Netflix backwards?")
153-
c.SendLine("xilfteN")
150+
console.ExpectString("What is 1+1?")
151+
console.SendLine("2")
152+
console.ExpectString("What is Netflix backwards?")
153+
console.SendLine("xilfteN")
154154
}()
155155

156-
err = Prompt(c.InTty(), c.OutTty())
156+
err = Prompt(console.InTty(), console.OutTty())
157157
if err != nil {
158158
t.Errorf("Expected no error but got '%s'", err)
159159
}
@@ -163,21 +163,21 @@ func TestExpect(t *testing.T) {
163163
func TestExpectOutput(t *testing.T) {
164164
t.Parallel()
165165

166-
c, err := newTestConsole(t)
166+
console, err := newTestConsole(t)
167167
if err != nil {
168168
t.Errorf("Expected no error but got'%s'", err)
169169
}
170-
defer testCloser(t, c)
170+
defer testCloser(t, console)
171171

172172
var wg sync.WaitGroup
173173
wg.Add(1)
174174
go func() {
175175
defer wg.Done()
176-
c.ExpectString("What is 1+1?")
177-
c.SendLine("3")
176+
console.ExpectString("What is 1+1?")
177+
console.SendLine("3")
178178
}()
179179

180-
err = Prompt(c.InTty(), c.OutTty())
180+
err = Prompt(console.InTty(), console.OutTty())
181181
if err == nil || err != ErrWrongAnswer {
182182
t.Errorf("Expected error '%s' but got '%s' instead", ErrWrongAnswer, err)
183183
}

‎expect/passthrough_pipe_test.go

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
package expect
1+
package expect_test
22

33
import (
44
"errors"
55
"io"
6+
67
//"os"
78
"testing"
89
"time"
910

1011
"github.com/stretchr/testify/require"
12+
13+
. "github.com/coder/coder/expect"
1114
)
1215

1316
func TestPassthroughPipe(t *testing.T) {
14-
r, w := io.Pipe()
17+
pipeReader, pipeWriter := io.Pipe()
1518

16-
passthroughPipe, err := NewPassthroughPipe(r)
19+
passthroughPipe, err := NewPassthroughPipe(pipeReader)
1720
require.NoError(t, err)
1821

1922
err = passthroughPipe.SetReadDeadline(time.Now().Add(time.Hour))
2023
require.NoError(t, err)
2124

2225
pipeError := errors.New("pipe error")
23-
err = w.CloseWithError(pipeError)
26+
err = pipeWriter.CloseWithError(pipeError)
2427
require.NoError(t, err)
2528

2629
p := make([]byte, 1)

‎expect/pty/pty_other.go

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,14 @@ func (p *unixPty) Resize(cols uint16, rows uint16) error {
5050
}
5151

5252
func (p *unixPty) Close() error {
53-
p.pty.Close()
54-
p.tty.Close()
53+
err := p.pty.Close()
54+
if err != nil {
55+
return err
56+
}
57+
58+
err = p.tty.Close()
59+
if err != nil {
60+
return err
61+
}
5562
return nil
5663
}

‎expect/reader_lease.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ type ReaderLease struct {
2929
// NewReaderLease returns a new ReaderLease that begins reading the given
3030
// io.Reader.
3131
func NewReaderLease(reader io.Reader) *ReaderLease {
32-
rm := &ReaderLease{
32+
readerLease := &ReaderLease{
3333
reader: reader,
3434
bytec: make(chan byte),
3535
}
3636

3737
go func() {
3838
for {
39-
p := make([]byte, 1)
40-
n, err := rm.reader.Read(p)
39+
bytes := make([]byte, 1)
40+
n, err := readerLease.reader.Read(bytes)
4141
if err != nil {
4242
return
4343
}
4444
if n == 0 {
4545
panic("non eof read 0 bytes")
4646
}
47-
rm.bytec <- p[0]
47+
readerLease.bytec <- bytes[0]
4848
}
4949
}()
5050

51-
return rm
51+
return readerLease
5252
}
5353

5454
// NewReader returns a cancellable io.Reader for the underlying io.Reader.
55-
// Readers can be cancelled without interrupting other Readers, and once
56-
// a reader is a cancelled it will not read anymore bytes from ReaderLease's
55+
// Readers can be canceled without interrupting other Readers, and once
56+
// a reader is a canceled it will not read anymore bytes from ReaderLease's
5757
// underlying io.Reader.
5858
func (rm *ReaderLease) NewReader(ctx context.Context) io.Reader {
5959
return NewChanReader(ctx, rm.bytec)
@@ -64,7 +64,7 @@ type chanReader struct {
6464
bytec <-chan byte
6565
}
6666

67-
// NewChanReader returns a io.Reader over a byte chan. If context is cancelled,
67+
// NewChanReader returns a io.Reader over a byte chan. If context is canceled,
6868
// future Reads will return io.EOF.
6969
func NewChanReader(ctx context.Context, bytec <-chan byte) io.Reader {
7070
return &chanReader{
@@ -73,15 +73,15 @@ func NewChanReader(ctx context.Context, bytec <-chan byte) io.Reader {
7373
}
7474
}
7575

76-
func (cr *chanReader) Read(p []byte) (n int, err error) {
76+
func (cr *chanReader) Read(bytes []byte) (n int, err error) {
7777
select {
7878
case <-cr.ctx.Done():
7979
return 0, io.EOF
8080
case b := <-cr.bytec:
81-
if len(p) < 1 {
81+
if len(bytes) < 1 {
8282
return 0, fmt.Errorf("cannot read into 0 len byte slice")
8383
}
84-
p[0] = b
84+
bytes[0] = b
8585
return 1, nil
8686
}
8787
}

‎expect/reader_lease_test.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package expect
1+
package expect_test
22

33
import (
44
"context"
@@ -7,14 +7,16 @@ import (
77
"testing"
88

99
"github.com/stretchr/testify/require"
10+
11+
. "github.com/coder/coder/expect"
1012
)
1113

1214
func TestReaderLease(t *testing.T) {
1315
in, out := io.Pipe()
1416
defer out.Close()
1517
defer in.Close()
1618

17-
rm := NewReaderLease(in)
19+
readerLease := NewReaderLease(in)
1820

1921
tests := []struct {
2022
title string
@@ -39,7 +41,7 @@ func TestReaderLease(t *testing.T) {
3941
wg.Add(1)
4042
go func() {
4143
defer wg.Done()
42-
io.Copy(tout, rm.NewReader(ctx))
44+
io.Copy(tout, readerLease.NewReader(ctx))
4345
}()
4446

4547
wg.Add(1)

‎expect/test_log.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,28 +36,28 @@ func NewTestConsole(t *testing.T, opts ...ConsoleOpt) (*Console, error) {
3636
// NewTestWriter returns an io.Writer where bytes written to the file are
3737
// logged by go's testing logger. Bytes are flushed to the logger on line end.
3838
func NewTestWriter(t *testing.T) (io.Writer, error) {
39-
r, w := io.Pipe()
40-
tw := testWriter{t}
39+
pipeReader, pipeWriter := io.Pipe()
40+
testWriter := testWriter{t}
4141

4242
go func() {
43-
defer r.Close()
43+
defer pipeReader.Close()
4444

45-
br := bufio.NewReader(r)
45+
br := bufio.NewReader(pipeReader)
4646

4747
for {
4848
line, _, err := br.ReadLine()
4949
if err != nil {
5050
return
5151
}
5252

53-
_, err = tw.Write(line)
53+
_, err = testWriter.Write(line)
5454
if err != nil {
5555
return
5656
}
5757
}
5858
}()
5959

60-
return w, nil
60+
return pipeWriter, nil
6161
}
6262

6363
// testWriter provides a io.Writer interface to go's testing logger.

0 commit comments

Comments
 (0)