From e8a2cd66219b08b8f25d9ba00a49c9fa5c3a9bfd Mon Sep 17 00:00:00 2001 From: Robert Nelson Date: Sun, 8 Dec 2013 04:38:44 -0800 Subject: [PATCH] Continuous integration testing support completed --- .gitignore | 2 + Gruntfile.js | 68 ++++++++++++++- Makefile | 5 +- package.json | 26 ++++-- test/ci-quick.js | 204 +++++++++++++++++++++++++++++++++++++++++++ test/ci-tests-all.js | 1 + test/ci-tests.html | 30 +++++++ 7 files changed, 324 insertions(+), 12 deletions(-) create mode 100644 test/ci-quick.js create mode 100644 test/ci-tests-all.js create mode 100644 test/ci-tests.html diff --git a/.gitignore b/.gitignore index 5b5aca84..a7ca6715 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ build/ .DS_Store node_modules/ npm* +test/lib/ +test/test-bundle.js diff --git a/Gruntfile.js b/Gruntfile.js index b1bb89bb..1a1917cb 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -4,9 +4,40 @@ module.exports = function(grunt) { grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), browserify: { - dist: { + openpgp: { files: { - 'resources/openpgp.js': ['src/**/*.js'] + 'resources/openpgp.js': [] + }, + options: { + alias: './src/:openpgp' + } + }, + openpgp_debug: { + files: { + 'resources/openpgp.debug.js': [] + }, + options: { + debug: true, + alias: './src/:openpgp' + } + }, + unittests: { + files: { + 'test/test-bundle.js': [] + }, + options: { + debug: true, + alias: './test/test-all.js:test-bundle.js' + } + }, + ci_tests: { + files: { + 'test/lib/ci-tests-bundle.js': [] + }, + options: { + debug: true, + alias: './test/ci-tests-all.js:ci-tests', + external: [ 'openpgp' ] } } }, @@ -51,6 +82,22 @@ module.exports = function(grunt) { destination: "doc" } } + }, + + copy: { + npm: { + expand: true, + flatten: true, + cwd: 'node_modules/', + src: ['mocha/mocha.css', 'mocha/mocha.js', 'chai/chai.js', 'sinon/pkg/sinon.js'], + dest: 'test/lib/' + }, + openpgp: { + expand: true, + cwd: 'resources/', + src: ['openpgp.debug.js', 'jquery.min.js'], + dest: 'test/lib/' + } } }); @@ -63,9 +110,24 @@ module.exports = function(grunt) { grunt.loadNpmTasks('grunt-jsdoc'); grunt.registerTask('default', 'Build OpenPGP.js', function() { - grunt.task.run(['jsbeautifier', 'browserify', 'replace', 'uglify']); + grunt.task.run(['browserify', 'replace', 'uglify']); //TODO jshint is not run because of too many discovered issues, once these are addressed it should autorun grunt.log.ok('Before Submitting a Pull Request please also run `grunt jshint`.'); }); grunt.registerTask('documentation', ['jsdoc']); + + // Load the plugin(s) + grunt.loadNpmTasks('grunt-contrib-copy'); + + // Alias the `mocha_phantomjs` task to run `mocha-phantomjs` + grunt.registerTask('mocha_phantomjs', 'mocha-phantomjs', function () { + var done = this.async(); + require('child_process').exec('node_modules/mocha-phantomjs/bin/mocha-phantomjs ./test/ci-tests.html', function (err, stdout) { + grunt.log.write(stdout); + done(err); + }); + }); + + // Test/Dev tasks + grunt.registerTask('test', ['copy', 'mocha_phantomjs']); }; diff --git a/Makefile b/Makefile index 2fb1264d..17b081a0 100644 --- a/Makefile +++ b/Makefile @@ -31,11 +31,14 @@ lint: @./scripts/lint.sh bundle: - @browserify -d -r ./:openpgp > ./resources/openpgp.js + @browserify -d -r ./src/:openpgp > ./resources/openpgp.js bundle-test: @browserify -d -r ./test/test-all.js:test-bundle.js > ./test/test-bundle.js +bundle-ci-test: + @browserify -d -x openpgp -r ./test/ci-tests-all.js:ci-tests > ./test/lib/ci-tests-bundle.js + test: @echo to be implemented @echo Open test/index.html instead diff --git a/package.json b/package.json index 01d1d960..b5c9ea1a 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,24 @@ { - "name": "openpgp", - "version": "0.0.1", - "main": "./src/index.js", - "scripts": { - "pretest": "make bundle && make bundle-test", - "test": "" - }, + "name": "openpgp", + "version": "0.0.1", + "engines": { + "node": ">=0.8" + }, + "main": "./src/index.js", + "scripts": { + "pretest": "grunt browserify", + "test": "grunt test", + "start": "grunt dev" + }, "devDependencies": { "browserify": "~2.35", - "grunt": "~0.4.1", + "grunt": "~0.4.2", + "mocha": "~1.15.1", + "mocha-phantomjs": "~3.1.6", + "phantomjs": "~1.9.2-5", + "chai": "~1.8.1", + "sinon": "~1.7.3", + "grunt-contrib-copy": "~0.4.1", "grunt-browserify": "~1.2.11", "grunt-contrib-uglify": "*", "grunt-text-replace": "*", diff --git a/test/ci-quick.js b/test/ci-quick.js new file mode 100644 index 00000000..3918f513 --- /dev/null +++ b/test/ci-quick.js @@ -0,0 +1,204 @@ +var openpgp = require('openpgp'); + //keyring = require('../../src/keyring.js'); + +'use strict'; + +var expect = chai.expect; + +describe('Openpgp integration tests', function() { + var user = 'test@t-online.de', + passphrase = 'asdf', + keySize = 512, + keyId = 'F6F60E9B42CDFF4C', + pubkey = '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' + + 'Version: OpenPGP.js v.1.20131011\n' + + 'Comment: http://openpgpjs.org\n' + + '\n' + + 'xk0EUlhMvAEB/2MZtCUOAYvyLFjDp3OBMGn3Ev8FwjzyPbIF0JUw+L7y2XR5\n' + + 'RVGvbK88unV3cU/1tOYdNsXI6pSp/Ztjyv7vbBUAEQEAAc0pV2hpdGVvdXQg\n' + + 'VXNlciA8d2hpdGVvdXQudGVzdEB0LW9ubGluZS5kZT7CXAQQAQgAEAUCUlhM\n' + + 'vQkQ9vYOm0LN/0wAAAW4Af9C+kYW1AvNWmivdtr0M0iYCUjM9DNOQH1fcvXq\n' + + 'IiN602mWrkd8jcEzLsW5IUNzVPLhrFIuKyBDTpLnC07Loce1\n' + + '=6XMW\n' + + '-----END PGP PUBLIC KEY BLOCK-----', + privkey = '-----BEGIN PGP PRIVATE KEY BLOCK-----\n' + + 'Version: OpenPGP.js v.1.20131011\n' + + 'Comment: http://openpgpjs.org\n' + + '\n' + + 'xcBeBFJYTLwBAf9jGbQlDgGL8ixYw6dzgTBp9xL/BcI88j2yBdCVMPi+8tl0\n' + + 'eUVRr2yvPLp1d3FP9bTmHTbFyOqUqf2bY8r+72wVABEBAAH+AwMIhNB4ivtv\n' + + 'Y2xg6VeMcjjHxZayESHACV+nQx5Tx6ev6xzIF1Qh72fNPDppLhFSFOuTTMsU\n' + + 'kTN4c+BVYt29spH+cA1jcDAxQ2ULrNAXo+hheOqhpedTs8aCbcLFkJAS16hk\n' + + 'YSk4OnJgp/z24rVju1SHRSFbgundPzmNgXeX9e8IkviGhhQ11Wc5YwVkx03t\n' + + 'Z3MdDMF0jyhopbPIoBdyJB0dhvBh98w3JmwpYh9wjUA9MBHD1tvHpRmSZ3BM\n' + + 'UCmATn2ZLWBRWiYqFbgDnL1GM80pV2hpdGVvdXQgVXNlciA8d2hpdGVvdXQu\n' + + 'dGVzdEB0LW9ubGluZS5kZT7CXAQQAQgAEAUCUlhMvQkQ9vYOm0LN/0wAAAW4\n' + + 'Af9C+kYW1AvNWmivdtr0M0iYCUjM9DNOQH1fcvXqIiN602mWrkd8jcEzLsW5\n' + + 'IUNzVPLhrFIuKyBDTpLnC07Loce1\n' + + '=ULta\n' + + '-----END PGP PRIVATE KEY BLOCK-----'; + + describe('Generate key pair', function() { + it('should work', function(done) { + // generate keypair (keytype 1=RSA) + var errMsg, err; + var keys = null; + + try { + var userId = 'Whiteout User <' + user + '>'; + var keys = openpgp.generateKeyPair(1, keySize, userId, passphrase); + var keyId = openpgp.util.hexstrdump(keys.key.getKeyPacket().getKeyId()).toUpperCase(); + expect(keyId).to.exist; + expect(keys.privateKeyArmored).to.exist; + expect(keys.publicKeyArmored).to.exist; + } catch (e) { + errMsg = 'Keygeneration failed!'; + err = e; + } + + expect(err).to.not.exist; + done(); + }); + }); + +// describe('Import key pair', function() { +// it('should work', function(done) { +// // clear any keypair already in the keychain +// keyring.init(); +// // import private key +// keyring.importPacketlist(privkey); +// // import public key +// keyring.importPacketlist(pubkey); +// done(); +// }); +// }); + + describe('Encryption', function() { + var message = 'asdfs\n\nThursday, Nov 21, 2013 7:38 PM asdf@example.com wrote:\n' + + '> asdf\n' + + '> \n' + + '> Thursday, Nov 21, 2013 7:32 PM asdf@example.com wrote:\n' + + '> > secret 3', + ciphertext; + + describe('Encrypt and Sign', function() { + it('should work', function(done) { + var signkey = openpgp.key.readArmored(privkey); + expect(signkey).to.exist; + var encryptkey = openpgp.key.readArmored(pubkey); + expect(encryptkey).to.exist; + expect(signkey.decrypt(passphrase)).to.be.true; + ciphertext = openpgp.signAndEncryptMessage([encryptkey], signkey, message); + expect(ciphertext).to.exist; + done(); + }); + }); + + describe('Decrypt and Verify', function() { + it('should work', function(done) { + var decryptkey = openpgp.key.readArmored(privkey); + expect(decryptkey, 'decryptkey').to.exist; + var verifykey = openpgp.key.readArmored(pubkey); + expect(verifykey, 'verifykey').to.exist; + var pgpmsg = openpgp.message.readArmored(ciphertext); + expect(pgpmsg, 'pgpmsg').to.exist; + var keyids = pgpmsg.getEncryptionKeyIds(); + expect(keyids, 'keyids').to.exist; + expect(decryptkey.decryptKeyPacket(keyids, passphrase), 'decryptKeyPacket()').to.be.true; + var result = openpgp.decryptAndVerifyMessage(decryptkey, [verifykey], pgpmsg); + expect(result, 'decryptAndVerifyMessage() result').to.exist; + expect(result.text, 'decryptAndVerifyMessage() result.text').to.exist.and.equal(message); + expect(result.signatures, 'decryptAndVerifyMessage() result.signatures').to.exist.and.not.be.empty; + expect(result.signatures[0].status, 'decryptAndVerifyMessage() result.signatures[0].status').to.be.true; + done(); + }); + }); + }); + + describe('Verify clearsign from gpg', function() { + describe('Verify V3 signature', function() { + var v3_clearsign_msg = '-----BEGIN PGP SIGNED MESSAGE-----\r\n' + + 'Hash: SHA1\r\n' + + '\r\n' + + 'This is a test message.\r\n' + + '\r\n' + + 'This paragraph is separated form the next by a line of dashes.\r\n' + + '\r\n' + + '- --------------------------------------------------------------------------\r\n' + + '\r\n' + + 'The next paragraph has a number of blank lines between this one and it.\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + 'This is the last paragraph.\r\n' + + '\r\n' + + '- --\r\n' + + '\r\n' + + 'Joe Test\r\n' + + '-----BEGIN PGP SIGNATURE-----\r\n' + + 'Version: GnuPG v1.4.15 (GNU/Linux)\r\n' + + '\r\n' + + 'iQBVAwUBUp/7GPb2DptCzf9MAQKviQH6A6Pqa63kxWI+atMiaSXz5uifgsBoiOof\r\n' + + 'E3/oVTIGyGTgB7KnwZiFkDMFrUNREJVSQGt6+4nxje8gARcuYpMnWw==\r\n' + + '=lOCC\r\n' + + '-----END PGP SIGNATURE-----\r\n'; + it('should work', function(done) { + var cleartext = openpgp.cleartext.readArmored(v3_clearsign_msg); + expect(cleartext).to.exist; + var verifykey = openpgp.key.readArmored(pubkey); + expect(verifykey, 'verifykey').to.exist; + var result = cleartext.verify([verifykey]) + expect(result, 'verify() result').to.exist.and.not.be.empty; + expect(result[0].keyid, 'verify() result[0].keyid').to.exist; + expect(result[0].status, 'verify() result[0].status').to.be.true; + done(); + }); + }); + + describe('Verify V4 signature', function() { + var v4_clearsign_msg = '-----BEGIN PGP SIGNED MESSAGE-----\r\n' + + 'Hash: SHA1\r\n' + + '\r\n' + + 'This is a test message.\r\n' + + '\r\n' + + 'This paragraph is separated form the next by a line of dashes.\r\n' + + '\r\n' + + '- --------------------------------------------------------------------------\r\n' + + '\r\n' + + 'The next paragraph has a number of blank lines between this one and it.\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + '\r\n' + + 'This is the last paragraph.\r\n' + + '\r\n' + + '- --\r\n' + + '\r\n' + + 'Joe Test\r\n' + + '-----BEGIN PGP SIGNATURE-----\r\n' + + 'Version: GnuPG v1.4.15 (GNU/Linux)\r\n' + + '\r\n' + + 'iFwEAQECAAYFAlKf5LcACgkQ9vYOm0LN/0ybVwH8CItdDh4kWKVcyUx3Q3hWZnWd\r\n' + + 'zP9CUbIa9uToIPABjV3GOTDM3ZgiP0/SE6Al5vG8hlx+/u2piVojoLovk/4LnA==\r\n' + + '=i6ew\r\n' + + '-----END PGP SIGNATURE-----\r\n'; + + it('should work', function(done) { + var cleartext = openpgp.cleartext.readArmored(v4_clearsign_msg); + expect(cleartext).to.exist; + var verifykey = openpgp.key.readArmored(pubkey); + expect(verifykey, 'verifykey').to.exist; + var result = cleartext.verify([verifykey]) + expect(result, 'verify() result').to.exist.and.not.be.empty; + expect(result[0].keyid, 'verify() result[0].keyid').to.exist; + expect(result[0].status, 'verify() result[0].status').to.be.true; + done(); + }); + }); + }); +}); diff --git a/test/ci-tests-all.js b/test/ci-tests-all.js new file mode 100644 index 00000000..50546202 --- /dev/null +++ b/test/ci-tests-all.js @@ -0,0 +1 @@ +require('./ci-quick.js'); diff --git a/test/ci-tests.html b/test/ci-tests.html new file mode 100644 index 00000000..6d8d278a --- /dev/null +++ b/test/ci-tests.html @@ -0,0 +1,30 @@ + + + + + OpenPGPJS Continuous Integration Tests + + + + +
+ + + + + + + + + + +