google-closure-library/closure/goog/testing/mockuseragent.js

Google's common JavaScript library

/**
 * @license
 * Copyright The Closure Library Authors.
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @fileoverview MockUserAgent overrides goog.userAgent.getUserAgentString()
 *     depending on a specified configuration.
 */

goog.setTestOnly('goog.testing.MockUserAgent');
goog.provide('goog.testing.MockUserAgent');

goog.require('goog.Disposable');
goog.require('goog.labs.userAgent.util');
goog.require('goog.testing.PropertyReplacer');
goog.require('goog.userAgent');



/**
 * Class for unit testing code that uses goog.userAgent.
 *
 * @extends {goog.Disposable}
 * @constructor
 * @final
 */
goog.testing.MockUserAgent = function() {
  'use strict';
  goog.Disposable.call(this);

  /**
   * Property replacer used to mock out User-Agent functions.
   * @type {!goog.testing.PropertyReplacer}
   * @private
   */
  this.propertyReplacer_ = new goog.testing.PropertyReplacer();

  /**
   * The userAgent string used by goog.userAgent.
   * @type {?string}
   * @private
   */
  this.userAgent_ = goog.userAgent.getUserAgentString();

  /**
   * The navigator object used by goog.userAgent
   * @type {?Navigator}
   * @private
   */
  this.navigator_ = goog.userAgent.getNavigatorTyped();

  /**
   * The documentMode number used by goog.userAgent
   * @type {number|undefined}
   * @private
   */
  this.documentMode_ = goog.userAgent.DOCUMENT_MODE;
};
goog.inherits(goog.testing.MockUserAgent, goog.Disposable);


/**
 * Whether this MockUserAgent has been installed.
 * @type {boolean}
 * @private
 */
goog.testing.MockUserAgent.prototype.installed_;


/**
 * Installs this MockUserAgent.
 */
goog.testing.MockUserAgent.prototype.install = function() {
  'use strict';
  if (!this.installed_) {
    // Stub out user agent functions.
    this.propertyReplacer_.replace(
        goog.userAgent, 'getUserAgentString',
        goog.bind(this.getUserAgentString, this));

    // Stub out navigator functions.
    this.propertyReplacer_.replace(
        goog.userAgent, 'getNavigator', goog.bind(this.getNavigator, this));

    // Stub out navigator functions.
    this.propertyReplacer_.replace(
        goog.userAgent, 'getNavigatorTyped',
        goog.bind(this.getNavigator, this));

    // Stub out documentMode functions.
    this.propertyReplacer_.replace(
        goog.userAgent, 'getDocumentMode_',
        goog.bind(this.getDocumentMode, this));

    this.propertyReplacer_.replace(
        goog.userAgent, 'DOCUMENT_MODE', this.getDocumentMode());

    this.installed_ = true;
  }
};


/**
 * @return {?string} The userAgent set in this class.
 */
goog.testing.MockUserAgent.prototype.getUserAgentString = function() {
  'use strict';
  return this.userAgent_;
};


/**
 * @param {string} userAgent The desired userAgent string to use.
 */
goog.testing.MockUserAgent.prototype.setUserAgentString = function(userAgent) {
  'use strict';
  this.userAgent_ = userAgent;
  // goog.labs.userAgent.util is a goog.module, so its properties can't be
  // stubbed. Use setUserAgent instead.
  goog.labs.userAgent.util.setUserAgent(userAgent);
};


/**
 * @return {?Object} The Navigator set in this class.
 */
goog.testing.MockUserAgent.prototype.getNavigator = function() {
  'use strict';
  return this.navigator_;
};


/**
 * @return {?Navigator} The Navigator set in this class.
 */
goog.testing.MockUserAgent.prototype.getNavigatorTyped = function() {
  'use strict';
  return this.navigator_;
};

/**
 * @param {Object} navigator The desired Navigator object to use.
 */
goog.testing.MockUserAgent.prototype.setNavigator = function(navigator) {
  'use strict';
  this.navigator_ = /** @type {?Navigator} */ (navigator);
};

/**
 * @return {number|undefined} The documentMode set in this class.
 */
goog.testing.MockUserAgent.prototype.getDocumentMode = function() {
  'use strict';
  return this.documentMode_;
};

/**
 * @param {number} documentMode The desired documentMode to use.
 */
goog.testing.MockUserAgent.prototype.setDocumentMode = function(documentMode) {
  'use strict';
  this.documentMode_ = documentMode;
  this.propertyReplacer_.set(goog.userAgent, 'DOCUMENT_MODE', documentMode);
};

/**
 * Uninstalls the MockUserAgent.
 */
goog.testing.MockUserAgent.prototype.uninstall = function() {
  'use strict';
  if (this.installed_) {
    this.propertyReplacer_.reset();
    goog.labs.userAgent.util.setUserAgent(null);
    this.installed_ = false;
  }
};


/** @override */
goog.testing.MockUserAgent.prototype.disposeInternal = function() {
  'use strict';
  this.uninstall();
  delete this.propertyReplacer_;
  delete this.navigator_;
  delete this.documentMode_;
  goog.testing.MockUserAgent.base(this, 'disposeInternal');
};