photoprism/frontend/karma.conf.js

/*

Copyright (c) 2018 - 2021 Michael Mayer <hello@photoprism.app>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

    PhotoPrism® is a registered trademark of Michael Mayer.  You may use it as required
    to describe our software, run your own server, for educational purposes, but not for
    offering commercial goods, products, or services without prior written permission.
    In other words, please ask.

Feel free to send an e-mail to hello@photoprism.app if you have questions,
want to support our work, or just want to say hello.

Additional information can be found in our Developer Guide:
https://docs.photoprism.app/developer-guide/

*/

const path = require("path");
const findChrome = require("chrome-finder");
const chromeBin = findChrome();
if (chromeBin) {
  process.env.CHROME_BIN = chromeBin;
} else {
  process.env.CHROME_BIN = require("puppeteer").executablePath();
}

module.exports = (config) => {
  config.set({
    logLevel: config.LOG_ERROR,
    webpackMiddleware: {
      stats: "errors-only",
    },

    frameworks: ["mocha"],

    browsers: ["LocalChrome"],

    customLaunchers: {
      LocalChrome: {
        base: "ChromeHeadless",
        flags: [
          "--disable-translate",
          "--disable-extensions",
          "--no-sandbox",
          "--disable-web-security",
          "--disable-dev-shm-usage",
        ],
      },
    },

    files: [
      "node_modules/@babel/polyfill/dist/polyfill.js",
      "node_modules/regenerator-runtime/runtime/runtime.js",
      { pattern: "tests/unit/**/*_test.js", watched: false },
    ],

    // Preprocess through webpack
    preprocessors: {
      "tests/unit/**/*_test.js": ["webpack"],
    },

    reporters: ["progress", "coverage-istanbul", "html"],

    htmlReporter: {
      outputFile: "tests/unit.html",
    },

    coverageIstanbulReporter: {
      // reports can be any that are listed here: https://github.com/istanbuljs/istanbuljs/tree/aae256fb8b9a3d19414dcf069c592e88712c32c6/packages/istanbul-reports/lib
      reports: ["lcovonly", "text-summary"],

      // base output directory. If you include %browser% in the path it will be replaced with the karma browser name
      dir: path.join(__dirname, "coverage"),

      // Combines coverage information from multiple browsers into one report rather than outputting a report
      // for each browser.
      combineBrowserReports: true,

      // if using webpack and pre-loaders, work around webpack breaking the source path
      fixWebpackSourcePaths: true,

      // Omit files with no statements, no functions and no branches from the report
      skipFilesWithNoCoverage: true,

      // Most reporters accept additional config options. You can pass these through the `report-config` option
      "report-config": {
        // all options available at: https://github.com/istanbuljs/istanbuljs/blob/aae256fb8b9a3d19414dcf069c592e88712c32c6/packages/istanbul-reports/lib/html/index.js#L135-L137
        html: {
          // outputs the report in ./coverage/html
          subdir: "html",
        },
      },

      // enforce percentage thresholds
      // anything under these percentages will cause karma to fail with an exit code of 1 if not running in watch mode
      thresholds: {
        emitWarning: true, // set to `true` to not fail the test command when thresholds are not met
        // thresholds for all files
        global: {
          //statements: 90,
          lines: 90,
          //branches: 90,
          //functions: 90,
        },
        // thresholds per file
        each: {
          //statements: 90,
          lines: 90,
          //branches: 90,
          //functions: 90,
          overrides: {
            "src/common/viewer.js": {
              lines: 0,
              functions: 0,
            },
          },
        },
      },

      verbose: true, // output config used by istanbul for debugging
    },

    webpack: {
      mode: "development",

      resolve: {
        fallback: {
          util: require.resolve("util"),
        },
        modules: [
          path.join(__dirname, "src"),
          path.join(__dirname, "node_modules"),
          path.join(__dirname, "tests/unit"),
        ],
        alias: {
          vue: "vue/dist/vue.min.js",
        },
      },
      module: {
        rules: [
          {
            test: /\.js$/,
            exclude: (file) => /node_modules/.test(file),
            use: [
              {
                loader: "babel-loader",
                options: {
                  compact: false,
                  presets: ["@babel/preset-env"],
                  plugins: [
                    "@babel/plugin-proposal-object-rest-spread",
                    "@babel/plugin-proposal-class-properties",
                    "@babel/plugin-transform-runtime",
                    ["istanbul", { exclude: ["**/*_test.js"] }],
                  ],
                },
              },
            ],
          },
        ],
      },
    },

    singleRun: true,
  });
};