Skip to content

Commit ecff4ba

Browse files
author
Jessie Frazelle
committed
Merge pull request moby#15125 from WeiZhang555/golint-stdcopy-system
fix golint warnings/errors on pkg/system and pkg/stdcopy
2 parents 008a8ff + 7e420ad commit ecff4ba

30 files changed

+131
-89
lines changed

‎daemon/volumes_unix.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func copyOwnership(source, destination string) error {
2828
return err
2929
}
3030

31-
if err := os.Chown(destination, int(stat.Uid()), int(stat.Gid())); err != nil {
31+
if err := os.Chown(destination, int(stat.UID()), int(stat.Gid())); err != nil {
3232
return err
3333
}
3434

‎docker/daemon_unix.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func setPlatformServerConfig(serverConfig *apiserver.Config, daemonCfg *daemon.C
2626
// file.
2727
func currentUserIsOwner(f string) bool {
2828
if fileInfo, err := system.Stat(f); err == nil && fileInfo != nil {
29-
if int(fileInfo.Uid()) == os.Getuid() {
29+
if int(fileInfo.UID()) == os.Getuid() {
3030
return true
3131
}
3232
}

‎hack/make/validate-lint‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,13 @@ packages=(
7676
pkg/reexec
7777
pkg/signal
7878
pkg/sockets
79+
pkg/stdcopy
7980
pkg/streamformatter
8081
pkg/stringid
8182
pkg/stringutils
82-
pkg/sysinfo
8383
pkg/symlink
84+
pkg/sysinfo
85+
pkg/system
8486
pkg/tailfile
8587
pkg/tarsum
8688
pkg/term

‎pkg/archive/changes.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ func Changes(layers []string, rw string) ([]Change, error) {
173173
type FileInfo struct {
174174
parent *FileInfo
175175
name string
176-
stat *system.Stat_t
176+
stat *system.StatT
177177
children map[string]*FileInfo
178178
capability []byte
179179
added bool

‎pkg/archive/changes_unix.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import (
88
"github.com/docker/docker/pkg/system"
99
)
1010

11-
func statDifferent(oldStat *system.Stat_t, newStat *system.Stat_t) bool {
11+
func statDifferent(oldStat *system.StatT, newStat *system.StatT) bool {
1212
// Don't look at size for dirs, its not a good measure of change
1313
if oldStat.Mode() != newStat.Mode() ||
14-
oldStat.Uid() != newStat.Uid() ||
14+
oldStat.UID() != newStat.UID() ||
1515
oldStat.Gid() != newStat.Gid() ||
1616
oldStat.Rdev() != newStat.Rdev() ||
1717
// Don't look at size for dirs, its not a good measure of change

‎pkg/archive/changes_windows.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"github.com/docker/docker/pkg/system"
55
)
66

7-
func statDifferent(oldStat *system.Stat_t, newStat *system.Stat_t) bool {
7+
func statDifferent(oldStat *system.StatT, newStat *system.StatT) bool {
88

99
// Don't look at size for dirs, its not a good measure of change
1010
if oldStat.ModTime() != newStat.ModTime() ||

‎pkg/stdcopy/stdcopy.go‎

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,24 @@ import (
99
)
1010

1111
const (
12-
StdWriterPrefixLen = 8
13-
StdWriterFdIndex = 0
14-
StdWriterSizeIndex = 4
12+
stdWriterPrefixLen = 8
13+
stdWriterFdIndex = 0
14+
stdWriterSizeIndex = 4
1515
)
1616

17-
type StdType [StdWriterPrefixLen]byte
17+
// StdType prefixes type and length to standard stream.
18+
type StdType [stdWriterPrefixLen]byte
1819

1920
var (
20-
Stdin StdType = StdType{0: 0}
21-
Stdout StdType = StdType{0: 1}
22-
Stderr StdType = StdType{0: 2}
21+
// Stdin represents standard input stream type.
22+
Stdin = StdType{0: 0}
23+
// Stdout represents standard output stream type.
24+
Stdout = StdType{0: 1}
25+
// Stderr represents standard error steam type.
26+
Stderr = StdType{0: 2}
2327
)
2428

29+
// StdWriter is wrapper of io.Writer with extra customized info.
2530
type StdWriter struct {
2631
io.Writer
2732
prefix StdType
@@ -36,10 +41,10 @@ func (w *StdWriter) Write(buf []byte) (n int, err error) {
3641
binary.BigEndian.PutUint32(w.prefix[4:], uint32(len(buf)))
3742
n1, err = w.Writer.Write(w.prefix[:])
3843
if err != nil {
39-
n = n1 - StdWriterPrefixLen
44+
n = n1 - stdWriterPrefixLen
4045
} else {
4146
n2, err = w.Writer.Write(buf)
42-
n = n1 + n2 - StdWriterPrefixLen
47+
n = n1 + n2 - stdWriterPrefixLen
4348
}
4449
if n < 0 {
4550
n = 0
@@ -61,7 +66,7 @@ func NewStdWriter(w io.Writer, t StdType) *StdWriter {
6166
}
6267
}
6368

64-
var ErrInvalidStdHeader = errors.New("Unrecognized input header")
69+
var errInvalidStdHeader = errors.New("Unrecognized input header")
6570

6671
// StdCopy is a modified version of io.Copy.
6772
//
@@ -75,7 +80,7 @@ var ErrInvalidStdHeader = errors.New("Unrecognized input header")
7580
// `written` will hold the total number of bytes written to `dstout` and `dsterr`.
7681
func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error) {
7782
var (
78-
buf = make([]byte, 32*1024+StdWriterPrefixLen+1)
83+
buf = make([]byte, 32*1024+stdWriterPrefixLen+1)
7984
bufLen = len(buf)
8085
nr, nw int
8186
er, ew error
@@ -85,12 +90,12 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
8590

8691
for {
8792
// Make sure we have at least a full header
88-
for nr < StdWriterPrefixLen {
93+
for nr < stdWriterPrefixLen {
8994
var nr2 int
9095
nr2, er = src.Read(buf[nr:])
9196
nr += nr2
9297
if er == io.EOF {
93-
if nr < StdWriterPrefixLen {
98+
if nr < stdWriterPrefixLen {
9499
logrus.Debugf("Corrupted prefix: %v", buf[:nr])
95100
return written, nil
96101
}
@@ -103,7 +108,7 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
103108
}
104109

105110
// Check the first byte to know where to write
106-
switch buf[StdWriterFdIndex] {
111+
switch buf[stdWriterFdIndex] {
107112
case 0:
108113
fallthrough
109114
case 1:
@@ -113,30 +118,30 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
113118
// Write on stderr
114119
out = dsterr
115120
default:
116-
logrus.Debugf("Error selecting output fd: (%d)", buf[StdWriterFdIndex])
117-
return 0, ErrInvalidStdHeader
121+
logrus.Debugf("Error selecting output fd: (%d)", buf[stdWriterFdIndex])
122+
return 0, errInvalidStdHeader
118123
}
119124

120125
// Retrieve the size of the frame
121-
frameSize = int(binary.BigEndian.Uint32(buf[StdWriterSizeIndex : StdWriterSizeIndex+4]))
126+
frameSize = int(binary.BigEndian.Uint32(buf[stdWriterSizeIndex : stdWriterSizeIndex+4]))
122127
logrus.Debugf("framesize: %d", frameSize)
123128

124129
// Check if the buffer is big enough to read the frame.
125130
// Extend it if necessary.
126-
if frameSize+StdWriterPrefixLen > bufLen {
127-
logrus.Debugf("Extending buffer cap by %d (was %d)", frameSize+StdWriterPrefixLen-bufLen+1, len(buf))
128-
buf = append(buf, make([]byte, frameSize+StdWriterPrefixLen-bufLen+1)...)
131+
if frameSize+stdWriterPrefixLen > bufLen {
132+
logrus.Debugf("Extending buffer cap by %d (was %d)", frameSize+stdWriterPrefixLen-bufLen+1, len(buf))
133+
buf = append(buf, make([]byte, frameSize+stdWriterPrefixLen-bufLen+1)...)
129134
bufLen = len(buf)
130135
}
131136

132137
// While the amount of bytes read is less than the size of the frame + header, we keep reading
133-
for nr < frameSize+StdWriterPrefixLen {
138+
for nr < frameSize+stdWriterPrefixLen {
134139
var nr2 int
135140
nr2, er = src.Read(buf[nr:])
136141
nr += nr2
137142
if er == io.EOF {
138-
if nr < frameSize+StdWriterPrefixLen {
139-
logrus.Debugf("Corrupted frame: %v", buf[StdWriterPrefixLen:nr])
143+
if nr < frameSize+stdWriterPrefixLen {
144+
logrus.Debugf("Corrupted frame: %v", buf[stdWriterPrefixLen:nr])
140145
return written, nil
141146
}
142147
break
@@ -148,7 +153,7 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
148153
}
149154

150155
// Write the retrieved frame (without header)
151-
nw, ew = out.Write(buf[StdWriterPrefixLen : frameSize+StdWriterPrefixLen])
156+
nw, ew = out.Write(buf[stdWriterPrefixLen : frameSize+stdWriterPrefixLen])
152157
if ew != nil {
153158
logrus.Debugf("Error writing frame: %s", ew)
154159
return 0, ew
@@ -161,8 +166,8 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
161166
written += int64(nw)
162167

163168
// Move the rest of the buffer to the beginning
164-
copy(buf, buf[frameSize+StdWriterPrefixLen:])
169+
copy(buf, buf[frameSize+stdWriterPrefixLen:])
165170
// Move the index
166-
nr -= frameSize + StdWriterPrefixLen
171+
nr -= frameSize + stdWriterPrefixLen
167172
}
168173
}

‎pkg/system/errors.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ import (
55
)
66

77
var (
8+
// ErrNotSupportedPlatform means the platform is not supported.
89
ErrNotSupportedPlatform = errors.New("platform and architecture is not supported")
910
)

‎pkg/system/events_windows.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@ import (
88
"unsafe"
99
)
1010

11-
const (
12-
EVENT_ALL_ACCESS = 0x1F0003
13-
EVENT_MODIFY_STATUS = 0x0002
14-
)
15-
1611
var (
1712
procCreateEvent = modkernel32.NewProc("CreateEventW")
1813
procOpenEvent = modkernel32.NewProc("OpenEventW")
@@ -21,13 +16,14 @@ var (
2116
procPulseEvent = modkernel32.NewProc("PulseEvent")
2217
)
2318

19+
// CreateEvent implements win32 CreateEventW func in golang. It will create an event object.
2420
func CreateEvent(eventAttributes *syscall.SecurityAttributes, manualReset bool, initialState bool, name string) (handle syscall.Handle, err error) {
2521
namep, _ := syscall.UTF16PtrFromString(name)
26-
var _p1 uint32 = 0
22+
var _p1 uint32
2723
if manualReset {
2824
_p1 = 1
2925
}
30-
var _p2 uint32 = 0
26+
var _p2 uint32
3127
if initialState {
3228
_p2 = 1
3329
}
@@ -40,9 +36,10 @@ func CreateEvent(eventAttributes *syscall.SecurityAttributes, manualReset bool,
4036
return
4137
}
4238

39+
// OpenEvent implements win32 OpenEventW func in golang. It opens an event object.
4340
func OpenEvent(desiredAccess uint32, inheritHandle bool, name string) (handle syscall.Handle, err error) {
4441
namep, _ := syscall.UTF16PtrFromString(name)
45-
var _p1 uint32 = 0
42+
var _p1 uint32
4643
if inheritHandle {
4744
_p1 = 1
4845
}
@@ -55,14 +52,17 @@ func OpenEvent(desiredAccess uint32, inheritHandle bool, name string) (handle sy
5552
return
5653
}
5754

55+
// SetEvent implements win32 SetEvent func in golang.
5856
func SetEvent(handle syscall.Handle) (err error) {
5957
return setResetPulse(handle, procSetEvent)
6058
}
6159

60+
// ResetEvent implements win32 ResetEvent func in golang.
6261
func ResetEvent(handle syscall.Handle) (err error) {
6362
return setResetPulse(handle, procResetEvent)
6463
}
6564

65+
// PulseEvent implements win32 PulseEvent func in golang.
6666
func PulseEvent(handle syscall.Handle) (err error) {
6767
return setResetPulse(handle, procPulseEvent)
6868
}

‎pkg/system/filesys.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import (
66
"os"
77
)
88

9+
// MkdirAll creates a directory named path along with any necessary parents,
10+
// with permission specified by attribute perm for all dir created.
911
func MkdirAll(path string, perm os.FileMode) error {
1012
return os.MkdirAll(path, perm)
1113
}

0 commit comments

Comments
 (0)