generalize the fix for #3164

Add a new flag, X_RPM_EXTRADEFS, which lets the user supply
any additional flag lines needed in the specfile. If the
tag is not present in the specfile, supply a value which
turns off debug package generation. To retain debug package
generation, supply the flag with a value of None, or with
a list that does not include the disable value.

So like the previous change the default is now not to
generate debug, but that default can be overridden, and it
is documented.

10 files changed, 72 insertions, 59 deletions

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 8be3bbe..8c5b90a 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -121,9 +121,12 @@ RELEASE 3.1.0.alpha.yyyymmdd - NEW DATE WILL BE INSERTED HERE
     - fix tests specifying octal constants for py3
     - fix must_contain tests for py3
     - rpm package generation: fix supplying a build architecture; disable
-      auto debug package generation on certain rpmbuild versions; adjust some tests
-      to be resistant to automatic supplying of build-id file on certain rpmbuild
-      versions; a little doc and comment cleanup.
+      auto debug package generation on certain rpmbuild versions; adjust some
+      tests to be resistant to automatic supplying of build-id file on
+      certain rpmbuild versions; tests now use a file fixture for the 
+      repeated (trivial) main.c program. A little doc and comment cleanup.
+      A new tag is added, X_RPM_EXTRADEFS, to allow supplying custom settings
+      to the specfile without adding specific logic for each one to scons.
     
   From Hao Wu
     - typo in customized decider example in user guide 
diff --git a/src/engine/SCons/Tool/packaging/__init__.xml b/src/engine/SCons/Tool/packaging/__init__.xml
index 68e4fed..348b2be 100644
--- a/src/engine/SCons/Tool/packaging/__init__.xml
+++ b/src/engine/SCons/Tool/packaging/__init__.xml
@@ -471,6 +471,38 @@ field in the RPM
 </summary>
 </cvar>
 
+<cvar name="X_RPM_EXTRADEFS">
+<summary>
+<para>
+A list used to supply extra defintions or flags
+to be added to the RPM <filename>.spec<filename> file.
+Each item is added as-is with a carriage return appended.
+This is useful if some specific RPM feature not otherwise
+anticipated by SCons needs to be turned on or off.
+Note if this variable is omitted, SCons will by
+default supply the value
+<literal>'%global debug_package %{nil}'</literal>
+to disable debug package generation.
+To enable debug package generation, include this
+variable set either to None, or to a custom
+list that does not include the default line.
+Added in version 3.1.
+</para>
+
+<example_commands>
+env.Package(
+    NAME             = 'foo',
+...
+    X_RPM_EXTRADEFS = [
+        '%define _unpackaged_files_terminate_build 0'
+        '%define _missing_doc_files_terminate_build 0'
+    ],
+... )
+</example_commands>
+
+</summary>
+</cvar>
+
 <cvar name="X_RPM_GROUP">
 <summary>
 <para>
diff --git a/src/engine/SCons/Tool/packaging/rpm.py b/src/engine/SCons/Tool/packaging/rpm.py
index e93c4f0..0a4db6c 100644
--- a/src/engine/SCons/Tool/packaging/rpm.py
+++ b/src/engine/SCons/Tool/packaging/rpm.py
@@ -198,7 +198,8 @@ def build_specfile_header(spec):
         'PACKAGEVERSION' : '%%define release %s\nRelease: %%{release}\n',
         'X_RPM_GROUP'    : 'Group: %s\n',
         'SUMMARY'        : 'Summary: %s\n',
-        'LICENSE'        : 'License: %s\n', }
+        'LICENSE'        : 'License: %s\n',
+    }
 
     str = str + SimpleTagCompiler(mandatory_header_fields).compile( spec )
 
@@ -227,7 +228,8 @@ def build_specfile_header(spec):
         'X_RPM_PREFIX'        : 'Prefix: %s\n',
 
         # internal use
-        'X_RPM_BUILDROOT'     : 'BuildRoot: %s\n', }
+        'X_RPM_BUILDROOT'     : 'BuildRoot: %s\n',
+    }
 
     # fill in default values:
     # Adding a BuildRequires renders the .rpm unbuildable under systems which
@@ -241,11 +243,17 @@ def build_specfile_header(spec):
 
     str = str + SimpleTagCompiler(optional_header_fields, mandatory=0).compile( spec )
 
+    # Add any extra specfile definitions the user may have supplied.
+    # These flags get no processing, they are just added.
     # github #3164: if we don't turn off debug package generation
-    # the tests which build packages all fail.  This just slams
-    # a flag into the specfile header, could make it an X_RPM_NODEBUGPKGS
-    # which is controllable by an environment setting.
-    str += '%global debug_package %{nil}\n'
+    # the tests which build packages all fail.  If there are no
+    # extra flags, default to adding this one. If the user wants
+    # to turn this back on, supply the flag set to None.
+
+    if 'X_RPM_EXTRADEFS' not in spec:
+        spec['X_RPM_EXTRADEFS'] = ['%global debug_package %{nil}']
+    for extra in spec['X_RPM_EXTRADEFS']:
+        str += extra + '\n'
 
     return str
 
diff --git a/test/packaging/rpm/cleanup.py b/test/packaging/rpm/cleanup.py
index b77dfd1..7483750 100644
--- a/test/packaging/rpm/cleanup.py
+++ b/test/packaging/rpm/cleanup.py
@@ -28,6 +28,7 @@ __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 Assert that files created by the RPM packager will be removed by 'scons -c'.
 """
 
+import os
 import TestSCons
 import SCons.Tool.rpmutils
 
@@ -47,13 +48,8 @@ if not rpm:
 rpm_build_root = test.workpath('rpm_build_root')
 
 test.subdir('src')
-
-test.write( [ 'src', 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath, mainpath)
 
 test.write('SConstruct', """
 env=Environment(tools=['default', 'packaging'])
diff --git a/test/packaging/rpm/explicit-target.py b/test/packaging/rpm/explicit-target.py
index c383b57..e8fbd39 100644
--- a/test/packaging/rpm/explicit-target.py
+++ b/test/packaging/rpm/explicit-target.py
@@ -28,6 +28,7 @@ __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 Test the ability to create a rpm package from a explicit target name.
 """
 
+import os
 import TestSCons
 
 _python_ = TestSCons._python_
@@ -44,13 +45,8 @@ if not rpm:
 rpm_build_root = test.workpath('rpm_build_root')
 
 test.subdir('src')
-
-test.write( [ 'src', 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath, mainpath)
 
 test.write('SConstruct', """
 import os
diff --git a/test/packaging/rpm/internationalization.py b/test/packaging/rpm/internationalization.py
index 2ef0dfd..ad77f40 100644
--- a/test/packaging/rpm/internationalization.py
+++ b/test/packaging/rpm/internationalization.py
@@ -33,7 +33,6 @@ These are x-rpm-Group, description, summary and the lang_xx file tag.
 
 import os
 import SCons.Tool.rpmutils
-
 import TestSCons
 
 _python_ = TestSCons._python_
@@ -52,12 +51,7 @@ rpm_build_root = test.workpath('rpm_build_root')
 #
 # test INTERNATIONAL PACKAGE META-DATA
 #
-test.write( [ 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+test.file_fixture('src/main.c', 'main.c')
 
 test.write('SConstruct', """
 # -*- coding: utf-8 -*-
@@ -123,13 +117,8 @@ test.fail_test( out != 'Application/office-hello-this should be really long' )
 #
 # test INTERNATIONAL PACKAGE TAGS
 #
-
-test.write( [ 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath)
 
 test.write( ['man.de'], '' )
 test.write( ['man.en'], '' )
diff --git a/test/packaging/rpm/multipackage.py b/test/packaging/rpm/multipackage.py
index f756cf4..fd67a09 100644
--- a/test/packaging/rpm/multipackage.py
+++ b/test/packaging/rpm/multipackage.py
@@ -47,13 +47,8 @@ if not rpm:
 rpm_build_root = test.workpath('rpm_build_root')
 
 test.subdir('src')
-
-test.write( [ 'src', 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath, mainpath)
 
 test.write('SConstruct', """
 import os
diff --git a/test/packaging/rpm/package.py b/test/packaging/rpm/package.py
index 6723a9f..2ba66b9 100644
--- a/test/packaging/rpm/package.py
+++ b/test/packaging/rpm/package.py
@@ -46,13 +46,8 @@ if not rpm:
 rpm_build_root = test.workpath('rpm_build_root')
 
 test.subdir('src')
-
-test.write( [ 'src', 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-  return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath, mainpath)
 
 test.write('SConstruct', """
 import os
diff --git a/test/packaging/rpm/src/main.c b/test/packaging/rpm/src/main.c
new file mode 100644
index 0000000..49e8969
--- /dev/null
+++ b/test/packaging/rpm/src/main.c
@@ -0,0 +1,5 @@
+
+int main( int argc, char* argv[] )
+{
+  return 0;
+}
diff --git a/test/packaging/rpm/tagging.py b/test/packaging/rpm/tagging.py
index 15f82a7..b685c91 100644
--- a/test/packaging/rpm/tagging.py
+++ b/test/packaging/rpm/tagging.py
@@ -30,7 +30,6 @@ Test the ability to add file tags
 
 import os
 import SCons.Tool.rpmutils
-
 import TestSCons
 
 _python_ = TestSCons._python_
@@ -50,13 +49,8 @@ rpm_build_root = test.workpath('rpm_build_root')
 # Test adding an attr tag to the built program.
 #
 test.subdir('src')
-
-test.write( [ 'src', 'main.c' ], r"""
-int main( int argc, char* argv[] )
-{
-return 0;
-}
-""")
+mainpath = os.path.join('src', 'main.c')
+test.file_fixture(mainpath, mainpath)
 
 test.write('SConstruct', """
 import os