Added rudimentary end-to-end test infrastructure (#81)

* Added rudimentary end-to-end test infrastructure

* Removed added test .js files

Author: Josh Goldberg

.eslintrc.json

@@ -0,0 +1,44 @@
+{
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": ["@typescript-eslint", "@typescript-eslint/tslint"],
+    "rules": {
+        "@typescript-eslint/array-type": "error",
+        "@typescript-eslint/interface-name-prefix": "error",
+        "@typescript-eslint/member-ordering": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-param-reassign": "off",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-use-before-declare": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "@typescript-eslint/unbound-method": "off",
+        "arrow-body-style": "off",
+        "default-case": "off",
+        "linebreak-style": "off",
+        "no-bitwise": "off",
+        "no-empty": "off",
+        "no-empty-functions": "off",
+        "no-magic-numbers": "off",
+        "prefer-template": "off",
+        "@typescript-eslint/tslint/config": [
+            "error",
+            {
+                "rules": {
+                    "no-implicit-dependencies": [true, "dev"],
+                    "strict-boolean-expressions": [
+                        true,
+                        "allow-boolean-or-undefined",
+                        "allow-number"
+                    ]
+                }
+            }
+        ]
+    }
+}

.gitignore

@@ -5,3 +5,5 @@
 coverage/
 node_modules/
 src/**/*.js
+test/*.js
+test/tests/**/.eslintrc*

.prettierignore

@@ -0,0 +1 @@
+test/tests/**/*

.vscode/settings.json

@@ -4,5 +4,6 @@
         "**/*.js.map": true,
         "**/*.js": { "when": "$(basename).ts" }
     },
+    "prettier.ignorePath": ".prettierignore",
     "typescript.tsdk": "node_modules/typescript/lib"
 }

docs/Architecture.md

@@ -0,0 +1,14 @@
+# Architecture
+
+## CLI Architecture
+
+-   CLI usage starts in `bin/tslint-to-eslint-config`, which immediately calls `src/cli/main.ts`.
+-   CLI settings are parsed and read in `src/cli/runCli.ts`.
+-   Application logic is run by `src/conversion/convertConfig.ts`.
+
+## Dependencies
+
+Methods are created using a variant of [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_Injection).
+Any method with dependencies that should be stubbed out during tests, such as file system bindings, logging, or other methods,
+takes in a first argument of name `dependencies`.
+Its dependencies object is manually created in `src/cli/main.ts` and bound to the method with `bind`.

docs/Development.md

@@ -17,32 +17,9 @@ cd tslint-to-eslint-config
 npm i
 ```
 
-Compile with `npm run tsc` and run tests with `npm run test`.
+Compile with `npm run tsc` and run tests with `npm run test:unit`.
 
-### CLI Architecture
+## More Reading
 
--   CLI usage starts in `bin/tslint-to-eslint-config`, which immediately calls `src/cli/main.ts`.
--   CLI settings are parsed and read in `src/cli/runCli.ts`.
--   Application logic is run by `src/conversion/convertConfig.ts`.
-
-### Dependencies
-
-Methods are created using a variant of [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_Injection).
-Any method with dependencies that should be stubbed out during tests, such as file system bindings, logging, or other methods,
-takes in a first argument of name `dependencies`.
-Its dependencies object is manually created in `src/cli/main.ts` and bound to the method with `bind`.
-
-### Unit Tests
-
-Each `src/**/*.ts` source file should have an equivalent `*.test.ts` next to it.
-Tests should include comments above each section of the "AAA" testing format:
-
--   `// Arrange`: Set up dependencies for the code under test
--   `// Act`: Perform the logic under test
--   `// Assert`: Check the results of the acted logic
-
-`tslint-to-eslint-config` requires 100% unit test coverage, excluding the following:
-
--   `src/cli/main.ts`
--   `src/adapters/*.ts`
--   `src/**/*.stubs.ts`
+-   [Architecture](./Architecture.md)
+-   [Testing](./Testing.md)

docs/Testing.md

@@ -0,0 +1,20 @@
+# Testing
+
+## Unit Tests
+
+```
+npm run test:unit
+```
+
+Each `src/**/*.ts` source file should have an equivalent `*.test.ts` next to it.
+Tests should include comments above each section of the "AAA" testing format:
+
+-   `// Arrange`: Set up dependencies for the code under test
+-   `// Act`: Perform the logic under test
+-   `// Assert`: Check the results of the acted logic
+
+`tslint-to-eslint-config` requires 100% unit test coverage, excluding the following:
+
+-   `src/cli/main.ts`
+-   `src/adapters/*.ts`
+-   `src/**/*.stubs.ts`

jest.config.js

@@ -17,6 +17,6 @@ module.exports = {
         },
     },
     moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
-    testRegex: "((\\.|/)test)\\.tsx?$",
+    testRegex: "src(.*)\\.test\\.tsx?$",
     testEnvironment: "node",
 };

package.json

@@ -59,9 +59,11 @@
     },
     "scripts": {
         "eslint": "eslint \"./src/*.ts\" \"./src/**/*.ts\" --report-unused-disable-directives",
-        "prettier": "prettier \"./src/*.{js,json,ts,xml,yaml}\" \"./src/**/*.{js,json,ts,xml,yaml}\"",
+        "prettier": "prettier \"./src/*.{js,json,ts,xml,yaml}\" \"./src/**/*.{js,json,ts,xml,yaml}\" --ignore-path .prettierignore",
         "prettier:write": "npm run prettier -- --write",
-        "test": "jest",
+        "test:unit": "jest",
+        "test:end-to-end": "jest --config=test/jest.config.js",
+        "test:end-to-end:accept": "jest --config=test/jest.config.js --globals=\"{\\\"acceptTestChanges\\\": true }\"",
         "tsc": "tsc"
     },
     "version": "0.1.7"

src/utils.ts

@@ -5,3 +5,5 @@ export const isError = <Item>(item: Item | Error): item is Error => item instanc
 export type RemoveErrors<Items> = {
     [P in keyof Items]: Exclude<Items[P], Error>;
 };
+
+export type PromiseValue<T> = T extends Promise<infer R> ? R : never;

test/createTestArgs.ts

@@ -0,0 +1,20 @@
+import * as fs from "fs";
+import * as path from "path";
+import { promisify } from "util";
+
+const readdir = promisify(fs.readdir);
+
+export const createTestArgs = async (cwd: string) => {
+    const items = new Set(await readdir(cwd));
+    const flags = [
+        "--config",
+        path.join(cwd, ".eslintrc.json"),
+        "--tslint",
+        path.join(cwd, "tslint.json"),
+    ];
+
+    if (items.has("tslint.json")) {
+    }
+
+    return flags.map(flag => `"${flag}"`).join(" ");
+};

test/createTests.ts

@@ -0,0 +1,46 @@
+import * as cp from "child_process";
+import * as fs from "fs";
+import * as path from "path";
+import { promisify } from "util";
+
+import { createTestArgs } from "./createTestArgs";
+import { PromiseValue } from "../src/utils";
+import { assertFileContents } from "./expectFileContains";
+
+const exec = promisify(cp.exec);
+const readFile = promisify(fs.readFile);
+
+export const createTests = (testName: string, accept: boolean) => {
+    const cwd = path.join(__dirname, "tests", testName);
+    const cwdPath = (fileName: string) => path.join(cwd, fileName);
+    const readTestFile = async (fileName: string) => (await readFile(cwdPath(fileName))).toString();
+
+    return () => {
+        let result: PromiseValue<ReturnType<typeof exec>>;
+        beforeAll(async () => {
+            // Arrange
+            const args = await createTestArgs(cwd);
+
+            // Act
+            result = await exec(`ts-node bin/tslint-to-eslint-config ${args}`);
+        });
+
+        test("configuration output", async () => {
+            await assertFileContents(
+                cwdPath("expected.json"),
+                await readTestFile(".eslintrc.json"),
+                accept,
+            );
+        });
+
+        // test("info log output", () => {});
+
+        test("stderr", async () => {
+            await assertFileContents(cwdPath("stderr.txt"), result.stderr, accept);
+        });
+
+        test("stdout", async () => {
+            await assertFileContents(cwdPath("stdout.txt"), result.stdout, accept);
+        });
+    };
+};

test/expectFileContains.ts

@@ -0,0 +1,25 @@
+import * as fs from "fs";
+import { promisify } from "util";
+
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+
+const standardizeEndlines = (text: string) => text.replace(/\r/g, "");
+
+export const assertFileContents = async (
+    filePath: string,
+    actual: string | Buffer,
+    accept: boolean,
+) => {
+    await (accept ? acceptFileContents : expectFileContents)(filePath, actual.toString());
+};
+
+const acceptFileContents = async (filePath: string, actual: string) => {
+    await writeFile(filePath, actual);
+};
+
+const expectFileContents = async (filePath: string, actual: string) => {
+    const expected = (await readFile(filePath)).toString();
+
+    expect(standardizeEndlines(actual)).toEqual(standardizeEndlines(expected));
+};

test/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+    testRegex: "test/runEndToEndTests.ts",
+    testEnvironment: "node",
+};

test/runEndToEndTests.ts

@@ -0,0 +1,12 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import { createTests } from "./createTests";
+
+const testNames = fs.readdirSync(path.join(__dirname, "tests"));
+
+const accept = "acceptTestChanges" in globalThis;
+
+for (const testName of testNames) {
+    describe(testName, createTests(testName, accept));
+}

test/tests/standalone tslint.json/.eslintrc.json

@@ -0,0 +1,50 @@
+{
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "@typescript-eslint/tslint"
+    ],
+    "rules": {
+        "@typescript-eslint/array-type": "error",
+        "@typescript-eslint/interface-name-prefix": "error",
+        "@typescript-eslint/member-ordering": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-param-reassign": "off",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-use-before-declare": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "@typescript-eslint/unbound-method": "off",
+        "arrow-body-style": "off",
+        "default-case": "off",
+        "linebreak-style": "off",
+        "no-bitwise": "off",
+        "no-empty": "off",
+        "no-empty-functions": "off",
+        "no-magic-numbers": "off",
+        "prefer-template": "off",
+        "@typescript-eslint/tslint/config": [
+            "error",
+            {
+                "rules": {
+                    "no-implicit-dependencies": [
+                        true,
+                        "dev"
+                    ],
+                    "strict-boolean-expressions": [
+                        true,
+                        "allow-boolean-or-undefined",
+                        "allow-number"
+                    ]
+                }
+            }
+        ]
+    }
+}

test/tests/standalone tslint.json/expected.json

@@ -0,0 +1,50 @@
+{
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "@typescript-eslint/tslint"
+    ],
+    "rules": {
+        "@typescript-eslint/array-type": "error",
+        "@typescript-eslint/interface-name-prefix": "error",
+        "@typescript-eslint/member-ordering": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-param-reassign": "off",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-use-before-declare": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "@typescript-eslint/unbound-method": "off",
+        "arrow-body-style": "off",
+        "default-case": "off",
+        "linebreak-style": "off",
+        "no-bitwise": "off",
+        "no-empty": "off",
+        "no-empty-functions": "off",
+        "no-magic-numbers": "off",
+        "prefer-template": "off",
+        "@typescript-eslint/tslint/config": [
+            "error",
+            {
+                "rules": {
+                    "no-implicit-dependencies": [
+                        true,
+                        "dev"
+                    ],
+                    "strict-boolean-expressions": [
+                        true,
+                        "allow-boolean-or-undefined",
+                        "allow-number"
+                    ]
+                }
+            }
+        ]
+    }
+}

test/tests/standalone tslint.json/stderr.txt

@@ -0,0 +1,3 @@
+✨ 17 rules replaced with their ESLint equivalents. ✨
+️👀 2 rules do not yet have ESLint equivalents; defaulting to eslint-plugin-tslint. 👀
+✅ All is well! ✅