github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/testutils/lint/passes/fmtsafe/functions.go (about) 1 // Copyright 2020 The Cockroach Authors. 2 // 3 // Use of this software is governed by the Business Source License 4 // included in the file licenses/BSL.txt. 5 // 6 // As of the Change Date specified in that file, in accordance with 7 // the Business Source License, use of this software will be governed 8 // by the Apache License, Version 2.0, included in the file 9 // licenses/APL.txt. 10 11 package fmtsafe 12 13 // requireConstMsg records functions for which the last string 14 // argument must be a constant string. 15 var requireConstMsg = map[string]bool{ 16 "errors.New": true, 17 18 "github.com/pkg/errors.New": true, 19 "github.com/pkg/errors.Wrap": true, 20 21 "github.com/cockroachdb/errors.New": true, 22 "github.com/cockroachdb/errors.Error": true, 23 "github.com/cockroachdb/errors.NewWithDepth": true, 24 "github.com/cockroachdb/errors.WithMessage": true, 25 "github.com/cockroachdb/errors.Wrap": true, 26 "github.com/cockroachdb/errors.WrapWithDepth": true, 27 "github.com/cockroachdb/errors.AssertionFailed": true, 28 "github.com/cockroachdb/errors.HandledWithMessage": true, 29 "github.com/cockroachdb/errors.HandledInDomainWithMessage": true, 30 31 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.New": true, 32 33 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.New": true, 34 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.NewWithIssue": true, 35 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.NewWithIssueDetail": true, 36 37 "github.com/cockroachdb/cockroach/pkg/sql/pgwire.newAdminShutdownErr": true, 38 39 "(*github.com/cockroachdb/cockroach/pkg/parser/lexer).Error": true, 40 41 "github.com/cockroachdb/cockroach/pkg/util/log.Shout": true, 42 "github.com/cockroachdb/cockroach/pkg/util/log.Info": true, 43 "github.com/cockroachdb/cockroach/pkg/util/log.Warning": true, 44 "github.com/cockroachdb/cockroach/pkg/util/log.Error": true, 45 "github.com/cockroachdb/cockroach/pkg/util/log.Event": true, 46 "github.com/cockroachdb/cockroach/pkg/util/log.VEvent": true, 47 "github.com/cockroachdb/cockroach/pkg/util/log.VErrEvent": true, 48 49 "(*github.com/cockroachdb/cockroach/pkg/sql.optPlanningCtx).log": true, 50 } 51 52 // requireConstFmt records functions for which the string arg 53 // before the final ellipsis must be a constant string. 54 var requireConstFmt = map[string]bool{ 55 // Logging things. 56 "log.Printf": true, 57 "log.Fatalf": true, 58 "log.Panicf": true, 59 "(*log.Logger).Fatalf": true, 60 "(*log.Logger).Panicf": true, 61 "(*log.Logger).Printf": true, 62 63 "github.com/cockroachdb/cockroach/pkg/util/log.Shoutf": true, 64 "github.com/cockroachdb/cockroach/pkg/util/log.Infof": true, 65 "github.com/cockroachdb/cockroach/pkg/util/log.Warningf": true, 66 "github.com/cockroachdb/cockroach/pkg/util/log.Errorf": true, 67 "github.com/cockroachdb/cockroach/pkg/util/log.Eventf": true, 68 "github.com/cockroachdb/cockroach/pkg/util/log.VEventf": true, 69 "github.com/cockroachdb/cockroach/pkg/util/log.VErrEventf": true, 70 "github.com/cockroachdb/cockroach/pkg/util/log.InfofDepth": true, 71 "github.com/cockroachdb/cockroach/pkg/util/log.WarningfDepth": true, 72 "github.com/cockroachdb/cockroach/pkg/util/log.ErrorfDepth": true, 73 "github.com/cockroachdb/cockroach/pkg/util/log.FatalfDepth": true, 74 "github.com/cockroachdb/cockroach/pkg/util/log.VEventfDepth": true, 75 "github.com/cockroachdb/cockroach/pkg/util/log.VErrEventfDepth": true, 76 "github.com/cockroachdb/cockroach/pkg/util/log.ReportOrPanic": true, 77 78 "(github.com/cockroachdb/cockroach/pkg/rpc.breakerLogger).Debugf": true, 79 "(github.com/cockroachdb/cockroach/pkg/rpc.breakerLogger).Infof": true, 80 81 "(*github.com/cockroachdb/cockroach/pkg/internal/rsg/yacc.Tree).errorf": true, 82 83 "(github.com/cockroachdb/cockroach/pkg/storage.pebbleLogger).Infof": true, 84 "(github.com/cockroachdb/cockroach/pkg/storage.pebbleLogger).Fatalf": true, 85 86 "(*github.com/cockroachdb/cockroach/pkg/util/grpcutil.logger).Infof": true, 87 "(*github.com/cockroachdb/cockroach/pkg/util/grpcutil.logger).Warningf": true, 88 "(*github.com/cockroachdb/cockroach/pkg/util/grpcutil.logger).Errorf": true, 89 "(*github.com/cockroachdb/cockroach/pkg/util/grpcutil.logger).Fatalf": true, 90 91 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Debugf": true, 92 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Infof": true, 93 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Warningf": true, 94 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Errorf": true, 95 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Fatalf": true, 96 "(*github.com/cockroachdb/cockroach/pkg/kv/kvserver.raftLogger).Panicf": true, 97 98 "github.com/cockroachdb/cockroach/pkg/kv/kvserver.makeNonDeterministicFailure": true, 99 "github.com/cockroachdb/cockroach/pkg/kv/kvserver.wrapWithNonDeterministicFailure": true, 100 101 "(go.etcd.io/etcd/raft.Logger).Debugf": true, 102 "(go.etcd.io/etcd/raft.Logger).Infof": true, 103 "(go.etcd.io/etcd/raft.Logger).Warningf": true, 104 "(go.etcd.io/etcd/raft.Logger).Errorf": true, 105 "(go.etcd.io/etcd/raft.Logger).Fatalf": true, 106 "(go.etcd.io/etcd/raft.Logger).Panicf": true, 107 108 "(google.golang.org/grpc/grpclog.Logger).Infof": true, 109 "(google.golang.org/grpc/grpclog.Logger).Warningf": true, 110 "(google.golang.org/grpc/grpclog.Logger).Errorf": true, 111 112 "(github.com/cockroachdb/pebble.Logger).Infof": true, 113 "(github.com/cockroachdb/pebble.Logger).Fatalf": true, 114 115 "(github.com/cockroachdb/circuitbreaker.Logger).Infof": true, 116 "(github.com/cockroachdb/circuitbreaker.Logger).Debugf": true, 117 118 "github.com/cockroachdb/cockroach/pkg/sql/opt/optgen/exprgen.errorf": true, 119 "github.com/cockroachdb/cockroach/pkg/sql/opt/optgen/exprgen.wrapf": true, 120 121 "(*github.com/cockroachdb/cockroach/pkg/sql.connExecutor).sessionEventf": true, 122 123 "(*github.com/cockroachdb/cockroach/pkg/sql/logictest.logicTest).outf": true, 124 "(*github.com/cockroachdb/cockroach/pkg/sql/logictest.logicTest).Errorf": true, 125 "(*github.com/cockroachdb/cockroach/pkg/sql/logictest.logicTest).Fatalf": true, 126 127 "(*github.com/cockroachdb/cockroach/pkg/server.adminServer).serverErrorf": true, 128 "github.com/cockroachdb/cockroach/pkg/server.guaranteedExitFatal": true, 129 130 "(*github.com/cockroachdb/cockroach/pkg/ccl/changefeedccl.kafkaLogAdapter).Printf": true, 131 132 // Error things. 133 "fmt.Errorf": true, 134 135 "github.com/pkg/errors.Errorf": true, 136 "github.com/pkg/errors.Wrapf": true, 137 138 "github.com/cockroachdb/errors.Newf": true, 139 "github.com/cockroachdb/errors.Errorf": true, 140 "github.com/cockroachdb/errors.NewWithDepthf": true, 141 "github.com/cockroachdb/errors.WithMessagef": true, 142 "github.com/cockroachdb/errors.Wrapf": true, 143 "github.com/cockroachdb/errors.WrapWithDepthf": true, 144 "github.com/cockroachdb/errors.AssertionFailedf": true, 145 "github.com/cockroachdb/errors.AssertionFailedWithDepthf": true, 146 "github.com/cockroachdb/errors.NewAssertionErrorWithWrappedErrf": true, 147 "github.com/cockroachdb/errors.WithSafeDetails": true, 148 149 "github.com/cockroachdb/cockroach/pkg/roachpb.NewErrorf": true, 150 151 "github.com/cockroachdb/cockroach/pkg/ccl/importccl.makeRowErr": true, 152 "github.com/cockroachdb/cockroach/pkg/ccl/importccl.wrapRowErr": true, 153 154 "github.com/cockroachdb/cockroach/pkg/sql/sqlbase.NewSyntaxErrorf": true, 155 "github.com/cockroachdb/cockroach/pkg/sql/sqlbase.NewDependentObjectErrorf": true, 156 157 "github.com/cockroachdb/cockroach/pkg/sql/sem/tree.newSourceNotFoundError": true, 158 "github.com/cockroachdb/cockroach/pkg/sql/sem/tree.decorateTypeCheckError": true, 159 160 "github.com/cockroachdb/cockroach/pkg/sql/opt/optbuilder.unimplementedWithIssueDetailf": true, 161 162 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.Newf": true, 163 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.NewWithDepthf": true, 164 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.DangerousStatementf": true, 165 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.Wrapf": true, 166 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror.WrapWithDepthf": true, 167 168 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgnotice.Newf": true, 169 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgnotice.NewWithSeverityf": true, 170 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgwirebase.NewProtocolViolationErrorf": true, 171 "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgwirebase.NewInvalidBinaryRepresentationErrorf": true, 172 173 "github.com/cockroachdb/cockroach/pkg/util/errorutil.UnexpectedWithIssueErrorf": true, 174 175 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.Newf": true, 176 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.NewWithDepthf": true, 177 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.NewWithIssuef": true, 178 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.NewWithIssueDetailf": true, 179 "github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented.unimplementedInternal": true, 180 181 "github.com/cockroachdb/cockroach/pkg/util/timeutil/pgdate.inputErrorf": true, 182 }