@buttercup/exporter/test/index.spec.js

Export Buttercup vaults

const { Vault } = require("buttercup");
const csvjson = require("csvjson");
const { exportVaultToCSV, exportVaultToCSVTable } = require("../source/index.js");

const UUID_REXP = /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/;

function setup() {
    const vault = (this.vault = new Vault());
    const mailGroup = vault.createGroup("Mail");
    mailGroup
        .createEntry("Hotmail")
        .setProperty("username", "test@hotmail.com")
        .setProperty("password", "abc123")
        .setProperty("URL", "https://login.live.com")
        .setProperty("Secret", "value");
    mailGroup
        .createEntry("Yahoo")
        .setProperty("username", "test@yahoo.com")
        .setProperty("password", "123abc")
        .setProperty("Pin", "1234");
    mailGroup
        .createGroup("General")
        .createEntry("Home PC")
        .setProperty("username", "test")
        .setProperty("password", "passw0rd");
}

describe("exportVaultToCSV", function() {
    beforeEach(function() {
        setup.call(this);
    });

    it("contains the correct number of lines", function() {
        // 7 lines expected:
        // - 3 lines for entries
        // - 1 line for heading
        // - 2 lines for groups
        // - 1 line for trailing line-ending
        return expect(exportVaultToCSV(this.vault)).to.eventually.satisfy(
            csv => csv.split("\n").length === 7
        );
    });

    it("contains titles, usernames and passwords of entries", function() {
        return exportVaultToCSV(this.vault).then(output => {
            const items = csvjson.toSchemaObject(output);
            items.forEach(item => {
                expect(item)
                    .to.have.property("title")
                    .that.is.a("string");
                expect(item)
                    .to.have.property("username")
                    .that.is.a("string");
                expect(item)
                    .to.have.property("password")
                    .that.is.a("string");
            });
        });
    });

    it("contains entry IDs", function() {
        return exportVaultToCSV(this.vault).then(output => {
            const items = csvjson.toSchemaObject(output);
            items.forEach(item => {
                if (item["!type"] !== "entry") return;
                expect(item)
                    .to.have.property("id")
                    .that.matches(UUID_REXP);
            });
        });
    });

    it("contains group IDs and titles", function() {
        return exportVaultToCSV(this.vault).then(output => {
            const items = csvjson.toSchemaObject(output);
            items.forEach(item => {
                expect(item)
                    .to.have.property("!group_id")
                    .that.matches(UUID_REXP);
                expect(item)
                    .to.have.property("!group_name")
                    .that.is.a("string");
            });
        });
    });

    it("contains group hierarchy", function() {
        return exportVaultToCSV(this.vault).then(output => {
            const items = csvjson
                .toSchemaObject(output)
                .map(item => `${item["!type"]} ${item["!group_name"]}`);
            expect(items).to.contain("group Mail");
            expect(items).to.contain("group General");
        });
    });
});

describe("exportVaultToCSVTable", function() {
    beforeEach(function() {
        setup.call(this);
    });

    it("outputs an array", function() {
        const output = exportVaultToCSVTable(this.vault);
        expect(output).to.be.an("array");
    });

    it("contains the correct number of lines", function() {
        const output = exportVaultToCSVTable(this.vault);
        expect(output).to.have.lengthOf(3 + 2 + 1); // 3 entries, 2 groups, 1 heading
    });
});