New Sync datatype for Synced Notifications App Info

sync/tools/testserver/chromiumsync.py

 # Copyright 2013 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.
 
 """An implementation of the server side of the Chromium sync protocol.
 
 The details of the protocol are described mostly by comments in the protocol
 buffer definition at chrome/browser/sync/protocol/sync.proto.
 """
 
@@ skipping 28 matching lines @@
 import favicon_tracking_specifics_pb2
 import history_delete_directive_specifics_pb2
 import managed_user_setting_specifics_pb2
 import managed_user_specifics_pb2
 import managed_user_shared_setting_specifics_pb2
 import nigori_specifics_pb2
 import password_specifics_pb2
 import preference_specifics_pb2
 import priority_preference_specifics_pb2
 import search_engine_specifics_pb2
+import server_app_info_specifics_pb2
 import session_specifics_pb2
 import sync_pb2
 import sync_enums_pb2
 import synced_notification_data_pb2
 import synced_notification_render_pb2
 import synced_notification_specifics_pb2
 import theme_specifics_pb2
 import typed_url_specifics_pb2
 
 # An enumeration of the various kinds of data that can be synced.
@@ skipping 18 matching lines @@
     MANAGED_USER_SETTING,
     MANAGED_USER_SHARED_SETTING,
     MANAGED_USER,
     NIGORI,
     PASSWORD,
     PREFERENCE,
     PRIORITY_PREFERENCE,
     SEARCH_ENGINE,
     SESSION,
     SYNCED_NOTIFICATION,
+    SYNCED_NOTIFICATION_APP_INFO,
     THEME,
     TYPED_URL,
     EXTENSION_SETTINGS,
     FAVICON_IMAGES,
-    FAVICON_TRACKING) = range(29)
+    FAVICON_TRACKING) = range(30)
 
 # An enumeration on the frequency at which the server should send errors
 # to the client. This would be specified by the url that triggers the error.
 # Note: This enum should be kept in the same order as the enum in sync_test.h.
 SYNC_ERROR_FREQUENCY = (
     ERROR_FREQUENCY_NONE,
     ERROR_FREQUENCY_ALWAYS,
     ERROR_FREQUENCY_TWO_THIRDS) = range(3)
 
 # Well-known server tag of the top level 'Google Chrome' folder.
@@ skipping 23 matching lines @@
         SYNC_TYPE_FIELDS['managed_user_shared_setting'],
     MANAGED_USER_SETTING: SYNC_TYPE_FIELDS['managed_user_setting'],
     MANAGED_USER: SYNC_TYPE_FIELDS['managed_user'],
     NIGORI: SYNC_TYPE_FIELDS['nigori'],
     PASSWORD: SYNC_TYPE_FIELDS['password'],
     PREFERENCE: SYNC_TYPE_FIELDS['preference'],
     PRIORITY_PREFERENCE: SYNC_TYPE_FIELDS['priority_preference'],
     SEARCH_ENGINE: SYNC_TYPE_FIELDS['search_engine'],
     SESSION: SYNC_TYPE_FIELDS['session'],
     SYNCED_NOTIFICATION: SYNC_TYPE_FIELDS["synced_notification"],
+    SYNCED_NOTIFICATION_APP_INFO:SYNC_TYPE_FIELDS["app_info"],
     THEME: SYNC_TYPE_FIELDS['theme'],
     TYPED_URL: SYNC_TYPE_FIELDS['typed_url'],
     }
 
 # The parent ID used to indicate a top-level node.
 ROOT_ID = '0'
 
 # Unix time epoch +1 day in struct_time format. The tuple corresponds to
 # UTC Thursday Jan 2 1970, 00:00:00, non-dst.
 # We have to add one day after start of epoch, since in timezones with positive
@@ skipping 393 matching lines @@
       PermanentItem('google_chrome_passwords', name='Passwords',
                     parent_tag=ROOT_ID, sync_type=PASSWORD),
       PermanentItem('google_chrome_preferences', name='Preferences',
                     parent_tag=ROOT_ID, sync_type=PREFERENCE),
       PermanentItem('google_chrome_priority_preferences',
                     name='Priority Preferences',
                     parent_tag=ROOT_ID, sync_type=PRIORITY_PREFERENCE),
       PermanentItem('google_chrome_synced_notifications',
                     name='Synced Notifications',
                     parent_tag=ROOT_ID, sync_type=SYNCED_NOTIFICATION),
+      PermanentItem('google_chrome_synced_notification_app_info',
+                    name='Synced Notification App Info',
+                    parent_tag=ROOT_ID, sync_type=SYNCED_NOTIFICATION_APP_INFO),
       PermanentItem('google_chrome_search_engines', name='Search Engines',
                     parent_tag=ROOT_ID, sync_type=SEARCH_ENGINE),
       PermanentItem('google_chrome_sessions', name='Sessions',
                     parent_tag=ROOT_ID, sync_type=SESSION),
       PermanentItem('google_chrome_themes', name='Themes',
                     parent_tag=ROOT_ID, sync_type=THEME),
       PermanentItem('google_chrome_typed_urls', name='Typed URLs',
                     parent_tag=ROOT_ID, sync_type=TYPED_URL),
       PermanentItem('google_chrome_dictionary', name='Dictionary',
                     parent_tag=ROOT_ID, sync_type=DICTIONARY),
@@ skipping 659 matching lines @@
     coalesced.key = unique_id
 
     specifics = sync_pb2.EntitySpecifics()
     notification_specifics = \
         synced_notification_specifics_pb2.SyncedNotificationSpecifics()
     notification_specifics.coalesced_notification.CopyFrom(coalesced)
     specifics.synced_notification.CopyFrom(notification_specifics)
 
     return specifics
 
-
   def _CreateSyncedNotificationClientTag(self, key):
     """Create the client_defined_unique_tag value for a SyncedNotification.
 
     Args:
       key: The entity used to create the client tag.
 
     Returns:
       The string value of the to be used as the client_defined_unique_tag.
     """
     serialized_type = sync_pb2.EntitySpecifics()
     specifics = synced_notification_specifics_pb2.SyncedNotificationSpecifics()
     serialized_type.synced_notification.CopyFrom(specifics)
     hash_input = serialized_type.SerializeToString() + key
     return base64.b64encode(hashlib.sha1(hash_input).digest())
 
+  def AddSyncedNotificationAppInfo(self, app_info):
+    """Adds an app info struct to the server data.
+
+    The notification will be delivered to the client on the next GetUpdates
+    call.
+
+    Args:
+      app_info: A serialized AppInfo.
+
+    Returns:
+      The string representation of the added SyncEntity.
+
+    Raises:
+      ClientNotConnectedError: if the client has not yet connected to this
+      server
+    """
+    # A unique string used wherever a unique ID for this notification is
+    # required.
+    unique_notification_id = str(uuid.uuid4())
+
+    specifics = self._AppInfoEntitySpecifics(
+        unique_notification_id, app_info)
+
+    # Create the root SyncEntity representing a single app info protobuf.
+    entity = sync_pb2.SyncEntity()
+    entity.specifics.CopyFrom(specifics)
+    entity.parent_id_string = self._ServerTagToId(
+        'google_chrome_synced_notifications_app_info')
+    entity.name = 'App info added for testing'
+    entity.server_defined_unique_tag = unique_notification_id
+
+    # Set the version to one more than the greatest version number already seen.
+    entries = sorted(self._entries.values(), key=operator.attrgetter('version'))
+    if len(entries) < 1:
+      raise ClientNotConnectedError
+    entity.version = entries[-1].version + 1
+
+    entity.client_defined_unique_tag = entity.id_string
+    entity.id_string = entity.id_string
+
+    self._entries[entity.id_string] = copy.deepcopy(entity)
+
+    return google.protobuf.text_format.MessageToString(entity)
+
 
 class TestServer(object):
   """An object to handle requests for one (and only one) Chrome Sync account.
 
   TestServer consumes the sync command messages that are the outermost
   layers of the protocol, performs the corresponding actions on its
   SyncDataModel, and constructs an appropriate response message.
   """
 
   def __init__(self):
@@ skipping 388 matching lines @@
 
     Args:
       sessions_commit_delay_seconds: The desired sync delay time for sessions.
     """
     if not self._client_command:
       self._client_command = client_commands_pb2.ClientCommand()
 
     self._client_command.sessions_commit_delay_seconds = \
         sessions_commit_delay_seconds
     return self._client_command