Refactor system tests

.prettierignore

@@ -12,3 +12,4 @@
 lib/utils/parseCalcExpression/parser.js
 scripts/**/*.css
 system-tests/**/*.css
+system-tests/**/*.scss

docs/developer-guide/syntaxes.md

@@ -31,5 +31,5 @@ stylelint currently turns off autofix for sources that contain:
 To add a new workaround, you should:
 
 1. Add code to [`lib/lintSource.js`](https://github.com/stylelint/stylelint/blob/master/lib/lintSource.js) to detect the incompatible pattern.
-2. Add a corresponding test to [`system-tests/fix/fix.test.js`](https://github.com/stylelint/stylelint/blob/master/system-tests/fix/fix.test.js).
+2. Add a corresponding test to [`lib/__tests__/standalone-fix.test.js`](https://github.com/stylelint/stylelint/blob/master/lib/__tests__/standalone-fix.test.js).
 3. Document the workaround in [`docs/developer-guides/syntaxes.md`](https://github.com/stylelint/stylelint/blob/master/docs/developer-guide/syntaxes.md).

docs/developer-guide/system-tests.md

@@ -19,5 +19,5 @@ To add a system test, you should:
 
 - add a test-case folder to `system-tests/` incrementing the number from existing test cases
 - add a configuration file and a stylesheet
-- setup the test following the format established by existing tests, and using the `systemTestUtils`
-- take a snapshot of the JSON `results` array
+- add a `fs.test.js` and `no-fs.test.js` following the format established by existing tests, and using the `systemTestUtils`
+- take a snapshot of `output`

lib/__tests__/cli.test.js

@@ -1,6 +1,23 @@
+/* eslint no-console: off */
+
 'use strict';
 
-const { buildCLI } = require('../cli');
+const _ = require('lodash');
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { promisify } = require('util');
+
+const cli = require('../cli');
+const pkg = require('../../package.json');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
+
+const readFile = promisify(fs.readFile);
+const fixturesPath = replaceBackslashes(path.join(__dirname, 'fixtures'));
+const { buildCLI } = cli;
+
+jest.mock('get-stdin');
 
 describe('buildCLI', () => {
 	it('flags - default', () => {
@@ -143,3 +160,134 @@ describe('buildCLI', () => {
 		expect(buildCLI(['-v']).flags.version).toBe(true);
 	});
 });
+
+describe('CLI', () => {
+	beforeAll(() => {
+		jest.spyOn(process, 'exit').mockImplementation(() => {});
+		jest.spyOn(process.stdout, 'write').mockImplementation(() => {});
+		jest.spyOn(console, 'log').mockImplementation(() => {});
+	});
+
+	afterAll(() => {
+		jest.restoreAllMocks();
+	});
+
+	it('basic', async () => {
+		await cli([]);
+
+		expect(process.exit).toHaveBeenCalledWith(2);
+
+		expect(console.log).toHaveBeenCalledTimes(1);
+		expect(console.log).toHaveBeenCalledWith(
+			expect.stringContaining('Usage: stylelint [input] [options]'),
+		);
+	});
+
+	it('--help', async () => {
+		await cli(['--help']);
+
+		expect(process.exit).toHaveBeenCalledWith(0);
+
+		expect(console.log).toHaveBeenCalledTimes(1);
+		expect(console.log.mock.calls[0][0]).toMatchSnapshot();
+	});
+
+	it('--version', async () => {
+		await cli(['--version']);
+
+		expect(process.exitCode).toBeUndefined();
+
+		expect(console.log).toHaveBeenCalledTimes(1);
+		expect(console.log).toHaveBeenCalledWith(expect.stringContaining(pkg.version));
+	});
+
+	it('--print-config', async () => {
+		await cli([
+			'--print-config',
+			'--config',
+			`${fixturesPath}/config-color-no-invalid-hex.json`,
+			`${fixturesPath}/invalid-hex.css`,
+		]);
+
+		expect(process.exitCode).toBeUndefined();
+
+		expect(process.stdout.write).toHaveBeenCalledTimes(1);
+		expect(process.stdout.write).toHaveBeenLastCalledWith(
+			JSON.stringify(
+				{
+					rules: {
+						'color-no-invalid-hex': [true],
+					},
+				},
+				null,
+				'  ',
+			),
+		);
+	});
+
+	it('--report-needless-disables', async () => {
+		await cli([
+			'--report-needless-disables',
+			'--config',
+			replaceBackslashes(path.join(fixturesPath, 'config-block-no-empty.json')),
+			replaceBackslashes(path.join(fixturesPath, 'empty-block-with-disables.css')),
+		]);
+
+		expect(process.exitCode).toBe(2);
+
+		expect(process.stdout.write).toHaveBeenCalledTimes(2);
+		expect(process.stdout.write).toHaveBeenNthCalledWith(
+			1,
+			expect.stringContaining('unused rule: color-named'),
+		);
+		expect(process.stdout.write).toHaveBeenNthCalledWith(
+			2,
+			expect.stringContaining('Unexpected empty block'),
+		);
+	});
+
+	it('--stdin', async () => {
+		await cli(['--stdin', '--config', `${fixturesPath}/config-no-empty-source.json`]);
+
+		expect(process.exitCode).toBe(2);
+
+		expect(process.stdout.write).toHaveBeenCalledTimes(1);
+		expect(process.stdout.write).toHaveBeenNthCalledWith(
+			1,
+			expect.stringContaining('Unexpected empty source'),
+		);
+	});
+
+	it('--output-file', async () => {
+		const outPath = path.join(os.tmpdir(), `out-${_.uniqueId()}.txt`);
+
+		await cli([
+			'--output-file',
+			outPath,
+			'--formatter',
+			'json',
+			'--config',
+			replaceBackslashes(path.join(fixturesPath, 'config-color-no-invalid-hex.json')),
+			replaceBackslashes(path.join(fixturesPath, 'invalid-hex.css')),
+		]);
+
+		const content = await readFile(outPath, 'utf-8');
+
+		expect(console.log).toHaveBeenCalledTimes(0);
+		expect(process.stdout.write).toHaveBeenCalledTimes(1);
+		expect(process.stdout.write).toHaveBeenNthCalledWith(1, expect.stringContaining(content));
+	});
+
+	it('exits with non zero on unfound module in config', async () => {
+		await cli([
+			'--config',
+			replaceBackslashes(path.join(fixturesPath, 'config-require-unknown.js')),
+			replaceBackslashes(path.join(fixturesPath, 'empty-block-with-disables.css')),
+		]);
+
+		expect(process.exit).not.toHaveBeenCalledWith(0);
+
+		expect(console.log).toHaveBeenCalledTimes(1);
+		expect(console.log).toHaveBeenCalledWith(expect.stringContaining('Cannot find module'));
+	});
+});

system-tests/cli/config.json → lib/__tests__/fixtures/config-no-empty-source.json

@@ -1,6 +1,5 @@
 {
 	"rules": {
-		"block-no-empty": true,
 		"no-empty-source": true
 	}
 }

lib/__tests__/ignore.test.js

@@ -2,7 +2,7 @@
 
 const NoFilesFoundError = require('../utils/noFilesFoundError');
 const path = require('path');
-const replaceBackslashes = require('./replaceBackslashes');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
 const standalone = require('../standalone');
 
 const fixturesPath = replaceBackslashes(path.join(__dirname, 'fixtures'));

lib/__tests__/invalidScopeDisables.test.js

@@ -2,7 +2,7 @@
 
 const invalidScopeDisables = require('../invalidScopeDisables');
 const path = require('path');
-const replaceBackslashes = require('./replaceBackslashes');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
 const standalone = require('../standalone');
 const stripIndent = require('common-tags').stripIndent;
 

lib/__tests__/needlessDisables.test.js

@@ -2,7 +2,7 @@
 
 const needlessDisables = require('../needlessDisables');
 const path = require('path');
-const replaceBackslashes = require('./replaceBackslashes');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
 const standalone = require('../standalone');
 const stripIndent = require('common-tags').stripIndent;
 

lib/__tests__/printConfig.test.js

@@ -3,7 +3,7 @@
 const path = require('path');
 const pluginWarnAboutFoo = require('./fixtures/plugin-warn-about-foo');
 const printConfig = require('../printConfig');
-const replaceBackslashes = require('./replaceBackslashes');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
 
 it('printConfig uses getConfigForFile to retrieve the config', () => {
 	const filepath = replaceBackslashes(

lib/__tests__/standalone-cache.test.js

@@ -5,7 +5,7 @@ const path = require('path');
 const standalone = require('../standalone');
 const fixturesPath = path.join(__dirname, 'fixtures');
 const fs = require('fs');
-const replaceBackslashes = require('./replaceBackslashes');
+const replaceBackslashes = require('../testUtils/replaceBackslashes');
 const { promisify } = require('util');
 const unlink = promisify(fs.unlink);
 const fCache = require('file-entry-cache');