improve error handling, client cleanup, added transactions, added new test

Author: Phil Bayfield

error.go

@@ -9,8 +9,11 @@ type Errno int
 
 const (
 	CR_UNKNOWN_ERROR        Errno = 2000
+	CR_SOCKET_CREATE_ERROR  Errno = 2001
 	CR_CONNECTION_ERROR     Errno = 2002
 	CR_CONN_HOST_ERROR      Errno = 2003
+	CR_IPSOCK_ERROR         Errno = 2004
+	CR_UNKNOWN_HOST         Errno = 2005
 	CR_SERVER_GONE_ERROR    Errno = 2006
 	CR_SERVER_HANDSHAKE_ERR Errno = 2012
 	CR_SERVER_LOST          Errno = 2013
@@ -24,8 +27,11 @@ type Error string
 
 const (
 	CR_UNKNOWN_ERROR_STR        Error = "Unknown MySQL error"
+	CR_SOCKET_CREATE_ERROR_STR  Error = "Can't create UNIX socket (%d)"
 	CR_CONNECTION_ERROR_STR     Error = "Can't connect to local MySQL server through socket '%s'"
 	CR_CONN_HOST_ERROR_STR      Error = "Can't connect to MySQL server on '%s' (%d)"
+	CR_IPSOCK_ERROR_STR         Error = "Can't create TCP/IP socket (%d)"
+	CR_UNKNOWN_HOST_STR         Error = "Uknown MySQL server host '%s' (%d)"
 	CR_SERVER_GONE_ERROR_STR    Error = "MySQL server has gone away"
 	CR_SERVER_HANDSHAKE_ERR_STR Error = "Error in server handshake"
 	CR_SERVER_LOST_STR          Error = "Lost connection to MySQL server during query"

mysql.go

@@ -163,6 +163,7 @@ func (c *Client) Close() (err os.Error) {
 	c.log(1, "=== Begin close ===")
 	// Check connection
 	if !c.checkConn() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("Must be connected to do this")
 		return
 	}
@@ -188,6 +189,7 @@ func (c *Client) ChangeDb(dbname string) (err os.Error) {
 	c.log(1, "=== Begin change db to '%s' ===", dbname)
 	// Pre-run checks
 	if !c.checkConn() || c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("Must be connected and not in a result set")
 		return
 	}
@@ -210,6 +212,7 @@ func (c *Client) Query(sql string) (err os.Error) {
 	c.log(1, "=== Begin query '%s' ===", sql)
 	// Pre-run checks
 	if !c.checkConn() || c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("Must be connected and not in a result set")
 		return
 	}
@@ -232,11 +235,13 @@ func (c *Client) StoreResult() (result *Result, err os.Error) {
 	c.log(1, "=== Begin store result ===")
 	// Check result
 	if !c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("A result is required to do this")
 		return
 	}
 	// Check if result already used/stored
 	if c.result.mode != RESULT_UNUSED {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("This result has already been used or stored")
 		return
 	}
@@ -263,11 +268,13 @@ func (c *Client) UseResult() (result *Result, err os.Error) {
 	c.log(1, "=== Begin use result ===")
 	// Check result
 	if !c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("A result is required to do this")
 		return
 	}
 	// Check if result already used/stored
 	if c.result.mode != RESULT_UNUSED {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("This result has already been used or stored")
 		return
 	}
@@ -288,6 +295,7 @@ func (c *Client) FreeResult() (err os.Error) {
 	c.log(1, "=== Begin free result ===")
 	// Check result
 	if !c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("A result is required to do this")
 		return
 	}
@@ -327,16 +335,18 @@ func (c *Client) MoreResults() bool {
 }
 
 // Move to the next available result
-func (c *Client) NextResult() (err os.Error) {
+func (c *Client) NextResult() (more bool, err os.Error) {
 	// Log next result
 	c.log(1, "=== Begin next result ===")
 	// Pre-run checks
 	if !c.checkConn() || c.checkResult() {
+		c.error(CR_COMMANDS_OUT_OF_SYNC, CR_COMMANDS_OUT_OF_SYNC_STR)
 		err = os.NewError("Must be connected and not in a result set")
 		return
 	}
-	if !c.MoreResults() {
-		err = os.NewError("No more results available")
+	// Check for more results
+	more = c.MoreResults()
+	if !more {
 		return
 	}
 	// Read result from server
@@ -347,6 +357,9 @@ func (c *Client) NextResult() (err os.Error) {
 
 // Set autocommit
 func (c *Client) SetAutoCommit(state bool) (err os.Error) {
+	// Log set autocommit
+	c.log(1, "=== Begin set autocommit ===")
+	// Use set autocommit query
 	sql := "set autocommit="
 	if state {
 		sql += "1"
@@ -358,16 +371,25 @@ func (c *Client) SetAutoCommit(state bool) (err os.Error) {
 
 // Start a transaction
 func (c *Client) Start() (err os.Error) {
+	// Log start transaction
+	c.log(1, "=== Begin start transaction ===")
+	// Use start transaction query
 	return c.Query("start transaction")
 }
 
 // Commit a transaction
 func (c *Client) Commit() (err os.Error) {
+	// Log commit
+	c.log(1, "=== Begin commit ===")
+	// Use commit query
 	return c.Query("commit")
 }
 
 // Rollback a transaction
 func (c *Client) Rollback() (err os.Error) {
+	// Log rollback
+	c.log(1, "=== Begin rollback ===")
+	// Use rollback query
 	return c.Query("rollback")
 }
 
@@ -393,11 +415,26 @@ func (c *Client) Escape(s string) (esc string) {
 
 // Initialise and prepare a new statement
 func (c *Client) Prepare(sql string) (stmt *Statement, err os.Error) {
+	// Initialise a new statement
+	stmt, err = c.InitStmt()
+	if err != nil {
+		return
+	}
+	// Prepare statement
+	err = stmt.Prepare(sql)
 	return
 }
 
 // Initialise a new statment
-func (c *Client) StmtInit() (stmt *Statement, err os.Error) {
+func (c *Client) InitStmt() (stmt *Statement, err os.Error) {
+	// Check connection
+	if !c.checkConn() {
+		err = os.NewError("Must be connected to do this")
+		return
+	}
+	// Create new statement
+	stmt = new(Statement)
+	stmt.c = c
 	return
 }
 
@@ -478,6 +515,9 @@ func (c *Client) reset() {
 	c.Errno = 0
 	c.Error = ""
 	c.sequence = 0
+	c.AffectedRows = 0
+	c.LastInsertId = 0
+	c.Warnings = 0
 	c.result = nil
 }
 

mysql_test.go

@@ -6,7 +6,10 @@
 package mysql
 
 import (
+	"fmt"
 	"os"
+	"rand"
+	"strconv"
 	"testing"
 )
 
@@ -18,6 +21,8 @@ const (
 	// create user gomysql_test@localhost identified by 'abc123';
 	// grant all privileges on gomysql_test.* to gomysql_test@localhost;
 	// grant all privileges on gomysql_test2.* to gomysql_test@localhost;
+
+	// Testing settings
 	TEST_HOST       = "localhost"
 	TEST_PORT       = "3306"
 	TEST_SOCK       = "/var/run/mysqld/mysqld.sock"
@@ -28,6 +33,17 @@ const (
 	TEST_DBNAME2    = "gomysql_test2" // This is a privileged database used to test changedb etc
 	TEST_DBNAMEUP   = "gomysql_test3" // This is an unprivileged database
 	TEST_DBNAMEBAD  = "gomysql_bad"   // This is a nonexistant database
+
+	// Simple table queries
+	CREATE_SIMPLE = "CREATE TABLE `simple` (`id` SERIAL NOT NULL, `number` BIGINT NOT NULL, `string` VARCHAR(32) NOT NULL, `text` TEXT NOT NULL, `datetime` DATETIME NOT NULL) ENGINE = InnoDB CHARACTER SET utf8 COLLATE utf8_unicode_ci COMMENT = 'GoMySQL Test Suite Simple Table';"
+	SELECT_SIMPLE = "SELECT * FROM simple"
+	INSERT_SIMPLE = "INSERT INTO simple VALUES (null, %d, '%s', '%s', NOW())"
+	UPDATE_SIMPLE = "UPDATE simple SET `text` = '%s', `datetime` = NOW() WHERE id = %d"
+	DROP_SIMPLE   = "DROP TABLE `simple`"
+
+	// All types table queries
+	CREATE_ALLTYPES = "CREATE TABLE `all_types` (`id` SERIAL NOT NULL, `tiny_int` TINYINT NOT NULL, `tiny_uint` TINYINT UNSIGNED NOT NULL, `small_int` SMALLINT NOT NULL, `small_uint` SMALLINT UNSIGNED NOT NULL, `medium_int` MEDIUMINT NOT NULL, `medium_uint` MEDIUMINT UNSIGNED NOT NULL, `int` INT NOT NULL, `uint` INT UNSIGNED NOT NULL, `big_int` BIGINT NOT NULL, `big_uint` BIGINT UNSIGNED NOT NULL, `decimal` DECIMAL(10,4) NOT NULL, `float` FLOAT NOT NULL, `double` DOUBLE NOT NULL, `real` REAL NOT NULL, `bit` BIT(32) NOT NULL, `boolean` BOOLEAN NOT NULL, `date` DATE NOT NULL, `datetime` DATETIME NOT NULL, `timestamp` TIMESTAMP NOT NULL, `time` TIME NOT NULL, `year` YEAR NOT NULL, `char` CHAR(32) NOT NULL, `varchar` VARCHAR(32) NOT NULL, `tiny_text` TINYTEXT NOT NULL, `text` TEXT NOT NULL, `medium_text` MEDIUMTEXT NOT NULL, `long_text` LONGTEXT NOT NULL, `binary` BINARY(32) NOT NULL, `var_binary` VARBINARY(32) NOT NULL, `tiny_blob` TINYBLOB NOT NULL, `medium_blob` MEDIUMBLOB NOT NULL, `blob` BLOB NOT NULL, `long_blob` LONGBLOB NOT NULL, `enum` ENUM('a','b','c','d','e') NOT NULL, `set` SET('a','b','c','d','e') NOT NULL, `geometry` GEOMETRY NOT NULL) ENGINE = InnoDB CHARACTER SET utf8 COLLATE utf8_unicode_ci COMMENT = 'GoMySQL Test Suite All Types Table'"
+	DROP_ALLTYPES   = "DROP TABLE `all_types`"
 )
 
 var (
@@ -104,6 +120,122 @@ func TestDialUnixBadPass(t *testing.T) {
 	}
 }
 
+// Test queries on a simple table (create database, select, insert, update, drop database)
+func TestSimple(t *testing.T) {
+	t.Logf("Running simple table tests")
+	db, err = DialUnix(TEST_SOCK, TEST_USER, TEST_PASSWD, TEST_DBNAME)
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Create table")
+	err = db.Query(CREATE_SIMPLE)
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Insert 1000 records")
+	rowMap := make(map[uint64][]string)
+	for i := 0; i < 1000; i++ {
+		num, str1, str2 := rand.Int(), randString(32), randString(128)
+		err = db.Query(fmt.Sprintf(INSERT_SIMPLE, num, str1, str2))
+		if err != nil {
+			t.Logf("Error #%d: %s", db.Errno, db.Error)
+			t.Fail()
+		}
+		row := []string{fmt.Sprintf("%d", num), str1, str2}
+		rowMap[db.LastInsertId] = row
+	}
+	t.Logf("Select inserted data")
+	err = db.Query(SELECT_SIMPLE)
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Use result")
+	res, err := db.UseResult()
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Validate inserted data")
+	for {
+		row := res.FetchRow()
+		if row == nil {
+			break
+		}
+		id, _ := strconv.Atoui64(row[0].(string))
+		num, str1, str2 := row[1].(string), row[2].(string), row[3].(string)
+		if rowMap[id][0] != num || rowMap[id][1] != str1 || rowMap[id][2] != str2 {
+			t.Logf("String from database doesn't match local string")
+			t.Fail()
+		}
+	}
+	t.Logf("Free result")
+	err = res.Free()
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Update some records")
+	for i := uint64(0); i < 1000; i += 5 {
+		rowMap[i+1][2] = randString(256)
+		err = db.Query(fmt.Sprintf(UPDATE_SIMPLE, rowMap[i+1][2], i+1))
+		if err != nil {
+			t.Logf("Error #%d: %s", db.Errno, db.Error)
+			t.Fail()
+		}
+		if db.AffectedRows != 1 {
+			t.Logf("Expected 1 effected row but got %d", db.AffectedRows)
+			t.Fail()
+		}
+	}
+	t.Logf("Select updated data")
+	err = db.Query(SELECT_SIMPLE)
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Store result")
+	res, err = db.StoreResult()
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	t.Logf("Validate updated data")
+	for {
+		row := res.FetchRow()
+		if row == nil {
+			break
+		}
+		id, _ := strconv.Atoui64(row[0].(string))
+		num, str1, str2 := row[1].(string), row[2].(string), row[3].(string)
+		if rowMap[id][0] != num || rowMap[id][1] != str1 || rowMap[id][2] != str2 {
+			t.Logf("%#v %#v", rowMap[id], row)
+			t.Logf("String from database doesn't match local string")
+			t.Fail()
+		}
+	}
+	t.Logf("Free result")
+	err = res.Free()
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+
+	t.Logf("Drop table")
+	err = db.Query(DROP_SIMPLE)
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+	err = db.Close()
+	if err != nil {
+		t.Logf("Error #%d: %s", db.Errno, db.Error)
+		t.Fail()
+	}
+}
+
 // Benchmark connect/handshake via TCP
 func BenchmarkDialTCP(b *testing.B) {
 	for i := 0; i < b.N; i++ {
@@ -117,3 +249,14 @@ func BenchmarkDialUnix(b *testing.B) {
 		DialUnix(TEST_SOCK, TEST_USER, TEST_PASSWD, TEST_DBNAME)
 	}
 }
+
+// Create a random string
+func randString(strLen int) (randStr string) {
+	strChars := "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
+	for i := 0; i < strLen; i++ {
+		randUint := rand.Uint32()
+		pos := randUint % uint32(len(strChars))
+		randStr += string(strChars[pos])
+	}
+	return
+}

password.go

@@ -13,16 +13,16 @@ import (
 const SCRAMBLE_LENGTH_323 = 8
 
 // Random struct, see libmysql/password.c
-type rand struct {
+type randStruct struct {
 	maxValue    uint32
 	maxValueDbl float64
 	seed1       uint32
 	seed2       uint32
 }
 
 // Initialise rand struct, see libmysql/password.c
-func randominit(seed1, seed2 uint32) *rand {
-	return &rand{
+func randominit(seed1, seed2 uint32) *randStruct {
+	return &randStruct{
 		maxValue:    0x3FFFFFFF,
 		maxValueDbl: 0x3FFFFFFF,
 		seed1:       seed1 % 0x3FFFFFFF,
@@ -31,7 +31,7 @@ func randominit(seed1, seed2 uint32) *rand {
 }
 
 // Generate a random number, see libmysql/password.c
-func (r *rand) myRnd() float64 {
+func (r *randStruct) myRnd() float64 {
 	r.seed1 = (r.seed1*3 + r.seed2) % r.maxValue
 	r.seed2 = (r.seed1 + r.seed2 + 33) % r.maxValue
 	return float64(r.seed1) / r.maxValueDbl