brighterscript 0.66.0-alpha.4 → 0.66.0-alpha.6

package/dist/bscPlugin/validation/ScopeValidator.spec.js

@@ -5,6 +5,8 @@ const DiagnosticMessages_1 = require("../../DiagnosticMessages");
 const Program_1 = require("../../Program");
 const testHelpers_spec_1 = require("../../testHelpers.spec");
 const chai_1 = require("chai");
+const IntegerType_1 = require("../../types/IntegerType");
+const StringType_1 = require("../../types/StringType");
 describe('ScopeValidator', () => {
     let sinon = sinonImport.createSandbox();
     let rootDir = process.cwd();
@@ -265,7 +267,7 @@ describe('ScopeValidator', () => {
             `);
             program.validate();
             (0, testHelpers_spec_1.expectDiagnostics)(program, [
-                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('string', 'Direction')
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('string', 'Direction').message
             ]);
         });
         it('supports passing enum type as enum type', () => {
@@ -697,6 +699,255 @@ describe('ScopeValidator', () => {
             //should have no errors
             (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
         });
+        it('allows calling future function and save to same variable', () => {
+            program.setFile('source/util.brs', `
+                function getSomeInt() as integer
+                    numVal = getUntypedNum()
+                    numVal = cInt(numVal)
+                    return numVal
+                end function
+
+                function getUntypedNum()
+                    return 1
+                end function
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('allows union types of all compatible types as arg', () => {
+            program.setFile('source/util.bs', `
+                sub printIntNum(num as float or double or integer)
+                    print cInt(num)
+                end sub
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('allows function calls of built-in members of primitives', () => {
+            program.setFile('source/util.brs', `
+                sub doSomething()
+                    myStr = "Hello World"
+                    myStr = myStr.replace("World", "You")
+                    print myStr
+                end sub
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('validates union types of all compatible types as arg - when some do not work', () => {
+            program.setFile('source/util.bs', `
+                sub printIntNum(maybeNum as float or string)
+                    print cInt(maybeNum)
+                end sub
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float or string', 'float').message
+            ]);
+        });
+        it('validates function calls of built-in members of primitives', () => {
+            program.setFile('source/util.brs', `
+                sub doSomething()
+                    myStr = "Hello World"
+                    notAString = 3.14
+                    myStr = myStr.replace("World", notAString)
+                    print myStr
+                end sub
+            `);
+            program.validate();
+            //should have error - 2nd param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates method calls of classes', () => {
+            program.setFile('source/util.bs', `
+                class Klass
+                    sub test(input as string)
+                    end sub
+                end class
+
+                sub doSomething()
+                    k = new Klass()
+                    k.test(3.14)
+                end sub
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates inside method calls of classes', () => {
+            program.setFile('source/util.bs', `
+                class Klass
+                    sub test(input as string)
+                    end sub
+
+                    sub otherTest()
+                        m.test(3.14)
+                    end sub
+                end class
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates calls of a constructor', () => {
+            program.setFile('source/util.bs', `
+                class Klass
+                   sub new(name as string)
+                   end sub
+                end class
+
+                sub createKlass()
+                    k = new Klass(3.14)
+                end sub
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates super calls in a constructor', () => {
+            program.setFile('source/util.bs', `
+                class Klass
+                   sub new(name as string)
+                   end sub
+                end class
+
+                class SubKlass extends Klass
+                    sub new()
+                        super(3.14)
+                    end sub
+                end class
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates super calls in a class methods', () => {
+            program.setFile('source/util.bs', `
+                class Klass
+                   sub test(name as string)
+                   end sub
+                end class
+
+                class SubKlass extends Klass
+                    sub test2()
+                        super.test(3.14)
+                    end sub
+                end class
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('float', 'string').message
+            ]);
+        });
+        it('validates a function passed as an arg', () => {
+            program.setFile('source/util.bs', `
+                sub foo()
+                    getPi = function()
+                        return 3.14
+                    end function
+                    bar(getPi)
+                end sub
+
+
+                sub bar(num as integer)
+                    print num
+                end sub
+            `);
+            program.validate();
+            //should have error - param should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('function () as dynamic', 'integer').message
+            ]);
+        });
+        it('allows AAs that match an interface to be passed as args', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    takesMyIface({beta: "hello", charlie: "world"})
+                end sub
+
+                sub takesMyIface(iFace as MyIFace)
+                end sub
+
+                interface MyIFace
+                    beta as string
+                    charlie as string
+                end interface
+            `);
+            program.validate();
+            //should have error
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('validates empty AAs that are passed as args to param expecting interface', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    takesMyIface({})
+                end sub
+
+                sub takesMyIface(iFace as MyIFace)
+                end sub
+
+                interface MyIFace
+                    beta as string
+                    charlie as string
+                end interface
+            `);
+            program.validate();
+            //should have error
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('roAssociativeArray', 'MyIFace', {
+                    missingFields: [{ name: 'beta', expectedType: StringType_1.StringType.instance }, { name: 'charlie', expectedType: StringType_1.StringType.instance }]
+                }).message
+            ]);
+        });
+        it('includes data on missing fields', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    takesMyIface({charlie: "hello"})
+                end sub
+
+                sub takesMyIface(iFace as MyIFace)
+                end sub
+
+                interface MyIFace
+                    beta as string
+                    charlie as integer
+                end interface
+            `);
+            program.validate();
+            //should have error
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.argumentTypeMismatch('roAssociativeArray', 'MyIFace', {
+                    missingFields: [{ name: 'beta', expectedType: StringType_1.StringType.instance }],
+                    fieldMismatches: [{ name: 'charlie', expectedType: IntegerType_1.IntegerType.instance, actualType: StringType_1.StringType.instance }]
+                }).message
+            ]);
+            //The aa should have 'beta' and 'charlie' properties of type string and integer
+            const diagnostics = program.getDiagnostics();
+            (0, chai_1.expect)(diagnostics.length).to.eq(1);
+            const data = diagnostics[0].data;
+            (0, chai_1.expect)(data.missingFields.length).to.eq(1);
+            (0, chai_1.expect)(data.missingFields[0].name).to.eq('beta');
+            (0, testHelpers_spec_1.expectTypeToBe)(data.missingFields[0].expectedType, StringType_1.StringType);
+            (0, chai_1.expect)(data.fieldMismatches.length).to.eq(1);
+            (0, chai_1.expect)(data.fieldMismatches[0].name).to.eq('charlie');
+            (0, testHelpers_spec_1.expectTypeToBe)(data.fieldMismatches[0].expectedType, IntegerType_1.IntegerType);
+            (0, testHelpers_spec_1.expectTypeToBe)(data.fieldMismatches[0].actualType, StringType_1.StringType);
+        });
     });
     describe('cannotFindName', () => {
         it('finds variables from assignments from member functions of primitive types', () => {
@@ -710,6 +961,375 @@ describe('ScopeValidator', () => {
             //should have no errors
             (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
         });
+        it('validates when lhs of compound assignment does not exist', () => {
+            program.setFile('source/util.brs', `
+                sub main()
+                    expected += chr(10) + " version=""2.0"""
+                end sub
+            `);
+            program.validate();
+            //should have error - cannot find "expected"
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.cannotFindName('expected').message
+            ]);
+        });
+    });
+    describe('returnTypeMismatch', () => {
+        it('finds when a function returns a type that is not what was declared', () => {
+            program.setFile('source/util.bs', `
+                function getPi() as float
+                    return "apple" ' get it?
+                end function
+            `);
+            program.validate();
+            //should have error - return value should be a float, not a string
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('string', 'float').message
+            ]);
+        });
+        it('finds all return statements that do not match', () => {
+            program.setFile('source/util.bs', `
+                function getPi(kind as integer) as float
+                    if kind = 1
+                        return "apple"
+                    else if kind = 2
+                        return false
+                    else if kind = 3
+                        return new Pie("lemon")
+                    end if
+                    return 3.14
+                end function
+
+                class Pie
+                   kind as string
+                   sub new(kind as string)
+                       m.kind = kind
+                   end sub
+                end class
+            `);
+            program.validate();
+            //should have error - return value should be a float, not whatever else
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('string', 'float').message,
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('boolean', 'float').message,
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('Pie', 'float').message
+            ]);
+        });
+        it('allows returning compatible types', () => {
+            program.setFile('source/util.bs', `
+                function getPi() as float
+                    return 3 ' integers are compatible with floats
+                end function
+
+                function getPie() as Pie
+                    return new Tart("lemon") ' Tart extends Pie
+                end function
+
+                class Pie
+                    kind as string
+                    sub new(kind as string)
+                        m.kind = kind
+                    end sub
+                end class
+
+                class Tart extends Pie
+                    size = "small"
+                end class
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('detects return types on void functions (subs)', () => {
+            program.setFile('source/util.bs', `
+                sub sayHello(name as string)
+                    return "hello " + name ' return should be void in subs
+                end sub
+            `);
+            program.validate();
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('string', 'void').message
+            ]);
+        });
+        it('detects return types on void functions', () => {
+            program.setFile('source/util.bs', `
+                function sayHello(name as string) as void
+                    return "hello " + name ' return should be void in subs
+                end function
+            `);
+            program.validate();
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.returnTypeMismatch('string', 'void').message
+            ]);
+        });
+    });
+    describe('assignmentTypeMismatch', () => {
+        it('finds when the type of the lhs is not compatible with the expected type', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(thing as iThing)
+                    thing.name = 123
+                end sub
+
+                interface iThing
+                    name as string
+                end interface
+            `);
+            program.validate();
+            //should have error - assignment value should be a string, not a float
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.assignmentTypeMismatch('integer', 'string').message
+            ]);
+        });
+        it('allows setting a member with correct type that is a union type', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(thing as iThing)
+                    thing.name = 123
+                end sub
+
+                interface iThing
+                    name as string or integer
+                end interface
+            `);
+            program.validate();
+            //should have no error - assignment value should be a string, not a float
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('finds when the rhs type is not compatible with the lhs, which is a union type', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(thing as iThing)
+                    thing.name = false
+                end sub
+
+                interface iThing
+                    name as string or integer
+                end interface
+            `);
+            program.validate();
+            //should have error - assignment value should be a string or integer, not a boolean
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.assignmentTypeMismatch('boolean', 'string or integer').message
+            ]);
+        });
+        it('validates when trying to assign to a class method', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(myThing as Thing)
+                    myThing.getPi = 3.14
+                end sub
+
+                class Thing
+                    function getPi() as float
+                        return 3.14
+                    end function
+                end class
+            `);
+            program.validate();
+            //should have error
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.assignmentTypeMismatch('float', 'function getPi() as float').message
+            ]);
+        });
+        it('allows adding new properties to a class (but why would you want to?)', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(myThing as Thing)
+                    myThing.getPi = 3.14
+                end sub
+
+                class Thing
+                end class
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('validates class constructors', () => {
+            program.setFile('source/util.bs', `
+                class Video
+                    sub new(url as integer)
+                        m.url = url 'this should be a compile error
+                    end sub
+                    public url as string
+                end class
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.assignmentTypeMismatch('integer', 'string').message
+            ]);
+        });
+        it('validates when assigning to a sgNode', () => {
+            program.setFile('source/util.bs', `
+                sub setLabelText(label as roSGNodeLabel)
+                    label.text = 1234
+                end sub
+
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.assignmentTypeMismatch('integer', 'string').message
+            ]);
+        });
+    });
+    describe('operatorTypeMismatch', () => {
+        it('finds when the type of the lhs is not compatible with the rhs type', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    a = 1 + true
+                    b = "hello" * 2
+                end sub
+
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('+', 'integer', 'boolean').message,
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('*', 'string', 'integer').message
+            ]);
+        });
+        it('allows when the type of the lhs is compatible with the rhs type', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    a = 10 << 1
+                    b = "hello" + "world"
+                    c = 78 / 34
+                    d = 100 \\ 5
+                    thing = new Klass()
+                    e = thing <> invalid
+                end sub
+
+                class Klass
+                end class
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('allows tests against invalid', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    thing = new Klass()
+                    x = thing <> invalid
+                end sub
+
+                class Klass
+                end class
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('disallows equality tests of classes', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    thing = new Klass()
+                    thing2 = new Klass()
+                    x = thing = thing2
+                end sub
+
+                class Klass
+                end class
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('=', 'Klass', 'Klass').message
+            ]);
+        });
+        it('disallows operations between dynamic and custom types', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(input)
+                    thing = new Klass()
+                    x = thing + input
+                end sub
+
+                class Klass
+                end class
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('+', 'Klass', 'dynamic').message
+            ]);
+        });
+        it('allows valid operations on enum members', () => {
+            program.setFile('source/util.bs', `
+                sub makeEasterly(d as Direction)
+                    print d + "e"
+                    print Direction.north + "east"
+                end sub
+
+                function getTax(itemAmt as ItemCost) as Float
+                    return itemAmt * 1.15
+                end function
+
+                enum Direction
+                    north = "n"
+                    south = "s"
+                end enum
+
+                enum ItemCost
+                    x = 99.99
+                    y = 29.99
+                end enum
+
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
+        it('finds invalid operations on enum members', () => {
+            program.setFile('source/util.bs', `
+                enum Direction
+                    north = "n"
+                    south = "s"
+                end enum
+
+                sub makeEasterly(d as Direction)
+                    print d + 2
+                    print 3.14 * Direction.north
+                end sub
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('+', 'Direction', 'integer').message,
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('*', 'float', 'Direction').message
+            ]);
+        });
+        it('validates unary operators', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff()
+                    x = - "hello world"
+                end sub
+            `);
+            program.validate();
+            //should have errors
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [
+                DiagnosticMessages_1.DiagnosticMessages.operatorTypeMismatch('-', 'string').message
+            ]);
+        });
+        it('allows unary on dynamic and union types', () => {
+            program.setFile('source/util.bs', `
+                sub doStuff(x)
+                    y = -x
+                    print y
+                end sub
+
+                sub doOtherStuff(x as float or integer)
+                    y = -x
+                    print y
+                end sub
+
+                sub doEventMoreStuff(x as boolean or dynamic)
+                    if not x
+                        print "ok"
+                    end if
+                end sub
+            `);
+            program.validate();
+            //should have no errors
+            (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+        });
     });
 });
 //# sourceMappingURL=ScopeValidator.spec.js.map