reformat errors

julienschmidt · julienschmidt · commit a059889267dc · 2016-01-19T18:30:29.000+01:00
diff --git a/dsn.go b/dsn.go
@@ -19,10 +19,10 @@ import (
 )
 
 var (
-	errInvalidDSNUnescaped       = errors.New("Invalid DSN: Did you forget to escape a param value?")
-	errInvalidDSNAddr            = errors.New("Invalid DSN: Network Address not terminated (missing closing brace)")
-	errInvalidDSNNoSlash         = errors.New("Invalid DSN: Missing the slash separating the database name")
-	errInvalidDSNUnsafeCollation = errors.New("Invalid DSN: interpolateParams can be used with ascii, latin1, utf8 and utf8mb4 charset")
+	errInvalidDSNUnescaped       = errors.New("invalid DSN: did you forget to escape a param value?")
+	errInvalidDSNAddr            = errors.New("invalid DSN: network address not terminated (missing closing brace)")
+	errInvalidDSNNoSlash         = errors.New("invalid DSN: missing the slash separating the database name")
+	errInvalidDSNUnsafeCollation = errors.New("invalid DSN: interpolateParams can not be used with unsafe collations")
 )
 
 // Config is a configuration parsed from a DSN string
@@ -141,7 +141,7 @@ func ParseDSN(dsn string) (cfg *Config, err error) {
 		case "unix":
 			cfg.Addr = "/tmp/mysql.sock"
 		default:
-			return nil, errors.New("Default addr for network '" + cfg.Net + "' unknown")
+			return nil, errors.New("default addr for network '" + cfg.Net + "' unknown")
 		}
 
 	}
@@ -166,31 +166,31 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 			var isBool bool
 			cfg.AllowAllFiles, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Use cleartext authentication mode (MySQL 5.5.10+)
 		case "allowCleartextPasswords":
 			var isBool bool
 			cfg.AllowCleartextPasswords, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Use old authentication mode (pre MySQL 4.1)
 		case "allowOldPasswords":
 			var isBool bool
 			cfg.AllowOldPasswords, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Switch "rowsAffected" mode
 		case "clientFoundRows":
 			var isBool bool
 			cfg.ClientFoundRows, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Collation
@@ -210,19 +210,19 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 			var isBool bool
 			cfg.ColumnsWithAlias, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Compression
 		case "compress":
-			return errors.New("Compression not implemented yet")
+			return errors.New("compression not implemented yet")
 
 		// Enable client side placeholder substitution
 		case "interpolateParams":
 			var isBool bool
 			cfg.InterpolateParams, isBool = readBool(value)
 			if !isBool {
-				return fmt.Errorf("Invalid Bool value: %s", value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Time Location
@@ -240,7 +240,7 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 			var isBool bool
 			cfg.ParseTime, isBool = readBool(value)
 			if !isBool {
-				return errors.New("Invalid Bool value: " + value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// I/O read Timeout
@@ -255,7 +255,7 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 			var isBool bool
 			cfg.Strict, isBool = readBool(value)
 			if !isBool {
-				return errors.New("Invalid Bool value: " + value)
+				return errors.New("invalid bool value: " + value)
 			}
 
 		// Dial Timeout
@@ -273,7 +273,7 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 					cfg.TLS = &tls.Config{}
 				}
 			} else if value, err := url.QueryUnescape(value); err != nil {
-				return fmt.Errorf("Invalid value for tls config name: %v", err)
+				return fmt.Errorf("invalid value for TLS config name: %v", err)
 			} else {
 				if strings.ToLower(value) == "skip-verify" {
 					cfg.TLS = &tls.Config{InsecureSkipVerify: true}
@@ -287,7 +287,7 @@ func parseDSNParams(cfg *Config, params string) (err error) {
 
 					cfg.TLS = tlsConfig
 				} else {
-					return fmt.Errorf("Invalid value / unknown config name: %s", value)
+					return errors.New("invalid value / unknown config name: " + value)
 				}
 			}
 
diff --git a/errors.go b/errors.go
@@ -19,20 +19,20 @@ import (
 
 // Various errors the driver might return. Can change between driver versions.
 var (
-	ErrInvalidConn       = errors.New("Invalid Connection")
-	ErrMalformPkt        = errors.New("Malformed Packet")
-	ErrNoTLS             = errors.New("TLS encryption requested but server does not support TLS")
-	ErrOldPassword       = errors.New("This user requires old password authentication. If you still want to use it, please add 'allowOldPasswords=1' to your DSN. See also https://github.com/go-sql-driver/mysql/wiki/old_passwords")
-	ErrCleartextPassword = errors.New("This user requires clear text authentication. If you still want to use it, please add 'allowCleartextPasswords=1' to your DSN.")
-	ErrUnknownPlugin     = errors.New("The authentication plugin is not supported.")
-	ErrOldProtocol       = errors.New("MySQL-Server does not support required Protocol 41+")
-	ErrPktSync           = errors.New("Commands out of sync. You can't run this command now")
-	ErrPktSyncMul        = errors.New("Commands out of sync. Did you run multiple statements at once?")
-	ErrPktTooLarge       = errors.New("Packet for query is too large. You can change this value on the server by adjusting the 'max_allowed_packet' variable.")
-	ErrBusyBuffer        = errors.New("Busy buffer")
+	ErrInvalidConn       = errors.New("invalid connection")
+	ErrMalformPkt        = errors.New("malformed packet")
+	ErrNoTLS             = errors.New("TLS requested but server does not support TLS")
+	ErrOldPassword       = errors.New("this user requires old password authentication. If you still want to use it, please add 'allowOldPasswords=1' to your DSN. See also https://github.com/go-sql-driver/mysql/wiki/old_passwords")
+	ErrCleartextPassword = errors.New("this user requires clear text authentication. If you still want to use it, please add 'allowCleartextPasswords=1' to your DSN")
+	ErrUnknownPlugin     = errors.New("this authentication plugin is not supported")
+	ErrOldProtocol       = errors.New("MySQL server does not support required protocol 41+")
+	ErrPktSync           = errors.New("commands out of sync. You can't run this command now")
+	ErrPktSyncMul        = errors.New("commands out of sync. Did you run multiple statements at once?")
+	ErrPktTooLarge       = errors.New("packet for query is too large. Try adjusting the 'max_allowed_packet' variable on the server")
+	ErrBusyBuffer        = errors.New("busy buffer")
 )
 
-var errLog = Logger(log.New(os.Stderr, "[MySQL] ", log.Ldate|log.Ltime|log.Lshortfile))
+var errLog = Logger(log.New(os.Stderr, "[mysql] ", log.Ldate|log.Ltime|log.Lshortfile))
 
 // Logger is used to log critical error messages.
 type Logger interface {
@@ -56,7 +56,7 @@ type MySQLError struct {
 }
 
 func (me *MySQLError) Error() string {
-	return fmt.Sprintf("Error %d: %s", me.Number, me.Message)
+	return fmt.Sprintf("error %d: %s", me.Number, me.Message)
 }
 
 // MySQLWarnings is an error type which represents a group of one or more MySQL
diff --git a/infile.go b/infile.go
@@ -139,12 +139,12 @@ func (mc *mysqlConn) handleInFileRequest(name string) (err error) {
 					} else if fileSize <= mc.maxPacketAllowed {
 						data = make([]byte, 4+mc.maxWriteSize)
 					} else {
-						err = fmt.Errorf("Local File '%s' too large: Size: %d, Max: %d", name, fileSize, mc.maxPacketAllowed)
+						err = fmt.Errorf("local file '%s' too large: size: %d, max: %d", name, fileSize, mc.maxPacketAllowed)
 					}
 				}
 			}
 		} else {
-			err = fmt.Errorf("Local File '%s' is not registered. Use the DSN parameter 'allowAllFiles=true' to allow all files", name)
+			err = fmt.Errorf("local file '%s' is not registered", name)
 		}
 	}
 
diff --git a/packets.go b/packets.go
@@ -145,7 +145,7 @@ func (mc *mysqlConn) readInitPacket() ([]byte, error) {
 	// protocol version [1 byte]
 	if data[0] < minProtocolVersion {
 		return nil, fmt.Errorf(
-			"Unsupported MySQL Protocol Version %d. Protocol Version %d or higher is required",
+			"unsupported protocol version %d. Version %d or higher is required",
 			data[0],
 			minProtocolVersion,
 		)
@@ -563,7 +563,7 @@ func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {
 			if i == count {
 				return columns, nil
 			}
-			return nil, fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))
+			return nil, fmt.Errorf("columns count mismatch n:%d len:%d", count, len(columns))
 		}
 
 		// Catalog
@@ -809,7 +809,7 @@ func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {
 func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
 	if len(args) != stmt.paramCount {
 		return fmt.Errorf(
-			"Arguments count mismatch (Got: %d Has: %d)",
+			"arguments count mismatch (got: %d; has: %d)",
 			len(args),
 			stmt.paramCount,
 		)
@@ -995,7 +995,7 @@ func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
 				paramValues = append(paramValues, val...)
 
 			default:
-				return fmt.Errorf("Can't convert type: %T", arg)
+				return fmt.Errorf("can not convert type: %T", arg)
 			}
 		}
 
@@ -1143,7 +1143,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {
 					dstlen = 8 + 1 + decimals
 				default:
 					return fmt.Errorf(
-						"MySQL protocol error, illegal decimals value %d",
+						"protocol error, illegal decimals value %d",
 						rows.columns[i].decimals,
 					)
 				}
@@ -1162,7 +1162,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {
 						dstlen = 19 + 1 + decimals
 					default:
 						return fmt.Errorf(
-							"MySQL protocol error, illegal decimals value %d",
+							"protocol error, illegal decimals value %d",
 							rows.columns[i].decimals,
 						)
 					}
@@ -1179,7 +1179,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {
 
 		// Please report if this happens!
 		default:
-			return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)
+			return fmt.Errorf("unknown field type %d", rows.columns[i].fieldType)
 		}
 	}
 
diff --git a/utils.go b/utils.go
@@ -48,7 +48,7 @@ var (
 //
 func RegisterTLSConfig(key string, config *tls.Config) error {
 	if _, isBool := readBool(key); isBool || strings.ToLower(key) == "skip-verify" {
-		return fmt.Errorf("Key '%s' is reserved", key)
+		return fmt.Errorf("key '%s' is reserved", key)
 	}
 
 	if tlsConfigRegister == nil {
@@ -260,7 +260,7 @@ func parseDateTime(str string, loc *time.Location) (t time.Time, err error) {
 		}
 		t, err = time.Parse(timeFormat[:len(str)], str)
 	default:
-		err = fmt.Errorf("Invalid Time-String: %s", str)
+		err = fmt.Errorf("invalid time string: %s", str)
 		return
 	}
 
@@ -309,7 +309,7 @@ func parseBinaryDateTime(num uint64, data []byte, loc *time.Location) (driver.Va
 			loc,
 		), nil
 	}
-	return nil, fmt.Errorf("Invalid DATETIME-packet length %d", num)
+	return nil, fmt.Errorf("invalid DATETIME packet length %d", num)
 }
 
 // zeroDateTime is used in formatBinaryDateTime to avoid an allocation
@@ -344,7 +344,7 @@ func formatBinaryDateTime(src []byte, length uint8, justTime bool) (driver.Value
 		switch len(src) {
 		case 8, 12:
 		default:
-			return nil, fmt.Errorf("Invalid TIME-packet length %d", len(src))
+			return nil, fmt.Errorf("invalid TIME packet length %d", len(src))
 		}
 		// +2 to enable negative time and 100+ hours
 		dst = make([]byte, 0, length+2)
@@ -378,7 +378,7 @@ func formatBinaryDateTime(src []byte, length uint8, justTime bool) (driver.Value
 			if length > 10 {
 				t += "TIME"
 			}
-			return nil, fmt.Errorf("illegal %s-packet length %d", t, len(src))
+			return nil, fmt.Errorf("illegal %s packet length %d", t, len(src))
 		}
 		dst = make([]byte, 0, length)
 		// start with the date

Original file line number	Diff line number	Diff line change
`@@ -139,12 +139,12 @@ func (mc *mysqlConn) handleInFileRequest(name string) (err error) {`
`139`	`139`	`} else if fileSize <= mc.maxPacketAllowed {`
`140`	`140`	`data = make([]byte, 4+mc.maxWriteSize)`
`141`	`141`	`} else {`
`142`		`- err = fmt.Errorf("Local File '%s' too large: Size: %d, Max: %d", name, fileSize, mc.maxPacketAllowed)`
	`142`	`+ err = fmt.Errorf("local file '%s' too large: size: %d, max: %d", name, fileSize, mc.maxPacketAllowed)`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`	`}`
`146`	`146`	`} else {`
`147`		`- err = fmt.Errorf("Local File '%s' is not registered. Use the DSN parameter 'allowAllFiles=true' to allow all files", name)`
	`147`	`+ err = fmt.Errorf("local file '%s' is not registered", name)`
`148`	`148`	`}`
`149`	`149`	`}`
`150`	`150`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ func (mc *mysqlConn) readInitPacket() ([]byte, error) {`
`145`	`145`	`// protocol version [1 byte]`
`146`	`146`	`if data[0] < minProtocolVersion {`
`147`	`147`	`return nil, fmt.Errorf(`
`148`		`- "Unsupported MySQL Protocol Version %d. Protocol Version %d or higher is required",`
	`148`	`+ "unsupported protocol version %d. Version %d or higher is required",`
`149`	`149`	`data[0],`
`150`	`150`	`minProtocolVersion,`
`151`	`151`	`)`
`@@ -563,7 +563,7 @@ func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {`
`563`	`563`	`if i == count {`
`564`	`564`	`return columns, nil`
`565`	`565`	`}`
`566`		`- return nil, fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))`
	`566`	`+ return nil, fmt.Errorf("columns count mismatch n:%d len:%d", count, len(columns))`
`567`	`567`	`}`
`568`	`568`
`569`	`569`	`// Catalog`
`@@ -809,7 +809,7 @@ func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {`
`809`	`809`	`func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {`
`810`	`810`	`if len(args) != stmt.paramCount {`
`811`	`811`	`return fmt.Errorf(`
`812`		`- "Arguments count mismatch (Got: %d Has: %d)",`
	`812`	`+ "arguments count mismatch (got: %d; has: %d)",`
`813`	`813`	`len(args),`
`814`	`814`	`stmt.paramCount,`
`815`	`815`	`)`
`@@ -995,7 +995,7 @@ func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {`
`995`	`995`	`paramValues = append(paramValues, val...)`
`996`	`996`
`997`	`997`	`default:`
`998`		`- return fmt.Errorf("Can't convert type: %T", arg)`
	`998`	`+ return fmt.Errorf("can not convert type: %T", arg)`
`999`	`999`	`}`
`1000`	`1000`	`}`
`1001`	`1001`
`@@ -1143,7 +1143,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {`
`1143`	`1143`	`dstlen = 8 + 1 + decimals`
`1144`	`1144`	`default:`
`1145`	`1145`	`return fmt.Errorf(`
`1146`		`- "MySQL protocol error, illegal decimals value %d",`
	`1146`	`+ "protocol error, illegal decimals value %d",`
`1147`	`1147`	`rows.columns[i].decimals,`
`1148`	`1148`	`)`
`1149`	`1149`	`}`
`@@ -1162,7 +1162,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {`
`1162`	`1162`	`dstlen = 19 + 1 + decimals`
`1163`	`1163`	`default:`
`1164`	`1164`	`return fmt.Errorf(`
`1165`		`- "MySQL protocol error, illegal decimals value %d",`
	`1165`	`+ "protocol error, illegal decimals value %d",`
`1166`	`1166`	`rows.columns[i].decimals,`
`1167`	`1167`	`)`
`1168`	`1168`	`}`
`@@ -1179,7 +1179,7 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {`
`1179`	`1179`
`1180`	`1180`	`// Please report if this happens!`
`1181`	`1181`	`default:`
`1182`		`- return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)`
	`1182`	`+ return fmt.Errorf("unknown field type %d", rows.columns[i].fieldType)`
`1183`	`1183`	`}`
`1184`	`1184`	`}`
`1185`	`1185`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ var (`
`48`	`48`	`//`
`49`	`49`	`func RegisterTLSConfig(key string, config *tls.Config) error {`
`50`	`50`	`if _, isBool := readBool(key); isBool \|\| strings.ToLower(key) == "skip-verify" {`
`51`		`- return fmt.Errorf("Key '%s' is reserved", key)`
	`51`	`+ return fmt.Errorf("key '%s' is reserved", key)`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`if tlsConfigRegister == nil {`
`@@ -260,7 +260,7 @@ func parseDateTime(str string, loc *time.Location) (t time.Time, err error) {`
`260`	`260`	`}`
`261`	`261`	`t, err = time.Parse(timeFormat[:len(str)], str)`
`262`	`262`	`default:`
`263`		`- err = fmt.Errorf("Invalid Time-String: %s", str)`
	`263`	`+ err = fmt.Errorf("invalid time string: %s", str)`
`264`	`264`	`return`
`265`	`265`	`}`
`266`	`266`
`@@ -309,7 +309,7 @@ func parseBinaryDateTime(num uint64, data []byte, loc *time.Location) (driver.Va`
`309`	`309`	`loc,`
`310`	`310`	`), nil`
`311`	`311`	`}`
`312`		`- return nil, fmt.Errorf("Invalid DATETIME-packet length %d", num)`
	`312`	`+ return nil, fmt.Errorf("invalid DATETIME packet length %d", num)`
`313`	`313`	`}`
`314`	`314`
`315`	`315`	`// zeroDateTime is used in formatBinaryDateTime to avoid an allocation`
`@@ -344,7 +344,7 @@ func formatBinaryDateTime(src []byte, length uint8, justTime bool) (driver.Value`
`344`	`344`	`switch len(src) {`
`345`	`345`	`case 8, 12:`
`346`	`346`	`default:`
`347`		`- return nil, fmt.Errorf("Invalid TIME-packet length %d", len(src))`
	`347`	`+ return nil, fmt.Errorf("invalid TIME packet length %d", len(src))`
`348`	`348`	`}`
`349`	`349`	`// +2 to enable negative time and 100+ hours`
`350`	`350`	`dst = make([]byte, 0, length+2)`
`@@ -378,7 +378,7 @@ func formatBinaryDateTime(src []byte, length uint8, justTime bool) (driver.Value`
`378`	`378`	`if length > 10 {`
`379`	`379`	`t += "TIME"`
`380`	`380`	`}`
`381`		`- return nil, fmt.Errorf("illegal %s-packet length %d", t, len(src))`
	`381`	`+ return nil, fmt.Errorf("illegal %s packet length %d", t, len(src))`
`382`	`382`	`}`
`383`	`383`	`dst = make([]byte, 0, length)`
`384`	`384`	`// start with the date`