Gruntfile.circle.js

/**!
 *
 * Copyright (c) 2015-2017 Cisco Systems, Inc. See LICENSE file.
 */

/* eslint quotes: [2, "backtick"] */

'use strict';

module.exports = function gruntConfig(grunt) {
  require(`load-grunt-tasks`)(grunt);
  require(`time-grunt`)(grunt);
  grunt.loadTasks(`tasks`);

  grunt.registerTask(`coverage`, [
    `makeReport2:all`
  ]);

  grunt.registerTask(`static-analysis`, [
    `eslint`,
    `stylelint`
  ]);

  grunt.registerTask(`publish-docs`, [
    `documentation`,
    `gh-pages:ghc`
  ]);

  const ALL_NODE_TASKS = [
    `build`
  ];

  const SINGLE_NODE_TASKS = [
    `test`
  ];

  const ALL_NODE_PACKAGES = grunt.file.expand({
    cwd: `packages`
  }, [
      // packages are order to optimize build time while keep flaky tests near
      // the start of the build
      // odd numbered blocks should be ordered fastest to slowest in the group
      // even numbered blocks should be ordered slowest to fastest in the
      // group
      `plugin-phone`,
      `ciscospark`,
      `spark-core`,

      `http-core`,
      `plugin-mercury`,
      `example-phone`,

      `helper-html`,
      `plugin-wdm`,
      `plugin-locus`,

      `common`,
      `generator-ciscospark`,
      `jsdoctrinetest`,

      `*`,
      `!test-helper*`,
      `!bin*`,
      `!xunit-with-logs`,
      `test-helper-mock-web-socket`,
      `test-helper-mock-socket`
  ]);

  const CIRCLE_NODE_TOTAL = parseInt(process.env.CIRCLE_NODE_TOTAL || 1, 10);
  const CIRCLE_NODE_INDEX = parseInt(process.env.CIRCLE_NODE_INDEX || 0, 10);

  let SINGLE_NODE_PACKAGES;
  if (CIRCLE_NODE_TOTAL === 1) {
    SINGLE_NODE_PACKAGES = ALL_NODE_PACKAGES;
  }
  else {
    SINGLE_NODE_PACKAGES = ALL_NODE_PACKAGES.filter((packageName, index) => index % CIRCLE_NODE_TOTAL === CIRCLE_NODE_INDEX);
  }


  const config = {
    concurrent: {
      options: {
        // Let circle take care of concurrency via multiple containers; each
        // container should be limited to one test run at a time
        limit: 1,
        logConcurrentOutput: true
      }
    },

    copy: {
      coverage: {
        files: [{
          cwd: `reports`,
          expand: true,
          src: [`**/cobertura.xml`],
          dest: process.env.CIRCLE_ARTIFACTS
        }]
      }
    },

    coveralls: {
      options: {
        // Don't fail the build if coveralls fails to receive reports for some
        // reason
        force: true
      },
      all: {
        src: [
          `./reports/lcov.info`
        ]
      }
    },

    documentation: {
      options: {
        private: false
      },
      html: {
        src: [
          `./packages/ciscospark/src/index.js`,
          `./packages/plugin-phone/src/index.js`
        ],
        options: {
          destination: `./docs/api/`,
          format: `html`,
          github: true,
          theme: `./docs/_theme`
        }
      }
    },

    env: {
      default: {
        src: `.env.default.json`
      },
      'default-overrides': {
        BUILD_NUMBER: process.env.CIRCLE_BUILD_NUM,
        XUNIT: true,
        XUNIT_DIR: `<%= xunitDir %>`
      }
    },

    eslint: {
      options: {
        format: process.env.XUNIT ? `junit` : `stylish`,
        outputFile: process.env.XUNIT && `<%= xunitDir %>/eslint.xml`
      },
      all: [
        `./packages/*/src/**/*.js`,
        `./packages/*/test/**/*.js`,
        `./packages/*/*.js`,
        `!./packages/*/browsers.processed.js`
      ]
    },

    'gh-pages': {
      options: {
        base: `docs`
      },
      docs: {
        src: [`**`]
      },
      ghc: {
        src: [`**`],
        options: {
          repo: `git@github.com:ciscospark/spark-js-sdk.git`
        }
      }
    },

    makeReport2: {
      all: {
        files: [{
          cwd: `./reports/coverage-final`,
          expand: true,
          src: `**/*.json`
        }],
        options: {
          reporters: {
            cobertura: {
              file: `./reports/cobertura.xml`
            },
            lcovonly: {
              file: `./reports/lcov.info`
            },
            'text-summary': {}
          }
        }
      }
    },

    shell: {},

    stylelint: {
      options: {
        configFile: `.stylelintrc`,
        format: `css`
      },
      src: [
        `./packages/*/src/**/*.css`
      ]
    },

    xunitDir: process.env.CIRCLE_TEST_REPORTS ? `${process.env.CIRCLE_TEST_REPORTS}/junit` : `./reports/junit`
  };

  grunt.task.run([
    `env:default`,
    `env:default-overrides`
  ]);

  // Set up tasks that run on all containers
  ALL_NODE_TASKS.forEach((taskName) => {
    ALL_NODE_PACKAGES.forEach((packageName) => {
      generateConcurrentCommand(config, taskName, packageName);
    });

    grunt.registerTask(taskName, `concurrent:${taskName}`);
  });

  // Set up tasks that run on *this* container
  SINGLE_NODE_TASKS.forEach((taskName) => {
    SINGLE_NODE_PACKAGES.forEach((packageName) => {
      generateConcurrentCommand(config, taskName, packageName);
    });

    grunt.registerTask(taskName, `concurrent:${taskName}`);
  });

  grunt.initConfig(config);

  function generateConcurrentCommand(config, task, packageName) {
    config.shell[`${task}_${packageName}`] = {
      command: `PACKAGE=${packageName} grunt --gruntfile Gruntfile.package.js --no-color ${task}`
    };

    config.concurrent[task] = config.concurrent[task] || {};
    config.concurrent[task].tasks = config.concurrent[task].tasks || [];
    config.concurrent[task].tasks.push(`shell:${task}_${packageName}`);
  }

  console.log(`Evaluating ${SINGLE_NODE_PACKAGES.join(`, `) || `legacy packages`} on this node`);
};