[MR] Add description field to MediaSink.

chrome/test/data/webui/media_router/media_router_container_tests.js

 // 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.
 
 /** @fileoverview Suite of tests for media-router-container. */
 cr.define('media_router_container', function() {
   function registerTests() {
     suite('MediaRouterContainer', function() {
       /**
        * Media Router Container created before each test.
@@ skipping 70 matching lines @@
 
       // Checks the visibility of an element with |elementId| in |container|.
       // An element is considered visible if it exists and its |hidden| property
       // is |false|.
       var checkElementVisibleWithId = function(visible, elementId) {
         var element = container.$$('#' + elementId);
         var elementVisible = !!element && !element.hidden;
         assertEquals(visible, elementVisible);
       };
 
-      // Checks whether |element| is hidden.
-      var checkElementHidden = function(hidden, element) {
-        assertEquals(hidden, element.hidden);
-      };
-
       // Checks whether |expected| and the text in the |element| are equal.
       var checkElementText = function(expected, element) {
         assertEquals(expected.trim(), element.textContent.trim());
       };
 
       // Checks whether |expected| and the |property| in |container| are equal.
       var checkPropertyValue = function(expected, property) {
         assertEquals(expected.trim(), container.property);
       }
 
@@ skipping 29 matching lines @@
         ];
 
         fakeRouteListWithLocalRoutesOnly = [
           new media_router.Route('id 1', 'sink id 1', 'Title 1', 0, true),
           new media_router.Route('id 2', 'sink id 2', 'Title 2', 1, true),
         ];
 
         // Note: These need to be in-order by name to prevent shuffling.
         // Sorting of sinks by name is tested separately.
         fakeSinkList = [
-          new media_router.Sink('sink id 1', 'Sink 1',
+          new media_router.Sink('sink id 1', 'Sink 1', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1, 2, 3]),
-          new media_router.Sink('sink id 2', 'Sink 2',
+          new media_router.Sink('sink id 2', 'Sink 2', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1, 2, 3]),
-          new media_router.Sink('sink id 3', 'Sink 3',
+          new media_router.Sink('sink id 3', 'Sink 3', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.PENDING, [1, 2, 3]),
         ];
 
         fakeBlockingIssue = new media_router.Issue(
             'issue id 1', 'Issue Title 1', 'Issue Message 1', 0, 1,
             'route id 1', true, 1234);
 
         fakeNonBlockingIssue = new media_router.Issue(
             'issue id 2', 'Issue Title 2', 'Issue Message 2', 0, 1,
@@ skipping 142 matching lines @@
           var sinkList =
               container.$['sink-list'].querySelectorAll('paper-item');
           assertEquals(fakeSinkList.length, sinkList.length);
           for (var i = 0; i < fakeSinkList.length; i++) {
             checkElementText(fakeSinkList[i].name, sinkList[i]);
           }
           done();
         });
       });
 
+

[apacible, 2015/11/25 23:05:41]

nit: remove newline.

[imcheng, 2015/12/01 19:29:27]

Done.

       // Tests the text shown for the sink list.
       test('initial sink list route text', function(done) {
-        container.allSinks = fakeSinkList;
-        container.routeList = fakeRouteList;
+        container.allSinks = [

[apacible, 2015/11/25 23:05:41]

Could we just update |fakeSinkList| to have some descriptions, rather than
creating a new list here? If it's too fragile to keep updating, please add
comments below on why each Sink/Route is set up specifically like this.

[imcheng, 2015/12/01 19:29:27]

Done. In general, I prefer having separate test data for each test case even if
that means duplicated code.

[apacible, 2015/12/02 23:27:26]

Acknowledged.

+            new media_router.Sink('sink id 1', 'Sink 1', null,
+                media_router.SinkIconType.CAST,
+                media_router.SinkStatus.ACTIVE, [1, 2, 3]),
+            new media_router.Sink('sink id 2', 'Sink 2', 'Sink 2 description',
+                media_router.SinkIconType.CAST,
+                media_router.SinkStatus.ACTIVE, [1, 2, 3]),
+            new media_router.Sink('sink id 3', 'Sink 3', null,
+                media_router.SinkIconType.CAST,
+                media_router.SinkStatus.PENDING, [1, 2, 3]),
+            new media_router.Sink('sink id 4', 'Sink 4', 'Sink 4 description',
+                media_router.SinkIconType.CAST,
+                media_router.SinkStatus.PENDING, [1, 2, 3])
+        ];
+
+        container.routeList = [
+            new media_router.Route('id 3', 'sink id 3', 'Title 3', 0, true),
+            new media_router.Route('id 4', 'sink id 4', 'Title 4', 1, false),
+        ];
 
         setTimeout(function() {
-          var routeList =
-              container.$['sink-list'].querySelectorAll('.route');
-          assertEquals(fakeSinkList.length, routeList.length);
-          checkElementText(fakeRouteList[0].description, routeList[0]);
-          checkElementText(fakeRouteList[1].description, routeList[1]);
-          checkElementText('', routeList[2]);
+          var sinkSubtextList =
+              container.$['sink-list'].querySelectorAll('.sink-subtext');
+
+          // There will only be 3 sink subtext entries, because Sink 1 does not
+          // have any subtext.
+          assertEquals(3, sinkSubtextList.length);
+
+          checkElementText(container.allSinks[1].description,
+              sinkSubtextList[0]);
+
+          // Route description overrides sink description for subtext.
+          checkElementText(container.routeList[0].description,
+              sinkSubtextList[1]);
+
+          checkElementText(container.routeList[1].description,
+              sinkSubtextList[2]);
           done();
         });
       });
-
-      // Tests the visibility of routes in the sink list.
-      test('initial route visibility', function(done) {
-        container.allSinks = fakeSinkList;
-        container.routeList = fakeRouteList;
-
-        setTimeout(function() {
-          var routeList =
-              container.$['sink-list'].querySelectorAll('.route');
-
-          checkElementHidden(false, routeList[0]);
-          checkElementHidden(false, routeList[1]);
-          checkElementHidden(true, routeList[2]);
-          done();
-        });
-      });
 
       // Tests the expected view when there is only one local active route and
       // media_router_container is created for the first time.
       test('initial view with one local route', function() {
         container.allSinks = fakeSinkList;
         container.routeList = fakeRouteList;
 
         checkCurrentView(media_router.MediaRouterView.ROUTE_DETAILS);
       });
 
@@ skipping 136 matching lines @@
                                       'sink-list']);
           done();
         });
       });
 
       // Tests that the sink list does not contain any sinks that are not
       // compatible with the current cast mode and are not associated with a
       // route.
       test('sink list filtering based on initial cast mode', function(done) {
         var newSinks = [
-          new media_router.Sink('sink id 10', 'Sink 10',
+          new media_router.Sink('sink id 10', 'Sink 10', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [2, 3]),
-          new media_router.Sink('sink id 20', 'Sink 20',
+          new media_router.Sink('sink id 20', 'Sink 20', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1, 2, 3]),
-          new media_router.Sink('sink id 30', 'Sink 30',
+          new media_router.Sink('sink id 30', 'Sink 30', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.PENDING, [2, 3]),
         ];
 
         container.allSinks = newSinks;
         container.routeList = [
           new media_router.Route('id 1', 'sink id 30', 'Title 1', 1, false),
         ];
 
         setTimeout(function() {
@@ skipping 43 matching lines @@
             assertEquals(3, sinkList.length);
             done();
           });
          });
       });
 
       // Tests that sinks provided in some random order will be sorted by name
       // when shown to the user.
       test('sinks are shown sorted by name', function(done) {
         var outOfOrderSinks = [
-          new media_router.Sink('6543', 'Sleepy',
+          new media_router.Sink('6543', 'Sleepy', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1]),
-          new media_router.Sink('543', 'Happy',
+          new media_router.Sink('543', 'Happy', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1]),
-          new media_router.Sink('43', 'Bashful',
+          new media_router.Sink('43', 'Bashful', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1]),
-          new media_router.Sink('2', 'George',
+          new media_router.Sink('2', 'George', null,
               media_router.SinkIconType.CAST_AUDIO,
               media_router.SinkStatus.ACTIVE, [1]),
-          new media_router.Sink('1', 'George',
+          new media_router.Sink('1', 'George', null,
               media_router.SinkIconType.CAST,
               media_router.SinkStatus.ACTIVE, [1]),
-          new media_router.Sink('3', 'George',
+          new media_router.Sink('3', 'George', null,
               media_router.SinkIconType.HANGOUT,
               media_router.SinkStatus.ACTIVE, [1]),
         ];
 
         container.allSinks = outOfOrderSinks;
 
         setTimeout(function() {
           var sinkList =
               container.$['sink-list'].querySelectorAll('paper-item');
 
@@ skipping 21 matching lines @@
           done();
         });
       });
     });
   }
 
   return {
     registerTests: registerTests,
   };
 });