// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

goog.provide('registry.registrar.ConsoleTestUtil');
goog.setTestOnly('registry.registrar.ConsoleTestUtil');

goog.require('goog.History');
goog.require('goog.asserts');
goog.require('goog.dom.xml');
goog.require('goog.soy');
goog.require('goog.testing.mockmatchers');
goog.require('registry.registrar.Console');
goog.require('registry.registrar.EppSession');
goog.require('registry.soy.registrar.console');
goog.require('registry.xml');


/**
 * Utility method that attaches mocks to a `TestCase`.  This was
 * originally in the ctor for ConsoleTest and should simply be
 * inherited but jstd_test breaks inheritance in test cases.
 * @param {!Object} test the test case to configure.
 */
registry.registrar.ConsoleTestUtil.setup = function(test) {
  test.historyMock = test.mockControl.createLooseMock(goog.History, true);
  test.sessionMock = test.mockControl.createLooseMock(
      registry.registrar.EppSession, true);
  test.mockControl.createConstructorMock(goog, 'History')()
      .$returns(test.historyMock);
  test.mockControl
      .createConstructorMock(registry.registrar, 'EppSession')(
          goog.testing.mockmatchers.isObject)
      .$returns(test.sessionMock);
};

/**
 * Utility method that renders the registry.soy.registrar.console.main element.
 *
 * This element has a lot of parameters. We use defaults everywhere, but you can
 * override them with 'opt_args'.
 *
 * @param {!Element} element the element whose content we are rendering into.
 * @param {?Object=} opt_args override for the default values of the soy params.
 */
registry.registrar.ConsoleTestUtil.renderConsoleMain = function(
    element, opt_args) {
  const args = opt_args || {};
  goog.soy.renderElement(element, registry.soy.registrar.console.main, {
    xsrfToken: args.xsrfToken || 'ignore',
    username: args.username || 'jart',
    logoutUrl: args.logoutUrl || 'https://logout.url.com',
    isAdmin: !!args.isAdmin,
    clientId: args.clientId || 'ignore',
    allClientIds: args.allClientIds || ['clientId1', 'clientId2'],
    logoFilename: args.logoFilename || 'logo.png',
    productName: args.productName || 'Nomulus',
    integrationEmail: args.integrationEmail || 'integration@example.com',
    supportEmail: args.supportEmail || 'support@example.com',
    announcementsEmail: args.announcementsEmail || 'announcement@example.com',
    supportPhoneNumber: args.supportPhoneNumber || '+1 (888) 555 0123',
    technicalDocsUrl: args.technicalDocsUrl || 'http://example.com/techdocs',
  });
};


/**
 * Simulates visiting a page on the console.  Sets path, then mocks
 * session and calls `handleHashChange_`.
 * @param {!Object} test the test case to configure.
 * @param {?Object=} opt_args may include path, isEppLoggedIn.
 * @param {?Function=} opt_moar extra setup after called just before
 *     `$replayAll`.  See memegen/3437690.
 */
registry.registrar.ConsoleTestUtil.visit = function(
    test, opt_args, opt_moar) {
  opt_args = opt_args || {};
  opt_args.path = opt_args.path || '';
  opt_args.clientId = opt_args.clientId || 'dummyRegistrarId';
  opt_args.xsrfToken = opt_args.xsrfToken || 'dummyXsrfToken';
  opt_args.isAdmin = !!opt_args.isAdmin;
  if (opt_args.isEppLoggedIn === undefined) {
    opt_args.isEppLoggedIn = true;
  }
  test.historyMock.$reset();
  test.sessionMock.$reset();
  test.historyMock.getToken().$returns(opt_args.path).$anyTimes();
  test.sessionMock.isEppLoggedIn().$returns(opt_args.isEppLoggedIn).$anyTimes();
  test.sessionMock.getClientId().$returns(opt_args.isEppLoggedIn ?
      opt_args.clientId : null).$anyTimes();
  if (opt_args.rspXml) {
    test.sessionMock
        .send(goog.testing.mockmatchers.isString,
              goog.testing.mockmatchers.isFunction)
        .$does(function(args, cb) {
          // XXX: Args should be checked.
          const xml = goog.dom.xml.loadXml(opt_args.rspXml);
          goog.asserts.assert(xml != null);
          cb(registry.xml.convertToJson(xml));
        }).$anyTimes();
  }
  if (opt_moar) {
    opt_moar();
  }
  test.mockControl.$replayAll();
  /** @type {!registry.registrar.Console} */
  test.console = new registry.registrar.Console(opt_args);
  // XXX: Should be triggered via event passing.
  test.console.handleHashChange();
  test.mockControl.$verifyAll();
};