Use inline snapshots for simple tests

ark120202 · ark120202 · commit 9312a0c9eea2 · 2020-01-06T17:41:44.000Z
diff --git a/test/unit/__snapshots__/conditionals.spec.ts.snap b/test/unit/__snapshots__/conditionals.spec.ts.snap
@@ -9,5 +9,3 @@ function ____exports.__main(self)
 end
 return ____exports"
 `;
-
-exports[`switch not allowed in 5.1: diagnostics 1`] = `"main.ts(2,9): error TSTL: Switch statements is/are not supported for target Lua 5.1."`;
diff --git a/test/unit/__snapshots__/loops.spec.ts.snap b/test/unit/__snapshots__/loops.spec.ts.snap
@@ -10,8 +10,6 @@ end
 return ____exports"
 `;
 
-exports[`forin[Array]: diagnostics 1`] = `"main.ts(3,9): error TSTL: Iterating over arrays with 'for ... in' is not allowed."`;
-
 exports[`forof object destructuring ({"initializer": "{a, b}", "vars": "let a: string, b: string;"}): code 1`] = `
 "local a
 local b
diff --git a/test/unit/builtins/__snapshots__/loading.spec.ts.snap b/test/unit/builtins/__snapshots__/loading.spec.ts.snap
@@ -6,12 +6,8 @@ ____exports.__result = Math.unknownProperty
 return ____exports"
 `;
 
-exports[`Unknown builtin property access: diagnostics 1`] = `"main.ts(1,25): error TSTL: Math.unknownProperty is unsupported."`;
-
 exports[`Unknown builtin property function call: code 1`] = `
 "local ____exports = {}
 ____exports.__result = ({}):unknownFunction()
 return ____exports"
 `;
-
-exports[`Unknown builtin property function call: diagnostics 1`] = `"main.ts(1,25): error TSTL: array.unknownFunction is unsupported."`;
diff --git a/test/unit/builtins/loading.spec.ts b/test/unit/builtins/loading.spec.ts
@@ -39,10 +39,18 @@ test("lualib should not include tstl header", () => {
 
 describe("Unknown builtin property", () => {
     test("access", () => {
-        util.testExpression`Math.unknownProperty`.disableSemanticCheck().expectDiagnosticsToMatchSnapshot();
+        util.testExpression`Math.unknownProperty`
+            .disableSemanticCheck()
+            .expectDiagnostics(m =>
+                m.toMatchInlineSnapshot(`"main.ts(1,25): error TSTL: Math.unknownProperty is unsupported."`)
+            );
     });
 
     test("function call", () => {
-        util.testExpression`[].unknownFunction()`.disableSemanticCheck().expectDiagnosticsToMatchSnapshot();
+        util.testExpression`[].unknownFunction()`
+            .disableSemanticCheck()
+            .expectDiagnostics(m =>
+                m.toMatchInlineSnapshot(`"main.ts(1,25): error TSTL: array.unknownFunction is unsupported."`)
+            );
     });
 });
diff --git a/test/unit/bundle.spec.ts b/test/unit/bundle.spec.ts
@@ -90,7 +90,13 @@ test("LuaLibImportKind.Inline generates a warning", () => {
         result.push(3);
     `
         .setOptions({ luaLibImport: LuaLibImportKind.Inline })
-        .expectDiagnosticsToMatchSnapshot(true)
+        .expectDiagnostics(
+            m =>
+                m.toMatchInlineSnapshot(
+                    `"warning TSTL: Using 'luaBundle' with 'luaLibImport: \\"inline\\"' might generate duplicate code. It is recommended to use 'luaLibImport: \\"require\\"'"`
+                ),
+            true
+        )
         .expectToEqual({ result: [1, 2, 3] });
 });
 
@@ -113,9 +119,22 @@ test("cyclic imports", () => {
 });
 
 test("no entry point", () => {
-    util.testBundle``.setOptions({ luaBundleEntry: undefined }).expectDiagnosticsToMatchSnapshot(true);
+    util.testBundle``
+        .setOptions({ luaBundleEntry: undefined })
+        .expectDiagnostics(
+            m => m.toMatchInlineSnapshot(`"error TSTL: 'luaBundleEntry' is required when 'luaBundle' is enabled."`),
+            true
+        );
 });
 
 test("luaEntry doesn't exist", () => {
-    util.testBundle``.setEntryPoint("entry.ts").expectDiagnosticsToMatchSnapshot(true);
+    util.testBundle``
+        .setEntryPoint("entry.ts")
+        .expectDiagnostics(
+            m =>
+                m.toMatchInlineSnapshot(
+                    `"error TSTL: Could not find bundle entry point 'entry.ts'. It should be a file in the project."`
+                ),
+            true
+        );
 });
diff --git a/test/unit/classes/__snapshots__/classes.spec.ts.snap b/test/unit/classes/__snapshots__/classes.spec.ts.snap
@@ -5,5 +5,3 @@ exports[`super without class: code 1`] = `
 ____exports.__result = ____.____constructor(self)
 return ____exports"
 `;
-
-exports[`super without class: diagnostics 1`] = `"main.ts(1,25): error TS2337: Super calls are not permitted outside constructors or in nested functions inside constructors."`;
diff --git a/test/unit/classes/__snapshots__/decorators.spec.ts.snap b/test/unit/classes/__snapshots__/decorators.spec.ts.snap
@@ -14,5 +14,3 @@ function ____exports.__main(self)
 end
 return ____exports"
 `;
-
-exports[`Throws error if decorator function has void context: diagnostics 1`] = `"main.ts(4,9): error TSTL: Decorator function cannot have 'this: void'."`;
diff --git a/test/unit/classes/classes.spec.ts b/test/unit/classes/classes.spec.ts
@@ -237,7 +237,11 @@ test("Subclass constructor across merged namespace", () => {
 });
 
 test("super without class", () => {
-    util.testExpression`super()`.expectDiagnosticsToMatchSnapshot();
+    util.testExpression`super()`.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(
+            `"main.ts(1,25): error TS2337: Super calls are not permitted outside constructors or in nested functions inside constructors."`
+        )
+    );
 });
 
 test("super in unnamed class", () => {
diff --git a/test/unit/classes/decorators.spec.ts b/test/unit/classes/decorators.spec.ts
@@ -108,7 +108,9 @@ test("Throws error if decorator function has void context", () => {
 
         @decorator
         class TestClass {}
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(`"main.ts(4,9): error TSTL: Decorator function cannot have 'this: void'."`)
+    );
 });
 
 test("Exported class decorator", () => {
diff --git a/test/unit/conditionals.spec.ts b/test/unit/conditionals.spec.ts
@@ -315,7 +315,11 @@ test("switch not allowed in 5.1", () => {
         switch ("abc") {}
     `
         .setOptions({ luaTarget: tstl.LuaTarget.Lua51 })
-        .expectDiagnosticsToMatchSnapshot();
+        .expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(
+                `"main.ts(2,9): error TSTL: Switch statements is/are not supported for target Lua 5.1."`
+            )
+        );
 });
 
 test.each([
diff --git a/test/unit/decorators/__snapshots__/customConstructor.spec.ts.snap b/test/unit/decorators/__snapshots__/customConstructor.spec.ts.snap
@@ -12,5 +12,3 @@ function ____exports.__main(self)
 end
 return ____exports"
 `;
-
-exports[`IncorrectUsage: diagnostics 1`] = `"main.ts(5,9): error TSTL: '@customConstructor' expects 1 arguments, but got 0."`;
diff --git a/test/unit/decorators/__snapshots__/forRange.spec.ts.snap b/test/unit/decorators/__snapshots__/forRange.spec.ts.snap
@@ -26,23 +26,17 @@ exports[`invalid usage argument types: code 1`] = `
 end"
 `;
 
-exports[`invalid usage argument types: diagnostics 1`] = `"main.ts(6,29): error TSTL: Invalid @forRange call: arguments must be numbers."`;
-
 exports[`invalid usage non-ambient declaration: code 1`] = `
 "function luaRange(self)
 end"
 `;
 
-exports[`invalid usage non-ambient declaration: diagnostics 1`] = `"main.ts(3,22): error TSTL: Invalid @forRange call: can be used only as an iterable in a for...of loop."`;
-
 exports[`invalid usage non-declared loop variable: code 1`] = `
 "local i
 for ____ = 1, 10, 2 do
 end"
 `;
 
-exports[`invalid usage non-declared loop variable: diagnostics 1`] = `"main.ts(7,18): error TSTL: Invalid @forRange call: loop must declare it's own control variable."`;
-
 exports[`invalid usage reference ("const call = undefined as any; call(luaRange);"): code 1`] = `
 "local call = nil
 call(_G, luaRange)"
@@ -83,11 +77,7 @@ exports[`invalid usage return type: code 1`] = `
 end"
 `;
 
-exports[`invalid usage return type: diagnostics 1`] = `"main.ts(6,29): error TSTL: Invalid @forRange call: function must return Iterable<number>."`;
-
 exports[`invalid usage variable destructuring: code 1`] = `
 "for ____ = 1, 10, 2 do
 end"
 `;
-
-exports[`invalid usage variable destructuring: diagnostics 1`] = `"main.ts(6,18): error TSTL: Invalid @forRange call: destructuring cannot be used."`;
diff --git a/test/unit/decorators/__snapshots__/luaIterator.spec.ts.snap b/test/unit/decorators/__snapshots__/luaIterator.spec.ts.snap
@@ -6,11 +6,7 @@ for ____ in luaIter(_G) do
 end"
 `;
 
-exports[`forof lua iterator tuple-return single existing variable: diagnostics 1`] = `"main.ts(9,14): error TSTL: Unsupported use of lua iterator with '@tupleReturn' annotation in for...of statement. You must use a destructuring statement to catch results from a lua iterator with the '@tupleReturn' annotation."`;
-
 exports[`forof lua iterator tuple-return single variable: code 1`] = `
 "for ____ in luaIter(_G) do
 end"
 `;
-
-exports[`forof lua iterator tuple-return single variable: diagnostics 1`] = `"main.ts(8,18): error TSTL: Unsupported use of lua iterator with '@tupleReturn' annotation in for...of statement. You must use a destructuring statement to catch results from a lua iterator with the '@tupleReturn' annotation."`;
diff --git a/test/unit/decorators/__snapshots__/metaExtension.spec.ts.snap b/test/unit/decorators/__snapshots__/metaExtension.spec.ts.snap
@@ -6,12 +6,8 @@ local __meta___LOADED = debug.getregistry()._LOADED
 local e = __TS__New(Ext)"
 `;
 
-exports[`DontAllowInstantiation: diagnostics 1`] = `"main.ts(5,19): error TSTL: Cannot construct classes with '@extension' or '@metaExtension' annotation."`;
-
 exports[`IncorrectUsage: code 1`] = `
 "function LoadedExt.test(self)
     return 5
 end"
 `;
-
-exports[`IncorrectUsage: diagnostics 1`] = `"main.ts(3,9): error TSTL: '@metaExtension' annotation requires the extension of the metatable class."`;
diff --git a/test/unit/decorators/customConstructor.spec.ts b/test/unit/decorators/customConstructor.spec.ts
@@ -29,5 +29,7 @@ test("IncorrectUsage", () => {
         class Point2D {}
 
         new Point2D();
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(`"main.ts(5,9): error TSTL: '@customConstructor' expects 1 arguments, but got 0."`)
+    );
 });
diff --git a/test/unit/decorators/forRange.spec.ts b/test/unit/decorators/forRange.spec.ts
@@ -28,7 +28,11 @@ describe("invalid usage", () => {
         util.testModule`
             /** @forRange */
             function luaRange() {}
-        `.expectDiagnosticsToMatchSnapshot();
+        `.expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(
+                `"main.ts(3,22): error TSTL: Invalid @forRange call: can be used only as an iterable in a for...of loop."`
+            )
+        );
     });
 
     test.each<[number[]]>([[[]], [[1]], [[1, 2, 3, 4]]])("argument count (%p)", args => {
@@ -43,28 +47,42 @@ describe("invalid usage", () => {
             ${createForRangeDeclaration()}
             let i: number;
             for (i of luaRange(1, 10, 2)) {}
-        `.expectDiagnosticsToMatchSnapshot();
+        `.expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(
+                `"main.ts(7,18): error TSTL: Invalid @forRange call: loop must declare it's own control variable."`
+            )
+        );
     });
 
     test("argument types", () => {
         util.testModule`
             ${createForRangeDeclaration("i: string, j: number")}
             for (const i of luaRange("foo", 2)) {}
-        `.expectDiagnosticsToMatchSnapshot();
+        `.expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(`"main.ts(6,29): error TSTL: Invalid @forRange call: arguments must be numbers."`)
+        );
     });
 
     test("variable destructuring", () => {
         util.testModule`
             ${createForRangeDeclaration(undefined, "number[][]")}
             for (const [i] of luaRange(1, 10, 2)) {}
-        `.expectDiagnosticsToMatchSnapshot();
+        `.expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(
+                `"main.ts(6,18): error TSTL: Invalid @forRange call: destructuring cannot be used."`
+            )
+        );
     });
 
     test("return type", () => {
         util.testModule`
             ${createForRangeDeclaration(undefined, "string[]")}
             for (const i of luaRange(1, 10)) {}
-        `.expectDiagnosticsToMatchSnapshot();
+        `.expectDiagnostics(m =>
+            m.toMatchInlineSnapshot(
+                `"main.ts(6,29): error TSTL: Invalid @forRange call: function must return Iterable<number>."`
+            )
+        );
     });
 
     test.each([
diff --git a/test/unit/decorators/luaIterator.spec.ts b/test/unit/decorators/luaIterator.spec.ts
@@ -143,7 +143,11 @@ test("forof lua iterator tuple-return single variable", () => {
         interface Iter extends Iterable<[string, string]> {}
         declare function luaIter(): Iter;
         for (let x of luaIter()) {}
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(
+            `"main.ts(8,18): error TSTL: Unsupported use of lua iterator with '@tupleReturn' annotation in for...of statement. You must use a destructuring statement to catch results from a lua iterator with the '@tupleReturn' annotation."`
+        )
+    );
 });
 
 test("forof lua iterator tuple-return single existing variable", () => {
@@ -156,7 +160,11 @@ test("forof lua iterator tuple-return single existing variable", () => {
         declare function luaIter(): Iter;
         let x: [string, string];
         for (x of luaIter()) {}
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(
+            `"main.ts(9,14): error TSTL: Unsupported use of lua iterator with '@tupleReturn' annotation in for...of statement. You must use a destructuring statement to catch results from a lua iterator with the '@tupleReturn' annotation."`
+        )
+    );
 });
 
 test("forof forwarded lua iterator", () => {
diff --git a/test/unit/decorators/metaExtension.spec.ts b/test/unit/decorators/metaExtension.spec.ts
@@ -32,7 +32,11 @@ test("IncorrectUsage", () => {
                 return 5;
             }
         }
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(
+            `"main.ts(3,9): error TSTL: '@metaExtension' annotation requires the extension of the metatable class."`
+        )
+    );
 });
 
 test("DontAllowInstantiation", () => {
@@ -41,5 +45,9 @@ test("DontAllowInstantiation", () => {
         /** @metaExtension */
         class Ext extends _LOADED {}
         const e = new Ext();
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(
+            `"main.ts(5,19): error TSTL: Cannot construct classes with '@extension' or '@metaExtension' annotation."`
+        )
+    );
 });
diff --git a/test/unit/loops.spec.ts b/test/unit/loops.spec.ts
@@ -234,7 +234,9 @@ test("forin[Array]", () => {
     util.testFunction`
         const array = [];
         for (const key in array) {}
-    `.expectDiagnosticsToMatchSnapshot();
+    `.expectDiagnostics(m =>
+        m.toMatchInlineSnapshot(`"main.ts(3,9): error TSTL: Iterating over arrays with 'for ... in' is not allowed."`)
+    );
 });
 
 test.each([{ inp: { a: 0, b: 1, c: 2, d: 3, e: 4 }, expected: { a: 0, b: 0, c: 2, d: 0, e: 4 } }])(
diff --git a/test/util.ts b/test/util.ts
@@ -389,15 +389,31 @@ export abstract class TestBuilder {
         return this;
     }
 
-    public expectDiagnosticsToMatchSnapshot(diagnosticsOnly = false): this {
+    private getDiagnosticsSnapshot(): string {
         this.expectToHaveDiagnostics();
 
         const diagnosticMessages = ts.formatDiagnostics(
             this.getLuaDiagnostics().map(tstl.prepareDiagnosticForFormatting),
             { getCurrentDirectory: () => "", getCanonicalFileName: fileName => fileName, getNewLine: () => "\n" }
         );
 
-        expect(diagnosticMessages.trim()).toMatchSnapshot("diagnostics");
+        return diagnosticMessages.trim();
+    }
+
+    public expectDiagnosticsToMatchSnapshot(diagnosticsOnly = false): this {
+        expect(this.getDiagnosticsSnapshot()).toMatchSnapshot("diagnostics");
+        if (!diagnosticsOnly) {
+            expect(this.getMainLuaCodeChunk()).toMatchSnapshot("code");
+        }
+
+        return this;
+    }
+
+    public expectDiagnostics(
+        callback: (matchers: Pick<jest.JestMatchers<string>, "toMatchInlineSnapshot">) => void,
+        diagnosticsOnly = false
+    ): this {
+        callback(expect(this.getDiagnosticsSnapshot()));
         if (!diagnosticsOnly) {
             expect(this.getMainLuaCodeChunk()).toMatchSnapshot("code");
         }
