test-headlamp-plugin.js

#!/bin/env node
const USAGE = `
This tests unpublished @kinvolk/headlamp-plugin package in repo.

./test-headlamp-plugin.js

Assumes being run within the plugins/headlamp-plugin folder
`;
const PACKAGE_NAME = 'headlamp-myfancy';

function testHeadlampPlugin() {
  // remove some temporary files.
  cleanup();

  // Make a package file of headlamp-plugin we can test
  run('npm', ['install']);
  run('npm', ['run', 'build']);
  run('npm', ['pack']);

  const packedFile = fs
    .readdirSync('.')
    .filter(file => file.match('kinvolk-headlamp-plugin-.*gz'))[0];
  console.log('Packed headlamp-plugin package file:', packedFile);

  // Use "link" to test the repo version of the headlamp-plugin tool.
  run('npm', ['link']);
  run('node', ['bin/headlamp-plugin.js', 'create', PACKAGE_NAME, '--link']);
  curDir = join('.', PACKAGE_NAME);
  run('npm', ['install', join('..', packedFile)]);

  // test headlamp-plugin build
  run('node', [join('..', 'bin', 'headlamp-plugin.js'), 'build']);
  checkFileExists(join(PACKAGE_NAME, 'dist', 'main.js'));

  // test headlamp-plugin build folder
  curDir = '.';
  fs.rmSync(PACKAGE_NAME, { recursive: true });
  run('node', ['bin/headlamp-plugin.js', 'create', PACKAGE_NAME, '--link']);
  curDir = PACKAGE_NAME;
  run('npm', ['install', join('..', packedFile)]);
  curDir = '.';
  run('node', ['bin/headlamp-plugin.js', 'build', PACKAGE_NAME]);
  checkFileExists(join(PACKAGE_NAME, 'dist', 'main.js'));

  fs.writeFileSync(join(PACKAGE_NAME, 'dist', 'extra.txt'), 'All dist/ files will be copied.');

  // test extraction works
  run('node', ['bin/headlamp-plugin.js', 'extract', '.', '.plugins']);
  checkFileExists(join('.plugins', PACKAGE_NAME, 'main.js'));
  checkFileExists(join('.plugins', PACKAGE_NAME, 'package.json'));
  // make sure extra files in dist/ folder are copied too
  checkFileExists(join('.plugins', PACKAGE_NAME, 'extra.txt'));

  // test packing works
  const tmpDir = fs.mkdtempSync('headlamp-plugin-test-');
  run('node', ['bin/headlamp-plugin.js', 'package', PACKAGE_NAME, tmpDir]);
  checkFileExists(join(tmpDir, `${PACKAGE_NAME}-0.1.0.tar.gz`));
  // extract archive and check files
  const extractionFolder = join(tmpDir, 'dst');
  fs.mkdirSync(extractionFolder, { recursive: true });
  run('tar', ['-xzf', join(tmpDir, `${PACKAGE_NAME}-0.1.0.tar.gz`), '-C', extractionFolder]);
  checkFileExists(join(extractionFolder, `${PACKAGE_NAME}`, 'main.js'));
  checkFileExists(join(extractionFolder, `${PACKAGE_NAME}`, 'package.json'));
  fs.rmSync(tmpDir, { recursive: true });

  // test format command and that default code is formatted correctly
  fs.rmSync(PACKAGE_NAME, { recursive: true });
  run('node', ['bin/headlamp-plugin.js', 'create', PACKAGE_NAME, '--link']);
  curDir = PACKAGE_NAME;
  run('npm', ['install', join('..', packedFile)]);
  run('npm', ['run', 'format']);

  // test lint command and default code is lint free
  run('npm', ['run', 'lint']);
  run('npm', ['run', 'lint-fix']);

  // test type script error checks
  run('npm', ['run', 'tsc']);

  // test the storybook builds
  // TODO: Reenable after storybook is fixed
  // run('npm run storybook-build');

  // test upgrade adds missing files
  const filesToRemove = [
    'tsconfig.json',
    join('src', 'headlamp-plugin.d.ts'),
    join('.vscode', 'extensions.json'),
  ];
  filesToRemove.forEach(file => {
    fs.rmSync(join(curDir, file), { recursive: true });
  });
  run('node', [join('..', 'bin', 'headlamp-plugin.js'), 'upgrade', '--skip-package-updates']);
  checkFileExists(join(curDir, 'tsconfig.json'));
  checkFileExists(join(curDir, 'src', 'headlamp-plugin.d.ts'));
  checkFileExists(join(curDir, '.vscode', 'extensions.json'));

  // Does it upgrade "@kinvolk/headlamp-plugin" from an old version?
  // change @kinvolk/headlamp-plugin version in package.json to an old one "^0.4.9"
  const packageJsonPath = join(curDir, 'package.json');
  const packageJson = fs.readFileSync(packageJsonPath, 'utf8');
  const changedJson = packageJson
    .split('\n')
    .map(line =>
      line.includes('"@kinvolk/headlamp-plugin"')
        ? '    "@kinvolk/headlamp-plugin": "^0.4.9"\n'
        : line
    )
    .join('\n');
  fs.writeFileSync(packageJsonPath, changedJson);

  // test upgrade updates the package line, and the old version is not in there
  run('node', [join('..', 'bin', 'headlamp-plugin.js'), 'upgrade']);
  const oldVersion = '0.4.9';
  if (fs.readFileSync(packageJsonPath, 'utf8').includes(oldVersion)) {
    exit(`Error: old version still in ${packageJsonPath}`);
  }

  // test there are no @material-ui imports, they should be mui
  if (fs.readFileSync(join(curDir, 'src', 'index.tsx'), 'utf8').includes('@material-ui')) {
    exit(`Error: @material-ui imports in ${mainJsPath}`);
  }
}

const fs = require('fs');
const child_process = require('child_process');
const path = require('path');
const join = path.join;
const resolve = path.resolve;
let curDir;

function cleanup() {
  console.log(`Cleaning up. Removing temp files...`);

  fs.readdirSync('.')
    .filter(file => file.match('kinvolk-headlamp-plugin-.*gz'))
    .forEach(file => fs.rmSync(file));

  const foldersToRemove = [path.join('.plugins', PACKAGE_NAME), PACKAGE_NAME];
  console.log('Temp foldersToRemove', foldersToRemove);
  foldersToRemove
    .filter(folder => fs.existsSync(folder))
    .forEach(folder => fs.rmSync(folder, { recursive: true }));
}

function run(cmd, args) {
  console.log('');
  console.log(
    `Running cmd:${cmd} with args:${args.join(' ')} inside of cwd:${curDir} abs: "${resolve(
      curDir
    )}"`
  );
  console.log('');
  try {
    child_process.execFileSync(cmd, args, {
      stdio: 'inherit',
      cwd: curDir,
      encoding: 'utf8',
    });
  } catch (e) {
    exit(
      `Error: Problem running "${cmd} ${args.join(' ')}" inside of "${curDir}" abs: "${resolve(
        curDir
      )}"`
    );
  }
}
function checkFileExists(fname) {
  if (!fs.existsSync(fname)) {
    exit(`Error: ${fname} does not exist.`);
  }
}
function exit(message) {
  console.error(message);
  cleanup();
  process.exit(1);
}

(function () {
  if (process.argv[1].includes('test-headlamp-plugin')) {
    console.log(USAGE);
    curDir = '.';

    process.on('beforeExit', cleanup);
    testHeadlampPlugin();
  }
})();