Move generateZipFile() code to separate PHP file; begin adding tests

In order to test the behavior of the migration feature's PHP code,
I moved that code to separate files so that it can be run by Jest.
This required modifying the generateZipFile() function a bit to accept
parameters.

jest.config.js

@@ -65,7 +65,9 @@ module.exports = {
 	// globalTeardown: undefined,
 
 	// A set of global variables that need to be available in all test environments
-	// globals: {},
+	globals: {
+		PHP_JS_HASH: '',
+	},
 
 	// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
 	// maxWorkers: "50%",

src/wordpress-playground/__tests__/migration-tests.ts

@@ -0,0 +1,151 @@
+import * as phpLoaderModule from '../../../build/php-7.4.node.js';
+import { startPHP } from '../../php-wasm/php-node';
+import { existsSync, rmSync, readFileSync } from 'fs';
+
+const { TextDecoder } = require('util');
+
+// Mock files
+const testDirPath = __dirname + '/__test39024';
+const fileSystemPath = testDirPath + '/filesystem';
+const wpImporterOutputPath = fileSystemPath + '/databaseExport.xml';
+const wpPath = fileSystemPath + '/wordpress';
+const wpAdminPath = wpPath + '/wp-admin';
+const wpContentPath = wpPath + '/wp-content';
+const wpIncludesPath = wpPath + '/wp-includes';
+const wpSqlDbPath = wpContentPath + '/database';
+const exportName = `wordpress-playground-export.zip`;
+const exportPath = `${testDirPath}/${exportName}`;
+
+// Code to test
+const migrationFilePath = __dirname + '/../migration.php';
+
+describe('generateZipFile()', () => {
+	let php;
+	let migration;
+
+	beforeEach(async () => {
+		php = await startPHP(phpLoaderModule, 'NODE');
+		if (existsSync(testDirPath)) {
+			rmSync(testDirPath, { recursive: true });
+		}
+		migration = readFileSync(migrationFilePath);
+		php.mkdirTree(testDirPath);
+		php.mkdirTree(fileSystemPath);
+		php.mkdirTree(wpPath);
+
+		php.writeFile(
+			wpImporterOutputPath,
+			'Mock WordPress Importer migration file'
+		);
+
+		// WP Root
+		php.writeFile(`${wpPath}/test-wp-root.php`, 'Mock WP root file');
+
+		// WP Admin
+		php.mkdirTree(wpAdminPath);
+		php.writeFile(`${wpAdminPath}/test-admin.php`, 'Mock WP admin file');
+
+		// WP Content
+		php.mkdirTree(wpContentPath);
+		php.writeFile(
+			`${wpContentPath}/test-content.php`,
+			'Mock WP content file'
+		);
+		php.mkdirTree(wpSqlDbPath);
+		php.writeFile(`${wpSqlDbPath}/test-database.php`, 'Mock SQL content');
+
+		// WP Includes
+		php.mkdirTree(wpIncludesPath);
+		php.writeFile(
+			`${wpIncludesPath}/test-includes.php`,
+			'Mock WP includes'
+		);
+
+		const exportWriteRequest = php.run({
+			code:
+				migration +
+				` generateZipFile("${exportPath}", "${wpImporterOutputPath}", "${wpPath}");`,
+		});
+
+		if (exportWriteRequest.exitCode !== 0) {
+			throw exportWriteRequest.errors;
+		}
+	});
+
+	afterAll(() => {
+		if (existsSync(testDirPath)) {
+			rmSync(testDirPath, { recursive: true });
+		}
+	});
+
+	it('should creata a ZIP file of specified WP Importer output file and WordPress files', () => {
+		const runTest = php.run({
+			code: `
+				<?php
+					$zip = new ZipArchive;
+					$res = $zip->open('${exportPath}');
+					if ($res === TRUE) {
+						if(
+							$zip->getFromName('${wpImporterOutputPath}') &&
+							$zip->getFromName('${wpPath}/test-wp-root.php') && 
+							$zip->getFromName('${wpContentPath}/test-content.php')
+						) {
+							echo 'success';
+						} else {
+							echo 'failure';
+						}
+					}
+			`,
+		});
+
+		const runTestOutput = new TextDecoder().decode(runTest.body).trim();
+
+		expect(runTestOutput).toEqual('success');
+	});
+
+	it('should omit wp-content/database directory', () => {
+		const runTest = php.run({
+			code: `
+				<?php
+					$zip = new ZipArchive;
+					$res = $zip->open('${exportPath}');
+					if ($res === TRUE) {
+						if(
+							!$zip->getFromName('${wpSqlDbPath}/test-database.php')
+						) {
+							echo 'success';
+						} else {
+							echo 'failure';
+						}
+					}
+			`,
+		});
+
+		const runTestOutput = new TextDecoder().decode(runTest.body).trim();
+
+		expect(runTestOutput).toEqual('success');
+	});
+
+	it('should omit wp-includes directory', () => {
+		const runTest = php.run({
+			code: `
+				<?php
+					$zip = new ZipArchive;
+					$res = $zip->open('${exportPath}');
+					if ($res === TRUE) {
+						if(
+							!$zip->getFromName('${wpIncludesPath}/test-includes.php')
+						) {
+							echo 'success';
+						} else {
+							echo 'failure';
+						}
+					}
+			`,
+		});
+
+		const runTestOutput = new TextDecoder().decode(runTest.body).trim();
+
+		expect(runTestOutput).toEqual('success');
+	});
+});

src/wordpress-playground/index.tsx

@@ -8,6 +8,7 @@ import { ProgressObserver, ProgressType } from './progress-observer';
 import { PromiseQueue } from './promise-queue';
 import { saveAs } from 'file-saver';
 import { DOCROOT } from './config';
+import migration from './migration.php';
 
 const query = new URL(document.location.href).searchParams as any;
 
@@ -346,51 +347,14 @@ async function generateZip() {
 	const databaseExportContent = new TextDecoder().decode(
 		databaseExportResponse.body
 	);
-	await workerThread.writeFile('/databaseExport.xml', databaseExportContent);
+	const databasePath = '/databaseExport.xml';
+	await workerThread.writeFile(databasePath, databaseExportContent);
 	const exportName = `wordpress-playground--wp${wpVersion}--php${phpVersion}.zip`;
 	const exportPath = `/${exportName}`;
 	const exportWriteRequest = await workerThread.run({
-		code: `<?php
-					$zip = new ZipArchive;
-					$res = $zip->open('${exportPath}', ZipArchive::CREATE);
-					if ($res === TRUE) {
-						$zip->addFile('/databaseExport.xml');
-						$directories = array();
-						$directories[] = '${DOCROOT}/';
-
-						while(sizeof($directories)) {
-							$dir = array_pop($directories);
-
-							if ($handle = opendir($dir)) {
-
-								while (false !== ($entry = readdir($handle))) {
-
-									if ($entry == '.' ||
-										$entry == '..') {
-										continue;
-									}
-
-									$entry = $dir . $entry;
-
-									if (is_dir($entry) &&
-										strpos($entry, 'wp-content/database') == false &&
-										strpos($entry, 'wp-includes') == false) {
-
-											$directory_path = $entry . '/';
-											array_push($directories, $directory_path);
-
-									} elseif (is_file($entry)) {
-
-										$zip->addFile($entry);
-									}
-								}
-								closedir($handle);
-							}
-						}
-						$zip->close();
-						chmod('${exportPath}', 0777);
-					}
-				`,
+		code:
+			migration +
+			` generateZipFile("${exportPath}", "${databasePath}", "${DOCROOT}");`,
 	});
 	if (exportWriteRequest.exitCode !== 0) {
 		throw exportWriteRequest.errors;

src/wordpress-playground/migration.php

@@ -0,0 +1,43 @@
+<?php
+
+function generateZipFile($exportPath, $databasePath, $docRoot) {
+    $zip = new ZipArchive;
+    $res = $zip->open($exportPath, ZipArchive::CREATE);
+    if ($res === TRUE) {
+        $zip->addFile($databasePath);
+        $directories = array();
+        $directories[] = $docRoot . '/';
+
+        while(sizeof($directories)) {
+            $dir = array_pop($directories);
+
+            if ($handle = opendir($dir)) {
+
+                while (false !== ($entry = readdir($handle))) {
+
+                    if ($entry == '.' ||
+                        $entry == '..') {
+                        continue;
+                    }
+
+                    $entry = $dir . $entry;
+
+                    if (is_dir($entry) &&
+                        strpos($entry, 'wp-content/database') == false &&
+                        strpos($entry, 'wp-includes') == false) {
+
+                            $directory_path = $entry . '/';
+                            array_push($directories, $directory_path);
+
+                    } elseif (is_file($entry)) {
+
+                        $zip->addFile($entry);
+                    }
+                }
+                closedir($handle);
+            }
+        }
+        $zip->close();
+        chmod($exportPath, 0777);
+    }
+}