Merge pull request #94 from guggero/lint

Add linter to makefile, lint on Travis build

Author: halseth

.golangci.yml

@@ -0,0 +1,43 @@
+run:
+  # timeout for analysis
+  deadline: 4m
+
+  # Linting uses a lot of memory. Keep it under control by only running a single
+  # worker.
+  concurrency: 1
+
+linters-settings:
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+
+linters:
+  enable-all: true
+  disable:
+  # Global variables are used in many places throughout the code base.
+  - gochecknoglobals
+
+  # Some lines are over 80 characters on purpose and we don't want to make them
+  # even longer by marking them as 'nolint'.
+  - lll
+
+  # We don't care (enough) about misaligned structs to lint that.
+  - maligned
+
+  # We have long functions, especially in tests. Moving or renaming those would
+  # trigger funlen problems that we may not want to solve at that time.
+  - funlen
+
+  # Disable for now as we haven't yet tuned the sensitivity to our codebase
+  # yet.  Enabling by default for example, would also force new contributors to
+  # potentially extensively refactor code, when they want to smaller change to
+  # land.
+  - gocyclo
+
+  # Instances of table driven tests that don't pre-allocate shouldn't trigger
+  # the linter.
+  - prealloc
+
+issues:
+  # Only show newly introduced problems.
+  new-from-rev: 36838cf7f464cf73b0201798063b2caffeae4250

.travis.yml

@@ -18,7 +18,7 @@ sudo: required
 
 script:
   - export GO111MODULE=on
-  - make unit
+  - make lint unit
 
 after_script:
   - echo "Uploading to termbin.com..." && find *.log | xargs -I{} sh -c "cat {} | nc termbin.com 9999 | xargs -r0 printf '{} uploaded to %s'"

Makefile

@@ -2,14 +2,35 @@ PKG := github.com/lightninglabs/loop
 
 GOTEST := GO111MODULE=on go test -v
 
+GO_BIN := ${GOPATH}/bin
+
+GOFILES_NOVENDOR = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
 GOLIST := go list $(PKG)/... | grep -v '/vendor/'
 
+LINT_BIN := $(GO_BIN)/golangci-lint
+LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
+LINT_COMMIT := v1.18.0
+LINT = $(LINT_BIN) run -v
+
+DEPGET := cd /tmp && GO111MODULE=on go get -v
 XARGS := xargs -L 1
 
 TEST_FLAGS = -test.timeout=20m
 
 UNIT := $(GOLIST) | $(XARGS) env $(GOTEST) $(TEST_FLAGS)
 
+$(LINT_BIN):
+	@$(call print, "Fetching linter")
+	$(DEPGET) $(LINT_PKG)@$(LINT_COMMIT)
+
 unit: 
 	@$(call print, "Running unit tests.")
 	$(UNIT)
+
+fmt:
+	@$(call print, "Formatting source.")
+	gofmt -l -w -s $(GOFILES_NOVENDOR)
+
+lint: $(LINT_BIN)
+	@$(call print, "Linting source.")
+	$(LINT)

client.go

@@ -384,7 +384,7 @@ func (s *Client) LoopOutQuote(ctx context.Context,
 	return &LoopOutQuote{
 		SwapFee:         swapFee,
 		MinerFee:        minerFee,
-		PrepayAmount:    btcutil.Amount(quote.PrepayAmount),
+		PrepayAmount:    quote.PrepayAmount,
 		SwapPaymentDest: quote.SwapPaymentDest,
 		CltvDelta:       quote.CltvDelta,
 	}, nil

cmd/loop/loopin.go

@@ -41,8 +41,7 @@ func loopIn(ctx *cli.Context) error {
 		args = args.Tail()
 	default:
 		// Show command help if no arguments and flags were provided.
-		cli.ShowCommandHelp(ctx, "in")
-		return nil
+		return cli.ShowCommandHelp(ctx, "in")
 	}
 
 	amt, err := parseAmt(amtStr)

cmd/loop/loopout.go

@@ -59,8 +59,7 @@ func loopOut(ctx *cli.Context) error {
 		args = args.Tail()
 	default:
 		// Show command help if no arguments and flags were provided.
-		cli.ShowCommandHelp(ctx, "out")
-		return nil
+		return cli.ShowCommandHelp(ctx, "out")
 	}
 
 	amt, err := parseAmt(amtStr)

cmd/loop/main.go

@@ -97,7 +97,7 @@ type limits struct {
 }
 
 func getLimits(amt btcutil.Amount, quote *looprpc.QuoteResponse) *limits {
-	maxSwapRoutingFee := getMaxRoutingFee(btcutil.Amount(amt))
+	maxSwapRoutingFee := getMaxRoutingFee(amt)
 	maxPrepayRoutingFee := getMaxRoutingFee(btcutil.Amount(
 		quote.PrepayAmt,
 	))
@@ -126,7 +126,7 @@ func displayLimits(swapType loop.Type, amt btcutil.Amount, l *limits,
 	if l.maxPrepayRoutingFee != nil {
 		totalSuccessMax += *l.maxPrepayRoutingFee
 	}
-	
+
 	if swapType == loop.TypeIn && externalHtlc {
 		fmt.Printf("On-chain fee for external loop in is not " +
 			"included.\nSufficient fees will need to be paid " +
@@ -135,7 +135,7 @@ func displayLimits(swapType loop.Type, amt btcutil.Amount, l *limits,
 	}
 
 	fmt.Printf("Max swap fees for %d Loop %v: %d\n",
-		btcutil.Amount(amt), swapType, totalSuccessMax,
+		amt, swapType, totalSuccessMax,
 	)
 
 	fmt.Printf("CONTINUE SWAP? (y/n), expand fee detail (x): ")

cmd/loop/quote.go

@@ -28,8 +28,7 @@ func quote(ctx *cli.Context) error {
 	// Show command help if the incorrect number arguments and/or flags were
 	// provided.
 	if ctx.NArg() != 1 || ctx.NumFlags() > 1 {
-		cli.ShowCommandHelp(ctx, "quote")
-		return nil
+		return cli.ShowCommandHelp(ctx, "quote")
 	}
 
 	args := ctx.Args()

executor.go

@@ -69,7 +69,7 @@ func (s *executor) run(mainCtx context.Context,
 
 	select {
 	case h := <-blockEpochChan:
-		setHeight(int32(h))
+		setHeight(h)
 	case err := <-blockErrorChan:
 		return err
 	case <-mainCtx.Done():
@@ -134,10 +134,10 @@ func (s *executor) run(mainCtx context.Context,
 			delete(blockEpochQueues, doneID)
 
 		case h := <-blockEpochChan:
-			setHeight(int32(h))
+			setHeight(h)
 			for _, queue := range blockEpochQueues {
 				select {
-				case queue.ChanIn() <- int32(h):
+				case queue.ChanIn() <- h:
 				case <-mainCtx.Done():
 					return mainCtx.Err()
 				}

lndclient/invoices_client.go

@@ -52,10 +52,10 @@ func (s *invoicesClient) WaitForFinished() {
 func (s *invoicesClient) SettleInvoice(ctx context.Context,
 	preimage lntypes.Preimage) error {
 
-	rpcCtx, cancel := context.WithTimeout(ctx, rpcTimeout)
+	timeoutCtx, cancel := context.WithTimeout(ctx, rpcTimeout)
 	defer cancel()
 
-	rpcCtx = s.invoiceMac.WithMacaroonAuth(ctx)
+	rpcCtx := s.invoiceMac.WithMacaroonAuth(timeoutCtx)
 	_, err := s.client.SettleInvoice(rpcCtx, &invoicesrpc.SettleInvoiceMsg{
 		Preimage: preimage[:],
 	})