Add shared preference file modification option to instrumentation test runner

build/android/pylib/instrumentation/instrumentation_test_instance.py

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import collections
 import copy
+import json
 import logging
 import os
 import pickle
 import re
 
 from devil.android import apk_helper
 from devil.android import md5sum
 from pylib import constants
 from pylib.base import base_test_result
 from pylib.base import test_exception
@@ skipping 476 matching lines @@
 
     self._coverage_directory = None
     self._initializeTestCoverageAttributes(args)
 
     self._store_tombstones = False
     self._initializeTombstonesAttributes(args)
 
     self._should_save_logcat = None
     self._initializeLogAttributes(args)
 
+    self._edit_shared_prefs = []
+    self._initializeEditPrefsAttributes(args)
+
   def _initializeApkAttributes(self, args, error_func):
     if args.apk_under_test:
       apk_under_test_path = args.apk_under_test
       if not args.apk_under_test.endswith('.apk'):
         apk_under_test_path = os.path.join(
             constants.GetOutDirectory(), constants.SDK_BUILD_APKS_DIR,
             '%s.apk' % args.apk_under_test)
 
       # TODO(jbudorick): Move the realpath up to the argument parser once
       # APK-by-name is no longer supported.
@@ skipping 155 matching lines @@
 
   def _initializeTestCoverageAttributes(self, args):
     self._coverage_directory = args.coverage_dir
 
   def _initializeTombstonesAttributes(self, args):
     self._store_tombstones = args.store_tombstones
 
   def _initializeLogAttributes(self, args):
     self._should_save_logcat = bool(args.json_results_file)
 
+  def _initializeEditPrefsAttributes(self, args):
+    if not hasattr(args, 'shared_prefs_file'):
+      return
+    if not isinstance(args.shared_prefs_file, str):
+      logging.warning("Given non-string for a filepath")
+      return
+
+    # json.load() loads strings as unicode, which causes issues when trying
+    # to edit string values in preference files, so convert to Python strings
+    def unicode_to_str(data):

[jbudorick, 2017/02/15 22:38:41]

Can we do this with one of the optional arguments to json.load? (encoding?)

[bsheedy, 2017/02/16 00:14:39]

Yes and no. Setting the encoding argument is only meant to be used if the file
is encoded in something besides UTF-8, and so doesn't do anything in this case.
You can specify the object_hook argument to do the re-encoding during json.load
instead of afterwards, but that doesn't result in less code or anything. See
http://stackoverflow.com/questions/956867/how-to-get-string-objects-instead-o...

+      if isinstance(data, dict):
+        return {unicode_to_str(key): unicode_to_str(value)
+                for key, value in data.iteritems()}
+      elif isinstance(data, list):
+        return [unicode_to_str(element) for element in data]
+      elif isinstance(data, unicode):
+        return data.encode('utf-8')
+      return data
+
+    filepath = os.path.abspath(os.path.join(

[jbudorick, 2017/02/15 22:38:41]

Remove this after the realpath change mentioned in test_runner.py.

[bsheedy, 2017/02/16 18:04:50]

Done.

+        host_paths.DIR_SOURCE_ROOT, args.shared_prefs_file))
+    with open(filepath) as prefs_file:
+      self._edit_shared_prefs = unicode_to_str(json.load(prefs_file))
+
   @property
   def additional_apks(self):
     return self._additional_apks
 
   @property
   def apk_under_test(self):
     return self._apk_under_test
 
   @property
   def apk_under_test_incremental_install_script(self):
     return self._apk_under_test_incremental_install_script
 
   @property
   def coverage_directory(self):
     return self._coverage_directory
 
   @property
   def driver_apk(self):
     return self._driver_apk
 
   @property
   def driver_package(self):
     return self._driver_package
 
   @property
   def driver_name(self):
     return self._driver_name
 
   @property
+  def edit_shared_prefs(self):
+    return self._edit_shared_prefs
+
+  @property
   def flags(self):
     return self._flags
 
   @property
   def should_save_logcat(self):
     return self._should_save_logcat
 
   @property
   def package_info(self):
     return self._package_info
@@ skipping 122 matching lines @@
 
   @staticmethod
   def GenerateTestResults(
       result_code, result_bundle, statuses, start_ms, duration_ms):
     return GenerateTestResults(result_code, result_bundle, statuses,
                                start_ms, duration_ms)
 
   #override
   def TearDown(self):
     pass