mirror of
https://gitee.com/milvus-io/milvus.git
synced 2025-12-07 17:48:29 +08:00
Add Makefile
Signed-off-by: cai.zhang <cai.zhang@zilliz.com>
This commit is contained in:
parent
f49c98ed85
commit
9d212505d8
2
.github/workflows/main.yaml
vendored
2
.github/workflows/main.yaml
vendored
@ -11,6 +11,7 @@ on:
|
|||||||
- 'cmd/**'
|
- 'cmd/**'
|
||||||
- '.github/workflows/main.yaml'
|
- '.github/workflows/main.yaml'
|
||||||
- docker-compose.yml
|
- docker-compose.yml
|
||||||
|
- Makefile
|
||||||
- '!**.md'
|
- '!**.md'
|
||||||
- '!**_test.go'
|
- '!**_test.go'
|
||||||
pull_request:
|
pull_request:
|
||||||
@ -21,6 +22,7 @@ on:
|
|||||||
- 'cmd/**'
|
- 'cmd/**'
|
||||||
- '.github/workflows/main.yaml'
|
- '.github/workflows/main.yaml'
|
||||||
- docker-compose.yml
|
- docker-compose.yml
|
||||||
|
- Makefile
|
||||||
- '!**.md'
|
- '!**.md'
|
||||||
- '!**_test.go'
|
- '!**_test.go'
|
||||||
|
|
||||||
|
|||||||
32
.golangci.yml
Normal file
32
.golangci.yml
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
run:
|
||||||
|
skip-dirs:
|
||||||
|
- build
|
||||||
|
- configs
|
||||||
|
- deployments
|
||||||
|
- docs
|
||||||
|
- scripts
|
||||||
|
- internal/core
|
||||||
|
|
||||||
|
linters-settings:
|
||||||
|
golint:
|
||||||
|
min-confidence: 0
|
||||||
|
|
||||||
|
misspell:
|
||||||
|
locale: US
|
||||||
|
|
||||||
|
linters:
|
||||||
|
disable-all: false
|
||||||
|
enable:
|
||||||
|
- typecheck
|
||||||
|
- goimports
|
||||||
|
- misspell
|
||||||
|
- govet
|
||||||
|
- golint
|
||||||
|
- ineffassign
|
||||||
|
- gosimple
|
||||||
|
- deadcode
|
||||||
|
- structcheck
|
||||||
|
|
||||||
|
service:
|
||||||
|
golangci-lint-version: 1.27.0 # use the fixed version to not introduce new linters unexpectedly
|
||||||
|
|
||||||
12
Makefile
12
Makefile
@ -22,7 +22,7 @@ all: build-cpp build-go
|
|||||||
get-check-deps:
|
get-check-deps:
|
||||||
@mkdir -p ${GOPATH}/bin
|
@mkdir -p ${GOPATH}/bin
|
||||||
@which golangci-lint 1>/dev/null || (echo "Installing golangci-lint" && curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin v1.27.0)
|
@which golangci-lint 1>/dev/null || (echo "Installing golangci-lint" && curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin v1.27.0)
|
||||||
# @which ruleguard 1>/dev/null || (echo "Installing ruleguard" && GO111MODULE=off $(GO) get github.com/quasilyte/go-ruleguard/...)
|
@which ruleguard 1>/dev/null || (echo "Installing ruleguard" && GO111MODULE=off $(GO) get github.com/quasilyte/go-ruleguard/...)
|
||||||
|
|
||||||
get-build-deps:
|
get-build-deps:
|
||||||
@(env bash $(PWD)/scripts/install_deps.sh)
|
@(env bash $(PWD)/scripts/install_deps.sh)
|
||||||
@ -36,9 +36,13 @@ fmt:
|
|||||||
lint:
|
lint:
|
||||||
@echo "Running $@ check"
|
@echo "Running $@ check"
|
||||||
@GO111MODULE=on ${GOPATH}/bin/golangci-lint cache clean
|
@GO111MODULE=on ${GOPATH}/bin/golangci-lint cache clean
|
||||||
# @GO111MODULE=on ${GOPATH}/bin/golangci-lint run --timeout=5m --config ./.golangci.yml
|
@GO111MODULE=on ${GOPATH}/bin/golangci-lint run --timeout=1m --config ./.golangci.yml || true
|
||||||
|
|
||||||
verifiers: get-check-deps fmt lint
|
ruleguard:
|
||||||
|
@echo "Running $@ check"
|
||||||
|
@${GOPATH}/bin/ruleguard -rules ruleguard.rule.go ./... || true
|
||||||
|
|
||||||
|
verifiers: get-check-deps fmt lint ruleguard
|
||||||
|
|
||||||
# Builds various components locally.
|
# Builds various components locally.
|
||||||
build-go: verifiers
|
build-go: verifiers
|
||||||
@ -65,7 +69,7 @@ test-go: verifiers build-go
|
|||||||
@(env bash $(PWD)/scripts/run_go_unittest.sh)
|
@(env bash $(PWD)/scripts/run_go_unittest.sh)
|
||||||
|
|
||||||
test-cpp: build-cpp-with-unittest
|
test-cpp: build-cpp-with-unittest
|
||||||
@echo "Running cpp unittest..."
|
@echo "Running cpp unittests..."
|
||||||
@(env bash $(PWD)/scripts/run_cpp_unittest.sh)
|
@(env bash $(PWD)/scripts/run_cpp_unittest.sh)
|
||||||
|
|
||||||
#TODO: build each component to docker
|
#TODO: build each component to docker
|
||||||
|
|||||||
@ -2,7 +2,6 @@ package msgstream
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"github.com/apache/pulsar-client-go/pulsar"
|
"github.com/apache/pulsar-client-go/pulsar"
|
||||||
commonPb "github.com/zilliztech/milvus-distributed/internal/proto/commonpb"
|
commonPb "github.com/zilliztech/milvus-distributed/internal/proto/commonpb"
|
||||||
"log"
|
"log"
|
||||||
@ -142,7 +141,27 @@ func (ms *PulsarMsgStream) Produce(msgPack *MsgPack) commonPb.Status {
|
|||||||
); err != nil {
|
); err != nil {
|
||||||
log.Printf("post into pulsar filed, error = %v", err)
|
log.Printf("post into pulsar filed, error = %v", err)
|
||||||
}
|
}
|
||||||
fmt.Println("send a msg")
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return commonPb.Status{ErrorCode: commonPb.ErrorCode_SUCCESS}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ms *PulsarMsgStream) BroadCast(msgPack *MsgPack) commonPb.Status {
|
||||||
|
producerLen := len(ms.producers)
|
||||||
|
for _, v := range msgPack.Msgs {
|
||||||
|
mb, status := (*ms.msgMarshaler).Marshal(v)
|
||||||
|
if status.ErrorCode != commonPb.ErrorCode_SUCCESS {
|
||||||
|
log.Printf("Marshal ManipulationReqMsg failed, error ")
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for i := 0; i < producerLen; i++ {
|
||||||
|
if _, err := (*ms.producers[i]).Send(
|
||||||
|
context.Background(),
|
||||||
|
&pulsar.ProducerMessage{Payload: mb},
|
||||||
|
); err != nil {
|
||||||
|
log.Printf("post into pulsar filed, error = %v", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -94,6 +94,22 @@ func getTsMsg(msgType MsgType, reqId int64, hashValue int32) *TsMsg {
|
|||||||
TimeSyncMsg: timeSyncResult,
|
TimeSyncMsg: timeSyncResult,
|
||||||
}
|
}
|
||||||
tsMsg = timeSyncMsg
|
tsMsg = timeSyncMsg
|
||||||
|
case kTimeTick:
|
||||||
|
insertRequest := internalPb.InsertRequest{
|
||||||
|
ReqType: internalPb.ReqType_kTimeTick,
|
||||||
|
ReqId: reqId,
|
||||||
|
CollectionName: "Collection",
|
||||||
|
PartitionTag: "Partition",
|
||||||
|
SegmentId: 1,
|
||||||
|
ChannelId: 1,
|
||||||
|
ProxyId: 1,
|
||||||
|
Timestamps: []uint64{1},
|
||||||
|
}
|
||||||
|
insertMsg := InsertTask{
|
||||||
|
HashValues: []int32{hashValue},
|
||||||
|
InsertRequest: insertRequest,
|
||||||
|
}
|
||||||
|
tsMsg = insertMsg
|
||||||
}
|
}
|
||||||
return &tsMsg
|
return &tsMsg
|
||||||
}
|
}
|
||||||
@ -211,3 +227,17 @@ func TestStream_TimeSync(t *testing.T) {
|
|||||||
//run stream
|
//run stream
|
||||||
initStream(pulsarAddress, producerChannels, consumerChannels, consumerSubName, &msgPack, kTimeSync, kTimeSync)
|
initStream(pulsarAddress, producerChannels, consumerChannels, consumerSubName, &msgPack, kTimeSync, kTimeSync)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStream_BroadCast(t *testing.T) {
|
||||||
|
pulsarAddress := "pulsar://localhost:6650"
|
||||||
|
producerChannels := []string{"insert"}
|
||||||
|
consumerChannels := []string{"insert"}
|
||||||
|
consumerSubName := "subInsert"
|
||||||
|
|
||||||
|
msgPack := MsgPack{}
|
||||||
|
msgPack.Msgs = append(msgPack.Msgs, getTsMsg(kTimeTick, 0, 0))
|
||||||
|
msgPack.Msgs = append(msgPack.Msgs, getTsMsg(kTimeTick, 3, 3))
|
||||||
|
|
||||||
|
//run stream
|
||||||
|
initStream(pulsarAddress, producerChannels, consumerChannels, consumerSubName, &msgPack, kInsert, kInsert)
|
||||||
|
}
|
||||||
|
|||||||
456
ruleguard.rules.go
Normal file
456
ruleguard.rules.go
Normal file
@ -0,0 +1,456 @@
|
|||||||
|
// Copyright (C) 2019-2020 Zilliz. All rights reserved.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
|
||||||
|
// with the License. You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software distributed under the License
|
||||||
|
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
|
||||||
|
// or implied. See the License for the specific language governing permissions and limitations under the License.
|
||||||
|
|
||||||
|
// +build ignore
|
||||||
|
|
||||||
|
package gorules
|
||||||
|
|
||||||
|
import "github.com/quasilyte/go-ruleguard/dsl/fluent"
|
||||||
|
|
||||||
|
// This is a collection of rules for ruleguard: https://github.com/quasilyte/go-ruleguard
|
||||||
|
|
||||||
|
// Remove extra conversions: mdempsky/unconvert
|
||||||
|
func unconvert(m fluent.Matcher) {
|
||||||
|
m.Match("int($x)").Where(m["x"].Type.Is("int") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
|
||||||
|
m.Match("float32($x)").Where(m["x"].Type.Is("float32") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("float64($x)").Where(m["x"].Type.Is("float64") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
|
||||||
|
// m.Match("byte($x)").Where(m["x"].Type.Is("byte")).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
// m.Match("rune($x)").Where(m["x"].Type.Is("rune")).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("bool($x)").Where(m["x"].Type.Is("bool") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
|
||||||
|
m.Match("int8($x)").Where(m["x"].Type.Is("int8") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("int16($x)").Where(m["x"].Type.Is("int16") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("int32($x)").Where(m["x"].Type.Is("int32") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("int64($x)").Where(m["x"].Type.Is("int64") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
|
||||||
|
m.Match("uint8($x)").Where(m["x"].Type.Is("uint8") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("uint16($x)").Where(m["x"].Type.Is("uint16") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("uint32($x)").Where(m["x"].Type.Is("uint32") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
m.Match("uint64($x)").Where(m["x"].Type.Is("uint64") && !m["x"].Const).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
|
||||||
|
m.Match("time.Duration($x)").Where(m["x"].Type.Is("time.Duration") && !m["x"].Text.Matches("^[0-9]*$")).Report("unnecessary conversion").Suggest("$x")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Don't use == or != with time.Time
|
||||||
|
// https://github.com/dominikh/go-tools/issues/47 : Wontfix
|
||||||
|
func timeeq(m fluent.Matcher) {
|
||||||
|
m.Match("$t0 == $t1").Where(m["t0"].Type.Is("time.Time")).Report("using == with time.Time")
|
||||||
|
m.Match("$t0 != $t1").Where(m["t0"].Type.Is("time.Time")).Report("using != with time.Time")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrong err in error check
|
||||||
|
func wrongerr(m fluent.Matcher) {
|
||||||
|
m.Match("if $*_, $err0 := $*_; $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 := $*_; $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 = $*_; $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 = $*_; $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 := $*_; $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 := $*_; $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 = $*_; $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("if $*_, $err0 = $*_; $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 := $*_; if $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 := $*_; if $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 := $*_; if $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 := $*_; if $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 = $*_; if $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 = $*_; if $err1 != nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 = $*_; if $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text == "err" && m["err0"].Type.Is("error") && m["err1"].Text != "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
|
||||||
|
m.Match("$*_, $err0 = $*_; if $err1 == nil { $*_ }").
|
||||||
|
Where(m["err0"].Text != "err" && m["err0"].Type.Is("error") && m["err1"].Text == "err" && m["err1"].Type.Is("error")).
|
||||||
|
Report("maybe wrong err in error check")
|
||||||
|
}
|
||||||
|
|
||||||
|
// err but no an error
|
||||||
|
func errnoterror(m fluent.Matcher) {
|
||||||
|
|
||||||
|
// Would be easier to check for all err identifiers instead, but then how do we get the type from m[] ?
|
||||||
|
|
||||||
|
m.Match(
|
||||||
|
"if $*_, err := $x; $err != nil { $*_ } else if $_ { $*_ }",
|
||||||
|
"if $*_, err := $x; $err != nil { $*_ } else { $*_ }",
|
||||||
|
"if $*_, err := $x; $err != nil { $*_ }",
|
||||||
|
|
||||||
|
"if $*_, err = $x; $err != nil { $*_ } else if $_ { $*_ }",
|
||||||
|
"if $*_, err = $x; $err != nil { $*_ } else { $*_ }",
|
||||||
|
"if $*_, err = $x; $err != nil { $*_ }",
|
||||||
|
|
||||||
|
"$*_, err := $x; if $err != nil { $*_ } else if $_ { $*_ }",
|
||||||
|
"$*_, err := $x; if $err != nil { $*_ } else { $*_ }",
|
||||||
|
"$*_, err := $x; if $err != nil { $*_ }",
|
||||||
|
|
||||||
|
"$*_, err = $x; if $err != nil { $*_ } else if $_ { $*_ }",
|
||||||
|
"$*_, err = $x; if $err != nil { $*_ } else { $*_ }",
|
||||||
|
"$*_, err = $x; if $err != nil { $*_ }",
|
||||||
|
).
|
||||||
|
Where(m["err"].Text == "err" && !m["err"].Type.Is("error") && m["x"].Text != "recover()").
|
||||||
|
Report("err variable not error type")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Identical if and else bodies
|
||||||
|
func ifbodythenbody(m fluent.Matcher) {
|
||||||
|
m.Match("if $*_ { $body } else { $body }").
|
||||||
|
Report("identical if and else bodies")
|
||||||
|
|
||||||
|
// Lots of false positives.
|
||||||
|
// m.Match("if $*_ { $body } else if $*_ { $body }").
|
||||||
|
// Report("identical if and else bodies")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Odd inequality: A - B < 0 instead of !=
|
||||||
|
// Too many false positives.
|
||||||
|
/*
|
||||||
|
func subtractnoteq(m fluent.Matcher) {
|
||||||
|
m.Match("$a - $b < 0").Report("consider $a != $b")
|
||||||
|
m.Match("$a - $b > 0").Report("consider $a != $b")
|
||||||
|
m.Match("0 < $a - $b").Report("consider $a != $b")
|
||||||
|
m.Match("0 > $a - $b").Report("consider $a != $b")
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Self-assignment
|
||||||
|
func selfassign(m fluent.Matcher) {
|
||||||
|
m.Match("$x = $x").Report("useless self-assignment")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Odd nested ifs
|
||||||
|
func oddnestedif(m fluent.Matcher) {
|
||||||
|
m.Match("if $x { if $x { $*_ }; $*_ }",
|
||||||
|
"if $x == $y { if $x != $y {$*_ }; $*_ }",
|
||||||
|
"if $x != $y { if $x == $y {$*_ }; $*_ }",
|
||||||
|
"if $x { if !$x { $*_ }; $*_ }",
|
||||||
|
"if !$x { if $x { $*_ }; $*_ }").
|
||||||
|
Report("odd nested ifs")
|
||||||
|
|
||||||
|
m.Match("for $x { if $x { $*_ }; $*_ }",
|
||||||
|
"for $x == $y { if $x != $y {$*_ }; $*_ }",
|
||||||
|
"for $x != $y { if $x == $y {$*_ }; $*_ }",
|
||||||
|
"for $x { if !$x { $*_ }; $*_ }",
|
||||||
|
"for !$x { if $x { $*_ }; $*_ }").
|
||||||
|
Report("odd nested for/ifs")
|
||||||
|
}
|
||||||
|
|
||||||
|
// odd bitwise expressions
|
||||||
|
func oddbitwise(m fluent.Matcher) {
|
||||||
|
m.Match("$x | $x",
|
||||||
|
"$x | ^$x",
|
||||||
|
"^$x | $x").
|
||||||
|
Report("odd bitwise OR")
|
||||||
|
|
||||||
|
m.Match("$x & $x",
|
||||||
|
"$x & ^$x",
|
||||||
|
"^$x & $x").
|
||||||
|
Report("odd bitwise AND")
|
||||||
|
|
||||||
|
m.Match("$x &^ $x").
|
||||||
|
Report("odd bitwise AND-NOT")
|
||||||
|
}
|
||||||
|
|
||||||
|
// odd sequence of if tests with return
|
||||||
|
func ifreturn(m fluent.Matcher) {
|
||||||
|
m.Match("if $x { return $*_ }; if $x {$*_ }").Report("odd sequence of if test")
|
||||||
|
m.Match("if $x { return $*_ }; if !$x {$*_ }").Report("odd sequence of if test")
|
||||||
|
m.Match("if !$x { return $*_ }; if $x {$*_ }").Report("odd sequence of if test")
|
||||||
|
m.Match("if $x == $y { return $*_ }; if $x != $y {$*_ }").Report("odd sequence of if test")
|
||||||
|
m.Match("if $x != $y { return $*_ }; if $x == $y {$*_ }").Report("odd sequence of if test")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func oddifsequence(m fluent.Matcher) {
|
||||||
|
/*
|
||||||
|
m.Match("if $x { $*_ }; if $x {$*_ }").Report("odd sequence of if test")
|
||||||
|
m.Match("if $x == $y { $*_ }; if $y == $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
m.Match("if $x != $y { $*_ }; if $y != $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
m.Match("if $x < $y { $*_ }; if $y > $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
m.Match("if $x <= $y { $*_ }; if $y >= $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
m.Match("if $x > $y { $*_ }; if $y < $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
m.Match("if $x >= $y { $*_ }; if $y <= $x {$*_ }").Report("odd sequence of if tests")
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
|
||||||
|
// odd sequence of nested if tests
|
||||||
|
func nestedifsequence(m fluent.Matcher) {
|
||||||
|
/*
|
||||||
|
m.Match("if $x < $y { if $x >= $y {$*_ }; $*_ }").Report("odd sequence of nested if tests")
|
||||||
|
m.Match("if $x <= $y { if $x > $y {$*_ }; $*_ }").Report("odd sequence of nested if tests")
|
||||||
|
m.Match("if $x > $y { if $x <= $y {$*_ }; $*_ }").Report("odd sequence of nested if tests")
|
||||||
|
m.Match("if $x >= $y { if $x < $y {$*_ }; $*_ }").Report("odd sequence of nested if tests")
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
|
||||||
|
// odd sequence of assignments
|
||||||
|
func identicalassignments(m fluent.Matcher) {
|
||||||
|
m.Match("$x = $y; $y = $x").Report("odd sequence of assignments")
|
||||||
|
}
|
||||||
|
|
||||||
|
func oddcompoundop(m fluent.Matcher) {
|
||||||
|
m.Match("$x += $x + $_",
|
||||||
|
"$x += $x - $_").
|
||||||
|
Report("odd += expression")
|
||||||
|
|
||||||
|
m.Match("$x -= $x + $_",
|
||||||
|
"$x -= $x - $_").
|
||||||
|
Report("odd -= expression")
|
||||||
|
}
|
||||||
|
|
||||||
|
func constswitch(m fluent.Matcher) {
|
||||||
|
m.Match("switch $x { $*_ }", "switch $*_; $x { $*_ }").
|
||||||
|
Where(m["x"].Const && !m["x"].Text.Matches(`^runtime\.`)).
|
||||||
|
Report("constant switch")
|
||||||
|
}
|
||||||
|
|
||||||
|
func oddcomparisons(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"$x - $y == 0",
|
||||||
|
"$x - $y != 0",
|
||||||
|
"$x - $y < 0",
|
||||||
|
"$x - $y <= 0",
|
||||||
|
"$x - $y > 0",
|
||||||
|
"$x - $y >= 0",
|
||||||
|
"$x ^ $y == 0",
|
||||||
|
"$x ^ $y != 0",
|
||||||
|
).Report("odd comparison")
|
||||||
|
}
|
||||||
|
|
||||||
|
func oddmathbits(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"64 - bits.LeadingZeros64($x)",
|
||||||
|
"32 - bits.LeadingZeros32($x)",
|
||||||
|
"16 - bits.LeadingZeros16($x)",
|
||||||
|
"8 - bits.LeadingZeros8($x)",
|
||||||
|
).Report("odd math/bits expression: use bits.Len*() instead?")
|
||||||
|
}
|
||||||
|
|
||||||
|
func floateq(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"$x == $y",
|
||||||
|
"$x != $y",
|
||||||
|
).
|
||||||
|
Where(m["x"].Type.Is("float32") && !m["x"].Const && !m["y"].Text.Matches("0(.0+)?")).
|
||||||
|
Report("floating point tested for equality")
|
||||||
|
|
||||||
|
m.Match(
|
||||||
|
"$x == $y",
|
||||||
|
"$x != $y",
|
||||||
|
).
|
||||||
|
Where(m["x"].Type.Is("float64") && !m["x"].Const && !m["y"].Text.Matches("0(.0+)?")).
|
||||||
|
Report("floating point tested for equality")
|
||||||
|
|
||||||
|
m.Match("switch $x { $*_ }", "switch $*_; $x { $*_ }").
|
||||||
|
Where(m["x"].Type.Is("float32")).
|
||||||
|
Report("floating point as switch expression")
|
||||||
|
|
||||||
|
m.Match("switch $x { $*_ }", "switch $*_; $x { $*_ }").
|
||||||
|
Where(m["x"].Type.Is("float64")).
|
||||||
|
Report("floating point as switch expression")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func badexponent(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"2 ^ $x",
|
||||||
|
"10 ^ $x",
|
||||||
|
).
|
||||||
|
Report("caret (^) is not exponentiation")
|
||||||
|
}
|
||||||
|
|
||||||
|
func floatloop(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"for $i := $x; $i < $y; $i += $z { $*_ }",
|
||||||
|
"for $i = $x; $i < $y; $i += $z { $*_ }",
|
||||||
|
).
|
||||||
|
Where(m["i"].Type.Is("float64")).
|
||||||
|
Report("floating point for loop counter")
|
||||||
|
|
||||||
|
m.Match(
|
||||||
|
"for $i := $x; $i < $y; $i += $z { $*_ }",
|
||||||
|
"for $i = $x; $i < $y; $i += $z { $*_ }",
|
||||||
|
).
|
||||||
|
Where(m["i"].Type.Is("float32")).
|
||||||
|
Report("floating point for loop counter")
|
||||||
|
}
|
||||||
|
|
||||||
|
func urlredacted(m fluent.Matcher) {
|
||||||
|
|
||||||
|
m.Match(
|
||||||
|
"log.Println($x, $*_)",
|
||||||
|
"log.Println($*_, $x, $*_)",
|
||||||
|
"log.Println($*_, $x)",
|
||||||
|
"log.Printf($*_, $x, $*_)",
|
||||||
|
"log.Printf($*_, $x)",
|
||||||
|
|
||||||
|
"log.Println($x, $*_)",
|
||||||
|
"log.Println($*_, $x, $*_)",
|
||||||
|
"log.Println($*_, $x)",
|
||||||
|
"log.Printf($*_, $x, $*_)",
|
||||||
|
"log.Printf($*_, $x)",
|
||||||
|
).
|
||||||
|
Where(m["x"].Type.Is("*url.URL")).
|
||||||
|
Report("consider $x.Redacted() when outputting URLs")
|
||||||
|
}
|
||||||
|
|
||||||
|
func sprinterr(m fluent.Matcher) {
|
||||||
|
m.Match(`fmt.Sprint($err)`,
|
||||||
|
`fmt.Sprintf("%s", $err)`,
|
||||||
|
`fmt.Sprintf("%v", $err)`,
|
||||||
|
).
|
||||||
|
Where(m["err"].Type.Is("error")).
|
||||||
|
Report("maybe call $err.Error() instead of fmt.Sprint()?")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func largeloopcopy(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
`for $_, $v := range $_ { $*_ }`,
|
||||||
|
).
|
||||||
|
Where(m["v"].Type.Size > 512).
|
||||||
|
Report(`loop copies large value each iteration`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func joinpath(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
`strings.Join($_, "/")`,
|
||||||
|
`strings.Join($_, "\\")`,
|
||||||
|
"strings.Join($_, `\\`)",
|
||||||
|
).
|
||||||
|
Report(`did you mean path.Join() or filepath.Join() ?`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func readfull(m fluent.Matcher) {
|
||||||
|
m.Match(`$n, $err := io.ReadFull($_, $slice)
|
||||||
|
if $err != nil || $n != len($slice) {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`$n, $err := io.ReadFull($_, $slice)
|
||||||
|
if $n != len($slice) || $err != nil {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`$n, $err = io.ReadFull($_, $slice)
|
||||||
|
if $err != nil || $n != len($slice) {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`$n, $err = io.ReadFull($_, $slice)
|
||||||
|
if $n != len($slice) || $err != nil {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`if $n, $err := io.ReadFull($_, $slice); $n != len($slice) || $err != nil {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`if $n, $err := io.ReadFull($_, $slice); $err != nil || $n != len($slice) {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`if $n, $err = io.ReadFull($_, $slice); $n != len($slice) || $err != nil {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
`if $n, $err = io.ReadFull($_, $slice); $err != nil || $n != len($slice) {
|
||||||
|
$*_
|
||||||
|
}`,
|
||||||
|
).Report("io.ReadFull() returns err == nil iff n == len(slice)")
|
||||||
|
}
|
||||||
|
|
||||||
|
func nilerr(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
`if err == nil { return err }`,
|
||||||
|
`if err == nil { return $*_, err }`,
|
||||||
|
).
|
||||||
|
Report(`return nil error instead of nil value`)
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func mailaddress(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
"fmt.Sprintf(`\"%s\" <%s>`, $NAME, $EMAIL)",
|
||||||
|
"fmt.Sprintf(`\"%s\"<%s>`, $NAME, $EMAIL)",
|
||||||
|
"fmt.Sprintf(`%s <%s>`, $NAME, $EMAIL)",
|
||||||
|
"fmt.Sprintf(`%s<%s>`, $NAME, $EMAIL)",
|
||||||
|
`fmt.Sprintf("\"%s\"<%s>", $NAME, $EMAIL)`,
|
||||||
|
`fmt.Sprintf("\"%s\" <%s>", $NAME, $EMAIL)`,
|
||||||
|
`fmt.Sprintf("%s<%s>", $NAME, $EMAIL)`,
|
||||||
|
`fmt.Sprintf("%s <%s>", $NAME, $EMAIL)`,
|
||||||
|
).
|
||||||
|
Report("use net/mail Address.String() instead of fmt.Sprintf()").
|
||||||
|
Suggest("(&mail.Address{Name:$NAME, Address:$EMAIL}).String()")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func errnetclosed(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
`strings.Contains($err.Error(), $text)`,
|
||||||
|
).
|
||||||
|
Where(m["text"].Text.Matches("\".*closed network connection.*\"")).
|
||||||
|
Report(`String matching against error texts is fragile; use net.ErrClosed instead`).
|
||||||
|
Suggest(`errors.Is($err, net.ErrClosed)`)
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func httpheaderadd(m fluent.Matcher) {
|
||||||
|
m.Match(
|
||||||
|
`$H.Add($KEY, $VALUE)`,
|
||||||
|
).
|
||||||
|
Where(m["H"].Type.Is("http.Header")).
|
||||||
|
Report("use http.Header.Set method instead of Add to overwrite all existing header values").
|
||||||
|
Suggest(`$H.Set($KEY, $VALUE)`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func hmacnew(m fluent.Matcher) {
|
||||||
|
m.Match("hmac.New(func() hash.Hash { return $x }, $_)",
|
||||||
|
`$f := func() hash.Hash { return $x }
|
||||||
|
$*_
|
||||||
|
hmac.New($f, $_)`,
|
||||||
|
).Where(m["x"].Pure).
|
||||||
|
Report("invalid hash passed to hmac.New()")
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user