testUpCmd.js

/*
 * Copyright 2018 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

/* eslint-env mocha */
/* eslint-disable no-unused-expressions */
const assert = require('assert');
const path = require('path');
const fse = require('fs-extra');
const {
  initGit,
  assertHttp,
  createTestRoot,
} = require('./utils.js');

const UpCommand = require('../src/up.cmd');

const TEST_DIR = path.resolve('test/integration');

describe('Integration test for up command', () => {
  let testDir;
  let buildDir;

  beforeEach(async function before() {
    this.timeout(20000);
    const testRoot = await createTestRoot();
    testDir = path.resolve(testRoot, 'project');
    buildDir = path.resolve(testRoot, '.hlx/build');
    await fse.copy(TEST_DIR, testDir);
  });

  it('up command fails outside git repository', (done) => {
    new UpCommand()
      .withCacheEnabled(false)
      .withFiles([path.join(testDir, 'src', '*.htl')])
      .withTargetDir(buildDir)
      .withDirectory(testDir)
      .run()
      .then(() => assert.fail('hlx up without .git should fail.'))
      .catch((err) => {
        assert.equal(err.message, 'Unable to start helix: Local README.md or index.md must be inside a valid git repository.');
        done();
      })
      .catch(done);
  });

  it('up command succeeds and can be stopped', (done) => {
    initGit(testDir);
    new UpCommand()
      .withCacheEnabled(false)
      .withFiles([path.join(testDir, 'src', '*.htl')])
      .withTargetDir(buildDir)
      .withDirectory(testDir)
      .withHttpPort(0)
      .on('started', (cmd) => {
        // eslint-disable-next-line no-console
        console.log(`test server running on port ${cmd.project.server.port}`);
        cmd.stop();
      })
      .on('stopped', () => {
        done();
      })
      .run()
      .catch(done);
  }).timeout(5000);

  it('up command delivers correct response.', (done) => {
    initGit(testDir);
    let error = null;
    const cmd = new UpCommand()
      .withCacheEnabled(false)
      .withFiles([path.join(testDir, 'src', '*.htl')])
      .withTargetDir(buildDir)
      .withDirectory(testDir)
      .withHttpPort(0);

    const myDone = (err) => {
      error = err;
      return cmd.stop();
    };

    cmd
      .on('started', async () => {
        try {
          const replacements = [
            { pattern: 'welcome.txt', with: 'welcome.bc53b44e.txt' },
          ];
          await assertHttp(`http://localhost:${cmd.project.server.port}/index.html`, 200, 'simple_response.html', replacements);
          await assertHttp(`http://localhost:${cmd.project.server.port}/dist/welcome.bc53b44e.txt`, 200, 'welcome_response.txt');
          myDone();
        } catch (e) {
          myDone(e);
        }
      })
      .on('stopped', () => {
        done(error);
      })
      .run()
      .catch(done);
  }).timeout(5000);

  it.skip('up command delivers modified sources and delivers correct response.', (done) => {
    // somehow doesn't work. when executing together with other tests, the bundler doesn't detect
    // changes to the source files.
    const srcFile = path.resolve(testDir, 'src/html2.htl');
    const dstFile = path.resolve(testDir, 'src/html.htl');

    initGit(testDir);
    let error = null;
    const cmd = new UpCommand()
      .withCacheEnabled(false)
      .withFiles([path.join(testDir, 'src', '*.htl')])
      .withTargetDir(buildDir)
      .withDirectory(testDir)
      .withHttpPort(0);

    const myDone = (err) => {
      error = err;
      return cmd.stop();
    };

    cmd
      .on('started', async () => {
        try {
          const replacements = [
            { pattern: 'welcome.txt', with: 'welcome.bc53b44e.txt' },
          ];
          await assertHttp(`http://localhost:${cmd.project.server.port}/index.html`, 200, 'simple_response.html', replacements);
          await assertHttp(`http://localhost:${cmd.project.server.port}/dist/welcome.bc53b44e.txt`, 200, 'welcome_response.txt');
          await fse.copy(srcFile, dstFile);
        } catch (e) {
          myDone(e);
        }
      })
      .on('stopped', () => {
        done(error);
      })
      .on('build', async () => {
        try {
          await assertHttp(`http://localhost:${cmd.project.server.port}/index.html`, 200, 'simple_response2.html');
          myDone();
        } catch (e) {
          myDone(e);
        }
      })
      .run()
      .catch(done);
  }).timeout(10000);

  it.skip('up command delivers modified static files and delivers correct response.', (done) => {
    const srcFile = path.resolve(testDir, 'src/welcome2.txt');
    const dstFile = path.resolve(testDir, 'src/welcome.txt');

    initGit(testDir);
    let error = null;
    const cmd = new UpCommand()
      .withCacheEnabled(false)
      .withFiles([path.join(testDir, 'src', '*.htl')])
      .withTargetDir(buildDir)
      .withDirectory(testDir)
      .withHttpPort(0);

    const myDone = (err) => {
      error = err;
      return cmd.stop();
    };

    cmd
      .on('started', async () => {
        try {
          const replacements = [
            { pattern: 'welcome.txt', with: 'welcome.bc53b44e.txt' },
          ];
          await assertHttp(`http://localhost:${cmd.project.server.port}/index.html`, 200, 'simple_response.html', replacements);
          await assertHttp(`http://localhost:${cmd.project.server.port}/dist/welcome.bc53b44e.txt`, 200, 'welcome_response.txt');
          await fse.copy(srcFile, dstFile);
        } catch (e) {
          myDone(e);
        }
      })
      .on('stopped', () => {
        done(error);
      })
      .on('build', async () => {
        try {
          await assertHttp(`http://localhost:${cmd.project.server.port}/dist/welcome.bc53b44e.txt`, 200, 'welcome_response2.txt');
          myDone();
        } catch (e) {
          myDone(e);
        }
      })
      .run()
      .catch(done);
  }).timeout(10000);
});