setup.ts

/**
 * @license
 * Copyright 2019 Google Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

import 'core-js/es'; // COPYBARA_COMMENT_THIS_LINE
import {MDCFoundation, MDCFoundationAdapter as FoundationAdapter, MDCFoundationConstructor as FoundationCtor, MDCFoundationDeprecatedConstructor as FoundationDeprecatedCtor} from '@material/base/foundation';

import {createMockAdapter} from './foundation';
import {spyOnAllFunctions} from './jasmine';

/** FoundationTest */
export interface FoundationTest<F extends MDCFoundation> {
  foundation: F;
  mockAdapter: jasmine.SpyObj<FoundationAdapter<F>>;
}

/** Alias type imports for shorter names due to clang-format's formatting */
export function setUpFoundationTest<C extends FoundationCtor>(
    foundationClass: C, defaultAdapter: FoundationAdapter<InstanceType<C>>):
    FoundationTest<InstanceType<C>>;
export function setUpFoundationTest<C extends FoundationDeprecatedCtor>(
    foundationClass: C,
    ): FoundationTest<InstanceType<C>>;
export function setUpFoundationTest(
    foundationClass: FoundationCtor|FoundationDeprecatedCtor,
    defaultAdapter?: FoundationAdapter<InstanceType<typeof foundationClass>>) {
  let mockAdapter: jasmine.SpyObj<typeof defaultAdapter>;
  if (defaultAdapter) {
    mockAdapter = spyOnAllFunctions(defaultAdapter).and.callThrough();
  } else {
    mockAdapter =
        createMockAdapter(foundationClass as FoundationDeprecatedCtor);
  }
  const foundation = new foundationClass(mockAdapter);
  return {foundation, mockAdapter};
}

/**
 * Sets up common functionality across all MDC foundation/component unit tests:
 * - Installation of the Jasmine clock.
 * - Replaces RAF with setTimeout so functionality in RAF's can be tested with
 *   the Jasmine clock.
 */
export function setUpMdcTestEnvironment() {
  beforeAll(() => {
    // Replace RAF with setTimeout, since setTimeout is overridden to be
    // synchronous in Jasmine clock installation.
    window.requestAnimationFrame = (fn: Function) => setTimeout(fn, 1);
    window.cancelAnimationFrame = (id: number) => {
      clearTimeout(id);
    };
  });

  beforeEach(() => {
    jasmine.clock().install();
  });

  afterEach(() => {
    jasmine.clock().uninstall();
  });
}