ui/file_manager/integration_tests/test_util.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 'use strict';
   6
   7 /**
   8  * Sends a test message.
   9  * @param {Object} message Message to be sent. It is converted into JSON string
  10  *     before sending.
  11  * @return {Promise} Promise to be fulfilled with a returned value.
  12  */
  13 function sendTestMessage(message) {
  14   return new Promise(function(fulfill) {
  15     chrome.test.sendMessage(JSON.stringify(message), fulfill);
  16   });
  17 }
  18
  19 /**
  20  * Returns promise to be fulfilled after the given milliseconds.
  21  * @param {number} time Time in milliseconds.
  22  */
  23 function wait(time) {
  24   return new Promise(function(callback) {
  25     setTimeout(callback, time);
  26   });
  27 }
  28
  29 /**
  30  * Interval milliseconds between checks of repeatUntil.
  31  * @type {number}
  32  * @const
  33  */
  34 var REPEAT_UNTIL_INTERVAL = 200;
  35
  36 /**
  37  * Interval milliseconds between log output of repeatUntil.
  38  * @type {number}
  39  * @const
  40  */
  41 var LOG_INTERVAL = 3000;
  42
  43 /**
  44  * Returns a pending marker. See also the repeatUntil function.
  45  * @param {string} message Pending reason including %s, %d, or %j markers. %j
  46  *     format an object as JSON.
  47  * @param {Array.<*>} var_args Values to be assigined to %x markers.
  48  * @return {Object} Object which returns true for the expression: obj instanceof
  49  *     pending.
  50  */
  51 function pending(message, var_args) {
  52   var index = 1;
  53   var args = arguments;
  54   var formattedMessage = message.replace(/%[sdj]/g, function(pattern) {
  55     var arg = args[index++];
  56     switch(pattern) {
  57       case '%s': return String(arg);
  58       case '%d': return Number(arg);
  59       case '%j': return JSON.stringify(arg);
  60       default: return pattern;
  61     }
  62   });
  63   var pendingMarker = Object.create(pending.prototype);
  64   pendingMarker.message = formattedMessage;
  65   return pendingMarker;
  66 };
  67
  68 /**
  69  * Waits until the checkFunction returns a value but a pending marker.
  70  * @param {function():*} checkFunction Function to check a condition. It can
  71  *     return a pending marker created by a pending function.
  72  * @return {Promise} Promise to be fulfilled with the return value of
  73  *     checkFunction when the checkFunction reutrns a value but a pending
  74  *     marker.
  75  */
  76 function repeatUntil(checkFunction) {
  77   var logTime = Date.now() + LOG_INTERVAL;
  78   var step = function() {
  79     return Promise.resolve(checkFunction()).then(function(result) {
  80       if (result instanceof pending) {
  81         if (Date.now() > logTime) {
  82           logTime += LOG_INTERVAL;
  83         }
  84         return wait(REPEAT_UNTIL_INTERVAL).then(step);
  85       } else {
  86         return result;
  87       }
  88     });
  89   };
  90   return step();
  91 };
  92
  93 /**
  94  * Adds the givin entries to the target volume(s).
  95  * @param {Array.<string>} volumeNames Names of target volumes.
  96  * @param {Array.<TestEntryInfo>} entries List of entries to be added.
  97  * @param {function(boolean)=} opt_callback Callback function to be passed the
  98  *     result of function. The argument is true on success.
  99  * @return {Promise} Promise to be fulfilled when the entries are added.
 100  */
 101 function addEntries(volumeNames, entries, opt_callback) {
 102   if (volumeNames.length == 0) {
 103     callback(true);
 104     return;
 105   }
 106   var volumeResultPromises = volumeNames.map(function(volume) {
 107     return sendTestMessage({
 108       name: 'addEntries',
 109       volume: volume,
 110       entries: entries
 111     });
 112   });
 113   var resultPromise = Promise.all(volumeResultPromises);
 114   if (opt_callback) {
 115     resultPromise.then(opt_callback.bind(null, true),
 116                        opt_callback.bind(null, false));
 117   }
 118   return resultPromise;
 119 };
 120
 121 /**
 122  * @enum {string}
 123  * @const
 124  */
 125 var EntryType = Object.freeze({
 126   FILE: 'file',
 127   DIRECTORY: 'directory'
 128 });
 129
 130 /**
 131  * @enum {string}
 132  * @const
 133  */
 134 var SharedOption = Object.freeze({
 135   NONE: 'none',
 136   SHARED: 'shared'
 137 });
 138
 139 /**
 140  * @enum {string}
 141  */
 142 var RootPath = Object.seal({
 143   DOWNLOADS: '/must-be-filled-in-test-setup',
 144   DRIVE: '/must-be-filled-in-test-setup',
 145 });
 146
 147 /**
 148  * File system entry information for tests.
 149  *
 150  * @param {EntryType} type Entry type.
 151  * @param {string} sourceFileName Source file name that provides file contents.
 152  * @param {string} targetName Name of entry on the test file system.
 153  * @param {string} mimeType Mime type.
 154  * @param {SharedOption} sharedOption Shared option.
 155  * @param {string} lastModifiedTime Last modified time as a text to be shown in
 156  *     the last modified column.
 157  * @param {string} nameText File name to be shown in the name column.
 158  * @param {string} sizeText Size text to be shown in the size column.
 159  * @param {string} typeText Type name to be shown in the type column.
 160  * @constructor
 161  */
 162 function TestEntryInfo(type,
 163                        sourceFileName,
 164                        targetPath,
 165                        mimeType,
 166                        sharedOption,
 167                        lastModifiedTime,
 168                        nameText,
 169                        sizeText,
 170                        typeText) {
 171   this.type = type;
 172   this.sourceFileName = sourceFileName || '';
 173   this.targetPath = targetPath;
 174   this.mimeType = mimeType || '';
 175   this.sharedOption = sharedOption;
 176   this.lastModifiedTime = lastModifiedTime;
 177   this.nameText = nameText;
 178   this.sizeText = sizeText;
 179   this.typeText = typeText;
 180   Object.freeze(this);
 181 };
 182
 183 TestEntryInfo.getExpectedRows = function(entries) {
 184   return entries.map(function(entry) { return entry.getExpectedRow(); });
 185 };
 186
 187 /**
 188  * Obtains a expected row contents of the file in the file list.
 189  */
 190 TestEntryInfo.prototype.getExpectedRow = function() {
 191   return [this.nameText, this.sizeText, this.typeText, this.lastModifiedTime];
 192 };
 193
 194 /**
 195  * Filesystem entries used by the test cases.
 196  * @type {Object.<string, TestEntryInfo>}
 197  * @const
 198  */
 199 var ENTRIES = {
 200   hello: new TestEntryInfo(
 201       EntryType.FILE, 'text.txt', 'hello.txt',
 202       'text/plain', SharedOption.NONE, 'Sep 4, 1998, 12:34 PM',
 203       'hello.txt', '51 bytes', 'Plain text'),
 204
 205   world: new TestEntryInfo(
 206       EntryType.FILE, 'video.ogv', 'world.ogv',
 207       'text/plain', SharedOption.NONE, 'Jul 4, 2012, 10:35 AM',
 208       'world.ogv', '59 KB', 'OGG video'),
 209
 210   unsupported: new TestEntryInfo(
 211       EntryType.FILE, 'random.bin', 'unsupported.foo',
 212       'application/x-foo', SharedOption.NONE, 'Jul 4, 2012, 10:36 AM',
 213       'unsupported.foo', '8 KB', 'FOO file'),
 214
 215   desktop: new TestEntryInfo(
 216       EntryType.FILE, 'image.png', 'My Desktop Background.png',
 217       'image/png', SharedOption.NONE, 'Jan 18, 2038, 1:02 AM',
 218       'My Desktop Background.png', '272 bytes', 'PNG image'),
 219
 220   image2: new TestEntryInfo(
 221       EntryType.FILE, 'image2.png', 'image2.png',
 222       'image/png', SharedOption.NONE, 'Jan 18, 2038, 1:02 AM',
 223       'image2.png', '4 KB', 'PNG image'),
 224
 225   image3: new TestEntryInfo(
 226       EntryType.FILE, 'image3.jpg', 'image3.jpg',
 227       'image/jpg', SharedOption.NONE, 'Jan 18, 2038, 1:02 AM',
 228       'image3.jpg', '272 bytes', 'JPEG image'),
 229
 230   beautiful: new TestEntryInfo(
 231       EntryType.FILE, 'music.ogg', 'Beautiful Song.ogg',
 232       'text/plain', SharedOption.NONE, 'Nov 12, 2086, 12:00 PM',
 233       'Beautiful Song.ogg', '14 KB', 'OGG audio'),
 234
 235   photos: new TestEntryInfo(
 236       EntryType.DIRECTORY, null, 'photos',
 237       null, SharedOption.NONE, 'Jan 1, 1980, 11:59 PM',
 238       'photos', '--', 'Folder'),
 239
 240   testDocument: new TestEntryInfo(
 241       EntryType.FILE, null, 'Test Document',
 242       'application/vnd.google-apps.document',
 243       SharedOption.NONE, 'Apr 10, 2013, 4:20 PM',
 244       'Test Document.gdoc', '--', 'Google document'),
 245
 246   testSharedDocument: new TestEntryInfo(
 247       EntryType.FILE, null, 'Test Shared Document',
 248       'application/vnd.google-apps.document',
 249       SharedOption.SHARED, 'Mar 20, 2013, 10:40 PM',
 250       'Test Shared Document.gdoc', '--', 'Google document'),
 251
 252   newlyAdded: new TestEntryInfo(
 253       EntryType.FILE, 'music.ogg', 'newly added file.ogg',
 254       'audio/ogg', SharedOption.NONE, 'Sep 4, 1998, 12:00 AM',
 255       'newly added file.ogg', '14 KB', 'OGG audio'),
 256
 257   directoryA: new TestEntryInfo(
 258       EntryType.DIRECTORY, null, 'A',
 259       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 260       'A', '--', 'Folder'),
 261
 262   directoryB: new TestEntryInfo(
 263       EntryType.DIRECTORY, null, 'A/B',
 264       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 265       'B', '--', 'Folder'),
 266
 267   directoryC: new TestEntryInfo(
 268       EntryType.DIRECTORY, null, 'A/B/C',
 269       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 270       'C', '--', 'Folder'),
 271
 272   directoryD: new TestEntryInfo(
 273       EntryType.DIRECTORY, null, 'D',
 274       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 275       'D', '--', 'Folder'),
 276
 277   directoryE: new TestEntryInfo(
 278       EntryType.DIRECTORY, null, 'D/E',
 279       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 280       'E', '--', 'Folder'),
 281
 282   directoryF: new TestEntryInfo(
 283       EntryType.DIRECTORY, null, 'D/E/F',
 284       null, SharedOption.NONE, 'Jan 1, 2000, 1:00 AM',
 285       'F', '--', 'Folder'),
 286
 287   zipArchive: new TestEntryInfo(
 288       EntryType.FILE, 'archive.zip', 'archive.zip',
 289       'application/x-zip', SharedOption.NONE, 'Jan 1, 2014, 1:00 AM',
 290       'archive.zip', '533 bytes', 'Zip archive')
 291 };