feat: adds logging + better hashing

Author: huafu

.github/ISSUE_TEMPLATE.md

@@ -7,9 +7,9 @@ https://github.com/kulshekhar/ts-jest/wiki/Troubleshooting -->
 ## Expected behavior <!-- describe the expected behavior below -->:
 
 
-## Output from debug log <!-- You can activate the debug logger by setting the environment variable TS_JEST_DEBUG="true" before running yarn test. The output of the logger will be in **<your_project_dir>/node_modules/ts-jest/debug.txt**, paste it below -->:
+## Output from debug log <!-- You can activate the debug logger by setting the environment variable TS_JEST_DEBUG="true" before running tests. The output of the logger will be in **ts-jest-debug.log**, paste it below -->:
 ```bash
-# content of debug.txt :
+# content of ts-jest-debug.log :
 
 ```
 

e2e/__helpers__/test-case/RunResult.ts

@@ -1,6 +1,10 @@
 import { SpawnSyncReturns } from 'child_process'
 import ProcessedFileIo from './ProcessedFileIo'
-import { stripAnsiColors, normalizeJestOutput } from './utils'
+import { stripAnsiColors, normalizeJestOutput, escapeRegex } from './utils'
+import { resolve } from 'path'
+import { readFileSync, realpathSync } from 'fs'
+import { LOG_PREFIX } from '../../../src/util/debug'
+import { tmpdir } from 'os'
 
 // tslint:disable-next-line:no-default-export
 export default class RunResult {
@@ -14,6 +18,14 @@ export default class RunResult {
       env: { [key: string]: string },
     }>,
   ) { }
+  get logFilePath() { return resolve(this.cwd, 'ts-jest-debug.log') }
+  get logFileContent() { return readFileSync(this.logFilePath).toString('utf8') }
+  get normalizedLogFileContent() {
+    const prefix = ` ${LOG_PREFIX} `
+    return this.normalize(this.logFileContent.split(/\n/g).map(s => {
+      return s.split(prefix).slice(1).join(prefix)
+    }).join('\n'))
+  }
   get isPass() { return this.status === 0 }
   get isFail() { return !this.isPass }
   get status() { return this.result.status }
@@ -25,11 +37,27 @@ export default class RunResult {
   get cmdLine() {
     return [this.context.cmd, ...this.context.args].join(' ')
   }
+
   ioFor(relFilePath: string): ProcessedFileIo {
     if (!this.context.ioDir) {
       throw new Error('IO not written for test, you must configure the test with `writeIo: true`.')
     }
     const io = require(`${this.context.ioDir}/${relFilePath}.json`)
     return new ProcessedFileIo(this.cwd, relFilePath, io.in, io.out)
   }
+
+  normalize(str: string) {
+    // TODO: hmmm clean this!
+    return [
+      { from: this.cwd, to: '<cwd>' },
+      { from: realpathSync(this.cwd), to: '<cwd>' },
+      { from: tmpdir(), to: '<tmp>' },
+      { from: realpathSync(tmpdir()), to: '<tmp>' },
+      { from: /\b[a-f0-9]{40}\b/g, to: '<hex:40>' },
+    ]
+      .sort((a, b) => ((b.from as any).length || 0) - ((a.from as any).length || 0))
+      .reduce((str, { from, to }) => {
+        return str.replace(typeof from === 'string' ? new RegExp(`${escapeRegex(from)}`, 'g') : from, to)
+      }, str)
+  }
 }

e2e/__helpers__/test-case/utils.ts

@@ -52,3 +52,7 @@ export function normalizeJestOutput(output: string): string {
   }
   return out
 }
+
+export function escapeRegex(s: string) {
+  return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&')
+}

e2e/__tests__/__snapshots__/logger.test.ts.snap

@@ -0,0 +1,28 @@
+import { configureTestCase } from '../__helpers__/test-case'
+import { PackageSets, allValidPackageSets } from '../__helpers__/templates'
+import { existsSync } from 'fs'
+
+describe('With unsupported version test', () => {
+  const testCase = configureTestCase('simple')
+
+  testCase.runWithTemplates([PackageSets.unsupportedVersion], 0, (runTest, { testLabel }) => {
+    it(testLabel, () => {
+      const result = runTest()
+      expect(result.status).toBe(0)
+      expect(result).toMatchSnapshot()
+    })
+  })
+})
+
+describe('TS_JEST_DEBUG', () => {
+  const testCase = configureTestCase('simple', { env: { TS_JEST_DEBUG: 'true' } })
+
+  testCase.runWithTemplates(allValidPackageSets, 0, (runTest, { templateName }) => {
+    it(`should pass and create log file when using tempalte "${templateName}"`, () => {
+      const result = runTest()
+      expect(result.status).toBe(0)
+      expect(existsSync(result.logFilePath))
+      expect(result.normalizedLogFileContent).toMatchSnapshot()
+    })
+  })
+})

e2e/__tests__/__snapshots__/warning-messages.test.ts.snap

@@ -81,7 +81,6 @@
     "lodash.merge": "^4.6.1",
     "lodash.set": "^4.3.2",
     "npm-run-all": "^4.1.3",
-    "outdent": "^0.5.0",
     "prettier": "^1.14.2",
     "reflect-metadata": "^0.1.12",
     "source-map": "^0.7.3",