Partilhar via

Referência da API

Esta API de referência do Power Platform Playwright documenta classes, métodos e tipos públicos que pode usar para automatizar testes de ponta a ponta de aplicações orientadas a modelos e canvas.

AppProvider

Ponto de entrada para lançar aplicações Power Platform. Instancia uma vez por teste, depois liga launch()para .

class AppProvider {
  constructor(page: Page, context: BrowserContext)

  launch(options: AppLaunchOptions): Promise<void>
  getModelDrivenAppPage(): ModelDrivenAppPage
  getCanvasAppPage(): CanvasAppPage
  getGenUxPage(): GenUxPage
}

AppLaunchOptions

Passaram opções para AppProvider.launch() configurar qual aplicação abrir e como.

interface AppLaunchOptions {
  app: string;                  // Display name of the app
  type: AppType;                // Canvas | ModelDriven
  mode: AppLaunchMode;          // Play | Edit
  skipMakerPortal?: boolean;    // true: use directUrl, skip make.powerapps.com navigation
  directUrl?: string;           // Full URL when skipMakerPortal is true
}

AppType

Especifica o tipo de aplicação Power Platform a lançar.

enum AppType {
  Canvas = 'canvas',
  ModelDriven = 'model-driven',
}

AppLaunchMode

Determina se a aplicação abre no modo de reprodução ou no modo de edição.

enum AppLaunchMode {
  Play = 'play',
  Edit = 'edit',
}

ModelDrivenAppPage

Retornado por AppProvider.getModelDrivenAppPage(). Fornece navegação e acesso a componentes.

class ModelDrivenAppPage {
  readonly grid: GridComponent
  readonly form: FormComponent
  readonly commanding: CommandingComponent

  navigateToGridView(entityLogicalName: string): Promise<void>
  navigateToFormView(entityLogicalName: string): Promise<void>
}

GridComponent

Envolve a Grelha AG usada em vistas de lista orientadas por modelos. Acedido via ModelDrivenAppPage.grid.

class GridComponent {
  waitForGridLoad(): Promise<void>

  filterByKeyword(keyword: string): Promise<void>
  filterByColumn(columnName: string, value: string): Promise<void>

  getCellValue(rowIndex: number, columnName: string): Promise<string | null>
  getRowCount(): Promise<number>
  isGridEmpty(): Promise<boolean>

  openRecord(options: OpenRecordOptions): Promise<void>
  selectRow(rowIndex: number): Promise<void>
  selectRows(rowIndexes: number[]): Promise<void>
}

OpenRecordOptions

Opções para identificar qual registo abrir na grelha.

interface OpenRecordOptions {
  rowNumber?: number;         // 0-based row index
  columnName?: string;        // column to match (display name or schema name)
  columnValue?: string;       // value to match in the column
}

FormComponent

Envolve o formato de execução do Dynamics 365. Acedido via ModelDrivenAppPage.form.

class FormComponent {
  getAttribute(fieldName: string): Promise<string | null>
  setAttribute(fieldName: string, value: string): Promise<void>

  save(): Promise<void>
  isDirty(): Promise<boolean>
  isValid(): Promise<boolean>

  navigateToTab(tabName: string): Promise<void>

  setFieldVisibility(fieldName: string, visible: boolean): Promise<void>
  setFieldDisabled(fieldName: string, disabled: boolean): Promise<void>
  setFieldRequiredLevel(
    fieldName: string,
    level: 'none' | 'recommended' | 'required'
  ): Promise<void>

  execute<T>(
    fn: (formContext: Xrm.FormContext) => T | Promise<T>
  ): Promise<T>
}

FormComponent.execute()

Executa código arbitrário no contexto do formulário do navegador, com acesso total à API do Cliente Xrm:

const value = await mda.form.execute(
  (ctx) => ctx.getAttribute('nwind_ordernumber')?.getValue()
);

Consulte testes de API através do contexto do formulário para utilização detalhada.

CommandingComponent

Envolve a barra de comandos da aplicação orientada ao modelo. Acedido via ModelDrivenAppPage.commanding.

class CommandingComponent {
  clickButton(ariaLabel: string): Promise<void>
  clickMoreCommands(): Promise<void>
}

CanvasAppPage

Retornado por AppProvider.getCanvasAppPage(). Fornece o localizador de frames iframe de tela.

class CanvasAppPage {
  getFrame(): FrameLocator
  waitForLoad(controlName?: string): Promise<void>
}

GenUxPage

Retornado por AppProvider.getGenUxPage(). Proporciona interações com o designer de IA GenUX do Power Apps Maker Portal para criar, gerar, inspecionar e publicar aplicações orientadas a modelos a partir de prompts de IA.

class GenUxPage {
  readonly previewFrame: FrameLocator  // UCI Preview iframe locator

  // Power Apps navigation
  goToAppsPage(): Promise<void>
  navigateToStartWithPageDesign(): Promise<void>
  createAppWithName(appName: string): Promise<void>
  addNewPage(): Promise<void>

  // AI generation
  waitForUCIPreviewFrameAndFillPrompt(prompt: string): Promise<void>
  waitForUCIPreviewFrameAndSelectTemplate(templateText: string): Promise<void>
  verifyThoughtStreaming(): Promise<void>
  verifyCodeAndPreviewTabsAvailable(): Promise<void>
  verifyCodeStreaming(): Promise<void>

  // Inspection
  clickPreviewTab(): Promise<void>
  clickCodeTab(): Promise<void>
  waitForGeneratedContent(): Promise<void>
  waitForCodeTabContent(): Promise<void>
  getPreviewTabDom(): Promise<string>
  getCodeTabContent(): Promise<string>

  // Publishing
  publishApp(): Promise<void>
  buildCanvasPlayUrl(): string

  // Form interaction
  submitForm(): Promise<void>
  waitForSubmitSuccess(timeout?: number): Promise<void>

  // App management
  getAppIdFromUrl(): string
  searchAndPlayApp(appName: string, context: BrowserContext): Promise<Page | null>
  deleteAppsMatchingPrefix(prefix: string): Promise<void>
  deleteAppFromAppListIfFound(appName: string): Promise<void>
}

GenUxPage.previewFrame

Expõe o FrameLocator para o iframe da Pré-visualização UCI. Use esta propriedade para consultar diretamente elementos de formulário gerados:

const input = genUxPage.previewFrame.getByRole('textbox', { name: 'First Name' });
await expect(input).toBeVisible();

GenUxPage.verifyThoughtStreaming()

Verifica indicadores transitórios de streaming GenUX, como texto de pensamento, botão de Parar e Pensamentos do Agente. Cada verificação é de melhor esforço – a geração pode terminar antes de todos os indicadores aparecerem. A única afirmação sólida é que ou o streaming está em curso ou "Your page is now generated" é visível.

GenUxPage.searchAndPlayApp()

Retorna null quando o Play está desativado (a app ainda não está publicada) em vez de lançar um erro. Uso test.skip() numa null devolução:

const appPage = await genUxPage.searchAndPlayApp(appName, context);
if (!appPage) test.skip();

Funções utilitárias

Funções auxiliares autónomas para tarefas comuns de configuração e configuração.

buildCanvasAppUrlFromEnv

Leituras CANVAS_APP_URL do ambiente:

function buildCanvasAppUrlFromEnv(): string

getStorageStatePath

Devolve o caminho para o ficheiro de estado de armazenamento Power Apps para o email dado:

function getStorageStatePath(email: string): string
// Returns: packages/e2e-tests/.playwright-ms-auth/state-<email>.json

ConfigHelper

Fornece ajudantes de configuração, como verificar se o estado de armazenamento em cache expirou.

class ConfigHelper {
  static checkStorageStateExpiration(
    statePath: string
  ): { expired: boolean; expiresOn?: number }
}

Utilidades localizadoras

Métodos auxiliares para localizar controlos do Power Apps dentro dos iframes.

LocatorUtils

Métodos estáticos para encontrar controlos de aplicações de canvas e itens de galeria por nome.

class LocatorUtils {
  static getByControlName(frame: FrameLocator, controlName: string): Locator
  static getGalleryItem(frame: FrameLocator, titleText: string): Locator
}

Exportações de tipos

Exporte todos os tipos a partir da raiz do pacote:

import {
  AppProvider,
  AppType,
  AppLaunchMode,
  AppLaunchOptions,
  ModelDrivenAppPage,
  GridComponent,
  FormComponent,
  CommandingComponent,
  CanvasAppPage,
  GenUxPage,
  buildCanvasAppUrlFromEnv,
  getStorageStatePath,
  ConfigHelper,
  LocatorUtils,
} from 'power-platform-playwright-toolkit';

Passos seguintes

Consulte também

  • Last updated on