karma.conf.js

// Karma configuration
// Generated on Thu Feb 10 2022 10:05:16 GMT+0100 (GMT+01:00)

module.exports = function (config) {
  const isCI = process.env.CI === "true" || process.env.CI === "1",
    browsers = [
      "bs_chrome_win11",
      "bs_chrome_mac_Monterey",
      "bs_chrome_mac_Sonoma",
      "bs_firefox_win11",
      "bs_firefox_mac_Sonoma",
      "bs_edge_win11",
      "bs_edge_latest_win11",
      "bs_safari_mac_Monterey",
      "bs_safari_mac_Sonoma",
      "bs_opera_win11",
      // "bs_yandex_win11",
      // "bs_ie_win10",
      "bs_chrome_pixel6",
      "bs_chrome_samsung_galaxy_S21",
      "bs_chrome_pixel7",
      "bs_iPhoneSE2022",
      "bs_iPhone14"
    ];

  if (!isCI) {
    // local/default target: headless Chrome. Never the GUI launcher, it does
    // not exit on its own when run unattended.
    browsers.splice(0, browsers.length, "ChromeHeadless");
  }

  // Which built bundle the QUnit suite runs against. Each lane is a separate
  // Karma run: loading more than one test bundle in one page would register the
  // whole suite twice.
  const testBundles = {
      umd: "qunit/qunit.js",
      jquery: "qunit/qunit.jquery.js",
      esm: "qunit/qunit.esm.js"
    },
    bundle = process.env.INPUTMASK_BUNDLE || "umd";

  if (!testBundles[bundle]) {
    throw new Error(
      `Unknown INPUTMASK_BUNDLE "${bundle}". Use one of: ${Object.keys(
        testBundles
      ).join(", ")}.`
    );
  }

  // The UMD jQuery bundle expects the global jQuery. The native and ESM lanes
  // deliberately run without it, so they prove those bundles need no jQuery.
  // For the jquery lane we load the built UMD as a global script (same as
  // consumers) so its UMD registration stays intact.
  const testFiles = [
    ...(bundle === "jquery"
      ? ["node_modules/jquery/dist/jquery.js", "dist/jquery.inputmask.js"]
      : []),
    testBundles[bundle]
  ];

  config.set({
    // base path that will be used to resolve all patterns (eg. files, exclude)
    basePath: "",

    // frameworks to use
    // available frameworks: https://www.npmjs.com/search?q=keywords:karma-adapter
    frameworks: ["qunit"],

    // list of files / patterns to load in the browser
    files: testFiles,

    // list of files / patterns to exclude
    exclude: [],

    // preprocess matching files before serving them to the browser
    // available preprocessors: https://www.npmjs.com/search?q=keywords:karma-preprocessor
    preprocessors: {},

    // test results reporter to use
    // possible values: 'dots', 'progress'
    // available reporters: https://www.npmjs.com/search?q=keywords:karma-reporter
    reporters: isCI ? ["progress", "BrowserStack"] : ["progress"],

    // web server port
    port: 9876,

    // enable / disable colors in the output (reporters and logs)
    colors: true,

    // level of logging
    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
    logLevel: config.LOG_INFO,

    // pass options to the QUnit runner (karma-qunit maps these to QUnit.config)
    client: {
      qunit: {
        showUI: false,
        // Fail a test that stops reporting instead of letting the browser go
        // quiet until Karma's browserNoActivityTimeout (30s) disconnects it and
        // takes the whole run down. Must stay below that 30s. See the
        // onincomplete test in qunit/tests_base.js, which only calls done() from
        // a blur-driven callback and never completes on real mobile devices.
        testTimeout: 10000
      }
    },

    // enable / disable watching file and executing tests whenever any file changes
    autoWatch: false,

    // start these browsers
    // available browser launchers: https://www.npmjs.com/search?q=keywords:karma-launcher
    // global config of your BrowserStack account
    browserStack: {
      username: "BROWSERSTACK_USERNAME",
      accessKey: "BROWSERSTACK_ACCESS_KEY"
    },

    // define browsers
    customLaunchers: {
      // headless Chrome for CI containers that run as root
      ChromeHeadlessNoSandbox: {
        base: "ChromeHeadless",
        flags: ["--no-sandbox", "--disable-gpu"]
      },
      bs_chrome96_win11: {
        base: "BrowserStack",
        browser: "chrome",
        browser_version: "96",
        os: "Windows",
        os_version: "11"
      },
      bs_chrome_win11: {
        base: "BrowserStack",
        browser: "chrome",
        os: "Windows",
        os_version: "11"
      },
      bs_chrome_mac_Monterey: {
        base: "BrowserStack",
        browser: "chrome",
        os: "OS X",
        os_version: "Monterey"
      },
      bs_chrome_mac_Sonoma: {
        base: "BrowserStack",
        browser: "chrome",
        browser_version: "latest",
        os: "OS X",
        os_version: "Sonoma"
      },
      bs_firefox_win11: {
        base: "BrowserStack",
        browser: "firefox",
        os: "Windows",
        os_version: "11"
      },
      bs_firefox_mac_Sonoma: {
        base: "BrowserStack",
        browser: "firefox",
        browser_version: "latest",
        os: "OS X",
        os_version: "Sonoma"
      },
      bs_edge_win11: {
        base: "BrowserStack",
        browser: "edge",
        os: "Windows",
        os_version: "11"
      },
      bs_edge_latest_win11: {
        base: "BrowserStack",
        browser: "edge",
        browser_version: "latest",
        os: "Windows",
        os_version: "11"
      },
      bs_safari_mac_Monterey: {
        base: "BrowserStack",
        browser: "safari",
        os: "OS X",
        os_version: "Monterey"
      },
      bs_safari_mac_Sonoma: {
        base: "BrowserStack",
        browser: "safari",
        browser_version: "latest",
        os: "OS X",
        os_version: "Sonoma"
      },
      bs_opera_win11: {
        base: "BrowserStack",
        browser: "opera",
        os: "Windows",
        os_version: "11"
      },
      bs_yandex_win11: {
        base: "BrowserStack",
        browser: "yandex",
        os: "Windows",
        os_version: "11"
      },
      bs_ie_win10: {
        base: "BrowserStack",
        browser: "ie",
        browser_version: "11",
        os: "Windows",
        os_version: "10"
      },
      bs_chrome_pixel6: {
        base: "BrowserStack",
        device: "Google Pixel 6",
        browser: "chrome",
        os: "Android",
        os_version: "12.0",
        realMobile: true
      },
      bs_chrome_samsung_galaxy_S21: {
        base: "BrowserStack",
        device: "Samsung Galaxy S21",
        browser: "chrome",
        os: "Android",
        os_version: "11.0",
        realMobile: true
      },
      bs_chrome_pixel7: {
        base: "BrowserStack",
        device: "Google Pixel 7",
        browser: "chrome",
        os: "Android",
        os_version: "13.0",
        realMobile: true
      },
      bs_iPhoneSE2022: {
        base: "BrowserStack",
        device: "iPhone SE 2022",
        browser: "safari",
        os: "IOS",
        os_version: "15",
        realMobile: true
      },
      bs_iPhone14: {
        base: "BrowserStack",
        device: "iPhone 14",
        browser: "safari",
        os: "IOS",
        os_version: "16",
        realMobile: true
      }
    },
    browsers,

    // Continuous Integration mode
    // if true, Karma captures browsers, runs the tests and exits
    singleRun: true,

    // Concurrency level
    // how many browser instances should be started simultaneously
    concurrency: Infinity
  });
};