Added tests for addition/removal of hard/soft casts

Author: Owen Jones

regression/LVSA/TestCasts/Test.java

@@ -0,0 +1,40 @@
+package LVSA.TestCasts;
+
+public class Test {
+    public static TestInterface interfaceFromChild;
+    public static TestInterface interfaceFromParent;
+    public static TestParent parentFromChild;
+    public static TestParent parentFromInterface;
+    public static TestChild childFromInterface;
+    public static TestChild childFromParent;
+
+    public void cast_from_child() {
+        TestChild testChild = new TestChild();
+
+        interfaceFromChild = (TestInterface)testChild;
+        parentFromChild = (TestParent)testChild;
+    }
+
+    public void cast_from_parent() {
+        TestParent testParent = new TestChild();
+
+        interfaceFromParent = (TestInterface)testParent;
+        childFromParent = (TestChild)testParent;
+    }
+
+    public void cast_from_interface() {
+        TestInterface testInterface = (TestInterface)new TestChild();
+
+        parentFromInterface = (TestParent)testInterface;
+        childFromInterface = (TestChild)testInterface;
+    }
+}
+
+interface TestInterface {
+}
+
+class TestParent {
+}
+
+class TestChild extends TestParent implements TestInterface {
+}

regression/LVSA/TestCasts/test_casts.py

@@ -0,0 +1,64 @@
+import fasteners
+import regression.LVSA.lvsa_driver as driver
+import os
+import regression.utils as utils
+
+
+def _get_this_file_dir():
+    return os.path.dirname(os.path.abspath(__file__))
+
+
+def _get_folder_name():
+    return os.path.basename(_get_this_file_dir())
+
+
+@fasteners.interprocess_locked(os.path.join(os.path.dirname(__file__), ".build_lock"))
+def test_cast_from_child(tmpdir):
+    """ Test addition and removal of casts to DO's """
+    with utils.working_dir(_get_this_file_dir()):
+        os.system("javac Test.java")
+    lvsa_driver = driver.LvsaDriver(tmpdir, _get_folder_name()).with_test_function('cast_from_child')
+    lvsa_expectation = lvsa_driver.run()
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('interfaceFromChild')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_typecast_dynamic_object(1, True, 'LVSA.TestCasts.TestInterface')
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('parentFromChild')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_soft_cast_dynamic_object(1, True, 'LVSA.TestCasts.TestParent')
+
+
+@fasteners.interprocess_locked(os.path.join(os.path.dirname(__file__), ".build_lock"))
+def test_cast_from_parent(tmpdir):
+    """ Test addition and removal of casts to DO's """
+    with utils.working_dir(_get_this_file_dir()):
+        os.system("javac Test.java")
+    lvsa_driver = driver.LvsaDriver(tmpdir, _get_folder_name()).with_test_function('cast_from_parent')
+    lvsa_expectation = lvsa_driver.run()
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('interfaceFromParent')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_typecast_dynamic_object(1, True, 'LVSA.TestCasts.TestInterface')
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('childFromParent')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_dynamic_object(1, True)
+
+
+@fasteners.interprocess_locked(os.path.join(os.path.dirname(__file__), ".build_lock"))
+def test_cast_from_interface(tmpdir):
+    """ Test addition and removal of casts to DO's """
+    with utils.working_dir(_get_this_file_dir()):
+        os.system("javac Test.java")
+    lvsa_driver = driver.LvsaDriver(tmpdir, _get_folder_name()).with_test_function('cast_from_interface')
+    lvsa_expectation = lvsa_driver.run()
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('parentFromInterface')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_soft_cast_dynamic_object(1, True, 'LVSA.TestCasts.TestParent')
+
+    value_set_expectation = lvsa_expectation.get_value_set_for_public_static('childFromInterface')
+    value_set_expectation.check_number_of_values(1)
+    value_set_expectation.check_contains_dynamic_object(1, True)
+

regression/LVSA/lvsa_driver.py

@@ -10,7 +10,9 @@ class Expr:
 
     def __init__(self, expr):
         if expr['namedSub']['type']['id'] == 'symbol':
-            self.type_identifier = expr['namedSub']['type']['namedSub']['identifier']['id']
+            self.type_identifier = expr['namedSub']['type']['namedSub']['identifier']['id'].replace('java::', '')
+        elif expr['namedSub']['type']['id'] == 'struct':
+            self.type_identifier = expr['namedSub']['type']['namedSub']['base_name']['id']
         else:
             self.type_identifier = None
 
@@ -27,6 +29,28 @@ def __init__(self, dynamic_object_expr):
             dynamic_object_expr['namedSub']['is_most_recent_allocation']['id'] == 'most_recent_allocation'
 
 
+class TypecastDynamicObject(Expr):
+    """Turn the json for a typecast dynamic object expr into a python object"""
+
+    def __init__(self, typecast_dynamic_object_expr):
+        assert typecast_dynamic_object_expr['id'] == 'typecast'
+        assert typecast_dynamic_object_expr['sub'][0]['id'] == 'dynamic_object'
+        Expr.__init__(self, typecast_dynamic_object_expr)
+        self.dynamic_object = DynamicObject(typecast_dynamic_object_expr['sub'][0])
+
+
+class SoftCastDynamicObject(Expr):
+    """Turn the json for a soft-cast dynamic object expr into a python object"""
+
+    def __init__(self, soft_cast_dynamic_object_expr):
+        assert soft_cast_dynamic_object_expr['id'] == 'member'
+        assert soft_cast_dynamic_object_expr['namedSub']['component_name']['id'].startswith('@')
+        assert soft_cast_dynamic_object_expr['sub'][0]['id'] == 'dynamic_object'
+        Expr.__init__(self, soft_cast_dynamic_object_expr)
+        assert soft_cast_dynamic_object_expr['namedSub']['component_name']['id'] == '@' + self.type_identifier
+        self.dynamic_object = DynamicObject(soft_cast_dynamic_object_expr['sub'][0])
+
+
 class EvsType(Enum):
     root_object = '0'
     per_field = '1'
@@ -72,13 +96,19 @@ def __init__(self, evs_expr):
                 else:
                     assert False
 
+
 class ValueSetExpectation:
     """Encapsulate the states that a particular variable can take"""
 
     def __init__(self, var_state):
         self.var_state = var_state['values']
         self.null_objects = [x for x in self.var_state if x['id'] == 'NULL-object']
         self.dynamic_objects = [DynamicObject(x) for x in self.var_state if x['id'] == 'dynamic_object']
+        self.typecast_dynamic_objects = [TypecastDynamicObject(x) for x in self.var_state if x['id'] ==
+                                         'typecast' and x['sub'][0]['id'] == 'dynamic_object']
+        self.soft_cast_dynamic_objects = [SoftCastDynamicObject(x) for x in self.var_state if
+                                          x['id'] == 'member' and x['namedSub']['component_name']['id'].startswith(
+                                              '@') and x['sub'][0]['id'] == 'dynamic_object']
         self.external_value_sets = [ExternalValueSet(x) for x in self.var_state if x['id'] == 'external_value_set']
         self.unknown = [x for x in self.var_state if x['id'] == 'unknown']
 
@@ -100,6 +130,23 @@ def check_contains_dynamic_object(self, expected_number=1, is_most_recent_alloca
             matches = [x for x in matches if x.is_most_recent_allocation == is_most_recent_allocation]
         assert expected_number == len(matches)
 
+    def check_contains_typecast_dynamic_object(self, expected_number=1, is_most_recent_allocation=None, type=None):
+        matches = self.typecast_dynamic_objects
+        if is_most_recent_allocation is not None:
+            # Expect True or False
+            matches = [x for x in matches if x.dynamic_object.is_most_recent_allocation == is_most_recent_allocation]
+        if type is not None:
+            # Expect string
+            matches = [x for x in matches if x.type_identifier == type]
+        assert expected_number == len(matches)
+
+    def check_contains_soft_cast_dynamic_object(self, expected_number=1, is_most_recent_allocation=None, type=None):
+        matches = self.soft_cast_dynamic_objects
+        if is_most_recent_allocation is not None:
+            # Expect string
+            matches = [x for x in matches if x.type_identifier == type]
+        assert expected_number == len(matches)
+
     def check_contains_root_object_evs(self, expected_number=1, label_suffix=None):
         matches = [x for x in self.external_value_sets if x.evs_type == EvsType.root_object]
         if label_suffix is not None:
@@ -267,7 +314,8 @@ def run(self):
         class_path = os.path.join('LVSA', self.folder_name, self.class_filename)
         cmd = [executable_path, '--local-value-set-analysis', '--lvsa-summary-directory', self.temp_dir_path,
                '--function', fq_function_name, '--show-value-sets', '--json-ui']
-        if "SECURITY_REGRESSION_TESTS_USE_CSVSA" in os.environ and os.environ["SECURITY_REGRESSION_TESTS_USE_CSVSA"] != 0:
+        if "SECURITY_REGRESSION_TESTS_USE_CSVSA" in os.environ and os.environ[
+            "SECURITY_REGRESSION_TESTS_USE_CSVSA"] != 0:
             cmd.append("--lazy-methods-context-sensitive")
         if self.max_input_tree_depth is not None:
             cmd += ['--java-max-input-tree-depth', str(self.max_input_tree_depth)]