1"""Test the SBEnvironment APIs."""
2
3
4
5from math import fabs
6import lldb
7from lldbsuite.test.decorators import *
8from lldbsuite.test.lldbtest import *
9from lldbsuite.test import lldbutil
10
11class SBEnvironmentAPICase(TestBase):
12
13    mydir = TestBase.compute_mydir(__file__)
14    NO_DEBUG_INFO_TESTCASE = True
15
16    # We use this function to test both kind of accessors:
17    # .  Get*AtIndex and GetEntries
18    def assertEqualEntries(self, env, entries):
19        self.assertEqual(env.GetNumValues(), len(entries))
20        for i in range(env.GetNumValues()):
21            name = env.GetNameAtIndex(i)
22            value = env.GetValueAtIndex(i)
23            self.assertIn(name + "=" + value, entries)
24
25        entries = env.GetEntries()
26        self.assertEqual(entries.GetSize(), len(entries))
27        for i in range(entries.GetSize()):
28            (name, value) = entries.GetStringAtIndex(i).split("=")
29            self.assertIn(name + "=" + value, entries)
30
31
32
33    @add_test_categories(['pyapi'])
34    @skipIfRemote # Remote environment not supported.
35    def test_platform_environment(self):
36        env = self.dbg.GetSelectedPlatform().GetEnvironment()
37        # We assume at least PATH is set
38        self.assertNotEqual(env.Get("PATH"), None)
39
40
41    @add_test_categories(['pyapi'])
42    def test_launch_info(self):
43        target = self.dbg.CreateTarget("")
44        launch_info = target.GetLaunchInfo()
45        env = launch_info.GetEnvironment()
46        env_count = env.GetNumValues()
47
48        env.Set("FOO", "bar", overwrite=True)
49        self.assertEqual(env.GetNumValues(), env_count + 1)
50
51        # Make sure we only modify the copy of the launchInfo's environment
52        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count)
53
54        launch_info.SetEnvironment(env, append=True)
55        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count + 1)
56
57        env.Set("FOO", "baz", overwrite=True)
58        launch_info.SetEnvironment(env, append=True)
59        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count + 1)
60        self.assertEqual(launch_info.GetEnvironment().Get("FOO"), "baz")
61
62        # Make sure we can replace the launchInfo's environment
63        env.Clear()
64        env.Set("BAR", "foo", overwrite=True)
65        env.PutEntry("X=y")
66        launch_info.SetEnvironment(env, append=False)
67        self.assertEqualEntries(launch_info.GetEnvironment(), ["BAR=foo", "X=y"])
68
69
70    @add_test_categories(['pyapi'])
71    @skipIfRemote # Remote environment not supported.
72    def test_target_environment(self):
73        env = self.dbg.GetSelectedTarget().GetEnvironment()
74        # There is no target, so env should be empty
75        self.assertEqual(env.GetNumValues(), 0)
76        self.assertEqual(env.Get("PATH"), None)
77
78        target = self.dbg.CreateTarget("")
79        env = target.GetEnvironment()
80        path = env.Get("PATH")
81        # Now there's a target, so at least PATH should exist
82        self.assertNotEqual(path, None)
83
84        # Make sure we are getting a copy by modifying the env we just got
85        env.PutEntry("PATH=#" + path)
86        self.assertEqual(target.GetEnvironment().Get("PATH"), path)
87
88    @add_test_categories(['pyapi'])
89    def test_creating_and_modifying_environment(self):
90        env = lldb.SBEnvironment()
91
92        self.assertEqual(env.Get("FOO"), None)
93        self.assertEqual(env.Get("BAR"), None)
94
95        # We also test empty values
96        self.assertTrue(env.Set("FOO", "", overwrite=False))
97        env.Set("BAR", "foo", overwrite=False)
98
99        self.assertEqual(env.Get("FOO"), "")
100        self.assertEqual(env.Get("BAR"), "foo")
101
102        self.assertEqual(env.GetNumValues(), 2)
103
104        self.assertEqualEntries(env, ["FOO=", "BAR=foo"])
105
106        # Make sure modifications work
107        self.assertFalse(env.Set("FOO", "bar", overwrite=False))
108        self.assertEqual(env.Get("FOO"), "")
109
110        env.PutEntry("FOO=bar")
111        self.assertEqual(env.Get("FOO"), "bar")
112
113        self.assertEqualEntries(env, ["FOO=bar", "BAR=foo"])
114
115        # Make sure we can unset
116        self.assertTrue(env.Unset("FOO"))
117        self.assertFalse(env.Unset("FOO"))
118        self.assertEqual(env.Get("FOO"), None)
119
120        # Test SetEntries
121        entries = lldb.SBStringList()
122        entries.AppendList(["X=x", "Y=y"], 2)
123
124        env.SetEntries(entries, append=True)
125        self.assertEqualEntries(env, ["BAR=foo", "X=x", "Y=y"])
126
127        env.SetEntries(entries, append=False)
128        self.assertEqualEntries(env, ["X=x", "Y=y"])
129
130        entries.Clear()
131        entries.AppendList(["X=y", "Y=x"], 2)
132        env.SetEntries(entries, append=True)
133        self.assertEqualEntries(env, ["X=y", "Y=x"])
134
135        # Test clear
136        env.Clear()
137        self.assertEqualEntries(env, [])
138