Skip to content

Commit

Permalink
Add tests for --no-default and --no-default --json
Browse files Browse the repository at this point in the history 
Squashed from several commits while figuring out what was going on:

Remove unnecessary replacements

Back in 7835a7d there was no `FILTER`
at the top but now that there is, these settings are not in the output.

Remove confusing cleanupJsonOutput method

This does not support ndjson so in all tests (prior to this PR)
it was failing to parse the JSON and not actually executing
most of the method body.

Now that one of the new tests returns only a single line of JSON
this 'resurrected' this dead broken method causing tests to fail.

Instead use the same cleanup method for all cases, which is what
has been happening anyway (due to the fallback in the `catch`)

Add the remaining to snapshots now the tests are fixed
  • Loading branch information
Tom Sparrow committed Dec 17, 2024
1 parent c020664 commit fbf7c38
Show file tree
Hide file tree
Showing 2 changed files with 147 additions and 43 deletions.
139 changes: 139 additions & 0 deletions packages/acceptance-tests/pkg-tests-specs/sources/commands/__snapshots__/config.test.ts.snap
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Commands config test (folder with rcfile / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "{"key":"initScope","effective":"my-test","source":"WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml","description":"Scope used when creating packages via the init command","type":"STRING","default":null}
",
}
`;

exports[`Commands config test (folder with rcfile / as json) 1`] = `
{
"code": 0,
Expand All @@ -11,6 +20,18 @@ exports[`Commands config test (folder with rcfile / as json) 1`] = `
}
`;
exports[`Commands config test (folder with rcfile / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "└─ initScope
- ├─ Description: Scope used when creating packages via the init command
- ├─ Source: WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml
- └─ Value: 'my-test'
",
}
`;
exports[`Commands config test (folder with rcfile / without flags) 1`] = `
{
"code": 0,
Expand All @@ -33,6 +54,16 @@ exports[`Commands config test (folder with rcfile / without flags) 1`] = `
}
`;
exports[`Commands config test (folder with rcfile and rc in ancestor parent / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "{"key":"initScope","effective":"my-test","source":"WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml","description":"Scope used when creating packages via the init command","type":"STRING","default":null}
{"key":"lastUpdateCheck","effective":"1555784893958","source":"WORKSPACE_ROOT/.yarnrc.yml","description":"Last timestamp we checked whether new Yarn versions were available","type":"STRING","default":null}
",
}
`;
exports[`Commands config test (folder with rcfile and rc in ancestor parent / as json) 1`] = `
{
"code": 0,
Expand All @@ -44,6 +75,23 @@ exports[`Commands config test (folder with rcfile and rc in ancestor parent / as
}
`;
exports[`Commands config test (folder with rcfile and rc in ancestor parent / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "├─ initScope
│ - ├─ Description: Scope used when creating packages via the init command
│ - ├─ Source: WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml
│ - └─ Value: 'my-test'
│
└─ lastUpdateCheck
- ├─ Description: Last timestamp we checked whether new Yarn versions were available
- ├─ Source: WORKSPACE_ROOT/.yarnrc.yml
- └─ Value: '1555784893958'
",
}
`;
exports[`Commands config test (folder with rcfile and rc in ancestor parent / without flags) 1`] = `
{
"code": 0,
Expand All @@ -66,6 +114,16 @@ exports[`Commands config test (folder with rcfile and rc in ancestor parent / wi
}
`;
exports[`Commands config test (folder with rcfile and rc in home folder / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "{"key":"initScope","effective":"my-test","source":"WORKSPACE_ROOT/.yarnrc.yml","description":"Scope used when creating packages via the init command","type":"STRING","default":null}
{"key":"lastUpdateCheck","effective":"1555784893958","source":"WORKSPACE_ROOT/.yarnrc.yml","description":"Last timestamp we checked whether new Yarn versions were available","type":"STRING","default":null}
",
}
`;
exports[`Commands config test (folder with rcfile and rc in home folder / as json) 1`] = `
{
"code": 0,
Expand All @@ -77,6 +135,23 @@ exports[`Commands config test (folder with rcfile and rc in home folder / as jso
}
`;
exports[`Commands config test (folder with rcfile and rc in home folder / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "├─ initScope
│ - ├─ Description: Scope used when creating packages via the init command
│ - ├─ Source: WORKSPACE_ROOT/.yarnrc.yml
│ - └─ Value: 'my-test'
│
└─ lastUpdateCheck
- ├─ Description: Last timestamp we checked whether new Yarn versions were available
- ├─ Source: WORKSPACE_ROOT/.yarnrc.yml
- └─ Value: '1555784893958'
",
}
`;
exports[`Commands config test (folder with rcfile and rc in home folder / without flags) 1`] = `
{
"code": 0,
Expand All @@ -99,6 +174,16 @@ exports[`Commands config test (folder with rcfile and rc in home folder / withou
}
`;
exports[`Commands config test (folder with rcfile and rc in parent / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "{"key":"initScope","effective":"my-test","source":"WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml","description":"Scope used when creating packages via the init command","type":"STRING","default":null}
{"key":"lastUpdateCheck","effective":"1555784893958","source":"WORKSPACE_ROOT/subfolder/.yarnrc.yml","description":"Last timestamp we checked whether new Yarn versions were available","type":"STRING","default":null}
",
}
`;
exports[`Commands config test (folder with rcfile and rc in parent / as json) 1`] = `
{
"code": 0,
Expand All @@ -110,6 +195,23 @@ exports[`Commands config test (folder with rcfile and rc in parent / as json) 1`
}
`;
exports[`Commands config test (folder with rcfile and rc in parent / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "├─ initScope
│ - ├─ Description: Scope used when creating packages via the init command
│ - ├─ Source: WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml
│ - └─ Value: 'my-test'
│
└─ lastUpdateCheck
- ├─ Description: Last timestamp we checked whether new Yarn versions were available
- ├─ Source: WORKSPACE_ROOT/subfolder/.yarnrc.yml
- └─ Value: '1555784893958'
",
}
`;
exports[`Commands config test (folder with rcfile and rc in parent / without flags) 1`] = `
{
"code": 0,
Expand All @@ -132,6 +234,15 @@ exports[`Commands config test (folder with rcfile and rc in parent / without fla
}
`;
exports[`Commands config test (folder with rcfile without trailing newline / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "{"key":"initScope","effective":"my-test","source":"WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml","description":"Scope used when creating packages via the init command","type":"STRING","default":null}
",
}
`;
exports[`Commands config test (folder with rcfile without trailing newline / as json) 1`] = `
{
"code": 0,
Expand All @@ -143,6 +254,18 @@ exports[`Commands config test (folder with rcfile without trailing newline / as
}
`;
exports[`Commands config test (folder with rcfile without trailing newline / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "└─ initScope
- ├─ Description: Scope used when creating packages via the init command
- ├─ Source: WORKSPACE_ROOT/subfolder/subfolder/.yarnrc.yml
- └─ Value: 'my-test'
",
}
`;
exports[`Commands config test (folder with rcfile without trailing newline / without flags) 1`] = `
{
"code": 0,
Expand All @@ -165,6 +288,14 @@ exports[`Commands config test (folder with rcfile without trailing newline / wit
}
`;
exports[`Commands config test (folder without rcfile in ancestry / as json no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "",
}
`;
exports[`Commands config test (folder without rcfile in ancestry / as json) 1`] = `
{
"code": 0,
Expand All @@ -176,6 +307,14 @@ exports[`Commands config test (folder without rcfile in ancestry / as json) 1`]
}
`;
exports[`Commands config test (folder without rcfile in ancestry / no defaults) 1`] = `
{
"code": 0,
"stderr": "",
"stdout": "",
}
`;
exports[`Commands config test (folder without rcfile in ancestry / without flags) 1`] = `
{
"code": 0,
Expand Down
51 changes: 8 additions & 43 deletions packages/acceptance-tests/pkg-tests-specs/sources/commands/config.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import {PortablePath, npath, ppath, xfs} from '@yarnpkg/fslib';

const RC_FILENAME = `.yarnrc.yml`;
const SUBFOLDER = `subfolder`;
const FAKE_REGISTRY_URL = `http://yarn.test.registry`;
const FAKE_LOCAL_APP_DATA = `LOCAL_APP_DATA`;
const FAKE_WORKSPACE_ROOT = `WORKSPACE_ROOT`;
const FAKE_HOME = `HOME`;
Expand Down Expand Up @@ -40,7 +39,7 @@ const environments: Record<string, (opts: {
},
};

function cleanupPlainOutput(output: string, path: PortablePath, homePath: PortablePath) {
function cleanupOutput(output: string, path: PortablePath, homePath: PortablePath) {
// Replace multiple consecutive spaces with one space.
// The output of the config command is aligned according to the longest value, which probably
// contains `path`. In other words, the formatting depends on the length of `path`.
Expand All @@ -65,51 +64,17 @@ function cleanupPlainOutput(output: string, path: PortablePath, homePath: Portab
return output;
}

function cleanupJsonOutput(output: string, path: PortablePath, homePath: PortablePath) {
let outputObject;
try {
outputObject = JSON.parse(output);
} catch (e) {
return cleanupPlainOutput(output, path, homePath);
}

// the default globalFolder contains the user's home folder, override that value
outputObject.globalFolder.default = `DEFAULT_GLOBAL_FOLDER`;

// replace the generated registry server URL with a constant
outputObject.npmRegistryServer.effective = FAKE_REGISTRY_URL;

const pathN = npath.fromPortablePath(path);
const homePathN = npath.fromPortablePath(homePath);

const cleanPath = (input: string) => input
.replaceAll(pathN, FAKE_WORKSPACE_ROOT)
.replaceAll(homePathN, FAKE_HOME);

for (const setting of Object.values<any>(outputObject)) {
if (typeof setting.source === `string`)
setting.source = cleanPath(setting.source);

if (typeof setting.default === `string`)
setting.default = cleanPath(setting.default);

if (typeof setting.effective === `string`) {
setting.effective = cleanPath(setting.effective);
}
}

return JSON.stringify(outputObject);
}

const options = {
[`without flags`]: {cleanupStdout: cleanupPlainOutput, flags: []},
[`as json`]: {cleanupStdout: cleanupJsonOutput, flags: [`--json`]},
[`without flags`]: {flags: []},
[`as json`]: {flags: [`--json`]},
[`no defaults`]: {flags: [`--no-defaults`]},
[`as json no defaults`]: {flags: [`--json`, `--no-defaults`]},
};

describe(`Commands`, () => {
describe(`config`, () => {
for (const [environmentDescription, environment] of Object.entries(environments)) {
for (const [optionDescription, {flags, cleanupStdout}] of Object.entries(options)) {
for (const [optionDescription, {flags}] of Object.entries(options)) {
test(`test (${environmentDescription} / ${optionDescription})`, makeTemporaryEnv({}, async ({path, run, source}) => {
const cwd = ppath.join(path, `${SUBFOLDER}/${SUBFOLDER}`);
const homePath = await xfs.mktempPromise();
Expand All @@ -127,8 +92,8 @@ describe(`Commands`, () => {
({code, stdout, stderr} = error);
}

stdout = cleanupStdout(stdout, path, homePath);
stderr = cleanupPlainOutput(stderr, path, homePath);
stdout = cleanupOutput(stdout, path, homePath);
stderr = cleanupOutput(stderr, path, homePath);

expect({code, stdout, stderr}).toMatchSnapshot();
}));
Expand Down

0 comments on commit fbf7c38

Please sign in to comment.