diff --git a/.coveralls.yml b/.coveralls.yml new file mode 100644 index 00000000..0709f6e0 --- /dev/null +++ b/.coveralls.yml @@ -0,0 +1,2 @@ +service_name: travis-pro +repo_token: 5F6dODinz9L9uFR6HatKmtsYDoV1A5S2N diff --git a/.travis.yml b/.travis.yml index 202c3078..daf50ba6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,3 +3,4 @@ node_js: - '0.10' - '6.9' - '8' +after_success: 'npm run coveralls' diff --git a/README.md b/README.md index ddf9bfcb..2228b80e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ pg-connection-string ==================== +[![NPM](https://nodei.co/npm/pg-connection-string.png?compact=true)](https://nodei.co/npm/pg-connection-string/) + [![Build Status](https://travis-ci.org/iceddev/pg-connection-string.svg?branch=master)](https://travis-ci.org/iceddev/pg-connection-string) +[![Coverage Status](https://coveralls.io/repos/iceddev/pg-connection-string/badge.svg?branch=master)](https://coveralls.io/r/iceddev/pg-connection-string?branch=master) Functions for dealing with a PostgresSQL connection string diff --git a/package.json b/package.json index 9b0e62ec..f6ff6e51 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,9 @@ "main": "./index.js", "types": "./index.d.ts", "scripts": { - "test": "tap ./test" + "test": "istanbul cover _mocha && npm run check-coverage", + "check-coverage": "istanbul check-coverage --statements 100 --branches 100 --lines 100 --functions 100", + "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls" }, "repository": { "type": "git", @@ -25,6 +27,8 @@ "homepage": "https://github.com/iceddev/pg-connection-string", "dependencies": {}, "devDependencies": { - "tap": "^10.3.3" + "chai": "^4.1.1", + "istanbul": "^0.4.5", + "mocha": "^3.5.0" } } diff --git a/test/parse.js b/test/parse.js index 8f4bcb43..8ff3ee81 100644 --- a/test/parse.js +++ b/test/parse.js @@ -1,206 +1,182 @@ 'use strict'; -var test = require('tap').test; +var chai = require('chai'); +var expect = chai.expect; +chai.should(); var parse = require('../').parse; -test('using connection string in client constructor', function(t){ - var subject = parse('postgres://brian:pw@boom:381/lala'); - t.equal(subject.user,'brian'); - t.equal(subject.password, 'pw'); - t.equal(subject.host, 'boom'); - t.equal(subject.port, '381'); - t.equal(subject.database, 'lala'); - t.end(); +describe('parse', function(){ + + it('using connection string in client constructor', function(){ + var subject = parse('postgres://brian:pw@boom:381/lala'); + subject.user.should.equal('brian'); + subject.password.should.equal( 'pw'); + subject.host.should.equal( 'boom'); + subject.port.should.equal( '381'); + subject.database.should.equal( 'lala'); + }); + + it('escape spaces if present', function(){ + var subject = parse('postgres://localhost/post gres'); + subject.database.should.equal('post gres'); + }); + + it('do not double escape spaces', function(){ + var subject = parse('postgres://localhost/post%20gres'); + subject.database.should.equal('post gres'); + }); + + it('initializing with unix domain socket', function(){ + var subject = parse('/var/run/'); + subject.host.should.equal('/var/run/'); + }); + + it('initializing with unix domain socket and a specific database, the simple way', function(){ + var subject = parse('/var/run/ mydb'); + subject.host.should.equal('/var/run/'); + subject.database.should.equal('mydb'); + }); + + it('initializing with unix domain socket, the health way', function(){ + var subject = parse('socket:/some path/?db=my[db]&encoding=utf8'); + subject.host.should.equal('/some path/'); + subject.database.should.equal('my[db]', 'must to be escaped and unescaped trough "my%5Bdb%5D"'); + subject.client_encoding.should.equal('utf8'); + }); + + it('initializing with unix domain socket, the escaped health way', function(){ + var subject = parse('socket:/some%20path/?db=my%2Bdb&encoding=utf8'); + subject.host.should.equal('/some path/'); + subject.database.should.equal('my+db'); + subject.client_encoding.should.equal('utf8'); + }); + + it('password contains < and/or > characters', function(){ + var sourceConfig = { + user:'brian', + password: 'helloe', + port: 5432, + host: 'localhost', + database: 'postgres' + }; + var connectionString = 'postgres://' + sourceConfig.user + ':' + sourceConfig.password + '@' + sourceConfig.host + ':' + sourceConfig.port + '/' + sourceConfig.database; + var subject = parse(connectionString); + subject.password.should.equal(sourceConfig.password); + }); + + it('password contains colons', function(){ + var sourceConfig = { + user:'brian', + password: 'hello:pass:world', + port: 5432, + host: 'localhost', + database: 'postgres' + }; + var connectionString = 'postgres://' + sourceConfig.user + ':' + sourceConfig.password + '@' + sourceConfig.host + ':' + sourceConfig.port + '/' + sourceConfig.database; + var subject = parse(connectionString); + subject.password.should.equal(sourceConfig.password); + }); + + it('username or password contains weird characters', function(){ + var strang = 'pg://my f%irst name:is&%awesome!@localhost:9000'; + var subject = parse(strang); + subject.user.should.equal('my f%irst name'); + subject.password.should.equal('is&%awesome!'); + subject.host.should.equal('localhost'); + }); + + it('url is properly encoded', function(){ + var encoded = 'pg://bi%25na%25%25ry%20:s%40f%23@localhost/%20u%2520rl'; + var subject = parse(encoded); + subject.user.should.equal('bi%na%%ry '); + subject.password.should.equal('s@f#'); + subject.host.should.equal('localhost'); + subject.database.should.equal(' u%20rl'); + }); + + it('relative url sets database', function(){ + var relative = 'different_db_on_default_host'; + var subject = parse(relative); + subject.database.should.equal('different_db_on_default_host'); + }); + + it('no pathname returns null database', function () { + var subject = parse('pg://myhost'); + (subject.database === null).should.equal(true); + }); + + it('pathname of "/" returns null database', function () { + var subject = parse('pg://myhost/'); + subject.host.should.equal('myhost'); + (subject.database === null).should.equal(true); + }); + + it('configuration parameter application_name', function(){ + var connectionString = 'pg:///?application_name=TheApp'; + var subject = parse(connectionString); + subject.application_name.should.equal('TheApp'); + }); + + it('configuration parameter fallback_application_name', function(){ + var connectionString = 'pg:///?fallback_application_name=TheAppFallback'; + var subject = parse(connectionString); + subject.fallback_application_name.should.equal('TheAppFallback'); + }); + + it('configuration parameter fallback_application_name', function(){ + var connectionString = 'pg:///?fallback_application_name=TheAppFallback'; + var subject = parse(connectionString); + subject.fallback_application_name.should.equal('TheAppFallback'); + }); + + it('configuration parameter ssl=true', function(){ + var connectionString = 'pg:///?ssl=true'; + var subject = parse(connectionString); + subject.ssl.should.equal(true); + }); + + it('configuration parameter ssl=1', function(){ + var connectionString = 'pg:///?ssl=1'; + var subject = parse(connectionString); + subject.ssl.should.equal(true); + }); + + it('set ssl', function () { + var subject = parse('pg://myhost/db?ssl=1'); + subject.ssl.should.equal(true); + }); + + it('allow other params like max, ...', function () { + var subject = parse('pg://myhost/db?max=18&min=4'); + subject.max.should.equal('18'); + subject.min.should.equal('4'); + }); + + + it('configuration parameter keepalives', function(){ + var connectionString = 'pg:///?keepalives=1'; + var subject = parse(connectionString); + subject.keepalives.should.equal('1'); + }); + + it('unknown configuration parameter is passed into client', function(){ + var connectionString = 'pg:///?ThereIsNoSuchPostgresParameter=1234'; + var subject = parse(connectionString); + subject.ThereIsNoSuchPostgresParameter.should.equal('1234'); + }); + + it('do not override a config field with value from query string', function(){ + var subject = parse('socket:/some path/?db=my[db]&encoding=utf8&client_encoding=bogus'); + subject.host.should.equal('/some path/'); + subject.database.should.equal('my[db]', 'must to be escaped and unescaped through "my%5Bdb%5D"'); + subject.client_encoding.should.equal('utf8'); + }); + + + it('return last value of repeated parameter', function(){ + var connectionString = 'pg:///?keepalives=1&keepalives=0'; + var subject = parse(connectionString); + subject.keepalives.should.equal('0'); + }); }); - -test('escape spaces if present', function(t){ - var subject = parse('postgres://localhost/post gres'); - t.equal(subject.database, 'post gres'); - t.end(); -}); - -test('do not double escape spaces', function(t){ - var subject = parse('postgres://localhost/post%20gres'); - t.equal(subject.database, 'post gres'); - t.end(); -}); - -test('initializing with unix domain socket', function(t){ - var subject = parse('/var/run/'); - t.equal(subject.host, '/var/run/'); - t.end(); -}); - -test('initializing with unix domain socket and a specific database, the simple way', function(t){ - var subject = parse('/var/run/ mydb'); - t.equal(subject.host, '/var/run/'); - t.equal(subject.database, 'mydb'); - t.end(); -}); - -test('initializing with unix domain socket, the health way', function(t){ - var subject = parse('socket:/some path/?db=my[db]&encoding=utf8'); - t.equal(subject.host, '/some path/'); - t.equal(subject.database, 'my[db]', 'must to be escaped and unescaped trough "my%5Bdb%5D"'); - t.equal(subject.client_encoding, 'utf8'); - t.end(); -}); - -test('initializing with unix domain socket, the escaped health way', function(t){ - var subject = parse('socket:/some%20path/?db=my%2Bdb&encoding=utf8'); - t.equal(subject.host, '/some path/'); - t.equal(subject.database, 'my+db'); - t.equal(subject.client_encoding, 'utf8'); - t.end(); -}); - -test('password contains < and/or > characters', function(t){ - var sourceConfig = { - user:'brian', - password: 'helloe', - port: 5432, - host: 'localhost', - database: 'postgres' - }; - var connectionString = 'postgres://' + sourceConfig.user + ':' + sourceConfig.password + '@' + sourceConfig.host + ':' + sourceConfig.port + '/' + sourceConfig.database; - var subject = parse(connectionString); - t.equal(subject.password, sourceConfig.password); - t.end(); -}); - -test('password contains colons', function(t){ - var sourceConfig = { - user:'brian', - password: 'hello:pass:world', - port: 5432, - host: 'localhost', - database: 'postgres' - }; - var connectionString = 'postgres://' + sourceConfig.user + ':' + sourceConfig.password + '@' + sourceConfig.host + ':' + sourceConfig.port + '/' + sourceConfig.database; - var subject = parse(connectionString); - t.equal(subject.password, sourceConfig.password); - t.end(); -}); - -test('username or password contains weird characters', function(t){ - var strang = 'pg://my f%irst name:is&%awesome!@localhost:9000'; - var subject = parse(strang); - t.equal(subject.user, 'my f%irst name'); - t.equal(subject.password, 'is&%awesome!'); - t.equal(subject.host, 'localhost'); - t.end(); -}); - -test('url is properly encoded', function(t){ - var encoded = 'pg://bi%25na%25%25ry%20:s%40f%23@localhost/%20u%2520rl'; - var subject = parse(encoded); - t.equal(subject.user, 'bi%na%%ry '); - t.equal(subject.password, 's@f#'); - t.equal(subject.host, 'localhost'); - t.equal(subject.database, ' u%20rl'); - t.end(); -}); - -test('relative url sets database', function(t){ - var relative = 'different_db_on_default_host'; - var subject = parse(relative); - t.equal(subject.database, 'different_db_on_default_host'); - t.end(); -}); - -test('no pathname returns null database', function (t) { - var subject = parse('pg://myhost'); - t.equal(subject.host, 'myhost'); - t.type(subject.database, 'null'); - - t.end(); -}); - -test('pathname of "/" returns null database', function (t) { - var subject = parse('pg://myhost/'); - t.equal(subject.host, 'myhost'); - t.type(subject.database, 'null'); - - t.end(); -}); - -test('configuration parameter application_name', function(t){ - var connectionString = 'pg:///?application_name=TheApp'; - var subject = parse(connectionString); - t.equal(subject.application_name, 'TheApp'); - t.end(); -}); - -test('configuration parameter fallback_application_name', function(t){ - var connectionString = 'pg:///?fallback_application_name=TheAppFallback'; - var subject = parse(connectionString); - t.equal(subject.fallback_application_name, 'TheAppFallback'); - t.end(); -}); - -test('configuration parameter fallback_application_name', function(t){ - var connectionString = 'pg:///?fallback_application_name=TheAppFallback'; - var subject = parse(connectionString); - t.equal(subject.fallback_application_name, 'TheAppFallback'); - t.end(); -}); - -test('configuration parameter ssl=true', function(t){ - var connectionString = 'pg:///?ssl=true'; - var subject = parse(connectionString); - t.equal(subject.ssl, true); - t.end(); -}); - -test('configuration parameter ssl=1', function(t){ - var connectionString = 'pg:///?ssl=1'; - var subject = parse(connectionString); - t.equal(subject.ssl, true); - t.end(); -}); - -test('set ssl', function (t) { - var subject = parse('pg://myhost/db?ssl=1'); - t.equal(subject.ssl, true); - t.end(); - }); - - test('allow other params like max, ...', function (t) { - var subject = parse('pg://myhost/db?max=18&min=4'); - t.equal(subject.max, '18'); - t.equal(subject.min, '4'); - t.end(); - }); - - -test('configuration parameter keepalives', function(t){ - var connectionString = 'pg:///?keepalives=1'; - var subject = parse(connectionString); - t.equal(subject.keepalives, '1'); - t.end(); -}); - -test('unknown configuration parameter is passed into client', function(t){ - var connectionString = 'pg:///?ThereIsNoSuchPostgresParameter=1234'; - var subject = parse(connectionString); - t.equal(subject.ThereIsNoSuchPostgresParameter, '1234'); - t.end(); -}); - -test('do not override a config field with value from query string', function(t){ - var subject = parse('socket:/some path/?db=my[db]&encoding=utf8&client_encoding=bogus'); - t.equal(subject.host, '/some path/'); - t.equal(subject.database, 'my[db]', 'must to be escaped and unescaped trough "my%5Bdb%5D"'); - t.equal(subject.client_encoding, 'utf8'); - t.end(); -}); - - -test('return last value of repeated parameter', function(t){ - var connectionString = 'pg:///?keepalives=1&keepalives=0'; - var subject = parse(connectionString); - t.equal(subject.keepalives, '0'); - t.end(); -}); -