Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: extends not working for some settings #4980

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix: extends not working for some settings #4980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72273cb
test(cli): add tests borrowed from #4407
manuth Apr 24, 2023
e76a0df
fix(cli): handle `extends` setting properly
manuth Apr 24, 2023
f131e9a
test(cli): test the functionality for rc files
manuth Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/cli/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const fs = require('fs');
const path = require('path');
const debug = require('debug')('mocha:cli:config');
const findUp = require('find-up');
const yargs = require('yargs/yargs');
const {createUnparsableFileError} = require('../errors');
const utils = require('../utils');

Expand Down Expand Up @@ -76,6 +77,10 @@ exports.loadConfig = filepath => {
} else {
config = parsers.json(filepath);
}

config = yargs(undefined, path.dirname(filepath))
.parserConfiguration(require('./options').YARGS_PARSER_CONFIG)
.config(config);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting https://github.com/mochajs/mocha/pull/4407/files#r1509449877 here: would be nice to have discussion on which API option to use. I'm leaning towards this one, but want to hear if there are advantages to applyExtends I missed.

} catch (err) {
throw createUnparsableFileError(
`Unable to read/parse ${filepath}: ${err}`,
Expand Down
3 changes: 3 additions & 0 deletions test/integration/fixtures/config/mocharc-extended/.mocharc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./extends.json"
}
6 changes: 6 additions & 0 deletions test/integration/fixtures/config/mocharc-extended/base.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"require": ["foo", "bar"],
"bail": true,
"reporter": "dot",
"slow": 60
}
3 changes: 3 additions & 0 deletions test/integration/fixtures/config/mocharc-extended/extends.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./modifiers.json"
}
5 changes: 5 additions & 0 deletions test/integration/fixtures/config/mocharc-extended/modifiers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": "./base.json",
"reporter": "html",
"slow": 30
}
42 changes: 42 additions & 0 deletions test/integration/options.spec.js
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Praise] As with #4407's tests, these are nice! I like that this also has an added second one for both --config and file coverage.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Non-Actionable] These tests look like they're a continuation of the code in #4407. I.e. their code was partially written by @mf-pherlihy in #4407. I added in a Co-authored-by attribution at the bottom of the PR description. Just a heads up. 🙂

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I indeed borrowed the code from there, I'll keep that in mind in case I'll contribute to mocha again.
Thanks a lot for taking care of that 😄

Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
'use strict';

var path = require('path');
var loadOptions = require('../../lib/cli/options').loadOptions;

describe('options', function () {
var workingDirectory;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question] Is there a reason not to make this set only once? Does it have to be set before each test?

Suggested change
var workingDirectory;
const workingDirectory = process.cwd();

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whenever I change directories for performing tests, I use to always restore the previous working directory in order to not have it interfer with other tests and beforeEach functions.

I could entirely drop it or replace it with beforeAll/afterAll

const workspaceDir = path.join(
__dirname,
'fixtures',
'config',
'mocharc-extended'
);

beforeEach(function () {
workingDirectory = process.cwd();
process.chdir(workspaceDir);
});

afterEach(function () {
process.chdir(workingDirectory);
});

it('Should support extended options using --config parameter', function () {
var extended = loadOptions([
'--config',
path.join(workspaceDir, 'extends.json')
]);
expect(extended.require, 'to equal', ['foo', 'bar']);
expect(extended.bail, 'to equal', true);
expect(extended.reporter, 'to equal', 'html');
expect(extended.slow, 'to equal', 30);
});

it('Should support extended options using rc file', function () {
var extended = loadOptions([]);
expect(extended.require, 'to equal', ['foo', 'bar']);
expect(extended.bail, 'to equal', true);
expect(extended.reporter, 'to equal', 'html');
expect(extended.slow, 'to equal', 30);
});
});