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

refactor: use mock-fs library to replace fs mock function #206

Merged
merged 1 commit into from
Nov 28, 2024
Merged

refactor: use mock-fs library to replace fs mock function #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"@changesets/cli": "^2.27.8",
"coffee": "^5.4.0",
"jest": "^27.4.0",
"mock-fs": "^5.4.1",
"prettier": "^3.3.3"
},
"engines": {
Expand Down
55 changes: 14 additions & 41 deletions tests/helpers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,21 @@
const ini = require('ini');
const chalk = require('chalk');
const fs = require('fs');
const mockFs = require('mock-fs');

const helpers = require('.././helpers');

const { NPMRC, NRMRC, REGISTRY } = require('.././constants');

// ========== mock `fs` within helpers.js ==========

let mockedFiles = Object.create(null);

function writeFileSync(path, content) {
mockedFiles[path] = content;
}

jest.mock('fs', () => {
const originalModule = jest.requireActual('fs');

function readFileSync(path) {
return mockedFiles[path];
}

/* for jest scope, so same to above */
function writeFileSync(path, content) {
mockedFiles[path] = content;
}

function existsSync(path) {
return path in mockedFiles;
}

return {
...originalModule,
existsSync: jest.fn(existsSync),
readFileSync: jest.fn(readFileSync),
writeFileSync: jest.fn(writeFileSync),
};
beforeEach(() => {
mockFs({
[NPMRC]: '',
[NRMRC]: '',
});
});

// ========== test cases ==========

beforeEach(() => {
mockedFiles = Object.create(null);
mockedFiles[NPMRC] = '';
mockedFiles[NRMRC] = '';
afterEach(() => {
mockFs.restore();
});

it('geneDashLine', () => {
Expand All @@ -54,22 +27,22 @@ it('geneDashLine', () => {

it('getCurrentRegistry', async () => {
const registry = ' https://registry.npmjs.org/';
writeFileSync(NPMRC, ini.stringify({ [REGISTRY]: registry }));
fs.writeFileSync(NPMRC, ini.stringify({ [REGISTRY]: registry }));
const currentRegistry = await helpers.getCurrentRegistry();
expect(currentRegistry).toBe(registry);
});

it('getRegistries', async () => {
const name = 'fake name';
const registry = 'https://registry.example.com/';
writeFileSync(NRMRC, ini.stringify({ [name]: { registry } }));
fs.writeFileSync(NRMRC, ini.stringify({ [name]: { registry } }));
const registries = await helpers.getRegistries();
expect(Object.keys(registries).includes(name)).toBe(true);
});

it('readFile', async () => {
const content = 'hello nrm';
writeFileSync(NRMRC, ini.stringify({ content: content }));
fs.writeFileSync(NRMRC, ini.stringify({ content: content }));
const result1 = await helpers.readFile(NRMRC);
const result2 = await helpers.readFile('file not exist');
expect(result1.content).toBe(content);
Expand Down Expand Up @@ -98,7 +71,7 @@ it('isRegistryNotFound', async () => {
const unknown = 'unknown';
const name = 'custom name';
const registry = 'https://registry.example.com/';
writeFileSync(NRMRC, ini.stringify({ [name]: registry }));
fs.writeFileSync(NRMRC, ini.stringify({ [name]: registry }));
const result1 = await helpers.isRegistryNotFound(unknown, false);
const result2 = await helpers.isRegistryNotFound(name, false);
expect(result1).toBe(true);
Expand All @@ -108,7 +81,7 @@ it('isRegistryNotFound', async () => {
it('isInternalRegistry', async () => {
const name = 'custom name';
const registry = 'https://registry.example.com/';
writeFileSync(NRMRC, ini.stringify({ [name]: registry }));
fs.writeFileSync(NRMRC, ini.stringify({ [name]: registry }));
const result1 = await helpers.isInternalRegistry(name);
const result2 = await helpers.isInternalRegistry('npm');
expect(result1).toBe(false);
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2465,6 +2465,11 @@ minimatch@^3.0.4, minimatch@^3.1.1:
dependencies:
brace-expansion "^1.1.7"

mock-fs@^5.4.1:
version "5.4.1"
resolved "https://registry.yarnpkg.com/mock-fs/-/mock-fs-5.4.1.tgz#b00abc658cb19dbbf282fde2f05bb751cd1e12a5"
integrity sha512-sz/Q8K1gXXXHR+qr0GZg2ysxCRr323kuN10O7CtQjraJsFDJ4SJ+0I5MzALz7aRp9lHk8Cc/YdsT95h9Ka1aFw==

mri@^1.2.0:
version "1.2.0"
resolved "https://registry.yarnpkg.com/mri/-/mri-1.2.0.tgz#6721480fec2a11a4889861115a48b6cbe7cc8f0b"
Expand Down