xref: /test/testfwk/arkxtest/jsunit/index.d.ts (revision 886da342)

/*
 * Copyright (c) 2021-2024 Huawei Device Co., Ltd.
 * 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.
 */

export const DEFAULT = 0B0000

export const when: when;

export enum TestType {
  FUNCTION = 0B1,
  PERFORMANCE = 0B1 << 1,
  POWER = 0B1 << 2,
  RELIABILITY = 0B1 << 3,
  SECURITY = 0B1 << 4,
  GLOBAL = 0B1 << 5,
  COMPATIBILITY = 0B1 << 6,
  USER = 0B1 << 7,
  STANDARD = 0B1 << 8,
  SAFETY = 0B1 << 9,
  RESILIENCE = 0B1 << 10
}

export enum Size {
  SMALLTEST = 0B1 << 16,
  MEDIUMTEST = 0B1 << 17,
  LARGETEST = 0B1 << 18
}

export enum Level {
  LEVEL0 = 0B1 << 24,
  LEVEL1 = 0B1 << 25,
  LEVEL2 = 0B1 << 26,
  LEVEL3 = 0B1 << 27,
  LEVEL4 = 0B1 << 28
}
export { xdescribe, xit, describe, it } from './index';



export function beforeItSpecified(testCaseNames: Array<string> | string, callback: Function): void

export function afterItSpecified(testCaseNames: Array<string> | string, callback: Function): void

export function beforeEach(callback: Function): void

export function afterEach(callback: Function): void

export function beforeAll(callback: Function): void

export function afterAll(callback: Function): void


export interface Assert {
  assertClose(expectValue: number, precision: number): void
  assertContain(expectValue: any): void
  assertEqual(expectValue: any): void
  assertFail(): void
  assertFalse(): void
  assertTrue(): void
  assertInstanceOf(expectValue: string): void
  assertLarger(expectValue: number): void
  assertLess(expectValue: number): void
  assertNull(): void
  assertThrowError(expectValue: string | Function): void
  assertUndefined(): void
  assertLargerOrEqual(expectValue: number): void
  assertLessOrEqual(expectValue: number): void
  assertNaN(): void
  assertNegUnlimited(): void
  assertPosUnlimited(): void
  not(): Assert;
  assertDeepEquals(expectValue: any): void
  assertPromiseIsPending(): Promise<void>
  assertPromiseIsRejected(): Promise<void>
  assertPromiseIsRejectedWith(expectValue?: any): Promise<void>
  assertPromiseIsRejectedWithError(...expectValue): Promise<void>
  assertPromiseIsResolved(): Promise<void>
  assertPromiseIsResolvedWith(expectValue?: any): Promise<void>
  message(msg: string): Assert
}

export function expect(actualValue?: any): Assert

export class ArgumentMatchers {
  static any;
  static anyString;
  static anyBoolean;
  static anyNumber;
  static anyObj;
  static anyFunction;
  static matchRegexs(Regex: RegExp): void
}

declare interface when {
  afterReturn(value: any): any
  afterReturnNothing(): undefined
  afterAction(action: any): any
  afterThrow(e_msg: string): string
  (argMatchers?: any): when;
}

export interface VerificationMode {
  times(count: Number): void
  never(): void
  once(): void
  atLeast(count: Number): void
  atMost(count: Number): void
}

export class MockKit {
  constructor()
  mockFunc(obj: Object, func: Function): Function
  mockObject(obj: Object): Object
  verify(methodName: String, argsArray: Array<any>): VerificationMode
  ignoreMock(obj: Object, func: Function): void
  clear(obj: Object): void
  clearAll(): void
}

export class SysTestKit {
  static getDescribeName(): string;
  static getItName(): string;
  static getItAttribute(): TestType | Size | Level
  static actionStart(tag: string): void
  static actionEnd(tag: string): void
  static existKeyword(keyword: string, timeout?: number): boolean
}

export class Hypium {
  static setData(data: { [key: string]: any }): void
  static setTimeConfig(systemTime: any)
  static hypiumTest(abilityDelegator: any, abilityDelegatorArguments: any, testsuite: Function): void
  static set(key: string, value: any): void
  static get(key: string): any
  static registerAssert(customAssertion: Function): void
  static unregisterAssert(customAssertion: string | Function): void
  static hypiumWorkerTest(abilityDelegator: Object, abilityDelegatorArguments: Object, testsuite: Function, workerPort: Object): void;
  static hypiumInitWorkers(abilityDelegator: Object, scriptURL: string, workerNum: number, params: Object): void;
}