aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/charithe
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2021-02-22 20:37:25 +0100
committerDmitry Vyukov <dvyukov@google.com>2021-02-22 21:02:12 +0100
commitfcc6d71be2c3ce7d9305c04fc2e87af554571bac (patch)
treeb01dbb3d1e2988e28ea158d2d543d603ec0b9569 /vendor/github.com/charithe
parent8f23c528ad5a943b9ffec5dcaf332fd0f614006e (diff)
go.mod: update golangci-lint to v1.37
Diffstat (limited to 'vendor/github.com/charithe')
-rw-r--r--vendor/github.com/charithe/durationcheck/.gitignore1
-rw-r--r--vendor/github.com/charithe/durationcheck/LICENSE201
-rw-r--r--vendor/github.com/charithe/durationcheck/Makefile5
-rw-r--r--vendor/github.com/charithe/durationcheck/README.md48
-rw-r--r--vendor/github.com/charithe/durationcheck/durationcheck.go176
-rw-r--r--vendor/github.com/charithe/durationcheck/go.mod5
-rw-r--r--vendor/github.com/charithe/durationcheck/go.sum20
7 files changed, 456 insertions, 0 deletions
diff --git a/vendor/github.com/charithe/durationcheck/.gitignore b/vendor/github.com/charithe/durationcheck/.gitignore
new file mode 100644
index 000000000..c2b126a84
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/.gitignore
@@ -0,0 +1 @@
+/durationcheck
diff --git a/vendor/github.com/charithe/durationcheck/LICENSE b/vendor/github.com/charithe/durationcheck/LICENSE
new file mode 100644
index 000000000..261eeb9e9
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
diff --git a/vendor/github.com/charithe/durationcheck/Makefile b/vendor/github.com/charithe/durationcheck/Makefile
new file mode 100644
index 000000000..8e2f81ae8
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/Makefile
@@ -0,0 +1,5 @@
+build:
+ @GO111MODULE=on go build -ldflags '-s -w' -o durationcheck ./cmd/durationcheck/main.go
+
+install:
+ @GO111MODULE=on go install -ldflags '-s -w' ./cmd/durationcheck
diff --git a/vendor/github.com/charithe/durationcheck/README.md b/vendor/github.com/charithe/durationcheck/README.md
new file mode 100644
index 000000000..122edb745
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/README.md
@@ -0,0 +1,48 @@
+[![CircleCI](https://circleci.com/gh/charithe/durationcheck.svg?style=svg)](https://circleci.com/gh/charithe/durationcheck)
+
+
+
+Duration Check
+===============
+
+A Go linter to detect cases where two `time.Duration` values are being multiplied in possibly erroneous ways.
+
+For example, consider the following (highly contrived) function:
+
+```go
+func waitFor(someDuration time.Duration) {
+ timeToWait := someDuration * time.Second
+ time.Sleep(timeToWait)
+}
+```
+
+Although the above code would compile without any errors, its runtime behaviour would almost certainly be incorrect.
+A caller would reasonably expect `waitFor(5 * time.Seconds)` to wait for ~5 seconds but they would actually end up
+waiting for ~1,388,889 hours.
+
+The above example is just for illustration purposes only. The problem is glaringly obvious in such a simple function
+and even the greenest Gopher would discover the issue immediately. However, imagine a much more complicated function
+with many more lines and it is not inconceivable that such logic errors could go unnoticed.
+
+See the [test cases](testdata/src/a/a.go) for more examples of the types of errors detected by the linter.
+
+
+Installation
+-------------
+
+Requires Go 1.11 or above.
+
+```
+go get -u github.com/charithe/durationcheck/cmd/durationcheck
+```
+
+Usage
+-----
+
+Invoke `durationcheck` with your package name
+
+```
+durationcheck ./...
+# or
+durationcheck github.com/you/yourproject/...
+```
diff --git a/vendor/github.com/charithe/durationcheck/durationcheck.go b/vendor/github.com/charithe/durationcheck/durationcheck.go
new file mode 100644
index 000000000..6eccd9c2a
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/durationcheck.go
@@ -0,0 +1,176 @@
+package durationcheck
+
+import (
+ "bytes"
+ "fmt"
+ "go/ast"
+ "go/format"
+ "go/token"
+ "go/types"
+ "log"
+ "os"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+)
+
+var Analyzer = &analysis.Analyzer{
+ Name: "durationcheck",
+ Doc: "check for two durations multiplied together",
+ Run: run,
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+ // if the package does not import time, it can be skipped from analysis
+ if !hasImport(pass.Pkg, "time") {
+ return nil, nil
+ }
+
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+
+ nodeTypes := []ast.Node{
+ (*ast.BinaryExpr)(nil),
+ }
+
+ inspect.Preorder(nodeTypes, check(pass))
+
+ return nil, nil
+}
+
+func hasImport(pkg *types.Package, importPath string) bool {
+ for _, imp := range pkg.Imports() {
+ if imp.Path() == importPath {
+ return true
+ }
+ }
+
+ return false
+}
+
+// check contains the logic for checking that time.Duration is used correctly in the code being analysed
+func check(pass *analysis.Pass) func(ast.Node) {
+ return func(node ast.Node) {
+ expr := node.(*ast.BinaryExpr)
+ // we are only interested in multiplication
+ if expr.Op != token.MUL {
+ return
+ }
+
+ // get the types of the two operands
+ x, xOK := pass.TypesInfo.Types[expr.X]
+ y, yOK := pass.TypesInfo.Types[expr.Y]
+
+ if !xOK || !yOK {
+ return
+ }
+
+ if isDuration(x.Type) && isDuration(y.Type) {
+ // check that both sides are acceptable expressions
+ if isUnacceptableExpr(pass, expr.X) && isUnacceptableExpr(pass, expr.Y) {
+ pass.Reportf(expr.Pos(), "Multiplication of durations: `%s`", formatNode(expr))
+ }
+ }
+ }
+}
+
+func isDuration(x types.Type) bool {
+ return x.String() == "time.Duration"
+}
+
+// isUnacceptableExpr returns true if the argument is not an acceptable time.Duration expression
+func isUnacceptableExpr(pass *analysis.Pass, expr ast.Expr) bool {
+ switch e := expr.(type) {
+ case *ast.BasicLit:
+ return false
+ case *ast.Ident:
+ return !isAcceptableNestedExpr(pass, e)
+ case *ast.CallExpr:
+ return !isAcceptableCast(pass, e)
+ case *ast.BinaryExpr:
+ return !isAcceptableNestedExpr(pass, e)
+ case *ast.UnaryExpr:
+ return !isAcceptableNestedExpr(pass, e)
+ case *ast.SelectorExpr:
+ return !isAcceptableNestedExpr(pass, e)
+ }
+
+ return true
+}
+
+// isAcceptableCast returns true if the argument is an acceptable expression cast to time.Duration
+func isAcceptableCast(pass *analysis.Pass, e *ast.CallExpr) bool {
+ // check that there's a single argument
+ if len(e.Args) != 1 {
+ return false
+ }
+
+ // check that the argument is acceptable
+ if !isAcceptableNestedExpr(pass, e.Args[0]) {
+ return false
+ }
+
+ // check for time.Duration cast
+ selector, ok := e.Fun.(*ast.SelectorExpr)
+ if !ok {
+ return false
+ }
+
+ return isDurationCast(selector)
+}
+
+func isDurationCast(selector *ast.SelectorExpr) bool {
+ pkg, ok := selector.X.(*ast.Ident)
+ if !ok {
+ return false
+ }
+
+ if pkg.Name != "time" {
+ return false
+ }
+
+ return selector.Sel.Name == "Duration"
+}
+
+func isAcceptableNestedExpr(pass *analysis.Pass, n ast.Expr) bool {
+ switch e := n.(type) {
+ case *ast.BasicLit:
+ return true
+ case *ast.BinaryExpr:
+ return isAcceptableNestedExpr(pass, e.X) && isAcceptableNestedExpr(pass, e.Y)
+ case *ast.UnaryExpr:
+ return isAcceptableNestedExpr(pass, e.X)
+ case *ast.Ident:
+ return isAcceptableIdent(pass, e)
+ case *ast.CallExpr:
+ t := pass.TypesInfo.TypeOf(e)
+ return !isDuration(t)
+ case *ast.SelectorExpr:
+ t := pass.TypesInfo.TypeOf(e)
+ return !isDuration(t)
+ }
+
+ return false
+}
+
+func isAcceptableIdent(pass *analysis.Pass, ident *ast.Ident) bool {
+ obj := pass.TypesInfo.ObjectOf(ident)
+ return !isDuration(obj.Type())
+}
+
+func formatNode(node ast.Node) string {
+ buf := new(bytes.Buffer)
+ if err := format.Node(buf, token.NewFileSet(), node); err != nil {
+ log.Printf("Error formatting expression: %v", err)
+ return ""
+ }
+
+ return buf.String()
+}
+
+func printAST(msg string, node ast.Node) {
+ fmt.Printf(">>> %s:\n%s\n\n\n", msg, formatNode(node))
+ ast.Fprint(os.Stdout, nil, node, nil)
+ fmt.Println("--------------")
+}
diff --git a/vendor/github.com/charithe/durationcheck/go.mod b/vendor/github.com/charithe/durationcheck/go.mod
new file mode 100644
index 000000000..12ebca0a0
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/go.mod
@@ -0,0 +1,5 @@
+module github.com/charithe/durationcheck
+
+go 1.14
+
+require golang.org/x/tools v0.0.0-20200403190813-44a64ad78b9b
diff --git a/vendor/github.com/charithe/durationcheck/go.sum b/vendor/github.com/charithe/durationcheck/go.sum
new file mode 100644
index 000000000..89f6e5508
--- /dev/null
+++ b/vendor/github.com/charithe/durationcheck/go.sum
@@ -0,0 +1,20 @@
+github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/mod v0.2.0 h1:KU7oHjnv3XNWfa5COkzUifxZmxp1TyI7ImMXqFxLwvQ=
+golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.0.0-20200403190813-44a64ad78b9b h1:AFZdJUT7jJYXQEC29hYH/WZkoV7+KhwxQGmdZ19yYoY=
+golang.org/x/tools v0.0.0-20200403190813-44a64ad78b9b/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=