Print out label and description on task entry in Audit task runner

third_party/WebKit/LayoutTests/webaudio/resources/audit.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.
 
 
 /**
  * @fileOverview  WebAudio layout test utility library. Built around W3C's
  *                testharness.js. Includes asynchronous test task manager,
  *                assertion utilities.
  * @dependency    testharness.js
@@ skipping 908 matching lines @@
     FINISHED: 2
   };
 
 
   /**
    * @class Task
    * @description WebAudio testing task. Managed by TaskRunner.
    */
   class Task {
 
+    /**
+     * Task constructor.
+     * @param  {Object} taskRunner Reference of associated task runner.
+     * @param  {String||Object} taskLabel Task label if a string is given. This
+     *                                    parameter can be a dictionary with the
+     *                                    following fields.
+     * @param  {String} taskLabel.label Task label.
+     * @param  {String} taskLabel.description Description of task.
+     * @param  {Function} taskFunction Task function to be performed.
+     * @return {Object} Task object.
+     */
     constructor (taskRunner, taskLabel, taskFunction) {
       this._taskRunner = taskRunner;
       this._taskFunction = taskFunction;
-      this._label = taskLabel;
-      this._description = '';
+
+      if (typeof taskLabel === 'string') {
+        this._label = taskLabel;
+        this._description = null;
+      } else if (typeof taskLabel === 'object') {
+        if (typeof taskLabel.label !== 'string') {
+          _throwException('Task.constructor:: task label must be string.');
+        }
+        this._label = taskLabel.label;
+        this._description = (typeof taskLabel.description === 'string')
+            ? taskLabel.description : null;
+      } else {
+        _throwException('Task.constructor:: task label must be a string or ' +
+                        'a dictionary.');
+      }
+
       this._state = TaskState.PENDING;
       this._result = true;
 
       this._totalAssertions = 0;
       this._failedAssertions = 0;
     }
 
-    // Set the description of this task. This is printed out in the test
-    // result.
+    // Set the description of this task. This is printed out in the test result
+    // right after the task starts. If the description is defined at the
+    // construction, this method does not have any effect.
     describe (message) {
-      this._description = message;
-      _logPassed('> [' + this._label + '] '
-          + this._description);
+      // TODO(hongchan): remove this method and fix layout test files use it.
+    }
+
+    get label () {
+      return this._label;
     }
 
     get state () {
       return this._state;
     }
 
     get result () {
       return this._result;
     }
 
     // Start the assertion chain.
     should (actual, actualDescription) {
       // If no argument is given, we cannot proceed. Halt.
       if (arguments.length === 0)
         _throwException('Task.should:: requires at least 1 argument.');
 
       return new Should(this, actual, actualDescription);
     }
 
     // Run this task. |this| task will be passed into the user-supplied test
     // task function.
     run () {
       this._state = TaskState.STARTED;
+
+      // Print out the task entry with label and description.
+      _logPassed('> [' + this._label + '] '
+          + (this._description ? this._description : ''));
+
       this._taskFunction(
           this,
           this.should.bind(this));
     }
 
     // Update the task success based on the individual assertion/test inside.
     update (subTask) {
       // After one of tests fails within a task, the result is irreversible.
       if (subTask.result === false) {
         this._result = false;
@@ skipping 72 matching lines @@
       } else {
         _logPassed(prefix + this._taskSequence.length
           + ' tasks ran successfully.');
       }
 
       // From testharness.js, report back to the test infrastructure that
       // the task runner completed all the tasks.
       done();
     }
 
+    // |taskLabel| can be either a string or a dictionary. See Task constructor
+    // for the detail.
     define (taskLabel, taskFunction) {
-      if (this._tasks.hasOwnProperty(taskLabel)) {
+      let task = new Task(this, taskLabel, taskFunction);
+      if (this._tasks.hasOwnProperty(task.label)) {
         _throwException('Audit.define:: Duplicate task definition.');
         return;
       }
-
-      this._tasks[taskLabel] = new Task(this, taskLabel, taskFunction);
-      this._taskSequence.push(taskLabel);
+      this._tasks[task.label] = task;
+      this._taskSequence.push(task.label);
     }
 
     // Start running all the tasks scheduled. Multiple task names can be passed
     // to execute them sequentially. Zero argument will perform all defined
     // tasks in the order of definition.
     run () {
       // Display the beginning of the test suite.
       _logPassed('# AUDIT TASK RUNNER STARTED.');
 
       // If the argument is specified, override the default task sequence with
@@ skipping 103 matching lines @@
 
     /**
      * Load file from a given URL and pass ArrayBuffer to the following promise.
      * See |loadFileFromUrl| method for the detail.
      */
     loadFileFromUrl: loadFileFromUrl
 
   };
 
 })();