gpgme/lang/js/unittests.js

/* gpgme.js - Javascript integration for gpgme
 * Copyright (C) 2018 Bundesamt für Sicherheit in der Informationstechnik
 *
 * This file is part of GPGME.
 *
 * GPGME is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * GPGME is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, see <https://www.gnu.org/licenses/>.
 * SPDX-License-Identifier: LGPL-2.1+
 */

import './node_modules/mocha/mocha'; /* global mocha, it, describe*/
import './node_modules/chai/chai';/* global chai*/
import { helper_params as hp } from './unittest_inputvalues';
import { message_params as mp } from './unittest_inputvalues';
import { whatever_params as wp } from './unittest_inputvalues';
import { key_params as kp } from './unittest_inputvalues';
import { Connection } from './src/Connection';
import { gpgme_error, err_list } from './src/Errors';
import { toKeyIdArray , isFingerprint } from './src/Helpers';
import { createKey } from './src/Key';
import { GPGME_Keyring } from './src/Keyring';
import { GPGME_Message, createMessage } from './src/Message';

mocha.setup('bdd');
const expect = chai.expect;
chai.config.includeStack = true;
const connectionTimeout = 2000;

function unittests (){
    describe('Connection testing', function (){

        it('Connecting', function (done) {
            let conn0 = new Connection;
            conn0.checkConnection(true, connectionTimeout).then(
                function (answer) {
                    expect(answer).to.not.be.empty;
                    expect(answer.gpgme).to.not.be.undefined;
                    expect(answer.gpgme).to.be.a('string');
                    expect(answer.info).to.be.an('Array');
                    expect(conn0.disconnect).to.be.a('function');
                    expect(conn0.post).to.be.a('function');
                    expect(conn0.isDisconnected).to.be.false;
                    done();
                });

        });

        it('Simple connection check', function (done) {
            let conn0 = new Connection;
            conn0.checkConnection(false, connectionTimeout).then(
                function (answer) {
                    expect(answer).to.be.true;
                    expect(conn0.isDisconnected).to.be.false;
                    done();
                });
        });

        it('Connection check with backend information', function (done) {
            let conn0 = new Connection;
            conn0.checkConnection(true, connectionTimeout).then(
                function (answer) {
                    expect(answer).to.be.an('Object');
                    expect(answer.gpgme).to.be.a('String');
                    expect(answer.info).to.be.an('Array');
                    expect(answer.info.length).to.be.above(0);
                    for (const item of answer.info) {
                        expect(item).to.have.property('protocol');
                        expect(item).to.have.property('fname');
                        expect(item).to.have.property('version');
                        expect(item).to.have.property('req_version');
                        expect(item).to.have.property('homedir');
                    }
                    expect(conn0.isDisconnected).to.be.false;
                    done();
                });
        });

        it('Disconnecting', function (done) {
            let conn0 = new Connection;
            conn0.checkConnection(false, connectionTimeout).then(
                function (answer) {
                    expect(answer).to.be.true;
                    conn0.disconnect();
                    conn0.checkConnection(false, connectionTimeout).then(
                        function (result) {
                            expect(result).to.be.false;
                            expect(conn0.isDisconnected).to.be.true;
                            done();
                        });
                });
        });
    });

    describe('Error Object handling', function (){
        // TODO: new GPGME_Error codes
        it('check the Timeout error', function (){
            let test0 = gpgme_error('CONN_TIMEOUT');

            expect(test0).to.be.an.instanceof(Error);
            expect(test0.code).to.equal('CONN_TIMEOUT');
        });

        it('Error Object returns generic code if code is not listed',
            function (){
                let test0 = gpgme_error(hp.invalidErrorCode);

                expect(test0).to.be.an.instanceof(Error);
                expect(test0.code).to.equal('GENERIC_ERROR');
            }
        );

        it('Warnings like PARAM_IGNORED should not return errors', function (){
            let test0 = gpgme_error('PARAM_IGNORED');

            expect(test0).to.be.null;
        });
    });

    describe('Fingerprint checking', function (){

        it('isFingerprint(): valid Fingerprint', function (){
            let test0  = isFingerprint(hp.validFingerprint);

            expect(test0).to.be.true;
        });

        it('isFingerprint(): invalid Fingerprints', function (){
            for (let i=0; i < hp.invalidFingerprints.length; i++){
                let test0 = isFingerprint(hp.invalidFingerprints[i]);

                expect(test0).to.be.false;
            }
        });
    });

    describe('toKeyIdArray() (converting input to fingerprint)', function (){

        it('Correct fingerprint string', function (){
            let test0 = toKeyIdArray(hp.validFingerprint);

            expect(test0).to.be.an('array');
            expect(test0).to.include(hp.validFingerprint);
        });

        it('openpgpjs-like object', function (){
            let test0 = toKeyIdArray(hp.valid_openpgplike);

            expect(test0).to.be.an('array').with.lengthOf(1);
            expect(test0).to.include(
                hp.valid_openpgplike.primaryKey.getFingerprint());
        });

        it('Array of valid inputs', function (){
            let test0 = toKeyIdArray(hp.validKeys);
            expect(test0).to.be.an('array');
            expect(test0).to.have.lengthOf(hp.validKeys.length);
        });

        it('Incorrect inputs', function (){

            it('valid Long ID', function (){
                let test0 = toKeyIdArray(hp.validLongId);

                expect(test0).to.be.empty;
            });

            it('invalidFingerprint', function (){
                let test0 = toKeyIdArray(hp.invalidFingerprint);

                expect(test0).to.be.empty;
            });

            it('invalidKeyArray', function (){
                let test0 = toKeyIdArray(hp.invalidKeyArray);

                expect(test0).to.be.empty;
            });

            it('Partially invalid array', function (){
                let test0 = toKeyIdArray(hp.invalidKeyArray_OneBad);

                expect(test0).to.be.an('array');
                expect(test0).to.have.lengthOf(
                    hp.invalidKeyArray_OneBad.length - 1);
            });
        });
    });

    describe('GPGME_Key', function (){
        it('Key has data after a first refresh', function (done) {
            let key = createKey(kp.validKeyFingerprint);
            key.refreshKey().then(function (key2){
                expect(key2.get).to.be.a('function');
                for (let i=0; i < kp.validKeyProperties.length; i++) {
                    let prop = key2.get(kp.validKeyProperties[i]);
                    expect(prop).to.not.be.undefined;
                    expect(prop).to.be.a('boolean');
                }
                expect(isFingerprint(key2.get('fingerprint'))).to.be.true;
                expect(
                    key2.get('fingerprint')).to.equal(kp.validKeyFingerprint);
                expect(
                    key2.get('fingerprint')).to.equal(key.fingerprint);
                done();
            });
        });

        it('Non-cached key async data retrieval', function (done){
            let key = createKey(kp.validKeyFingerprint, true);
            key.get('can_authenticate').then(function (result){
                expect(result).to.be.a('boolean');
                done();
            });
        });

        it('Non-cached key async armored Key', function (done){
            let key = createKey(kp.validKeyFingerprint, true);
            key.get('armored').then(function (result){
                expect(result).to.be.a('string');
                expect(result).to.include('KEY BLOCK-----');
                done();
            });
        });

        it('Non-cached key async hasSecret', function (done){
            let key = createKey(kp.validKeyFingerprint, true);
            key.get('hasSecret').then(function (result){
                expect(result).to.be.a('boolean');
                done();
            });
        });

        it('Non-cached key async hasSecret (no secret in Key)', function (done){
            let key = createKey(kp.validFingerprintNoSecret, true);
            key.get('hasSecret').then(function (result){
                expect(result).to.be.a('boolean');
                expect(result).to.equal(false);
                done();
            });
        });

        it('Querying non-existing Key returns an error', function (done) {
            let key = createKey(kp.invalidKeyFingerprint);
            key.refreshKey().then(function (){},
                function (error){
                    expect(error).to.be.an.instanceof(Error);
                    expect(error.code).to.equal('KEY_NOKEY');
                    done();
                });
        });

        it('createKey returns error if parameters are wrong', function (){
            for (let i=0; i< 4; i++){
                expect(function (){
                    createKey(wp.four_invalid_params[i]);
                }).to.throw(
                    err_list.PARAM_WRONG.msg
                );

            }
        });

    //     it('Overwriting getFingerprint does not work', function(){
    //         const evilFunction = function(){
    //             return 'bad Data';
    //         };
    //         let key = createKey(kp.validKeyFingerprint, true);
    //         expect(key.fingerprint).to.equal(kp.validKeyFingerprint);
    //         try {
    //             key.getFingerprint = evilFunction;
    //         }
    //         catch(e) {
    //             expect(e).to.be.an.instanceof(TypeError);
    //         }
    //         expect(key.fingerprint).to.equal(kp.validKeyFingerprint);
    //         expect(key.getFingerprint).to.not.equal(evilFunction);
    //     });
    });

    describe('GPGME_Keyring', function (){

        it('correct Keyring initialization', function (){
            let keyring = new GPGME_Keyring;
            expect(keyring).to.be.an.instanceof(GPGME_Keyring);
            expect(keyring.getKeys).to.be.a('function');
        });

        it('Loading Keys from Keyring, to be used synchronously',
            function (done){
                let keyring = new GPGME_Keyring;
                keyring.getKeys({ prepare_sync: true }).then(function (result){
                    expect(result).to.be.an('array');
                    expect(result[0].get('hasSecret')).to.be.a('boolean');
                    done();
                });
            }
        );

        it('Loading specific Key from Keyring, to be used synchronously',
            function (done){
                let keyring = new GPGME_Keyring;
                keyring.getKeys({
                    pattern: kp.validKeyFingerprint,
                    prepare_sync: true }).then(
                    function (result){
                        expect(result).to.be.an('array');
                        expect(result[0].get('hasSecret')).to.be.a('boolean');
                        done();
                    }
                );
            }
        );

        it('Querying non-existing Key from Keyring', function (done){
            let keyring = new GPGME_Keyring;
            keyring.getKeys({
                pattern: kp.invalidKeyFingerprint,
                prepare_sync: true
            }).then(function (result){
                expect(result).to.be.an('array');
                expect(result.length).to.equal(0);
                done();
            });
        });

    });

    describe('GPGME_Message', function (){

        it('creating encrypt Message', function (){
            let test0 = createMessage('encrypt');

            expect(test0).to.be.an.instanceof(GPGME_Message);
            expect(test0.isComplete()).to.be.false;
        });

        it('Message is complete after setting mandatory data', function (){
            let test0 = createMessage('encrypt');
            test0.setParameter('data', mp.valid_encrypt_data);
            test0.setParameter('keys', hp.validFingerprints);

            expect(test0.isComplete()).to.be.true;
        });

        it('Message is not complete after mandatory data is empty', function (){
            let test0 = createMessage('encrypt');
            test0.setParameter('keys', hp.validFingerprints);
            expect(test0.isComplete()).to.be.false;
            expect(function (){
                test0.setParameter('data', '');
            }).to.throw(
                err_list.PARAM_WRONG.msg);
        });

        it('Complete Message contains the data that was set', function (){
            let test0 = createMessage('encrypt');
            test0.setParameter('data', mp.valid_encrypt_data);
            test0.setParameter('keys', hp.validFingerprints);

            expect(test0.message).to.not.be.null;
            expect(test0.message).to.have.keys('op', 'data', 'keys',
                'chunksize');
            expect(test0.message.op).to.equal('encrypt');
            expect(test0.message.data).to.equal(
                mp.valid_encrypt_data);
        });

        it ('Not accepting non-allowed operation', function (){
            expect(function () {
                createMessage(mp.invalid_op_action);
            }).to.throw(
                err_list.MSG_WRONG_OP.msg);
        });
        it('Not accepting wrong parameter type', function (){
            expect(function () {
                createMessage(mp.invalid_op_type);
            }).to.throw(
                err_list.PARAM_WRONG.msg);
        });

        it('Not accepting wrong parameter name', function (){
            let test0 = createMessage(mp.invalid_param_test.valid_op);
            for (let i=0;
                i < mp.invalid_param_test.invalid_param_names.length; i++){
                expect(function (){
                    test0.setParameter(
                        mp.invalid_param_test.invalid_param_names[i],
                        'Somevalue');}
                ).to.throw(err_list.PARAM_WRONG.msg);
            }
        });

        it('Not accepting wrong parameter value', function (){
            let test0 = createMessage(mp.invalid_param_test.valid_op);
            for (let j=0;
                j < mp.invalid_param_test.invalid_values_0.length; j++){
                expect(function (){
                    test0.setParameter(
                        mp.invalid_param_test.validparam_name_0,
                        mp.invalid_param_test.invalid_values_0[j]);
                }).to.throw(err_list.PARAM_WRONG.msg);
            }
        });
    });

}

export default { unittests };