@wordpress/e2e-test-utils-playwright 1.48.0 → 1.48.2-next.v.202606191442.0

package/src/request-utils/index.ts

@@ -1,222 +0,0 @@
-/**
- * External dependencies
- */
-import * as fs from 'fs/promises';
-import * as path from 'path';
-import { request } from '@playwright/test';
-import type { APIRequestContext, Cookie } from '@playwright/test';
-
-/**
- * Internal dependencies
- */
-import { WP_ADMIN_USER, WP_BASE_URL } from '../config';
-import type { User } from './login';
-import { login } from './login';
-import { listMedia, uploadMedia, deleteMedia, deleteAllMedia } from './media';
-import { createUser, deleteAllUsers } from './users';
-import { setupRest, rest, getMaxBatchSize, batchRest } from './rest';
-import { getPluginsMap, activatePlugin, deactivatePlugin } from './plugins';
-import { deleteAllTemplates, createTemplate } from './templates';
-import {
-	activateTheme,
-	getCurrentThemeGlobalStylesPostId,
-	getThemeGlobalStylesRevisions,
-} from './themes';
-import { createBlock, deleteAllBlocks } from './blocks';
-import { createComment, deleteAllComments } from './comments';
-import { createPost, deleteAllPosts } from './posts';
-import {
-	createClassicMenu,
-	createNavigationMenu,
-	deleteAllMenus,
-	getNavigationMenus,
-} from './menus';
-import { deleteAllPages, createPage } from './pages';
-import { createRecord } from './records';
-import { resetPreferences, setPreferences } from './preferences';
-import { getSiteSettings, updateSiteSettings } from './site-settings';
-import { deleteAllWidgets, addWidgetBlock } from './widgets';
-import { deleteAllPatternCategories } from './patterns';
-import { setGutenbergExperiments } from './gutenberg-experiments';
-
-interface StorageState {
-	cookies: Cookie[];
-	nonce: string;
-	rootURL: string;
-}
-
-class RequestUtils {
-	request: APIRequestContext;
-	user: User;
-	maxBatchSize?: number;
-	storageState?: StorageState;
-	storageStatePath?: string;
-	baseURL?: string;
-
-	pluginsMap: Record< string, string > | null = null;
-
-	static async setup( {
-		user,
-		storageStatePath,
-		baseURL = WP_BASE_URL,
-	}: {
-		user?: User;
-		storageStatePath?: string;
-		baseURL?: string;
-	} ) {
-		let storageState: StorageState | undefined;
-		if ( storageStatePath ) {
-			await fs.mkdir( path.dirname( storageStatePath ), {
-				recursive: true,
-			} );
-
-			try {
-				storageState = JSON.parse(
-					await fs.readFile( storageStatePath, 'utf-8' )
-				);
-			} catch ( error ) {
-				if (
-					error instanceof Error &&
-					( error as NodeJS.ErrnoException ).code === 'ENOENT'
-				) {
-					// Ignore errors if the state is not found.
-				} else {
-					throw error;
-				}
-			}
-		}
-
-		const requestContext = await request.newContext( {
-			baseURL,
-			storageState: storageState && {
-				cookies: storageState.cookies,
-				origins: [],
-			},
-		} );
-
-		const requestUtils = new this( requestContext, {
-			user,
-			storageState,
-			storageStatePath,
-			baseURL,
-		} );
-
-		return requestUtils;
-	}
-
-	constructor(
-		requestContext: APIRequestContext,
-		{
-			user = WP_ADMIN_USER,
-			storageState,
-			storageStatePath,
-			baseURL = WP_BASE_URL,
-		}: {
-			user?: User;
-			storageState?: StorageState;
-			storageStatePath?: string;
-			baseURL?: string;
-		} = {}
-	) {
-		this.user = user;
-		this.request = requestContext;
-		this.storageStatePath = storageStatePath;
-		this.storageState = storageState;
-		this.baseURL = baseURL;
-	}
-
-	/** @borrows login as this.login */
-	login: typeof login = login.bind( this );
-	/** @borrows setupRest as this.setupRest */
-	setupRest: typeof setupRest = setupRest.bind( this );
-	// .bind() drops the generic types. Re-casting it to keep the type signature.
-	rest: typeof rest = rest.bind( this ) as typeof rest;
-	/** @borrows getMaxBatchSize as this.getMaxBatchSize */
-	getMaxBatchSize: typeof getMaxBatchSize = getMaxBatchSize.bind( this );
-	// .bind() drops the generic types. Re-casting it to keep the type signature.
-	batchRest: typeof batchRest = batchRest.bind( this ) as typeof batchRest;
-	// .bind() drops the generic types. Re-casting it to keep the type signature.
-	createRecord: typeof createRecord = createRecord.bind(
-		this
-	) as typeof createRecord;
-	/** @borrows getPluginsMap as this.getPluginsMap */
-	getPluginsMap: typeof getPluginsMap = getPluginsMap.bind( this );
-	/** @borrows activatePlugin as this.activatePlugin */
-	activatePlugin: typeof activatePlugin = activatePlugin.bind( this );
-	/** @borrows deactivatePlugin as this.deactivatePlugin */
-	deactivatePlugin: typeof deactivatePlugin = deactivatePlugin.bind( this );
-	/** @borrows activateTheme as this.activateTheme */
-	activateTheme: typeof activateTheme = activateTheme.bind( this );
-	/** @borrows createBlock as this.createBlock */
-	createBlock: typeof createBlock = createBlock.bind( this );
-	/** @borrows deleteAllBlocks as this.deleteAllBlocks */
-	deleteAllBlocks = deleteAllBlocks.bind( this );
-	/** @borrows createPost as this.createPost */
-	createPost: typeof createPost = createPost.bind( this );
-	/** @borrows deleteAllPosts as this.deleteAllPosts */
-	deleteAllPosts: typeof deleteAllPosts = deleteAllPosts.bind( this );
-	/** @borrows createClassicMenu as this.createClassicMenu */
-	createClassicMenu: typeof createClassicMenu =
-		createClassicMenu.bind( this );
-	/** @borrows createNavigationMenu as this.createNavigationMenu */
-	createNavigationMenu: typeof createNavigationMenu =
-		createNavigationMenu.bind( this );
-	/** @borrows deleteAllMenus as this.deleteAllMenus */
-	deleteAllMenus: typeof deleteAllMenus = deleteAllMenus.bind( this );
-	/** @borrows getNavigationMenus as this.getNavigationMenus */
-	getNavigationMenus: typeof getNavigationMenus =
-		getNavigationMenus.bind( this );
-	/** @borrows createComment as this.createComment */
-	createComment: typeof createComment = createComment.bind( this );
-	/** @borrows deleteAllComments as this.deleteAllComments */
-	deleteAllComments: typeof deleteAllComments =
-		deleteAllComments.bind( this );
-	/** @borrows deleteAllWidgets as this.deleteAllWidgets */
-	deleteAllWidgets: typeof deleteAllWidgets = deleteAllWidgets.bind( this );
-	/** @borrows addWidgetBlock as this.addWidgetBlock */
-	addWidgetBlock: typeof addWidgetBlock = addWidgetBlock.bind( this );
-	/** @borrows deleteAllTemplates as this.deleteAllTemplates */
-	deleteAllTemplates: typeof deleteAllTemplates =
-		deleteAllTemplates.bind( this );
-	/** @borrows createTemplate as this.createTemplate */
-	createTemplate: typeof createTemplate = createTemplate.bind( this );
-	/** @borrows resetPreferences as this.resetPreferences */
-	resetPreferences: typeof resetPreferences = resetPreferences.bind( this );
-	/** @borrows setPreferences as this.setPreferences */
-	setPreferences: typeof setPreferences = setPreferences.bind( this );
-	/** @borrows listMedia as this.listMedia */
-	listMedia: typeof listMedia = listMedia.bind( this );
-	/** @borrows uploadMedia as this.uploadMedia */
-	uploadMedia: typeof uploadMedia = uploadMedia.bind( this );
-	/** @borrows deleteMedia as this.deleteMedia */
-	deleteMedia: typeof deleteMedia = deleteMedia.bind( this );
-	/** @borrows deleteAllMedia as this.deleteAllMedia */
-	deleteAllMedia: typeof deleteAllMedia = deleteAllMedia.bind( this );
-	/** @borrows createUser as this.createUser */
-	createUser: typeof createUser = createUser.bind( this );
-	/** @borrows deleteAllUsers as this.deleteAllUsers */
-	deleteAllUsers: typeof deleteAllUsers = deleteAllUsers.bind( this );
-	/** @borrows getSiteSettings as this.getSiteSettings */
-	getSiteSettings: typeof getSiteSettings = getSiteSettings.bind( this );
-	/** @borrows updateSiteSettings as this.updateSiteSettings */
-	updateSiteSettings: typeof updateSiteSettings =
-		updateSiteSettings.bind( this );
-	/** @borrows deleteAllPages as this.deleteAllPages */
-	deleteAllPages: typeof deleteAllPages = deleteAllPages.bind( this );
-	/** @borrows createPage as this.createPage */
-	createPage: typeof createPage = createPage.bind( this );
-	/** @borrows getCurrentThemeGlobalStylesPostId as this.getCurrentThemeGlobalStylesPostId */
-	getCurrentThemeGlobalStylesPostId: typeof getCurrentThemeGlobalStylesPostId =
-		getCurrentThemeGlobalStylesPostId.bind( this );
-	/** @borrows getThemeGlobalStylesRevisions as this.getThemeGlobalStylesRevisions */
-	getThemeGlobalStylesRevisions: typeof getThemeGlobalStylesRevisions =
-		getThemeGlobalStylesRevisions.bind( this );
-	/** @borrows deleteAllPatternCategories as this.deleteAllPatternCategories */
-	deleteAllPatternCategories = deleteAllPatternCategories.bind( this );
-	/** @borrows setGutenbergExperiments as this.setGutenbergExperiments */
-	setGutenbergExperiments: typeof setGutenbergExperiments =
-		setGutenbergExperiments.bind( this );
-}
-
-export type { StorageState };
-export { RequestUtils };

package/src/request-utils/login.ts

@@ -1,34 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-export interface User {
-	username: string;
-	password: string;
-}
-
-async function login( this: RequestUtils, user: User = this.user ) {
-	// Login to admin using request context.
-	let response = await this.request.post( 'wp-login.php', {
-		failOnStatusCode: true,
-		form: {
-			log: user.username,
-			pwd: user.password,
-		},
-	} );
-	await response.dispose();
-
-	// Get the nonce.
-	response = await this.request.get(
-		'wp-admin/admin-ajax.php?action=rest-nonce',
-		{
-			failOnStatusCode: true,
-		}
-	);
-	const nonce = await response.text();
-
-	return nonce;
-}
-
-export { login };

package/src/request-utils/media.ts

@@ -1,102 +0,0 @@
-/**
- * External dependencies
- */
-import * as fs from 'fs';
-
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-export interface Media {
-	id: number;
-	title: {
-		raw: string;
-		rendered: string;
-	};
-	source_url: string;
-	slug: string;
-	alt_text: string;
-	caption: { rendered: string };
-	link: string;
-}
-
-/**
- * List all media files.
- *
- * @see https://developer.wordpress.org/rest-api/reference/media/#list-media
- * @param this
- */
-async function listMedia( this: RequestUtils ) {
-	const response = await this.rest< Media[] >( {
-		method: 'GET',
-		path: '/wp/v2/media',
-		params: {
-			per_page: 100,
-		},
-	} );
-
-	return response;
-}
-
-/**
- * Upload a media file.
- *
- * @see https://developer.wordpress.org/rest-api/reference/media/#create-a-media-item
- * @param this
- * @param filePathOrData The path or data of the file being uploaded.
- */
-async function uploadMedia(
-	this: RequestUtils,
-	filePathOrData: string | fs.ReadStream
-) {
-	const file =
-		typeof filePathOrData === 'string'
-			? fs.createReadStream( filePathOrData )
-			: filePathOrData;
-
-	const response = await this.rest< Media >( {
-		method: 'POST',
-		path: '/wp/v2/media',
-		multipart: {
-			file,
-		},
-	} );
-
-	return response;
-}
-
-/**
- * delete a media file.
- *
- * @see https://developer.wordpress.org/rest-api/reference/media/#delete-a-media-item
- * @param this
- * @param mediaId The ID of the media file.
- */
-async function deleteMedia( this: RequestUtils, mediaId: number ) {
-	const response = await this.rest( {
-		method: 'DELETE',
-		path: `/wp/v2/media/${ mediaId }`,
-		params: { force: true },
-	} );
-
-	return response;
-}
-
-/**
- * delete all media files.
- *
- * @param this
- */
-async function deleteAllMedia( this: RequestUtils ) {
-	const files = await this.listMedia();
-
-	// The media endpoint doesn't support batch request yet.
-	const responses = await Promise.all(
-		files.map( ( media ) => this.deleteMedia( media.id ) )
-	);
-
-	return responses;
-}
-
-export { listMedia, uploadMedia, deleteMedia, deleteAllMedia };

package/src/request-utils/menus.ts

@@ -1,145 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-export interface MenuData {
-	title: string;
-	content: string;
-}
-export interface NavigationMenu {
-	id: number;
-	content: string;
-	status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
-}
-
-/**
- * Create a classic menu
- *
- * @param name Menu name.
- * @return Menu content.
- */
-export async function createClassicMenu( this: RequestUtils, name: string ) {
-	const menuItems = [
-		{
-			title: 'Custom link',
-			url: 'http://localhost:8889/',
-			type: 'custom',
-			menu_order: 1,
-		},
-	];
-
-	const menu = await this.rest< NavigationMenu >( {
-		method: 'POST',
-		path: `/wp/v2/menus/`,
-		data: {
-			name,
-		},
-	} );
-
-	await this.batchRest(
-		menuItems.map( ( menuItem ) => ( {
-			method: 'POST',
-			path: `/wp/v2/menu-items`,
-			body: {
-				menus: menu.id,
-				object_id: undefined,
-				...menuItem,
-				parent: undefined,
-			},
-		} ) )
-	);
-
-	return menu;
-}
-
-/**
- * Create a navigation menu
- *
- * @param menuData navigation menu post data.
- * @return Menu content.
- */
-export async function createNavigationMenu(
-	this: RequestUtils,
-	menuData: MenuData
-) {
-	return this.createRecord< NavigationMenu >( 'navigation', {
-		status: 'publish',
-		...menuData,
-	} );
-}
-
-/**
- * Delete all navigation and classic menus
- *
- */
-export async function deleteAllMenus( this: RequestUtils ) {
-	const navMenus = await this.rest< NavigationMenu[] >( {
-		path: `/wp/v2/navigation/`,
-		data: {
-			status: [
-				'publish',
-				'pending',
-				'draft',
-				'auto-draft',
-				'future',
-				'private',
-				'inherit',
-				'trash',
-			],
-		},
-	} );
-
-	if ( navMenus.length ) {
-		await this.batchRest(
-			navMenus.map( ( menu ) => ( {
-				method: 'DELETE',
-				path: `/wp/v2/navigation/${ menu.id }?force=true`,
-			} ) )
-		);
-	}
-
-	const classicMenus = await this.rest< NavigationMenu[] >( {
-		path: `/wp/v2/menus/`,
-		data: {
-			status: [
-				'publish',
-				'pending',
-				'draft',
-				'auto-draft',
-				'future',
-				'private',
-				'inherit',
-				'trash',
-			],
-		},
-	} );
-
-	if ( classicMenus.length ) {
-		await this.batchRest(
-			classicMenus.map( ( menu ) => ( {
-				method: 'DELETE',
-				path: `/wp/v2/menus/${ menu.id }?force=true`,
-			} ) )
-		);
-	}
-}
-
-/**
- * Get latest navigation menus
- *
- * @param  args
- * @param  args.status
- * @return {string} Menu content.
- */
-export async function getNavigationMenus(
-	this: RequestUtils,
-	args: { status: 'publish' }
-) {
-	const navigationMenus = await this.rest< NavigationMenu[] >( {
-		method: 'GET',
-		path: `/wp/v2/navigation/`,
-		data: args,
-	} );
-	return navigationMenus;
-}

package/src/request-utils/pages.ts

@@ -1,75 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-const PAGE_STATUS = [
-	'publish',
-	'future',
-	'draft',
-	'pending',
-	'private',
-	'trash',
-] as const;
-
-export type Page = {
-	id: number;
-	status: ( typeof PAGE_STATUS )[ number ];
-};
-
-export type CreatePagePayload = {
-	title?: string;
-	content?: string;
-	status: ( typeof PAGE_STATUS )[ number ];
-	date?: string;
-	date_gmt?: string;
-};
-
-export async function deletePage( this: RequestUtils, id: number ) {
-	// https://developer.wordpress.org/rest-api/reference/pages/#delete-a-page
-	return await this.rest( {
-		method: 'DELETE',
-		path: `/wp/v2/pages/${ id }`,
-		params: {
-			force: true,
-		},
-	} );
-}
-
-/**
- * Delete all pages using REST API.
- *
- * @param this
- */
-export async function deleteAllPages( this: RequestUtils ) {
-	// List all pages.
-	// https://developer.wordpress.org/rest-api/reference/pages/#list-pages
-	const pages = await this.rest< Page[] >( {
-		path: '/wp/v2/pages',
-		params: {
-			per_page: 100,
-
-			status: PAGE_STATUS.join( ',' ),
-		},
-	} );
-
-	// Delete all pages one by one.
-	// "/wp/v2/pages" not yet supports batch requests.
-	await Promise.all(
-		pages.map( ( page ) => deletePage.call( this, page.id ) )
-	);
-}
-
-/**
- * Create a new page.
- *
- * @param this
- * @param payload The page payload.
- */
-export async function createPage(
-	this: RequestUtils,
-	payload: CreatePagePayload
-) {
-	// https://developer.wordpress.org/rest-api/reference/pages/#create-a-page
-	return this.createRecord< Page >( 'pages', { ...payload } );
-}

package/src/request-utils/patterns.ts

@@ -1,31 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-/**
- * Delete all pattern categories using REST API.
- *
- * @see https://developer.wordpress.org/rest-api/reference/categories/#list-categories
- * @param this
- */
-export async function deleteAllPatternCategories( this: RequestUtils ) {
-	// List all pattern categories.
-	// https://developer.wordpress.org/rest-api/reference/categories/#list-categories
-	const categories = await this.rest( {
-		path: '/wp/v2/wp_pattern_category',
-		params: {
-			per_page: 100,
-		},
-	} );
-
-	// Delete pattern categories.
-	// https://developer.wordpress.org/rest-api/reference/categories/#delete-a-category
-	// "/wp/v2/category" does not yet supports batch requests.
-	await this.batchRest(
-		categories.map( ( category: { id: number } ) => ( {
-			method: 'DELETE',
-			path: `/wp/v2/wp_pattern_category/${ category.id }?force=true`,
-		} ) )
-	);
-}

package/src/request-utils/plugins.ts

@@ -1,103 +0,0 @@
-/**
- * External dependencies
- */
-import { paramCase as kebabCase } from 'change-case';
-
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-/**
- * Fetch the plugins from API and cache them in memory,
- * since they are unlikely to change during testing.
- *
- * @param this
- * @param forceRefetch Force refetch the installed plugins to update the cache.
- */
-async function getPluginsMap( this: RequestUtils, forceRefetch = false ) {
-	if ( ! forceRefetch && this.pluginsMap ) {
-		return this.pluginsMap;
-	}
-
-	const plugins = await this.rest( {
-		path: '/wp/v2/plugins',
-	} );
-	this.pluginsMap = {};
-	for ( const plugin of plugins ) {
-		// Ideally, we should be using sanitize_title() in PHP rather than kebabCase(),
-		// but we don't have the exact port of it in JS.
-		// This is a good approximation though.
-		const slug = kebabCase( plugin.name.toLowerCase() );
-		this.pluginsMap[ slug ] = plugin.plugin;
-	}
-	return this.pluginsMap;
-}
-
-/**
- * Finds a plugin in the plugin map.
- *
- * Attempts to provide a helpful error message if not found.
- *
- * @param slug       Plugin slug.
- * @param pluginsMap Plugins map.
- */
-function getPluginFromMap(
-	slug: string,
-	pluginsMap: Record< string, string >
-) {
-	const plugin = pluginsMap[ slug ];
-
-	if ( ! plugin ) {
-		for ( const key of Object.keys( pluginsMap ) ) {
-			if (
-				key.toLowerCase().replace( /-/g, '' ) ===
-				slug.toLowerCase().replace( /-/g, '' )
-			) {
-				throw new Error(
-					`The plugin "${ slug }" isn't installed. Did you perhaps mean "${ key }"?`
-				);
-			}
-		}
-
-		throw new Error( `The plugin "${ slug }" isn't installed` );
-	}
-
-	return plugin;
-}
-
-/**
- * Activates an installed plugin.
- *
- * @param this RequestUtils.
- * @param slug Plugin slug.
- */
-async function activatePlugin( this: RequestUtils, slug: string ) {
-	const pluginsMap = await this.getPluginsMap();
-	const plugin = getPluginFromMap( slug, pluginsMap );
-
-	await this.rest( {
-		method: 'PUT',
-		path: `/wp/v2/plugins/${ plugin }`,
-		data: { status: 'active' },
-	} );
-}
-
-/**
- * Deactivates an active plugin.
- *
- * @param this RequestUtils.
- * @param slug Plugin slug.
- */
-async function deactivatePlugin( this: RequestUtils, slug: string ) {
-	const pluginsMap = await this.getPluginsMap();
-	const plugin = getPluginFromMap( slug, pluginsMap );
-
-	await this.rest( {
-		method: 'PUT',
-		path: `/wp/v2/plugins/${ plugin }`,
-		data: { status: 'inactive' },
-	} );
-}
-
-export { getPluginsMap, activatePlugin, deactivatePlugin };