[recommendations] Refactor important log messages

So it will be easier for us to maintain the tests for recommendations module

Author: opacam

pythonforandroid/recommendations.py

@@ -9,9 +9,38 @@
 MIN_NDK_VERSION = 17
 MAX_NDK_VERSION = 17
 
-RECOMMENDED_NDK_VERSION = '17c'
+RECOMMENDED_NDK_VERSION = "17c"
+NDK_DOWNLOAD_URL = "https://developer.android.com/ndk/downloads/"
+
+# Important log messages
 NEW_NDK_MESSAGE = 'Newer NDKs may not be fully supported by p4a.'
-NDK_DOWNLOAD_URL = 'https://developer.android.com/ndk/downloads/'
+UNKNOWN_NDK_MESSAGE = (
+    'Could not determine NDK version, no source.properties in the NDK dir'
+)
+PARSE_ERROR_NDK_MESSAGE = (
+    'Could not parse $NDK_DIR/source.properties, not checking NDK version'
+)
+READ_ERROR_NDK_MESSAGE = (
+    'Unable to read the NDK version from the given directory {ndk_dir}'
+)
+ENSURE_RIGHT_NDK_MESSAGE = (
+    'Make sure your NDK version is greater than {min_supported}. If you get '
+    'build errors, download the recommended NDK {rec_version} from {ndk_url}'
+)
+NDK_LOWER_THAN_SUPPORTED_MESSAGE = (
+    'The minimum supported NDK version is {min_supported}. '
+    'You can download it from {ndk_url}'
+)
+UNSUPPORTED_NDK_API_FOR_ARMEABI_MESSAGE = (
+    'Asked to build for armeabi architecture with API '
+    '{req_ndk_api}, but API {max_ndk_api} or greater does not support armeabi'
+)
+CURRENT_NDK_VERSION_MESSAGE = (
+    'Found NDK version {ndk_version}'
+)
+RECOMMENDED_NDK_VERSION_MESSAGE = (
+    'Maximum recommended NDK version is {recommended_ndk_version}'
+)
 
 
 def check_ndk_version(ndk_dir):
@@ -29,14 +58,9 @@ def check_ndk_version(ndk_dir):
     version = read_ndk_version(ndk_dir)
 
     if version is None:
+        warning(READ_ERROR_NDK_MESSAGE.format(ndk_dir=ndk_dir))
         warning(
-            'Unable to read the NDK version from the given directory '
-            '{}'.format(ndk_dir)
-        )
-        warning(
-            "Make sure your NDK version is greater than {min_supported}. "
-            "If you get build errors, download the recommended NDK "
-            "{rec_version} from {ndk_url}".format(
+            ENSURE_RIGHT_NDK_MESSAGE.format(
                 min_supported=MIN_NDK_VERSION,
                 rec_version=RECOMMENDED_NDK_VERSION,
                 ndk_url=NDK_DOWNLOAD_URL,
@@ -60,13 +84,12 @@ def check_ndk_version(ndk_dir):
         major_version=major_version, letter_version=letter_version
     )
 
-    info('Found NDK version {}'.format(string_version))
+    info(CURRENT_NDK_VERSION_MESSAGE.format(ndk_version=string_version))
 
     if major_version < MIN_NDK_VERSION:
         raise BuildInterruptingException(
-            'The minimum supported NDK version is {min_supported}. You can '
-            'download it from {ndk_url}'.format(
-                min_supported=MIN_NDK_VERSION, ndk_url=NDK_DOWNLOAD_URL,
+            NDK_LOWER_THAN_SUPPORTED_MESSAGE.format(
+                min_supported=MIN_NDK_VERSION, ndk_url=NDK_DOWNLOAD_URL
             ),
             instructions=(
                 'Please, go to the android NDK page ({ndk_url}) and download a'
@@ -79,8 +102,8 @@ def check_ndk_version(ndk_dir):
         )
     elif major_version > MAX_NDK_VERSION:
         warning(
-            'Maximum recommended NDK version is {}'.format(
-                RECOMMENDED_NDK_VERSION
+            RECOMMENDED_NDK_VERSION_MESSAGE.format(
+                recommended_ndk_version=RECOMMENDED_NDK_VERSION
             )
         )
         warning(NEW_NDK_MESSAGE)
@@ -92,16 +115,14 @@ def read_ndk_version(ndk_dir):
         with open(join(ndk_dir, 'source.properties')) as fileh:
             ndk_data = fileh.read()
     except IOError:
-        info('Could not determine NDK version, no source.properties '
-             'in the NDK dir')
+        info(UNKNOWN_NDK_MESSAGE)
         return
 
     for line in ndk_data.split('\n'):
         if line.startswith('Pkg.Revision'):
             break
     else:
-        info('Could not parse $NDK_DIR/source.properties, not checking '
-             'NDK version')
+        info(PARSE_ERROR_NDK_MESSAGE)
         return
 
     # Line should have the form "Pkg.Revision = ..."
@@ -130,9 +151,9 @@ def check_target_api(api, arch):
 
     if api >= ARMEABI_MAX_TARGET_API and arch == 'armeabi':
         raise BuildInterruptingException(
-            'Asked to build for armeabi architecture with API '
-            '{}, but API {} or greater does not support armeabi'.format(
-                api, ARMEABI_MAX_TARGET_API),
+            UNSUPPORTED_NDK_API_FOR_ARMEABI_MESSAGE.format(
+                req_ndk_api=api, max_ndk_api=ARMEABI_MAX_TARGET_API
+            ),
             instructions='You probably want to build with --arch=armeabi-v7a instead')
 
     if api < MIN_TARGET_API:
@@ -143,14 +164,19 @@ def check_target_api(api, arch):
 MIN_NDK_API = 21
 RECOMMENDED_NDK_API = 21
 OLD_NDK_API_MESSAGE = ('NDK API less than {} is not supported'.format(MIN_NDK_API))
+TARGET_NDK_API_GREATER_THAN_TARGET_API_MESSAGE = (
+    'Target NDK API is {ndk_api}, '
+    'higher than the target Android API {android_api}.'
+)
 
 
 def check_ndk_api(ndk_api, android_api):
     """Warn if the user's NDK is too high or low."""
     if ndk_api > android_api:
         raise BuildInterruptingException(
-            'Target NDK API is {}, higher than the target Android API {}.'.format(
-                ndk_api, android_api),
+            TARGET_NDK_API_GREATER_THAN_TARGET_API_MESSAGE.format(
+                ndk_api=ndk_api, android_api=android_api
+            ),
             instructions=('The NDK API is a minimum supported API number and must be lower '
                           'than the target Android API'))
 

tests/test_recommendations.py

@@ -21,8 +21,21 @@
     NDK_DOWNLOAD_URL,
     ARMEABI_MAX_TARGET_API,
     MIN_TARGET_API,
+    UNKNOWN_NDK_MESSAGE,
+    PARSE_ERROR_NDK_MESSAGE,
+    READ_ERROR_NDK_MESSAGE,
+    ENSURE_RIGHT_NDK_MESSAGE,
+    NDK_LOWER_THAN_SUPPORTED_MESSAGE,
+    UNSUPPORTED_NDK_API_FOR_ARMEABI_MESSAGE,
+    CURRENT_NDK_VERSION_MESSAGE,
+    RECOMMENDED_NDK_VERSION_MESSAGE,
+    TARGET_NDK_API_GREATER_THAN_TARGET_API_MESSAGE,
+    OLD_NDK_API_MESSAGE,
+    NEW_NDK_MESSAGE,
+    OLD_API_MESSAGE,
 )
 from pythonforandroid.util import BuildInterruptingException
+
 running_in_py2 = int(py_version[0]) < 3
 
 
@@ -45,15 +58,17 @@ def test_check_ndk_version_greater_than_recommended(self, mock_read_ndk):
         self.assertEqual(
             cm.output,
             [
-                "INFO:p4a:[INFO]:    Found NDK version {ndk_current}".format(
-                    ndk_current=MAX_NDK_VERSION + 1
+                "INFO:p4a:[INFO]:    {}".format(
+                    CURRENT_NDK_VERSION_MESSAGE.format(
+                        ndk_version=MAX_NDK_VERSION + 1
+                    )
                 ),
-                "WARNING:p4a:[WARNING]:"
-                " Maximum recommended NDK version is {ndk_recommended}".format(
-                    ndk_recommended=RECOMMENDED_NDK_VERSION
+                "WARNING:p4a:[WARNING]: {}".format(
+                    RECOMMENDED_NDK_VERSION_MESSAGE.format(
+                        recommended_ndk_version=RECOMMENDED_NDK_VERSION
+                    )
                 ),
-                "WARNING:p4a:[WARNING]:"
-                " Newer NDKs may not be fully supported by p4a.",
+                "WARNING:p4a:[WARNING]: {}".format(NEW_NDK_MESSAGE),
             ],
         )
 
@@ -64,9 +79,8 @@ def test_check_ndk_version_lower_than_recommended(self, mock_read_ndk):
             check_ndk_version(self.ndk_dir)
         self.assertEqual(
             e.exception.args[0],
-            "Unsupported NDK version detected {ndk_current}"
-            "\n* Note: Minimum supported NDK version is {ndk_min}".format(
-                ndk_current=MIN_NDK_VERSION - 1, ndk_min=MIN_NDK_VERSION
+            NDK_LOWER_THAN_SUPPORTED_MESSAGE.format(
+                min_supported=MIN_NDK_VERSION, ndk_url=NDK_DOWNLOAD_URL
             ),
         )
         mock_read_ndk.assert_called_once_with(self.ndk_dir)
@@ -83,16 +97,17 @@ def test_check_ndk_version_error(self):
         self.assertEqual(
             cm.output,
             [
-                "INFO:p4a:[INFO]:    Could not determine NDK version, "
-                "no source.properties in the NDK dir",
-                "WARNING:p4a:[WARNING]: Unable to read the ndk version, "
-                "assuming that you are using an NDK greater than 17 (the "
-                "minimum ndk required to use p4a successfully).\n"
-                "Note: If you got build errors, consider to download the "
-                "recommended ndk version which is 17c and try it again (after "
-                "removing all the files generated with this build). To "
-                "download the android NDK visit the following "
-                "page: {download_url}".format(download_url=NDK_DOWNLOAD_URL),
+                "INFO:p4a:[INFO]:    {}".format(UNKNOWN_NDK_MESSAGE),
+                "WARNING:p4a:[WARNING]: {}".format(
+                    READ_ERROR_NDK_MESSAGE.format(ndk_dir=self.ndk_dir)
+                ),
+                "WARNING:p4a:[WARNING]: {}".format(
+                    ENSURE_RIGHT_NDK_MESSAGE.format(
+                        min_supported=MIN_NDK_VERSION,
+                        rec_version=RECOMMENDED_NDK_VERSION,
+                        ndk_url=NDK_DOWNLOAD_URL,
+                    )
+                ),
             ],
         )
 
@@ -119,10 +134,7 @@ def test_read_ndk_version_error(self, mock_open_src_prop):
             version = read_ndk_version(self.ndk_dir)
         self.assertEqual(
             cm.output,
-            [
-                "INFO:p4a:[INFO]:    Could not parse "
-                "$NDK_DIR/source.properties, not checking NDK version"
-            ],
+            ["INFO:p4a:[INFO]:    {}".format(PARSE_ERROR_NDK_MESSAGE)],
         )
         mock_open_src_prop.assert_called_once_with(
             join(self.ndk_dir, "source.properties")
@@ -135,10 +147,9 @@ def test_check_target_api_error_arch_armeabi(self):
             check_target_api(RECOMMENDED_TARGET_API, "armeabi")
         self.assertEqual(
             e.exception.args[0],
-            "Asked to build for armeabi architecture with API {ndk_api}, but "
-            "API {max_target_api} or greater does not support armeabi".format(
-                ndk_api=RECOMMENDED_TARGET_API,
-                max_target_api=ARMEABI_MAX_TARGET_API,
+            UNSUPPORTED_NDK_API_FOR_ARMEABI_MESSAGE.format(
+                req_ndk_api=RECOMMENDED_TARGET_API,
+                max_ndk_api=ARMEABI_MAX_TARGET_API,
             ),
         )
 
@@ -151,10 +162,9 @@ def test_check_target_api_warning_target_api(self):
             cm.output,
             [
                 "WARNING:p4a:[WARNING]: Target API 25 < 26",
-                "WARNING:p4a:[WARNING]: Target APIs lower than 26 are no "
-                "longer supported on Google Play, and are not recommended. "
-                "Note that the Target API can be higher than your device "
-                "Android version, and should usually be as high as possible.",
+                "WARNING:p4a:[WARNING]: {old_api_msg}".format(
+                    old_api_msg=OLD_API_MESSAGE
+                ),
             ],
         )
 
@@ -169,8 +179,7 @@ def test_check_ndk_api_error_android_api(self):
             check_ndk_api(ndk_api, android_api)
         self.assertEqual(
             e.exception.args[0],
-            "Target NDK API is {ndk_api}, higher than the target Android "
-            "API {android_api}.".format(
+            TARGET_NDK_API_GREATER_THAN_TARGET_API_MESSAGE.format(
                 ndk_api=ndk_api, android_api=android_api
             ),
         )
@@ -187,5 +196,9 @@ def test_check_ndk_api_warning_old_ndk(self):
             check_ndk_api(ndk_api, android_api)
         self.assertEqual(
             cm.output,
-            ["WARNING:p4a:[WARNING]: NDK API less than 21 is not supported"],
+            [
+                "WARNING:p4a:[WARNING]: {}".format(
+                    OLD_NDK_API_MESSAGE.format(MIN_NDK_API)
+                )
+            ],
         )