Skip to content

Commit

Permalink
fix(config): ignore entry options (#479)
Browse files Browse the repository at this point in the history
karma-webpack will no longer crash when an entry
option is set in webpack config, instead a warning
will be thrown and the property will be ignored
for the time being.

Fixes N/A
  • Loading branch information
codymikol authored Feb 2, 2021
1 parent 05cfa79 commit 71fc63a
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/karma-webpack/controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class KW_Controller {
console.warn(
`
karma-webpack does not currently support customized filenames via
webpack output.filename, if this is something you need consider opening a ticket.
webpack output.filename, if this is something you need consider opening an issue.
defaulting ${newOptions.output.filename} to [name].js.`.trim()
);
delete newOptions.output.filename;
Expand Down
10 changes: 10 additions & 0 deletions lib/karma-webpack/preprocessor.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ function KW_Preprocessor(config, emitter) {
entry: configToWebpackEntries(config),
watch: config.autoWatch,
});

if (config.webpack.entry) {
console.warn(`
karma-webpack does not currently support custom entries, if this is something you need,
consider opening an issue.
ignoring attempt to set the entry option...
`);
delete config.webpack.entry;
}

controller.updateWebpackOptions(config.webpack);
controller.karmaEmitter = emitter;
}
Expand Down
68 changes: 68 additions & 0 deletions test/integration/scenarios/basic-setup/custom-entry-path.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/* eslint-disable prettier/prettier */

import karmaChromeLauncher from 'karma-chrome-launcher';
import karmaMocha from 'karma-mocha';
import karmaChai from 'karma-chai';

import Scenario from '../../utils/scenario';

process.env.CHROME_BIN = require('puppeteer').executablePath();

const path = require('path');

const karmaWebpack = require('../../../../lib/index');

// The karma server integration tests take longer than the jest 5 sec default,
// we will give them 30 seconds to complete.
const KARMA_SERVER_TIMEOUT = 30 * 1000;

describe('A basic karma-webpack setup', () => {
let scenario;

const TEST_PATH = path.resolve(__dirname, './index.scenario.js');

const config = {
frameworks: ['mocha', 'chai', 'webpack'],
files: [{ pattern: TEST_PATH }],
preprocessors: { [TEST_PATH]: ['webpack'] },
webpack: {
devtool: false,
entry: './test.js',
},
browsers: ['ChromeHeadless'],
// Explicitly turn off reporters so the simulated test results are not confused with the actual results.
reporters: [],
plugins: [karmaWebpack, karmaChromeLauncher, karmaMocha, karmaChai],
port: 2389,
logLevel: 'ERROR',
singleRun: true
};

beforeAll((done) => {
Scenario.run(config)
.then((res) => {
scenario = res;
})
.catch((err) => console.error('Integration Scenario Failed: ', err))
.finally(() => done());
}, KARMA_SERVER_TIMEOUT);

// karma-webpack should ignore the entry option and throw a warning.

it('should have an exit code of 1 because it contains a failing test', () => {
expect(scenario.exitCode).toBe(1);
})

it('should have three successful test runs', () => {
expect(scenario.success).toBe(3);
});

it('should have one failed test run', () => {
expect(scenario.failed).toBe(1);
});

it('should complete with no errors', () => {
expect(scenario.error).toBe(false);
});

});

0 comments on commit 71fc63a

Please sign in to comment.