Fix CPPDEFINES problems with dicts (both Append and MergeFlags). From Jean-Baptiste Lab. Fixes issue #2671.

3 files changed, 325 insertions, 2 deletions

diff --git a/test/CPPDEFINES/append.py b/test/CPPDEFINES/append.py
new file mode 100644
index 00000000..92b113c4
--- /dev/null
+++ b/test/CPPDEFINES/append.py
@@ -0,0 +1,223 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify appending to CPPPDEFINES with various data types.
+See also pkg-config.py in this dir.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('SConstruct', """\
+env_1738_2 = Environment()
+env_1738_2['CPPDEFINES'] = ['FOO']
+env_1738_2.Append(CPPDEFINES={'value' : '1'})
+print env_1738_2.subst('$_CPPDEFFLAGS')
+#env_1738_2.Object('test_1738_2', 'main.c')
+
+# http://scons.tigris.org/issues/show_bug.cgi?id=2300
+env_2300_1 = DefaultEnvironment(CPPDEFINES = 'foo')
+env_2300_1.Append(CPPDEFINES='bar')
+print env_2300_1.subst('$_CPPDEFFLAGS')
+#env_2300_1.Object('test_2300_1', 'main.c')
+
+env_2300_2 = DefaultEnvironment(CPPDEFINES = ['foo']) # note the list
+env_2300_2.Append(CPPDEFINES='bar')
+print env_2300_2.subst('$_CPPDEFFLAGS')
+#env_2300_2.Object('test_2300_2', 'main.c')
+
+# http://scons.tigris.org/issues/show_bug.cgi?id=1152
+cases=[('string', 'FOO'),
+       ('list', ['NAME1', 'NAME2']),
+       ('list-of-2lists', [('NAME1','VAL1'), ['NAME2','VAL2']]),
+       ('dict', {'NAME1' : 'VAL1', 'NAME2' : 'VAL2'})
+       ]
+
+for (t1, c1) in cases:
+    for (t2, c2) in cases:
+        print "==== Testing CPPDEFINES, appending a %s to a %s"%(t2, t1)
+        print "   orig = %s, append = %s"%(c1, c2)
+        env=Environment(CPPDEFINES = c1)
+        env.Append(CPPDEFINES = c2)
+        final=env.subst('$_CPPDEFFLAGS',source="src", target="tgt")
+        print 'Append: \\n\\tresult=%s\\n\\tfinal=%s'%\\
+              (env['CPPDEFINES'], final)
+        env=Environment(CPPDEFINES = c1)
+        env.AppendUnique(CPPDEFINES = c2)
+        final=env.subst('$_CPPDEFFLAGS',source="src", target="tgt")
+        print 'AppendUnique:\\n\\tresult=%s\\n\\tfinal=%s'%\\
+              (env['CPPDEFINES'], final)
+""")
+
+
+expect_print_output="""\
+-DFOO -Dvalue=1
+-Dfoo -Dbar
+-Dfoo -Dbar -Dbar
+==== Testing CPPDEFINES, appending a string to a string
+   orig = FOO, append = FOO
+Append: 
+	result=['FOO', 'FOO']
+	final=-DFOO -DFOO
+AppendUnique:
+	result=['FOO']
+	final=-DFOO
+==== Testing CPPDEFINES, appending a list to a string
+   orig = FOO, append = ['NAME1', 'NAME2']
+Append: 
+	result=['FOO', 'NAME1', 'NAME2']
+	final=-DFOO -DNAME1 -DNAME2
+AppendUnique:
+	result=[('FOO',), ('NAME1',), ('NAME2',)]
+	final=-DFOO -DNAME1 -DNAME2
+==== Testing CPPDEFINES, appending a list-of-2lists to a string
+   orig = FOO, append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+Append: 
+	result=['FOO', ('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+	final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result=[('FOO',), ('NAME1', 'VAL1'), ('NAME2', 'VAL2')]
+	final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2
+==== Testing CPPDEFINES, appending a dict to a string
+   orig = FOO, append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+Append: 
+	result=['FOO', {'NAME2': 'VAL2', 'NAME1': 'VAL1'}]
+	final=-DFOO -DNAME2=VAL2 -DNAME1=VAL1
+AppendUnique:
+	result=['FOO', ('NAME2', 'VAL2'), ('NAME1', 'VAL1')]
+	final=-DFOO -DNAME2=VAL2 -DNAME1=VAL1
+==== Testing CPPDEFINES, appending a string to a list
+   orig = ['NAME1', 'NAME2'], append = FOO
+Append: 
+	result=['NAME1', 'NAME2', 'FOO']
+	final=-DNAME1 -DNAME2 -DFOO
+AppendUnique:
+	result=[('NAME1',), ('NAME2',), ('FOO',)]
+	final=-DNAME1 -DNAME2 -DFOO
+==== Testing CPPDEFINES, appending a list to a list
+   orig = ['NAME1', 'NAME2'], append = ['NAME1', 'NAME2']
+Append: 
+	result=['NAME1', 'NAME2', 'NAME1', 'NAME2']
+	final=-DNAME1 -DNAME2 -DNAME1 -DNAME2
+AppendUnique:
+	result=[('NAME1',), ('NAME2',)]
+	final=-DNAME1 -DNAME2
+==== Testing CPPDEFINES, appending a list-of-2lists to a list
+   orig = ['NAME1', 'NAME2'], append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+Append: 
+	result=['NAME1', 'NAME2', ('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+	final=-DNAME1 -DNAME2 -DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result=[('NAME1',), ('NAME2',), ('NAME1', 'VAL1'), ('NAME2', 'VAL2')]
+	final=-DNAME1 -DNAME2 -DNAME1=VAL1 -DNAME2=VAL2
+==== Testing CPPDEFINES, appending a dict to a list
+   orig = ['NAME1', 'NAME2'], append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+Append: 
+	result=['NAME1', 'NAME2', {'NAME2': 'VAL2', 'NAME1': 'VAL1'}]
+	final=-DNAME1 -DNAME2 -DNAME2=VAL2 -DNAME1=VAL1
+AppendUnique:
+	result=[('NAME1',), ('NAME2',), ('NAME2', 'VAL2'), ('NAME1', 'VAL1')]
+	final=-DNAME1 -DNAME2 -DNAME2=VAL2 -DNAME1=VAL1
+==== Testing CPPDEFINES, appending a string to a list-of-2lists
+   orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = FOO
+Append: 
+	result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], 'FOO']
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DFOO
+AppendUnique:
+	result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2'), ('FOO',)]
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DFOO
+==== Testing CPPDEFINES, appending a list to a list-of-2lists
+   orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = ['NAME1', 'NAME2']
+Append: 
+	result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], 'NAME1', 'NAME2']
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1 -DNAME2
+AppendUnique:
+	result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2'), ('NAME1',), ('NAME2',)]
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1 -DNAME2
+==== Testing CPPDEFINES, appending a list-of-2lists to a list-of-2lists
+   orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+Append: 
+	result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], ('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2')]
+	final=-DNAME1=VAL1 -DNAME2=VAL2
+==== Testing CPPDEFINES, appending a dict to a list-of-2lists
+   orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+Append: 
+	result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], {'NAME2': 'VAL2', 'NAME1': 'VAL1'}]
+	final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME2=VAL2 -DNAME1=VAL1
+AppendUnique:
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1')]
+	final=-DNAME2=VAL2 -DNAME1=VAL1
+==== Testing CPPDEFINES, appending a string to a dict
+   orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = FOO
+Append: 
+	result={'FOO': None, 'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+	final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), 'FOO']
+	final=-DNAME2=VAL2 -DNAME1=VAL1 -DFOO
+==== Testing CPPDEFINES, appending a list to a dict
+   orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = ['NAME1', 'NAME2']
+Append: 
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), 'NAME1', 'NAME2']
+	final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1 -DNAME2
+AppendUnique:
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), ('NAME1',), ('NAME2',)]
+	final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1 -DNAME2
+==== Testing CPPDEFINES, appending a list-of-2lists to a dict
+   orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+Append: 
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), ('NAME1', 'VAL1'), ['NAME2', 'VAL2']]
+	final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1')]
+	final=-DNAME2=VAL2 -DNAME1=VAL1
+==== Testing CPPDEFINES, appending a dict to a dict
+   orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+Append: 
+	result={'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+	final=-DNAME1=VAL1 -DNAME2=VAL2
+AppendUnique:
+	result={'NAME2': 'VAL2', 'NAME1': 'VAL1'}
+	final=-DNAME1=VAL1 -DNAME2=VAL2
+"""
+
+build_output="scons: `.' is up to date.\n"
+
+expect = test.wrap_stdout(build_str=build_output, 
+                          read_str = expect_print_output)
+test.run(arguments = '.', stdout=expect)
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
diff --git a/test/CPPDEFINES/basic.py b/test/CPPDEFINES/basic.py
index 4259a243..b54a421d 100644
--- a/test/CPPDEFINES/basic.py
+++ b/test/CPPDEFINES/basic.py
@@ -39,11 +39,11 @@ test_list = [
     ['x', ['y', 123], 'z', ('int', '$INTEGER')],
     { 'c' : 3, 'b': None, 'a' : 1 },
 ]
-env = Environment(CPPDEFPREFIX='-D', CPPDEFSUFFIX='', INTEGER=0)
 for i in test_list:
+    env = Environment(CPPDEFPREFIX='-D', CPPDEFSUFFIX='', INTEGER=0)
     print env.Clone(CPPDEFINES=i).subst('$_CPPDEFFLAGS')
-env = Environment(CPPDEFPREFIX='|', CPPDEFSUFFIX='|', INTEGER=1)
 for i in test_list:
+    env = Environment(CPPDEFPREFIX='|', CPPDEFSUFFIX='|', INTEGER=1)
     print env.Clone(CPPDEFINES=i).subst('$_CPPDEFFLAGS')
 """)
 
diff --git a/test/CPPDEFINES/pkg-config.py b/test/CPPDEFINES/pkg-config.py
new file mode 100644
index 00000000..f59b3b06
--- /dev/null
+++ b/test/CPPDEFINES/pkg-config.py
@@ -0,0 +1,100 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify merging with MergeFlags to CPPPDEFINES with various data types.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('bug.pc', """\
+prefix=/usr
+exec_prefix=${prefix}
+libdir=${exec_prefix}/lib
+includedir=${prefix}/include
+
+Name: bug
+Description: A test case .pc file
+Version: 1.2
+Cflags: -DSOMETHING -DVARIABLE=2
+""")
+
+test.write('main.c', """\
+int main(int argc, char *argv[])
+{
+  return 0;
+}
+""")
+
+test.write('SConstruct', """\
+# http://scons.tigris.org/issues/show_bug.cgi?id=2671
+# Passing test cases
+env_1 = Environment(CPPDEFINES=[('DEBUG','1'), 'TEST'])
+env_1.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags bug')
+print env_1.subst('$_CPPDEFFLAGS')
+
+env_2 = Environment(CPPDEFINES=[('DEBUG','1'), 'TEST'])
+env_2.MergeFlags('-DSOMETHING -DVARIABLE=2')
+print env_2.subst('$_CPPDEFFLAGS')
+
+# Failing test cases
+env_3 = Environment(CPPDEFINES={'DEBUG':1, 'TEST':None})
+env_3.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags bug')
+print env_3.subst('$_CPPDEFFLAGS')
+
+env_4 = Environment(CPPDEFINES={'DEBUG':1, 'TEST':None})
+env_4.MergeFlags('-DSOMETHING -DVARIABLE=2')
+print env_4.subst('$_CPPDEFFLAGS')
+
+# http://scons.tigris.org/issues/show_bug.cgi?id=1738
+env_1738_1 = Environment(tools=['default'])
+env_1738_1.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags --libs bug')
+env_1738_1.Append(CPPDEFINES={'value' : '1'})
+print env_1738_1.subst('$_CPPDEFFLAGS')
+""")
+
+expect_print_output="""\
+-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2
+-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2
+-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2
+-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2
+-DSOMETHING -DVARIABLE=2 -Dvalue=1
+"""
+
+build_output="scons: `.' is up to date.\n"
+
+expect = test.wrap_stdout(build_str=build_output, 
+                          read_str = expect_print_output)
+test.run(arguments = '.', stdout=expect)
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: