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    @skipIfRemote # Remote environment not supported.
34    def test_platform_environment(self):
35        env = self.dbg.GetSelectedPlatform().GetEnvironment()
36        # We assume at least PATH is set
37        self.assertNotEqual(env.Get("PATH"), None)
38
39
40    def test_launch_info(self):
41        target = self.dbg.CreateTarget("")
42        launch_info = target.GetLaunchInfo()
43        env = launch_info.GetEnvironment()
44        env_count = env.GetNumValues()
45
46        env.Set("FOO", "bar", overwrite=True)
47        self.assertEqual(env.GetNumValues(), env_count + 1)
48
49        # Make sure we only modify the copy of the launchInfo's environment
50        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count)
51
52        launch_info.SetEnvironment(env, append=True)
53        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count + 1)
54
55        env.Set("FOO", "baz", overwrite=True)
56        launch_info.SetEnvironment(env, append=True)
57        self.assertEqual(launch_info.GetEnvironment().GetNumValues(), env_count + 1)
58        self.assertEqual(launch_info.GetEnvironment().Get("FOO"), "baz")
59
60        # Make sure we can replace the launchInfo's environment
61        env.Clear()
62        env.Set("BAR", "foo", overwrite=True)
63        env.PutEntry("X=y")
64        launch_info.SetEnvironment(env, append=False)
65        self.assertEqualEntries(launch_info.GetEnvironment(), ["BAR=foo", "X=y"])
66
67
68    @skipIfRemote # Remote environment not supported.
69    def test_target_environment(self):
70        env = self.dbg.GetSelectedTarget().GetEnvironment()
71        # There is no target, so env should be empty
72        self.assertEqual(env.GetNumValues(), 0)
73        self.assertEqual(env.Get("PATH"), None)
74
75        target = self.dbg.CreateTarget("")
76        env = target.GetEnvironment()
77        path = env.Get("PATH")
78        # Now there's a target, so at least PATH should exist
79        self.assertNotEqual(path, None)
80
81        # Make sure we are getting a copy by modifying the env we just got
82        env.PutEntry("PATH=#" + path)
83        self.assertEqual(target.GetEnvironment().Get("PATH"), path)
84
85    def test_creating_and_modifying_environment(self):
86        env = lldb.SBEnvironment()
87
88        self.assertEqual(env.Get("FOO"), None)
89        self.assertEqual(env.Get("BAR"), None)
90
91        # We also test empty values
92        self.assertTrue(env.Set("FOO", "", overwrite=False))
93        env.Set("BAR", "foo", overwrite=False)
94
95        self.assertEqual(env.Get("FOO"), "")
96        self.assertEqual(env.Get("BAR"), "foo")
97
98        self.assertEqual(env.GetNumValues(), 2)
99
100        self.assertEqualEntries(env, ["FOO=", "BAR=foo"])
101
102        # Make sure modifications work
103        self.assertFalse(env.Set("FOO", "bar", overwrite=False))
104        self.assertEqual(env.Get("FOO"), "")
105
106        env.PutEntry("FOO=bar")
107        self.assertEqual(env.Get("FOO"), "bar")
108
109        self.assertEqualEntries(env, ["FOO=bar", "BAR=foo"])
110
111        # Make sure we can unset
112        self.assertTrue(env.Unset("FOO"))
113        self.assertFalse(env.Unset("FOO"))
114        self.assertEqual(env.Get("FOO"), None)
115
116        # Test SetEntries
117        entries = lldb.SBStringList()
118        entries.AppendList(["X=x", "Y=y"], 2)
119
120        env.SetEntries(entries, append=True)
121        self.assertEqualEntries(env, ["BAR=foo", "X=x", "Y=y"])
122
123        env.SetEntries(entries, append=False)
124        self.assertEqualEntries(env, ["X=x", "Y=y"])
125
126        entries.Clear()
127        entries.AppendList(["X=y", "Y=x"], 2)
128        env.SetEntries(entries, append=True)
129        self.assertEqualEntries(env, ["X=y", "Y=x"])
130
131        # Test clear
132        env.Clear()
133        self.assertEqualEntries(env, [])
134