nextcloud-server/tests/karma.config.js

/**
 * SPDX-FileCopyrightText: 2016-2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2014-2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

/**
 * This node module is run by the karma executable to specify its configuration.
 *
 * The list of files from all needed JavaScript files including the ones from the
 * apps to test, and the test specs will be passed as configuration object.
 *
 * Note that it is possible to test a single app by setting the KARMA_TESTSUITE
 * environment variable to the apps name, for example "core" or "files_encryption".
 * Multiple apps can be specified by separating them with space.
 *
 * Setting the environment variable NOCOVERAGE to 1 will disable the coverage
 * preprocessor, which is needed to be able to debug tests properly in a browser.
 */

if (!process.env.CHROMIUM_BIN) {
	process.env.CHROMIUM_BIN = require('puppeteer').executablePath()
}

/* jshint node: true */
module.exports = function(config) {
	function findApps() {
		/*
		var fs = require('fs');
		var apps = fs.readdirSync('apps');
		return apps;
		*/
		// other apps tests don't run yet... needs further research / clean up
		return [
			'files',
			'files_versions',
			{
				name: 'files_sharing',
				srcFiles: [
					// only test these files, others are not ready and mess
					// up with the global namespace/classes/state
					'dist/files_sharing-additionalScripts.js',
					'dist/files_sharing-files_sharing_tab.js',
					'dist/files_sharing-files_sharing.js',
					'dist/files_sharing-main.js',
					'apps/files_sharing/js/files_drop.js',
					'apps/files_sharing/js/public.js',
					'apps/files_sharing/js/sharedfilelist.js',
					'apps/files_sharing/js/templates.js',
				],
				testFiles: ['apps/files_sharing/tests/js/*.js']
			},
			'files_trashbin',
		];
	}

	// respect NOCOVERAGE env variable
	// it is useful to disable coverage for debugging
	// because the coverage preprocessor will wrap the JS files somehow
	var enableCoverage = !parseInt(process.env.NOCOVERAGE, 10);
	console.log(
		'Coverage preprocessor: ',
		enableCoverage ? 'enabled' : 'disabled'
	);

	// default apps to test when none is specified (TODO: read from filesystem ?)
	let appsToTest = []
	if (process.env.KARMA_TESTSUITE) {
		appsToTest = process.env.KARMA_TESTSUITE.split(' ');
	} else {
		appsToTest = ['core'].concat(findApps());
	}

	console.log('Apps to test: ', appsToTest);

	// read core files from core.json,
	// these are required by all apps so always need to be loaded
	// note that the loading order is important that's why they
	// are specified in a separate file
	var corePath = 'dist/';
	var coreModule = require('../core/js/core.json');
	var testCore = false;
	var files = [];
	var index;
	var preprocessors = {};

	// find out what apps to test from appsToTest
	index = appsToTest.indexOf('core');
	if (index > -1) {
		appsToTest.splice(index, 1);
		testCore = true;
	}

	var srcFile, i;
	// add core library files
	for (i = 0; i < coreModule.libraries.length; i++) {
		srcFile = corePath + coreModule.libraries[i];
		files.push(srcFile);
	}

	files.push('core/js/tests/html-domparser.js');
	files.push('dist/core-main.js');
	files.push('dist/core-files_fileinfo.js');
	files.push('dist/core-files_client.js');
	files.push('dist/core-systemtags.js');

	// core mocks
	files.push('core/js/tests/specHelper.js');

	// add core modules files
	for (i = 0; i < coreModule.modules.length; i++) {
		srcFile = corePath + coreModule.modules[i];
		files.push(srcFile);
		if (enableCoverage) {
			preprocessors[srcFile] = 'coverage';
		}
	}

	// TODO: settings pages

	// need to test the core app as well ?
	if (testCore) {
		// core tests
		files.push('core/js/tests/specs/**/*.js');
	}

	function addApp(app) {
		// if only a string was specified, expand to structure
		if (typeof app === 'string') {
			app = {
				srcFiles: ['dist/' + app + '-*.js', 'apps/' + app + '/js/**/*.js'],
				testFiles: 'apps/' + app + '/tests/js/**/*.js'
			};
		}

		// add source files/patterns
		files = files.concat(app.srcFiles || []);
		// add test files/patterns
		files = files.concat(app.testFiles || []);
		if (enableCoverage) {
			// add coverage entry for each file/pattern
			for (var i = 0; i < app.srcFiles.length; i++) {
				preprocessors[app.srcFiles[i]] = 'coverage';
			}
		}
	}

	// add source files for apps to test
	for (i = 0; i < appsToTest.length; i++) {
		addApp(appsToTest[i]);
	}

	// serve images to avoid warnings
	files.push({
		pattern: 'core/img/**/*',
		watched: false,
		included: false,
		served: true
	});

	// include core CSS
	files.push({
		pattern: 'core/css/*.css',
		watched: true,
		included: true,
		served: true
	});

	// Allow fonts
	files.push({
		pattern: 'core/fonts/*',
		watched: false,
		included: false,
		served: true
	});

	console.log(files)

	config.set({
		// base path, that will be used to resolve files and exclude
		basePath: '..',

		// frameworks to use
		frameworks: ['jasmine', 'jasmine-sinon', 'viewport'],

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

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

		proxies: {
			// prevent warnings for images
			'/base/tests/img/': 'http://localhost:9876/base/core/img/',
			'/base/tests/css/': 'http://localhost:9876/base/core/css/',
			'/base/core/css/images/': 'http://localhost:9876/base/core/css/images/',
			'/actions/': 'http://localhost:9876/base/core/img/actions/',
			'/base/core/fonts/': 'http://localhost:9876/base/core/fonts/',
			'/svg/': '../core/img/'
		},

		// test results reporter to use
		// possible values: 'dots', 'progress', 'junit', 'growl', 'coverage'
		reporters: ['spec'],

		specReporter: {
			maxLogLines: 5,
			suppressErrorSummary: false,
			suppressFailed: false,
			suppressPassed: true,
			suppressSkipped: true,
			showSpecTiming: false,
		},

		junitReporter: {
			outputFile: 'tests/autotest-results-js.xml'
		},

		// web server port
		port: 9876,

		preprocessors: preprocessors,

		coverageReporter: {
			dir: 'tests/karma-coverage',
			reporters: [
				{ type: 'html' },
				{ type: 'cobertura' },
				{ type: 'lcovonly' }
			]
		},

		// 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,

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

		// Start these browsers, currently available:
		// - Chrome
		// - ChromeCanary
		// - Firefox
		// - Opera (has to be installed with `npm install karma-opera-launcher`)
		// - Safari (only Mac; has to be installed with `npm install karma-safari-launcher`)
		// - PhantomJS
		// - IE (only Windows; has to be installed with `npm install karma-ie-launcher`)
		// use PhantomJS_debug for extra local debug
		browsers: ['ChromiumHeadless'],

		// you can define custom flags
		customLaunchers: {
			PhantomJS_debug: {
				base: 'PhantomJS',
				debug: true
			}
		},

		// If browser does not capture in given timeout [ms], kill it
		captureTimeout: 60000,

		// Continuous Integration mode
		// if true, it capture browsers, run tests and exit
		singleRun: false
	});
};