Fix debug build missing symbols and other related issues

Jonas Thiem · Jonas Thiem · commit 550f2d14b13d · 2019-06-16T19:56:40.000+02:00
- fixes that a debug (non-`--release`) `.apk` build won't actually enable gdb debugging in the manifest
- renames `build.py`'s `parse_args` to `parse_args_and_make_package` because that is what it appears to be actually doing 😄
- makes SDL2 and any standard `NDKRecipe` build with `NDK_DEBUG=1` when `--release` is not specified to add debugging symbols
diff --git a/pythonforandroid/bootstraps/common/build/build.py b/pythonforandroid/bootstraps/common/build/build.py
@@ -488,7 +488,8 @@ def make_package(args):
         "args": args,
         "service": service,
         "service_names": service_names,
-        "android_api": android_api
+        "android_api": android_api,
+        "debug": "debug" in args.build_mode,
     }
     if get_bootstrap_name() == "sdl2":
         render_args["url_scheme"] = url_scheme
@@ -576,7 +577,7 @@ def make_package(args):
                     raise e
 
 
-def parse_args(args=None):
+def parse_args_and_make_package(args=None):
     global BLACKLIST_PATTERNS, WHITELIST_PATTERNS, PYTHON
 
     # Get the default minsdk, equal to the NDK API that this dist is built against
@@ -676,6 +677,10 @@ def parse_args(args=None):
                     default=join(curdir, 'whitelist.txt'),
                     help=('Use a whitelist file to prevent blacklisting of '
                           'file in the final APK'))
+    ap.add_argument('--release', dest='build_mode', action='store_const',
+                    const='release', default='debug',
+                    help='Build your app as a non-debug release build. '
+                         '(Disables gdb debugging among other things)')
     ap.add_argument('--add-jar', dest='add_jar', action='append',
                     help=('Add a Java .jar to the libs, so you can access its '
                           'classes with pyjnius. You can specify this '
@@ -820,4 +825,4 @@ def _read_configuration():
 
 
 if __name__ == "__main__":
-    parse_args()
+    parse_args_and_make_package()
diff --git a/pythonforandroid/bootstraps/sdl2/build/templates/AndroidManifest.tmpl.xml b/pythonforandroid/bootstraps/sdl2/build/templates/AndroidManifest.tmpl.xml
@@ -52,6 +52,7 @@
          An example Java class can be found in README-android.txt
     -->
     <application android:label="@string/app_name"
+                 {% if debug %}android:debuggable="true"{% endif %}
                  android:icon="@drawable/icon"
                  android:allowBackup="{{ args.allow_backup }}"
                  android:theme="@android:style/Theme.NoTitleBar{% if not args.window %}.Fullscreen{% endif %}"
diff --git a/pythonforandroid/build.py b/pythonforandroid/build.py
@@ -517,7 +517,7 @@ def not_has_package(self, name, arch=None):
 
 
 def build_recipes(build_order, python_modules, ctx, project_dir,
-                  ignore_project_setup_py=False
+                  ignore_project_setup_py=False, debug_build=False,
                  ):
     # Put recipes in correct build order
     info_notify("Recipe build order is {}".format(build_order))
@@ -527,7 +527,10 @@ def build_recipes(build_order, python_modules, ctx, project_dir,
             ('The requirements ({}) were not found as recipes, they will be '
              'installed with pip.').format(', '.join(python_modules)))
 
-    recipes = [Recipe.get_recipe(name, ctx) for name in build_order]
+    recipes = [
+        Recipe.get_recipe(name, ctx, build_as_debuggable=debug_build)
+        for name in build_order
+    ]
 
     # download is arch independent
     info_main('# Downloading recipes ')
diff --git a/pythonforandroid/recipe.py b/pythonforandroid/recipe.py
@@ -106,6 +106,10 @@ class Recipe(with_metaclass(RecipeMeta)):
 
     archs = ['armeabi']  # Not currently implemented properly
 
+    build_as_debuggable = False
+    ''' Whether to build with debugging symbols, e.g. NDK_DEBUG=1 for
+        NDK-based recipes '''
+
     @property
     def version(self):
         key = 'VERSION_' + self.name
@@ -577,12 +581,13 @@ def list_recipes(cls, ctx):
                         yield name
 
     @classmethod
-    def get_recipe(cls, name, ctx):
+    def get_recipe(cls, name, ctx, build_as_debuggable=False):
         '''Returns the Recipe with the given name, if it exists.'''
         name = name.lower()
         if not hasattr(cls, "recipes"):
             cls.recipes = {}
         if name in cls.recipes:
+            cls.recipes[name].build_as_debuggable = build_as_debuggable
             return cls.recipes[name]
 
         recipe_file = None
@@ -607,6 +612,7 @@ def get_recipe(cls, name, ctx):
         if len(logger.handlers) > 1:
             logger.removeHandler(logger.handlers[1])
         recipe = mod.recipe
+        recipe.build_as_debuggable = build_as_debuggable
         recipe.ctx = ctx
         cls.recipes[name.lower()] = recipe
         return recipe
@@ -695,6 +701,7 @@ def build_arch(self, arch, *extra_args):
             shprint(
                 sh.ndk_build,
                 'V=1',
+                'NDK_DEBUG=' + ("1" if self.build_as_debuggable else "0"),
                 'APP_PLATFORM=android-' + str(self.ctx.ndk_api),
                 'APP_ABI=' + arch.arch,
                 *extra_args, _env=env
diff --git a/pythonforandroid/recipes/sdl2/__init__.py b/pythonforandroid/recipes/sdl2/__init__.py
@@ -22,7 +22,12 @@ def build_arch(self, arch):
         env = self.get_recipe_env(arch)
 
         with current_directory(self.get_jni_dir()):
-            shprint(sh.ndk_build, "V=1", _env=env)
+            shprint(
+                sh.ndk_build,
+                "V=1",
+                "NDK_DEBUG=" + ("1" if self.build_as_debuggable else "0"),
+                _env=env
+            )
 
 
 recipe = LibSDL2Recipe()
diff --git a/pythonforandroid/toolchain.py b/pythonforandroid/toolchain.py
@@ -193,6 +193,10 @@ def build_dist_from_args(ctx, dist, args):
         ctx.recipe_build_order))
     info('Dist will also contain modules ({}) installed from pip'.format(
         ', '.join(ctx.python_modules)))
+    if args.build_mode == "debug":
+        info('Building WITH debugging symbols (no --release option used')
+    else:
+        info('Building WITHOUT debugging symbols (--release option used)')
 
     ctx.dist_name = bs.distribution.name
     ctx.prepare_bootstrap(bs)
@@ -204,6 +208,7 @@ def build_dist_from_args(ctx, dist, args):
                   ignore_project_setup_py=getattr(
                       args, "ignore_setup_py", False
                   ),
+                  debug_build=(args.build_mode == "debug"),
                  )
 
     ctx.bootstrap.run_distribute()
@@ -495,7 +500,8 @@ def add_parser(subparsers, *args, **kwargs):
         parser_apk.add_argument(
             '--release', dest='build_mode', action='store_const',
             const='release', default='debug',
-            help='Build the PARSER_APK. in Release mode')
+            help='Build your app as a non-debug release build. '
+                 '(Disables gdb debugging among other things)')
         parser_apk.add_argument(
             '--use-setup-py', dest="use_setup_py",
             action='store_true', default=False,
@@ -571,6 +577,8 @@ def add_parser(subparsers, *args, **kwargs):
         if hasattr(args, "private") and args.private is not None:
             # Pass this value on to the internal bootstrap build.py:
             args.unknown_args += ["--private", args.private]
+        if args.build_mode == "release":
+            args.unknown_args += ["--release"]
         if hasattr(args, "ignore_setup_py") and args.ignore_setup_py:
             args.use_setup_py = False
 
@@ -944,7 +952,9 @@ def apk(self, args):
         with current_directory(dist.dist_dir):
             self.hook("before_apk_build")
             os.environ["ANDROID_API"] = str(self.ctx.android_api)
-            build_args = build.parse_args(args.unknown_args)
+            build_args = build.parse_args_and_make_package(
+                args.unknown_args
+            )
             self.hook("after_apk_build")
             self.hook("before_apk_assemble")
 
@@ -994,7 +1004,9 @@ def apk(self, args):
                     gradle_task = "assembleRelease"
                 else:
                     raise BuildInterruptingException(
-                        "Unknown build mode {} for apk()".format(args.build_mode))
+                        "Unknown release type {} for apk()".
+                        format(args.build_mode)
+                    )
                 output = shprint(gradlew, gradle_task, _tail=20,
                                  _critical=True, _env=env)
 
