Print Preview: Migrate JS tests to use Mocha, part 2.

chrome/test/data/webui/print_preview/print_preview_tests.js

 // Copyright 2016 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.
 
 cr.define('print_preview_test', function() {
   /**
    * Index of the "Save as PDF" printer.
    * @type {number}
    * @const
    */
@@ skipping 13 matching lines @@
    */
   var BAR_INDEX = 2;
 
   var printPreview = null;
   var nativeLayer = null;
   var initialSettings = null;
   var localDestinationInfos = null;
   var previewArea = null;
 
   /**
+   * Creates an instance of print_preview.PrintPreview and initializes the
+   * |nativeLayer| and |previewArea|.
+   */
+  function createPrintPreview() {
+    nativeLayer = new print_preview.NativeLayerStub();
+    print_preview.NativeLayer.setInstance(nativeLayer);
+    printPreview = new print_preview.PrintPreview();
+    previewArea = printPreview.getPreviewArea();
+  }
+
+  /**
    * Initialize print preview with the initial settings currently stored in
    * |initialSettings|. Creates |printPreview| if it does not
    * already exist.
    */
   function setInitialSettings() {
     nativeLayer.setInitialSettings(initialSettings);
     printPreview.initialize();
   }
 
   /**
@@ skipping 24 matching lines @@
    * @param {HTMLDivElement} section The section to check.
    * @param {boolean} visible The expected state of visibility.
    */
   function checkSectionVisible(section, visible) {
     assertNotEquals(null, section);
     expectEquals(
         visible,
         section.classList.contains('visible'), 'section=' + section.id);
   }
 
+  function checkElementDisplayed(el, isDisplayed) {

[rbpotter, 2017/05/26 18:50:17]

@param {HTMLElement} el
@param {boolean} isDisplayed

[dpapad, 2017/05/26 18:57:54]

Done.

+    assertNotEquals(null, el);
+    expectEquals(isDisplayed,
+                 !el.hidden,
+                 'element="' + el.id + '" of class "' + el.classList + '"');
+  }
+
   function getCddTemplate(printerId) {
     return {
       printerId: printerId,
       capabilities: {
         version: '1.0',
         printer: {
           supported_content_type: [{content_type: 'application/pdf'}],
           collate: {},
           color: {
             option: [
@@ skipping 23 matching lines @@
                 height_microns: 279400,
                 is_default: true
               }
             ]
           }
         }
       }
     };
   }
 
+  /**
+   * Even though animation duration and delay is set to zero, it is necessary to
+   * wait until the animation has finished.
+   * @return {!Promise} A promise firing when the animation is done.
+   */
+  function whenAnimationDone(elementId) {
+    return new Promise(function(resolve) {
+      // Add a listener for the animation end event.
+      var element = $(elementId);
+      element.addEventListener('animationend', function f(e) {
+        element.removeEventListener(f, 'animationend');
+        resolve();
+      });
+    });
+  }
+
+  /**
+   * Expand the 'More Settings' div to expose all options.
+   */
+  function expandMoreSettings() {
+    var moreSettings = $('more-settings');
+    checkSectionVisible(moreSettings, true);
+    moreSettings.click();
+  }
+
+  /** @return {boolean} */
+  function isPrintAsImageEnabled() {
+    // Should be enabled by default on non Windows/Mac.
+    return (!cr.isWindows && !cr.isMac &&
+            loadTimeData.getBoolean('printPdfAsImageEnabled'));
+  }
+
   suite('PrintPreview', function() {
     setup(function() {
       initialSettings = new print_preview.NativeInitialSettings(
         false /*isInKioskAutoPrintMode*/,
         false /*isInAppKioskMode*/,
         ',' /*thousandsDelimeter*/,
         '.' /*decimalDelimeter*/,
         1 /*unitType*/,
         true /*isDocumentModifiable*/,
         'title' /*documentTitle*/,
         true /*documentHasSelection*/,
         false /*selectionOnly*/,
         'FooDevice' /*systemDefaultDestinationId*/,
         null /*serializedAppStateStr*/,
         null /*serializedDefaultDestinationSelectionRulesStr*/);
 
       localDestinationInfos = [
         { printerName: 'FooName', deviceName: 'FooDevice' },
         { printerName: 'BarName', deviceName: 'BarDevice' },
       ];
 
-      nativeLayer = new print_preview.NativeLayerStub();
-      print_preview.NativeLayer.setInstance(nativeLayer);
-      printPreview = new print_preview.PrintPreview();
-      previewArea = printPreview.getPreviewArea();
+      createPrintPreview();

[rbpotter, 2017/05/26 18:50:17]

See comment below. If the second call in the "SectionsDisabled" test is
not needed it is possible this function may not need to be migrated.

     });
 
     // Test some basic assumptions about the print preview WebUI.
     test('PrinterList', function() {
       setInitialSettings();
       return nativeLayer.whenCalled('getInitialSettings').then(
           function() {
             setLocalDestinations();
             var recentList =
                 $('destination-search').querySelector('.recent-list ul');
@@ skipping 176 matching lines @@
       initialSettings.serializedDefaultDestinationSelectionRulesStr_ =
           JSON.stringify({namePattern: '.*Bar.*'});
       setInitialSettings();
       return nativeLayer.whenCalled('getInitialSettings').then(
           function() {
             setLocalDestinations();
             assertEquals(
                 'BarDevice',
                 printPreview.destinationStore_.selectedDestination.id);
           });
-        });
+    });
+
+    test('SystemDialogLinkIsHiddenInAppKioskMode', function() {
+      if (!cr.isChromeOS)
+        initialSettings.isInAppKioskMode_ = true;
+
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            if (cr.isChromeOS)
+              assertEquals(null, $('system-dialog-link'));
+            else
+              checkElementDisplayed($('system-dialog-link'), false);
+          });
+    });
+
+    test('SectionsDisabled', function() {
+      createPrintPreview();

[rbpotter, 2017/05/26 18:50:17]

It looks like this is called in setup() already. Does it need to be
called again here?

[dpapad, 2017/05/26 18:57:54]

Removed. It looks that it is not needed.

+      checkSectionVisible($('layout-settings'), false);
+      checkSectionVisible($('color-settings'), false);
+      checkSectionVisible($('copies-settings'), false);
+
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            var device = getCddTemplate('FooDevice');
+            device.capabilities.printer.color = {
+              option: [{is_default: true, type: 'STANDARD_COLOR'}]
+            };
+            delete device.capabilities.printer.copies;
+            setCapabilities(device);
+
+            checkSectionVisible($('layout-settings'), true);
+            checkSectionVisible($('color-settings'), false);
+            checkSectionVisible($('copies-settings'), false);
+
+            return whenAnimationDone('other-options-collapsible');
+          });
+    });
+
+    // When the source is 'PDF' and 'Save as PDF' option is selected, we hide
+    // the fit to page option.
+    test('PrintToPDFSelectedCapabilities', function() {
+      // Add PDF printer.
+      initialSettings.isDocumentModifiable_ = false;
+      initialSettings.systemDefaultDestinationId_ = 'Save as PDF';
+      setInitialSettings();
+
+      return nativeLayer.whenCalled('getInitialSettings').then(function() {
+        var device = {
+          printerId: 'Save as PDF',
+          capabilities: {
+            version: '1.0',
+            printer: {
+              page_orientation: {
+                option: [
+                  {type: 'AUTO', is_default: true},
+                  {type: 'PORTRAIT'},
+                  {type: 'LANDSCAPE'}
+                ]
+              },
+              color: {
+                option: [
+                  {type: 'STANDARD_COLOR', is_default: true}
+                ]
+              },
+              media_size: {
+                option: [
+                  { name: 'NA_LETTER',
+                    width_microns: 0,
+                    height_microns: 0,
+                    is_default: true
+                  }
+                ]
+              }
+            }
+          }
+        };
+        setCapabilities(device);
+
+        var otherOptions = $('other-options-settings');
+        // If rasterization is an option, other options should be visible. If
+        // not, there should be no available other options.
+        checkSectionVisible(otherOptions, isPrintAsImageEnabled());
+        if (isPrintAsImageEnabled()) {
+          checkElementDisplayed(
+              otherOptions.querySelector('#fit-to-page-container'), false);
+          checkElementDisplayed(
+              otherOptions.querySelector('#rasterize-container'), true);
+        }
+        checkSectionVisible($('media-size-settings'), false);
+        checkSectionVisible($('scaling-settings'), false);
+      });
+    });
+
+    // When the source is 'HTML', we always hide the fit to page option and show
+    // media size option.
+    test('SourceIsHTMLCapabilities', function() {
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(function() {
+        setLocalDestinations();
+        setCapabilities(getCddTemplate("FooDevice"));

[rbpotter, 2017/05/26 18:50:17]

optional: set to single quotes for consistency with change in
TestSystemDialogLinkIsHiddenInAppKioskMode above (same with
next few tests).

[dpapad, 2017/05/26 18:57:54]

Done.

+
+        var otherOptions = $('other-options-settings');
+        var fitToPage = otherOptions.querySelector('#fit-to-page-container');
+        var rasterize;
+        if (isPrintAsImageEnabled())
+          rasterize = otherOptions.querySelector('#rasterize-container');
+        var mediaSize = $('media-size-settings');
+        var scalingSettings = $('scaling-settings');
+
+        // Check that options are collapsed (section is visible, because duplex
+        // is available).
+        checkSectionVisible(otherOptions, true);
+        checkElementDisplayed(fitToPage, false);
+        if (isPrintAsImageEnabled())
+          checkElementDisplayed(rasterize, false);
+        checkSectionVisible(mediaSize, false);
+        checkSectionVisible(scalingSettings, false);
+
+        expandMoreSettings();
+
+        checkElementDisplayed(fitToPage, false);
+        if (isPrintAsImageEnabled())
+          checkElementDisplayed(rasterize, false);
+        checkSectionVisible(mediaSize, true);
+        checkSectionVisible(scalingSettings, true);
+
+        return whenAnimationDone('more-settings');
+      });
+    });
+
+    // When the source is "PDF", depending on the selected destination printer,
+    // we show/hide the fit to page option and hide media size selection.
+    test('SourceIsPDFCapabilities', function() {
+      initialSettings.isDocumentModifiable_ = false;
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            var otherOptions = $('other-options-settings');
+            var scalingSettings = $('scaling-settings');
+            var fitToPageContainer =
+                otherOptions.querySelector('#fit-to-page-container');
+            var rasterizeContainer;
+            if (isPrintAsImageEnabled()) {
+              rasterizeContainer =
+                otherOptions.querySelector('#rasterize-container');
+            }
+
+            checkSectionVisible(otherOptions, true);
+            checkElementDisplayed(fitToPageContainer, true);
+            if (isPrintAsImageEnabled())
+              checkElementDisplayed(rasterizeContainer, false);
+            expectTrue(
+                fitToPageContainer.querySelector('.checkbox').checked);
+            expandMoreSettings();
+            if (isPrintAsImageEnabled()) {
+              checkElementDisplayed(rasterizeContainer, true);
+              expectFalse(
+                  rasterizeContainer.querySelector('.checkbox').checked);
+            }
+            checkSectionVisible($('media-size-settings'), true);
+            checkSectionVisible(scalingSettings, true);
+
+            return whenAnimationDone('other-options-collapsible');
+          });
+    });
+
+    // When the source is "PDF", depending on the selected destination printer,
+    // we show/hide the fit to page option and hide media size selection.
+    test('ScalingUnchecksFitToPage', function() {
+      initialSettings.isDocumentModifiable_ = false;
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            var otherOptions = $('other-options-settings');
+            var scalingSettings = $('scaling-settings');
+
+            checkSectionVisible(otherOptions, true);
+            var fitToPageContainer =
+                otherOptions.querySelector('#fit-to-page-container');
+            checkElementDisplayed(fitToPageContainer, true);
+            expectTrue(
+                fitToPageContainer.querySelector('.checkbox').checked);
+            expandMoreSettings();
+            checkSectionVisible($('media-size-settings'), true);
+            checkSectionVisible(scalingSettings, true);
+
+            // Change scaling input
+            var scalingInput = scalingSettings.querySelector('.user-value');
+            expectEquals('100', scalingInput.value);
+            scalingInput.stepUp(5);
+            expectEquals('105', scalingInput.value);
+
+            // Trigger the event
+            var enterEvent = document.createEvent('Event');
+            enterEvent.initEvent('keydown');
+            enterEvent.keyCode = 'Enter';
+            scalingInput.dispatchEvent(enterEvent);
+            expectFalse(
+                fitToPageContainer.querySelector('.checkbox').checked);
+
+            return whenAnimationDone('other-options-collapsible');
+          });
+    });
+
+    // When the number of copies print preset is set for source 'PDF', we update
+    // the copies value if capability is supported by printer.
+    test('CheckNumCopiesPrintPreset', function() {
+      initialSettings.isDocumentModifiable_ = false;
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(function() {
+        setLocalDestinations();
+        setCapabilities(getCddTemplate("FooDevice"));
+
+        // Indicate that the number of copies print preset is set for source
+        // PDF.
+        var printPresetOptions = {
+          disableScaling: true,
+          copies: 2
+        };
+        var printPresetOptionsEvent = new Event(
+            print_preview.NativeLayer.EventType.PRINT_PRESET_OPTIONS);
+        printPresetOptionsEvent.optionsFromDocument = printPresetOptions;
+        nativeLayer.getEventTarget().
+            dispatchEvent(printPresetOptionsEvent);
+
+        checkSectionVisible($('copies-settings'), true);
+        expectEquals(
+            printPresetOptions.copies,
+            parseInt($('copies-settings').querySelector('.user-value').value));
+
+        return whenAnimationDone('other-options-collapsible');
+      });
+    });
+
+    // When the duplex print preset is set for source 'PDF', we update the
+    // duplex setting if capability is supported by printer.
+    test('CheckDuplexPrintPreset', function() {
+      initialSettings.isDocumentModifiable_ = false;
+      setInitialSettings();
+
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            // Indicate that the duplex print preset is set to "long edge" for
+            // source PDF.
+            var printPresetOptions = {
+              duplex: 1
+            };
+            var printPresetOptionsEvent = new Event(
+                print_preview.NativeLayer.EventType.PRINT_PRESET_OPTIONS);
+            printPresetOptionsEvent.optionsFromDocument = printPresetOptions;
+            nativeLayer.getEventTarget().
+                dispatchEvent(printPresetOptionsEvent);
+
+            var otherOptions = $('other-options-settings');
+            checkSectionVisible(otherOptions, true);
+            var duplexContainer =
+                otherOptions.querySelector('#duplex-container');
+            checkElementDisplayed(duplexContainer, true);
+            expectTrue(duplexContainer.querySelector('.checkbox').checked);
+
+            return whenAnimationDone('other-options-collapsible');
+          });
+    });
+
+    // Make sure that custom margins controls are properly set up.
+    test('CustomMarginsControlsCheck', function() {
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            printPreview.printTicketStore_.marginsType.updateValue(
+                print_preview.ticket_items.MarginsTypeValue.CUSTOM);
+
+            ['left', 'top', 'right', 'bottom'].forEach(function(margin) {
+              var control =
+                  $('preview-area').querySelector('.margin-control-' + margin);
+              assertNotEquals(null, control);
+              var input = control.querySelector('.margin-control-textbox');
+              assertTrue(input.hasAttribute('aria-label'));
+              assertNotEquals('undefined', input.getAttribute('aria-label'));
+            });
+            return whenAnimationDone('more-settings');
+          });
+    });
+
+    // Page layout has zero margins. Hide header and footer option.
+    test('PageLayoutHasNoMarginsHideHeaderFooter', function() {
+      setInitialSettings();
+      return nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            var otherOptions = $('other-options-settings');
+            var headerFooter =
+                otherOptions.querySelector('#header-footer-container');
+
+            // Check that options are collapsed (section is visible, because
+            // duplex is available).
+            checkSectionVisible(otherOptions, true);
+            checkElementDisplayed(headerFooter, false);
+
+            expandMoreSettings();
+
+            checkElementDisplayed(headerFooter, true);
+
+            printPreview.printTicketStore_.marginsType.updateValue(
+                print_preview.ticket_items.MarginsTypeValue.CUSTOM);
+            printPreview.printTicketStore_.customMargins.updateValue(
+                new print_preview.Margins(0, 0, 0, 0));
+
+            checkElementDisplayed(headerFooter, false);
+
+            return whenAnimationDone('more-settings');
+          });
+    });
+
+    // Page layout has half-inch margins. Show header and footer option.
+    test('PageLayoutHasMarginsShowHeaderFooter', function() {
+      setInitialSettings();
+      nativeLayer.whenCalled('getInitialSettings').then(
+          function() {
+            setLocalDestinations();
+            setCapabilities(getCddTemplate("FooDevice"));
+
+            var otherOptions = $('other-options-settings');
+            var headerFooter =
+                otherOptions.querySelector('#header-footer-container');
+
+            // Check that options are collapsed (section is visible, because
+            // duplex is available).
+            checkSectionVisible(otherOptions, true);
+            checkElementDisplayed(headerFooter, false);
+
+            expandMoreSettings();
+
+            checkElementDisplayed(headerFooter, true);
+
+            printPreview.printTicketStore_.marginsType.updateValue(
+                print_preview.ticket_items.MarginsTypeValue.CUSTOM);
+            printPreview.printTicketStore_.customMargins.updateValue(
+                new print_preview.Margins(36, 36, 36, 36));
+
+            checkElementDisplayed(headerFooter, true);
+
+            return whenAnimationDone('more-settings');
+          });
+    });
+
+
   });
 });