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