Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable new linters and fix found bugs #156

Merged
merged 1 commit into from
Jul 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions .golangci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,25 @@ linters:
- exportloopref
- revive
- dupl
- gosimple
- gocognit
- unused
- stylecheck
- ineffassign
- unconvert
- varcheck
- errorlint

linters-settings:
goimports:
local-prefixes: github.com/filecoin-project/mir
gocognit:
min-complexity: 50

run:
timeout: 2m
timeout: 5m

issues:
exclude-rules:
- path: .*\.pb\.mir\.go
linters: [revive, golint]
linters: [revive, stylecheck]
3 changes: 2 additions & 1 deletion cmd/mircat/debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package main
import (
"bufio"
"context"
"errors"
"fmt"
"io"
"os"
Expand Down Expand Up @@ -96,7 +97,7 @@ func debug(args *arguments) error {
}
}

if err != io.EOF {
if errors.Is(err, io.EOF) {
return fmt.Errorf("error reading event log: %w", err)
}

Expand Down
3 changes: 2 additions & 1 deletion cmd/mircat/display.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package main

import (
"errors"
"fmt"
"io"
"strconv"
Expand Down Expand Up @@ -57,7 +58,7 @@ func displayEvents(args *arguments) error {
}
}

if err != io.EOF {
if errors.Is(err, io.EOF) {
return fmt.Errorf("error reading event log: %w", err)
}

Expand Down
9 changes: 5 additions & 4 deletions cmd/mircat/eventloader.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package main

import (
"errors"
"fmt"
"io"
"os"
Expand Down Expand Up @@ -54,7 +55,7 @@ func getEventList(file *os.File) (map[string]struct{}, map[string]struct{}, int,
}
}
}
if err != io.EOF {
if errors.Is(err, io.EOF) {
return events, issEvents, cnt, fmt.Errorf("failed reading event log: %w", err)
}

Expand All @@ -64,15 +65,15 @@ func getEventList(file *os.File) (map[string]struct{}, map[string]struct{}, int,
// eventName returns a string name of an Event.
func eventName(event *eventpb.Event) string {
return strings.ReplaceAll(
reflect.TypeOf(event.Type).Elem().Name(), //gets the type's name i.e. Event_Tick , Event_Iss,etc
reflect.TypeOf(event.Type).Elem().Name(), // gets the type's name i.e. Event_Tick , Event_Iss,etc
"Event_", "")
}

// issEventName returns a string name of an ISS event.
func issEventName(issEvent *isspb.ISSEvent) string {
return strings.ReplaceAll(
reflect.TypeOf(issEvent.Type).Elem().Name(), //gets the type's name i.e. ISSEvent_sb , ISSEvent_PersistCheckpoint,etc
"ISSEvent_", "") //replaces the given substring from the name
reflect.TypeOf(issEvent.Type).Elem().Name(), // gets the type's name i.e. ISSEvent_sb , ISSEvent_PersistCheckpoint,etc
"ISSEvent_", "") // replaces the given substring from the name
}

// selected returns true if the given event has been selected by the user according to the given criteria.
Expand Down
2 changes: 1 addition & 1 deletion pkg/crypto/ecdsa.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func ecdsaSignatureFromBytes(raw []byte) (*big.Int, *big.Int, error) {
sig := new(ecdsaSignature)
_, err := asn1.Unmarshal(raw, sig)
if err != nil {
return nil, nil, fmt.Errorf("failed unmashalling signature [%s]", err)
return nil, nil, fmt.Errorf("failed unmashalling signature [%w]", err)
}

// Validate sig
Expand Down
3 changes: 1 addition & 2 deletions pkg/deploytest/testreplica.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ import (
"strconv"
"sync"

"github.com/filecoin-project/mir/pkg/net"

"github.com/filecoin-project/mir"
"github.com/filecoin-project/mir/pkg/eventlog"
"github.com/filecoin-project/mir/pkg/events"
"github.com/filecoin-project/mir/pkg/logging"
"github.com/filecoin-project/mir/pkg/modules"
"github.com/filecoin-project/mir/pkg/net"
"github.com/filecoin-project/mir/pkg/pb/requestpb"
"github.com/filecoin-project/mir/pkg/requestreceiver"
"github.com/filecoin-project/mir/pkg/simplewal"
Expand Down
6 changes: 3 additions & 3 deletions pkg/eventlog/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ func (i *Recorder) Stop() error {
<-i.exitC
i.exitErrMutex.Lock()
defer i.exitErrMutex.Unlock()
if i.exitErr == errStopped {
if errors.Is(i.exitErr, errStopped) {
return nil
}
return i.exitErr
Expand Down Expand Up @@ -285,7 +285,7 @@ func NewReader(source io.Reader) (*Reader, error) {
func (r *Reader) ReadEntry() (*recordingpb.Entry, error) {
re := &recordingpb.Entry{}
err := readSizePrefixedProto(r.source, re, r.buffer)
if err == io.EOF {
if errors.Is(err, io.EOF) {
r.gzReader.Close()
return re, err
}
Expand All @@ -300,7 +300,7 @@ func (r *Reader) ReadEntry() (*recordingpb.Entry, error) {
func readSizePrefixedProto(reader *bufio.Reader, msg proto.Message, buffer *bytes.Buffer) error {
l, err := binary.ReadVarint(reader)
if err != nil {
if err == io.EOF {
if errors.Is(err, io.EOF) {
return err
}
return errors.WithMessage(err, "could not read size prefix")
Expand Down
3 changes: 2 additions & 1 deletion pkg/iss/iss.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"encoding/binary"
"fmt"

"google.golang.org/protobuf/proto"

"github.com/filecoin-project/mir/pkg/events"
"github.com/filecoin-project/mir/pkg/logging"
"github.com/filecoin-project/mir/pkg/messagebuffer"
Expand All @@ -28,7 +30,6 @@ import (
"github.com/filecoin-project/mir/pkg/serializing"
t "github.com/filecoin-project/mir/pkg/types"
"github.com/filecoin-project/mir/pkg/util/maputil"
"google.golang.org/protobuf/proto"
)

// ============================================================
Expand Down
3 changes: 2 additions & 1 deletion pkg/modules/mockmodules/mock_modules.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
package mockmodules

import (
"github.com/golang/mock/gomock"

"github.com/filecoin-project/mir/pkg/events"
"github.com/filecoin-project/mir/pkg/modules"
"github.com/filecoin-project/mir/pkg/modules/mockmodules/internal/mock_internal"
"github.com/golang/mock/gomock"
)

// MockPassiveModule is a slightly more user-friendly wrapper around gomock_modules.MockPassiveModule.
Expand Down
11 changes: 6 additions & 5 deletions pkg/pb/eventpb/eventpb.pb.mir.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
package eventpb

import (
availabilitypb "github.com/filecoin-project/mir/pkg/pb/availabilitypb"
bcbpb "github.com/filecoin-project/mir/pkg/pb/bcbpb"
isspb "github.com/filecoin-project/mir/pkg/pb/isspb"
mempoolpb "github.com/filecoin-project/mir/pkg/pb/mempoolpb"
wrapperspb "google.golang.org/protobuf/types/known/wrapperspb"
"google.golang.org/protobuf/types/known/wrapperspb"

"github.com/filecoin-project/mir/pkg/pb/availabilitypb"
"github.com/filecoin-project/mir/pkg/pb/bcbpb"
"github.com/filecoin-project/mir/pkg/pb/isspb"
"github.com/filecoin-project/mir/pkg/pb/mempoolpb"
)

type Event_Type = isEvent_Type
Expand Down
5 changes: 3 additions & 2 deletions samples/chat-demo/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ import (
"strconv"
"strings"

"github.com/multiformats/go-multiaddr"
"gopkg.in/alecthomas/kingpin.v2"

"github.com/filecoin-project/mir"
mirCrypto "github.com/filecoin-project/mir/pkg/crypto"
"github.com/filecoin-project/mir/pkg/dummyclient"
Expand All @@ -34,8 +37,6 @@ import (
"github.com/filecoin-project/mir/pkg/requestreceiver"
t "github.com/filecoin-project/mir/pkg/types"
libp2ptools "github.com/filecoin-project/mir/pkg/util/libp2p"
"github.com/multiformats/go-multiaddr"
"gopkg.in/alecthomas/kingpin.v2"
)

const (
Expand Down