gpg/__tests__/openpgp.test.ts

import {describe, expect, it} from '@jest/globals';
import * as fs from 'fs';
import * as openpgp from '../src/openpgp';

const userInfos = [
  {
    key: 'test-key',
    pgp: fs.readFileSync('__tests__/fixtures/test-key.pgp', {
      encoding: 'utf8',
      flag: 'r'
    }),
    pgp_base64: fs.readFileSync('__tests__/fixtures/test-key-base64.pgp', {
      encoding: 'utf8',
      flag: 'r'
    }),
    passphrase: fs.readFileSync('__tests__/fixtures/test-key.pass', {
      encoding: 'utf8',
      flag: 'r'
    }),
    primaryUserId: {
      name: 'Joe Tester',
      email: 'joe@foo.bar'
    },
    userIds: [
      {
        name: 'Joe Tester',
        email: 'joe@foo.bar'
      }
    ],
    keyID: '7D851EB72D73BDA0',
    fingerprint: '27571A53B86AF0C799B38BA77D851EB72D73BDA0',
    keygrip: '3E2D1142AA59E08E16B7E2C64BA6DDC773B1A627'
  },
  {
    key: 'test-subkey',
    pgp: fs.readFileSync('__tests__/fixtures/test-subkey.pgp', {
      encoding: 'utf8',
      flag: 'r'
    }),
    pgp_base64: fs.readFileSync('__tests__/fixtures/test-subkey-base64.pgp', {
      encoding: 'utf8',
      flag: 'r'
    }),
    passphrase: fs.readFileSync('__tests__/fixtures/test-subkey.pass', {
      encoding: 'utf8',
      flag: 'r'
    }),
    primaryUserId: {
      name: 'Joe Bar',
      email: 'joe@bar.foo'
    },
    userIds: [
      {
        name: 'Joe Bar',
        email: 'joe@bar.foo'
      }
    ],
    keyID: '6071D218380FDCC8',
    fingerprint: '87F257B89CE462100BEC0FFE6071D218380FDCC8',
    keygrips: ['F5C3ABFAAB36B427FD98C4EDD0387E08EA1E8092', 'DEE0FC98F441519CA5DE5D79773CB29009695FEB']
  }
];

for (const userInfo of userInfos) {
  // eslint-disable-next-line jest/valid-title
  describe(userInfo.key, () => {
    describe('readPrivateKey', () => {
      it('returns a PGP private key from an armored string', async () => {
        await openpgp.readPrivateKey(userInfo.pgp).then(privateKey => {
          expect(privateKey.keyID).toEqual(userInfo.keyID);
          expect(privateKey.primaryUserId.name).toEqual(userInfo.primaryUserId.name);
          expect(privateKey.primaryUserId.email).toEqual(userInfo.primaryUserId.email);
          expect(privateKey.allUserIds).toHaveLength(userInfo.userIds.length);
          expect(privateKey.allUserIds[0].name).toEqual(userInfo.userIds[0].name);
          expect(privateKey.allUserIds[0].email).toEqual(userInfo.userIds[0].email);
          expect(privateKey.fingerprint).toEqual(userInfo.fingerprint);
        });
      });
      it('returns a PGP private key from a base64 armored string', async () => {
        await openpgp.readPrivateKey(userInfo.pgp_base64).then(privateKey => {
          expect(privateKey.keyID).toEqual(userInfo.keyID);
          expect(privateKey.primaryUserId.name).toEqual(userInfo.primaryUserId.name);
          expect(privateKey.primaryUserId.email).toEqual(userInfo.primaryUserId.email);
          expect(privateKey.allUserIds).toHaveLength(userInfo.userIds.length);
          expect(privateKey.allUserIds[0].name).toEqual(userInfo.userIds[0].name);
          expect(privateKey.allUserIds[0].email).toEqual(userInfo.userIds[0].email);
          expect(privateKey.fingerprint).toEqual(userInfo.fingerprint);
        });
      });
    });

    describe('generateKeyPair', () => {
      it('generates a PGP key pair', async () => {
        await openpgp.generateKeyPair(userInfo.primaryUserId.name, userInfo.primaryUserId.email, userInfo.passphrase).then(keyPair => {
          expect(keyPair).not.toBeUndefined();
          expect(keyPair.publicKey).not.toBeUndefined();
          expect(keyPair.privateKey).not.toBeUndefined();
        });
      }, 30000);
    });

    describe('isArmored', () => {
      it('returns true for armored key string', async () => {
        await openpgp.isArmored(userInfo.pgp).then(armored => {
          expect(armored).toEqual(true);
        });
      });
      it('returns false for base64 key string', async () => {
        await openpgp.isArmored(userInfo.pgp_base64).then(armored => {
          expect(armored).toEqual(false);
        });
      });
    });
  });
}