From f9d61b808032f9c57d134ddc251f07ed9b4de2d0 Mon Sep 17 00:00:00 2001 From: Alex Efros Date: Sat, 25 May 2019 00:10:22 +0300 Subject: [PATCH] ci: update linter, add deploy --- .circleci/config.yml | 33 +++- .gitattributes | 7 + .golangci.yml | 332 +++++++++++++++++++++++++++++-------- README.md | 11 +- cmd/jsonrpc2client/main.go | 3 +- jsonrpc2/batch.go | 4 +- jsonrpc2/http.go | 10 +- jsonrpc2/log.go | 9 + jsonrpc2/server.go | 2 +- release | 31 ++++ 10 files changed, 363 insertions(+), 79 deletions(-) create mode 100644 .gitattributes create mode 100644 jsonrpc2/log.go create mode 100755 release diff --git a/.circleci/config.yml b/.circleci/config.yml index 0484665..dc5b559 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,11 +1,11 @@ version: 2.1 jobs: - build: + test: docker: - image: circleci/golang:1 environment: - GOLANGCI_LINT_VER: 1.12.2 + GOLANGCI_LINT_VER: 1.15.0 steps: - checkout - run: @@ -37,3 +37,32 @@ jobs: - /go/pkg/ - /go/src/ - ~/.cache/go-build/ + release: + docker: + - image: circleci/golang:1 + environment: + GHR_VER: 0.12.0 + steps: + - checkout + - run: + name: Install tools + command: | + curl -sfL https://github.com/tcnksm/ghr/releases/download/v${GHR_VER}/ghr_v${GHR_VER}_linux_amd64.tar.gz | + tar xzf - -C /tmp && mv /tmp/ghr_v${GHR_VER}_linux_amd64/ghr /go/bin/ + - run: ./release + +workflows: + test-and-release: + jobs: + - test: + filters: + tags: + only: /v.*/ + - release: + requires: + - test + filters: + tags: + only: /v.*/ + branches: + ignore: /.*/ diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8336044 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,7 @@ +# /name - apply (* doesn't match /) to file "name" beginning in project root +# na/me - apply (* doesn't match /) to file "na/me" anywhere +# name - apply (* do match /) to file "name" anywhere +# name/** - apply … to dir … +# **/name - apply (* doesn't match /) to file "name" in any dir including project root +# na/**/me - apply (* doesn't match /) to file "na/me", "na/*/me", "na/*/*/me", … +go.sum binary diff --git a/.golangci.yml b/.golangci.yml index a3a384c..fcb363f 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,72 +1,272 @@ +# This file contains all available configuration options +# with their default values. + +# options for analysis running +run: + # default concurrency is a available CPU number + # concurrency: 4 + + # timeout for analysis, e.g. 30s, 5m, default is 1m + # deadline: 1m + + # exit code when at least one issue was found, default is 1 + # issues-exit-code: 1 + + # include test files or not, default is true + # tests: true + + # list of build tags, all linters use it. Default is empty list. + build-tags: + - integration + + # which dirs to skip: they won't be analyzed; + # can use regexp here: generated.*, regexp is applied on full path; + # default value is empty list, but next dirs are always skipped independently + # from this option's value: + # vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + # skip-dirs: + # - src/external_libs + # - autogenerated_by_my_lib + + # which files to skip: they will be analyzed, but issues from them + # won't be reported. Default value is empty list, but there is + # no need to include all autogenerated files, we confidently recognize + # autogenerated files. If it's not please let us know. + # skip-files: + # - "\\.html\\.go$" + # - "\\.json\\.go$" + # - "\\.sql\\.go$" + # - "_reform\\.go$" + + # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + modules-download-mode: readonly + + +# output configuration options +output: + # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number" + # format: colored-line-number + + # print lines of code with issue, default is true + # print-issued-lines: true + + # print linter name in the end of issue text, default is true + # print-linter-name: true + + +# all available settings of specific linters linters-settings: - errcheck: - check-type-assertions: false - check-blank: false - govet: - check-shadowing: true - golint: - min-confidence: 0 # 0.8 - gocyclo: - min-complexity: 25 # 30 - maligned: - suggest-new: false - dupl: - threshold: 150 - goconst: - min-len: 3 - min-occurrences: 3 - unused: - check-exported: false - unparam: - algo: cha - check-exported: false - nakedret: - max-func-lines: 30 - prealloc: - simple: true - range-loops: true - for-loops: false - gocritic: - enabled-checks: - - appendAssign - - appendCombine - - assignOp - - boolExprSimplify - - caseOrder - - defaultCaseOrder - - deprecatedComment - - dupArg - - dupBranchBody - - dupCase - - flagDeref - - ifElseChain - - indexAlloc - - methodExprCall - - rangeExprCopy - # - rangeValCopy - - regexpMust - - singleCaseSwitch - - sloppyLen - # - switchTrue - - typeSwitchVar - - underef - # - unlabelStmt - - unlambda - - unslice + errcheck: + # report about not checking of errors in type assetions: `a := b.(MyStruct)`; + # default is false: such cases aren't reported by default. + # check-type-assertions: false + + # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`; + # default is false: such cases aren't reported by default. + # check-blank: false + + # [deprecated] comma-separated list of pairs of the form pkg:regex + # the regex is used to ignore names within pkg. (default "fmt:.*"). + # see https://github.com/kisielk/errcheck#the-deprecated-method for details + # ignore: fmt:.*,io/ioutil:^Read.* + + # path to a file containing a list of functions to exclude from checking + # see https://github.com/kisielk/errcheck#excluding-functions for details + # exclude: .errcheck.excludes + govet: + # report about shadowed variables + check-shadowing: true + golint: + # minimal confidence for issues, default is 0.8 + # min-confidence: 0.8 + gofmt: + # simplify code: gofmt with `-s` option, true by default + # simplify: true + goimports: + # put imports beginning with prefix after 3rd-party packages; + # it's a comma-separated list of prefixes + # local-prefixes: github.com/mtgroupit + gocyclo: + # minimal code complexity to report, 30 by default (but we recommend 10-20) + min-complexity: 25 + maligned: + # print struct with more effective memory layout or not, false by default + suggest-new: true + dupl: + # tokens count to trigger issue, 150 by default + threshold: 100 + goconst: + # minimal length of string constant, 3 by default + # min-len: 3 + # minimal occurrences count to trigger, 3 by default + # min-occurrences: 3 + depguard: + list-type: blacklist + include-go-root: true + # packages: + # - log + misspell: + # Correct spellings using locale preferences for US or UK. + # Default is to use a neutral variety of English. + # Setting locale to US will correct the British spelling of 'colour' to 'color'. + locale: US + # ignore-words: + # - someword + lll: + # max line length, lines longer will be reported. Default is 120. + # '\t' is counted as 1 character by default, and can be changed with the tab-width option + # line-length: 120 + # tab width in spaces. Default to 1. + # tab-width: 1 + unused: + # treat code as a program (not a library) and report unused exported identifiers; default is false. + # XXX: if you enable this setting, unused will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find funcs usages. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + # check-exported: false + unparam: + # Inspect exported functions, default is false. Set to true if no external program/library imports your code. + # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find external interfaces. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + # check-exported: false + nakedret: + # make an issue if func has more lines of code than this setting and it has naked returns; default is 30 + # max-func-lines: 30 + prealloc: + # XXX: we don't recommend using this linter before doing performance profiling. + # For most programs usage of prealloc will be a premature optimization. + + # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them. + # True by default. + # simple: true + # range-loops: true # Report preallocation suggestions on range loops, true by default + # for-loops: false # Report preallocation suggestions on for loops, false by default + gocritic: + # Which checks should be enabled; can't be combined with 'disabled-checks'; + # See https://go-critic.github.io/overview#checks-overview + # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run` + # By default list of stable checks is used. + # enabled-checks: + # - rangeValCopy + + # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty + disabled-checks: + - hugeParam # premature optimization + - paramTypeCombine # questionable + + # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks. + # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags". + enabled-tags: + - diagnostic + - style + - performance + - experimental + - opinionated + + settings: # settings passed to gocritic + captLocal: # must be valid enabled check name + paramsOnly: true + rangeValCopy: + sizeThreshold: 32 linters: - enable-all: true - disable: - - gofmt - - goimports - - depguard + # enable: + # - megacheck + # - govet + enable-all: true + disable: + # - dupl + # - gochecknoglobals + # - gochecknoinits + - lll + # - misspell + - prealloc + # disable-all: false + # presets: + # - bugs + # - unused + fast: false + + +issues: + # List of regexps of issue texts to exclude, empty list by default. + # But independently from this option we use default exclude patterns, + # it can be disabled by `exclude-use-default: false`. To list all + # excluded by default patterns execute `golangci-lint run --help` + exclude: + - "declaration of \"(log|err|ctx)\" shadows" + - "Potential file inclusion via variable" # [DEFAULT] gosec: False positive is triggered by 'src, err := ioutil.ReadFile(filename)' + + # Excluding configuration per-path and per-linter + exclude-rules: + # Exclude some linters from running on tests files. + - path: _test\.go + linters: + - gocyclo + - errcheck - dupl - - gochecknoglobals + - gosec - gochecknoinits - - lll - - scopelint + - gochecknoglobals -issues: - exclude-use-default: true - exclude: - - "declaration of \"err\" shadows" + # Ease some gocritic warnings on test files. + - path: _test\.go + text: "(unnamedResult|exitAfterDefer)" + linters: + - gocritic + + # Package def is designed to contain global constants. + - path: internal/def/ + linters: + - gochecknoglobals + + # Exclude known linters from partially hard-vendored code, + # which is impossible to exclude via "nolint" comments. + # - path: internal/hmac/ + # text: "weak cryptographic primitive" + # linters: + # - gosec + # - path: internal/hmac/ + # text: "Write\\` is not checked" + # linters: + # - errcheck + + # Ease linting on benchmarking code. + # - path: cmd/stun-bench/ + # linters: + # - gosec + # - errcheck + + # Independently from option `exclude` we use default exclude patterns, + # it can be disabled by this option. To list all + # excluded by default patterns execute `golangci-lint run --help`. + # Default value for this option is true. + exclude-use-default: false + + # Maximum issues count per one linter. Set to 0 to disable. Default is 50. + max-per-linter: 0 + + # Maximum count of issues with the same text. Set to 0 to disable. Default is 3. + max-same-issues: 0 + + # Show only new issues: if there are unstaged changes or untracked files, + # only those changes are analyzed, else only changes in HEAD~ are analyzed. + # It's a super-useful option for integration of golangci-lint into existing + # large codebase. It's not practical to fix all existing issues at the moment + # of integration: much better don't allow issues in new code. + # Default is false. + # new: false + + # Show only new issues created after git revision `REV` + # new-from-rev: REV + + # Show only new issues created in git patch with set file path. + # new-from-patch: path/to/patch/file diff --git a/README.md b/README.md index ad51e3e..74f97aa 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,21 @@ Also provides command-line tool `jsonrcp2client`. go get github.com/powerman/rpc-codec/... ``` +Or, if you need only `jsonrpc2client` tool, then download binary for your +OS manually from +[releases](https://github.com/powerman/rpc-codec/releases) or run this to +install the latest version: + +```sh +curl -sfL $(curl -s https://api.github.com/repos/powerman/rpc-codec/releases/latest | grep -i /jsonrpc2client-$(uname -s)-$(uname -m)\" | cut -d\" -f4) | sudo install /dev/stdin /usr/local/bin/jsonrpc2client +``` + ## Usage ### jsonrcp2client ``` -$ jsonrcp2client +$ jsonrcp2client -h Usage: jsonrpc2client [flags] method params-as-json -http.endpoint string service endpoint as url diff --git a/cmd/jsonrpc2client/main.go b/cmd/jsonrpc2client/main.go index 17bd4bb..78dbdd7 100644 --- a/cmd/jsonrpc2client/main.go +++ b/cmd/jsonrpc2client/main.go @@ -25,7 +25,7 @@ const ( //nolint:gochecknoglobals var ( cmd = strings.TrimSuffix(path.Base(os.Args[0]), ".test") - ver = "0.1.0" + ver string // set by ./release cfg struct { version bool notification bool @@ -86,7 +86,6 @@ func main() { default: panic("never here") } - defer client.Close() var result interface{} if cfg.notification { diff --git a/jsonrpc2/batch.go b/jsonrpc2/batch.go index e52130a..93aff00 100644 --- a/jsonrpc2/batch.go +++ b/jsonrpc2/batch.go @@ -6,7 +6,7 @@ import ( "net/rpc" ) -var jErrRequest = json.RawMessage(`{"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"invalid request"}}`) +var jErrRequest = json.RawMessage(`{"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"invalid request"}}`) //nolint:gochecknoglobals // JSONRPC2 is an internal RPC service used to process batch requests. type JSONRPC2 struct{} @@ -21,7 +21,7 @@ type BatchArg struct { // Batch is an internal RPC method used to process batch requests. func (JSONRPC2) Batch(arg BatchArg, replies *[]*json.RawMessage) (err error) { cli, srv := net.Pipe() - defer cli.Close() + defer logIfFail(cli.Close) go arg.srv.ServeCodec(NewServerCodecContext(arg.Context(), srv, arg.srv)) replyc := make(chan *json.RawMessage, len(arg.reqs)) diff --git a/jsonrpc2/http.go b/jsonrpc2/http.go index d4b703a..ecb3fe1 100644 --- a/jsonrpc2/http.go +++ b/jsonrpc2/http.go @@ -16,7 +16,7 @@ const contentType = "application/json" type contextKey int -var httpRequestContextKey contextKey +var httpRequestContextKey contextKey //nolint:gochecknoglobals // HTTPRequestFromContext returns HTTP request related to this RPC (if // you use HTTPHander to serve JSON RPC 2.0 over HTTP) or nil otherwise. @@ -92,7 +92,7 @@ type Doer interface { // signature, DoerFunc(f) is a client that calls f. type DoerFunc func(req *http.Request) (resp *http.Response, err error) -// DoerFunc calls f(req). +// Do calls f(req). func (f DoerFunc) Do(req *http.Request) (resp *http.Response, err error) { return f(req) } @@ -115,7 +115,7 @@ func (conn *httpClientConn) Read(buf []byte) (int, error) { } n, err := conn.body.Read(buf) if err == io.EOF { - conn.body.Close() + logIfFail(conn.body.Close) conn.body = nil err = nil if n == 0 { @@ -151,7 +151,7 @@ func (conn *httpClientConn) Write(buf []byte) (int, error) { if resp.ContentLength == -1 || resp.ContentLength <= maxBodySlurpSize { _, _ = io.CopyN(ioutil.Discard, resp.Body, maxBodySlurpSize) } - resp.Body.Close() + logIfFail(resp.Body.Close) return default: err = fmt.Errorf("bad HTTP Status: %s", resp.Status) @@ -163,7 +163,7 @@ func (conn *httpClientConn) Write(buf []byte) (int, error) { if resp.ContentLength == -1 || resp.ContentLength <= maxBodySlurpSize { _, _ = io.CopyN(ioutil.Discard, resp.Body, maxBodySlurpSize) } - resp.Body.Close() + logIfFail(resp.Body.Close) } } var res clientResponse diff --git a/jsonrpc2/log.go b/jsonrpc2/log.go new file mode 100644 index 0000000..e04e408 --- /dev/null +++ b/jsonrpc2/log.go @@ -0,0 +1,9 @@ +package jsonrpc2 + +import "log" + +func logIfFail(f func() error) { + if err := f(); err != nil { + log.Print(err) + } +} diff --git a/jsonrpc2/server.go b/jsonrpc2/server.go index af4f71e..5dd0300 100644 --- a/jsonrpc2/server.go +++ b/jsonrpc2/server.go @@ -211,7 +211,7 @@ func (c *serverCodec) ReadRequestBody(x interface{}) error { return nil } -var null = json.RawMessage([]byte("null")) +var null = json.RawMessage([]byte("null")) //nolint:gochecknoglobals func (c *serverCodec) WriteResponse(r *rpc.Response, x interface{}) error { // If return error: nothing happens. diff --git a/release b/release new file mode 100755 index 0000000..893e4bf --- /dev/null +++ b/release @@ -0,0 +1,31 @@ +#!/bin/bash +set -x -e -o pipefail + +DIST_DIR=dist +TAG=$(git describe --match='v*' --exact-match) +GH="$(git remote get-url origin | sed -e 's/.*://' -e 's/\.git$//')" +GH_USER="${GH%%/*}" +GH_REPO="${GH##*/}" + +mkdir -p $DIST_DIR +while read suffix GOOS GOARCH GOARM; do + for pkg in ./cmd/*/; do + CGO_ENABLED=0 GOOS=$GOOS GOARCH=$GOARCH GOARM=$GOARM \ + go build -mod=readonly -v -o "$DIST_DIR/$(basename $pkg)-$suffix" \ + -ldflags "-X 'main.ver=$TAG'" $pkg + done +done <