node_modules/streamroller/test/moveAndMaybeCompressFile-test.js

require("should");

const fs = require('fs-extra');
const path = require('path');
const zlib = require('zlib');
const proxyquire = require('proxyquire').noPreserveCache();
const moveAndMaybeCompressFile = require('../lib/moveAndMaybeCompressFile');
const TEST_DIR = path.normalize(`/tmp/moveAndMaybeCompressFile_${Math.floor(Math.random()*10000)}`);

describe('moveAndMaybeCompressFile', () => {
  beforeEach(async () => {
    await fs.emptyDir(TEST_DIR);
  });

  after(async () => {
    await fs.remove(TEST_DIR);
  });

  it('should move the source file to a new destination', async () => {
    const source = path.join(TEST_DIR, 'test.log');
    const destination = path.join(TEST_DIR, 'moved-test.log');
    await fs.outputFile(source, 'This is the test file.');
    await moveAndMaybeCompressFile(source, destination);

    const contents = await fs.readFile(destination, 'utf8');
    contents.should.equal('This is the test file.');

    const exists = await fs.pathExists(source);
    exists.should.be.false();

  });

  it('should compress the source file at the new destination', async () => {
    const source = path.join(TEST_DIR, 'test.log');
    const destination = path.join(TEST_DIR, 'moved-test.log.gz');
    await fs.outputFile(source, 'This is the test file.');
    await moveAndMaybeCompressFile(source, destination, true);

    const zippedContents = await fs.readFile(destination);
    const contents = await new Promise(resolve => {
      zlib.gunzip(zippedContents, (e, data) => {
        resolve(data.toString());
      });
    });
    contents.should.equal('This is the test file.');

    const exists = await fs.pathExists(source);
    exists.should.be.false();
  });

  it('should do nothing if the source file and destination are the same', async () => {
    const source = path.join(TEST_DIR, 'pants.log');
    const destination = path.join(TEST_DIR, 'pants.log');
    await fs.outputFile(source, 'This is the test file.');
    await moveAndMaybeCompressFile(source, destination);

    (await fs.readFile(source, 'utf8')).should.equal('This is the test file.');
  });

  it('should do nothing if the source file does not exist', async () => {
    const source = path.join(TEST_DIR, 'pants.log');
    const destination = path.join(TEST_DIR, 'moved-pants.log');
    await moveAndMaybeCompressFile(source, destination);

    (await fs.pathExists(destination)).should.be.false();
  });

  it('should use copy+truncate if source file is locked (windows)', async () => {
    const moveWithMock = proxyquire('../lib/moveAndMaybeCompressFile', {
      "fs-extra": {
        exists: () => Promise.resolve(true),
        move: () => Promise.reject({ code: 'EBUSY', message: 'all gone wrong'}),
        copy: (fs.copy.bind(fs)),
        truncate: (fs.truncate.bind(fs))
      }
    });

    const source = path.join(TEST_DIR, 'test.log');
    const destination = path.join(TEST_DIR, 'moved-test.log');
    await fs.outputFile(source, 'This is the test file.');
    await moveWithMock(source, destination);

    const contents = await fs.readFile(destination, 'utf8');
    contents.should.equal('This is the test file.');

    // won't delete the source, but it will be empty
    (await fs.readFile(source, 'utf8')).should.be.empty()

  });

  it('should truncate file if remove fails when compressed (windows)', async () => {
    const moveWithMock = proxyquire('../lib/moveAndMaybeCompressFile', {
      "fs-extra": {
        exists: () => Promise.resolve(true),
        unlink: () => Promise.reject({ code: 'EBUSY', message: 'all gone wrong'}),
        createReadStream: fs.createReadStream.bind(fs),
        truncate: fs.truncate.bind(fs)
      }
    });

    const source = path.join(TEST_DIR, 'test.log');
    const destination = path.join(TEST_DIR, 'moved-test.log.gz');
    await fs.outputFile(source, 'This is the test file.');
    await moveWithMock(source, destination, true);

    const zippedContents = await fs.readFile(destination);
    const contents = await new Promise(resolve => {
      zlib.gunzip(zippedContents, (e, data) => {
        resolve(data.toString());
      });
    });
    contents.should.equal('This is the test file.');

    // won't delete the source, but it will be empty
    (await fs.readFile(source, 'utf8')).should.be.empty()

  });
});