Merge pull request #496 from kai-koch/master

* Adding support for unit tests on windows systems
* Clarified the use of config option 'charset'

Author: kai-koch

Readme.md

@@ -138,7 +138,7 @@ When establishing a connection, you can set the following options:
 * `user`: The MySQL user to authenticate as.
 * `password`: The password of that MySQL user.
 * `database`: Name of the database to use for this connection (Optional).
-* `charset`: The charset for the connection. (Default: `'UTF8_GENERAL_CI'`)
+* `charset`: The charset for the connection. (Default: `'UTF8_GENERAL_CI'`. Value needs to be all in upper case letters!)
 * `timezone`: The timezone used to store local dates. (Default: `'local'`)
 * `stringifyObjects`: Stringify objects instead of converting to values. See
 issue [#501](https://github.com/felixge/node-mysql/issues/501). (Default: `'false'`)
@@ -880,6 +880,14 @@ For example, if you have an installation of mysql running on localhost:3306 and
   MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_DATABASE=node_mysql_test MYSQL_USER=root MYSQL_PASSWORD= make test
 ```
 
+## Running unit tests on windows
+
+* Edit the variables in the file ```make.bat```  according to your system and mysql-settings.
+* Make sure the database (e.g. 'test') you want to use exists and the user you entered has the proper rights to use the test database. (E.g. do not forget to execute the SQL-command ```FLUSH PRIVILEGES``` after you have created the user.)
+* In a DOS-box (or CMD-shell) in the folder of your application run ```npm install mysql --dev``` or in the mysql folder (```node_modules\mysql```), run ```npm install --dev```. (This will install additional developer-dependencies for node-mysql.)
+* Run ```npm test mysql``` in your applications folder or ```npm test``` in the mysql subfolder.
+* If you want to log the output into a file use ```npm test mysql > test.log``` or ```npm test > test.log```. 
+
 ## Todo
 
 * Prepared statements

make.bat

@@ -0,0 +1,29 @@
+@ECHO OFF
+REM Simple 'make' replacement for windows-based system, 'npm test' will now find
+REM 'make.bat' and sets the MYSQL_ enviroment variables according to this file
+
+REM Edit the variables according to your system
+REM No spaces (' ') between variablenames, '=' and the values!
+
+REM Host to test with default: localhost
+SET MYSQL_HOST=localhost
+
+REM Default mysql port: 3306
+SET MYSQL_PORT=3306
+
+REM For a standard installatons of Wampp using http://www.apachefriends.org/
+REM the default login is 'root' and no password, but any user should do, change
+REM  the settings according to your installation
+SET MYSQL_USER=root
+SET MYSQL_PASSWORD=
+
+REM make sure the database you are using exists and the above user has access to
+REM it. Normally every user has access to the database 'test'
+SET MYSQL_DATABASE=test
+
+@ECHO ON
+node test/run.js
+@ECHO OFF
+ECHO **********************
+ECHO If the tests should fail, make sure you have SET the correct values for the enviroment variables in the file 'make.bat'
+ECHO **********************

test/integration/connection/test-unix-domain-socket.js

@@ -1,9 +1,19 @@
+/**
+ * This test is skipped, if the environment variable "windir" is set.
+ * It assumes that it runs on a windows system then.
+ */
+if (process.env.windir) {
+  return console.log('Skipping "test-unix-domain-socket.js" - Environment' 
+    + ' variable "windir" is set. Skipping this, because we seem to be on' 
+    + ' a windows system');  
+}
 var common     = require('../../common');
 var connection = common.createConnection({socketPath: common.fakeServerSocket});
 var assert     = require('assert');
 
 var server = common.createFakeServer();
 var didConnect = false;
+
 server.listen(common.fakeServerSocket, function(err) {
   if (err) throw err;
 
@@ -27,6 +37,6 @@ server.on('connection', function(connection) {
 });
 
 process.on('exit', function() {
-  assert.equal(didConnect, true);
-  assert.equal(hadConnection, true);
+    assert.equal(didConnect, true);
+    assert.equal(hadConnection, true);
 });