knex/test/cli/migrate-unlock.spec.js

'use strict';

const path = require('path');
const sqlite3 = require('sqlite3');
const { expect } = require('chai');
const { execCommand } = require('cli-testlab');
const { getRootDir } = require('./cli-test-utils');
const KNEX = path.normalize(__dirname + '/../../bin/cli.js');

describe('migrate:unlock', () => {

    const rootDir = getRootDir();
    const dbPath = path.resolve(rootDir, 'db');
    let db;

    before(async () => {
        process.env.KNEX_PATH = '../knex.js';
        db = await new sqlite3.Database(dbPath);
    });

    after(async () => {
        db.close();
    });

    async function verifyMigrationsUnlocked() {
        const rows = await new Promise((resolve, reject) => {
            db.all('SELECT * FROM knex_migrations_lock', {}, (err, rows) => {
                err ? reject(err) : resolve(rows);
            });
        });
        expect(rows.length).to.equal(1);
        expect(rows[0].is_locked).to.equal(0);
    }

    function runUnlockCommand() {
        return execCommand(`node ${KNEX} migrate:unlock \
            --client=sqlite3 --connection=${dbPath} \
            --migrations-directory=${rootDir}/migrations test_unlock`);
    }

    it('should create row in lock table if none exists', async () => {
        // Purge the lock table to ensure none exists
        await new Promise((resolve, reject) => {
            db.run('DELETE FROM knex_migrations_lock', (err) => err ? reject(err) : resolve());
        });
        await runUnlockCommand();
        await verifyMigrationsUnlocked();
    });

    it('should restore lock table to one row with is_locked=0 if multiple rows exist', async () => {
        // Seed multiple rows into the lock table
        await new Promise((resolve, reject) => {
            db.run('INSERT INTO knex_migrations_lock(is_locked) VALUES (?),(?),(?)', [1, 0, 1], (err) => {
                err ? reject(err) : resolve();
            });
        });
        await runUnlockCommand();
        await verifyMigrationsUnlocked();
    });

});