Begin moving import code to separate file; add tests

Moved part of the import logic to separate file, modified it to
use parameters, and added many constants in the migration test file
to prevent code duplication.

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

@@ -4,72 +4,93 @@ import { existsSync, rmSync, readFileSync } from 'fs';
 
 const { TextDecoder } = require('util');
 
+// Code to test
+const migration = readFileSync(__dirname + '/../migration.php');
+
 // 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 wpImporterOutputValue = 'Mock WordPress Importer migration file';
+
 const exportName = `wordpress-playground-export.zip`;
 const exportPath = `${testDirPath}/${exportName}`;
 
-// Code to test
-const migrationFilePath = __dirname + '/../migration.php';
+// ------------------------
+// Mock WordPress Directory
+// ------------------------
+
+// Root
+const wpDir = fileSystemPath + '/wordpress';
+const wpDirFilePath = wpDir + '/test-wp-root.php';
+const wpDirFileValue = 'Mock WP root file';
+
+// WP Admin
+const wpAdminDir = wpDir + '/wp-admin';
+const wpAdminFilePath = wpAdminDir + '/test-admin.php';
+const wpAdminFileValue = 'Mock WP admin file';
+
+// WP Content
+const wpContentDir = wpDir + '/wp-content';
+const wpContentFilePath = wpContentDir + '/test-content.php';
+const wpContentFileValue = 'Mock WP content file';
+
+// WP Content - SQL DB
+const wpSqlDbDir = wpContentDir + '/database';
+const wpSqlDbFilePath = wpSqlDbDir + '/test-database.php';
+const wpSqlDbFileValue = 'Mock SQL content';
+
+// WP Includes
+const wpIncludesDir = wpDir + '/wp-includes';
+const wpIncludesFilePath = wpIncludesDir + '/test-includes.php';
+const wpIncludesFileValue = 'Mock WP includes';
+
+function createMockStructure(phpRuntime) {
+	phpRuntime.mkdirTree(testDirPath);
+	phpRuntime.mkdirTree(fileSystemPath);
+	phpRuntime.mkdirTree(wpDir);
+
+	phpRuntime.writeFile(wpImporterOutputPath, wpImporterOutputValue);
+
+	// WP Root
+	phpRuntime.writeFile(wpDirFilePath, wpDirFileValue);
+
+	// WP Admin
+	phpRuntime.mkdirTree(wpAdminDir);
+	phpRuntime.writeFile(wpAdminFilePath, wpAdminFileValue);
+
+	// WP Content
+	phpRuntime.mkdirTree(wpContentDir);
+	phpRuntime.writeFile(wpContentFilePath, wpContentFileValue);
+
+	// WP Content - SQL DB
+	phpRuntime.mkdirTree(wpSqlDbDir);
+	phpRuntime.writeFile(wpSqlDbFilePath, wpSqlDbFileValue);
+
+	// WP Includes
+	phpRuntime.mkdirTree(wpIncludesDir);
+	phpRuntime.writeFile(wpIncludesFilePath, wpIncludesFileValue);
+
+	const exportWriteRequest = phpRuntime.run({
+		code:
+			migration +
+			` generateZipFile("${exportPath}", "${wpImporterOutputPath}", "${wpDir}");`,
+	});
+
+	if (exportWriteRequest.exitCode !== 0) {
+		throw exportWriteRequest.errors;
+	}
+}
 
 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;
-		}
+		createMockStructure(php);
 	});
 
 	afterAll(() => {
@@ -87,8 +108,8 @@ describe('generateZipFile()', () => {
 					if ($res === TRUE) {
 						if(
 							$zip->getFromName('${wpImporterOutputPath}') &&
-							$zip->getFromName('${wpPath}/test-wp-root.php') && 
-							$zip->getFromName('${wpContentPath}/test-content.php')
+							$zip->getFromName('${wpDirFilePath}') && 
+							$zip->getFromName('${wpContentFilePath}')
 						) {
 							echo 'success';
 						} else {
@@ -111,7 +132,7 @@ describe('generateZipFile()', () => {
 					$res = $zip->open('${exportPath}');
 					if ($res === TRUE) {
 						if(
-							!$zip->getFromName('${wpSqlDbPath}/test-database.php')
+							!$zip->getFromName('${wpSqlDbFilePath}')
 						) {
 							echo 'success';
 						} else {
@@ -134,7 +155,7 @@ describe('generateZipFile()', () => {
 					$res = $zip->open('${exportPath}');
 					if ($res === TRUE) {
 						if(
-							!$zip->getFromName('${wpIncludesPath}/test-includes.php')
+							!$zip->getFromName('${wpIncludesFilePath}')
 						) {
 							echo 'success';
 						} else {
@@ -149,3 +170,92 @@ describe('generateZipFile()', () => {
 		expect(runTestOutput).toEqual('success');
 	});
 });
+
+describe('readFileFromZipArchive()', () => {
+	let php;
+
+	beforeEach(async () => {
+		php = await startPHP(phpLoaderModule, 'NODE');
+		if (existsSync(testDirPath)) {
+			rmSync(testDirPath, { recursive: true });
+		}
+		createMockStructure(php);
+	});
+
+	afterAll(() => {
+		if (existsSync(testDirPath)) {
+			rmSync(testDirPath, { recursive: true });
+		}
+	});
+
+	describe("given a path to a generateZipFile() output, it should return a specified file's contents", () => {
+		it('filesystem root file', () => {
+			const readFileRequest = php.run({
+				code:
+					migration +
+					` readFileFromZipArchive('${exportPath}', '${wpImporterOutputPath}');`,
+			});
+
+			if (readFileRequest.exitCode !== 0) {
+				throw readFileRequest.errors;
+			}
+
+			const readFileOutput = new TextDecoder()
+				.decode(readFileRequest.body)
+				.trim();
+
+			expect(readFileOutput).toEqual(wpImporterOutputValue);
+		});
+		it('wp root file', () => {
+			const readFileRequest = php.run({
+				code:
+					migration +
+					` readFileFromZipArchive('${exportPath}', '${wpDirFilePath}');`,
+			});
+
+			if (readFileRequest.exitCode !== 0) {
+				throw readFileRequest.errors;
+			}
+
+			const readFileOutput = new TextDecoder()
+				.decode(readFileRequest.body)
+				.trim();
+
+			expect(readFileOutput).toEqual(wpDirFileValue);
+		});
+		it('wp admin file', () => {
+			const readFileRequest = php.run({
+				code:
+					migration +
+					` readFileFromZipArchive('${exportPath}', '${wpAdminFilePath}');`,
+			});
+
+			if (readFileRequest.exitCode !== 0) {
+				throw readFileRequest.errors;
+			}
+
+			const readFileOutput = new TextDecoder()
+				.decode(readFileRequest.body)
+				.trim();
+
+			expect(readFileOutput).toEqual(wpAdminFileValue);
+		});
+		it('wp content file', () => {
+			const readFileRequest = php.run({
+				code:
+					migration +
+					` readFileFromZipArchive('${exportPath}', '${wpContentFilePath}');`,
+			});
+
+			if (readFileRequest.exitCode !== 0) {
+				throw readFileRequest.errors;
+			}
+
+			const readFileOutput = new TextDecoder()
+				.decode(readFileRequest.body)
+				.trim();
+
+			expect(readFileOutput).toEqual(wpContentFileValue);
+		});
+	});
+});

src/wordpress-playground/index.tsx

@@ -46,6 +46,9 @@ const importCloseModalButton = document.querySelector(
 	'#import-close-modal--btn'
 ) as HTMLButtonElement;
 
+const databaseExportName = 'databaseExport.xml';
+const databaseExportPath = '/' + databaseExportName;
+
 let workerThread;
 
 let isBooted = false;
@@ -347,14 +350,13 @@ async function generateZip() {
 	const databaseExportContent = new TextDecoder().decode(
 		databaseExportResponse.body
 	);
-	const databasePath = '/databaseExport.xml';
-	await workerThread.writeFile(databasePath, databaseExportContent);
+	await workerThread.writeFile(databaseExportPath, databaseExportContent);
 	const exportName = `wordpress-playground--wp${wpVersion}--php${phpVersion}.zip`;
 	const exportPath = `/${exportName}`;
 	const exportWriteRequest = await workerThread.run({
 		code:
 			migration +
-			` generateZipFile("${exportPath}", "${databasePath}", "${DOCROOT}");`,
+			` generateZipFile('${exportPath}', '${databaseExportPath}', '${DOCROOT}');`,
 	});
 	if (exportWriteRequest.exitCode !== 0) {
 		throw exportWriteRequest.errors;
@@ -384,19 +386,15 @@ async function importFile() {
 
 	const fileArrayBuffer = await userUploadedFile.arrayBuffer();
 	const fileContent = new Uint8Array(fileArrayBuffer);
-	await workerThread.writeFile('/import.zip', fileContent);
+	const importPath = '/import.zip';
+
+	await workerThread.writeFile(importPath, fileContent);
 
 	// Import the database
 	const databaseFromZipFileReadRequest = await workerThread.run({
-		code: `<?php
-					chmod('/import.zip', 0777);
-					$zip = new ZipArchive;
-					$res = $zip->open('/import.zip');
-					if ($res === TRUE) {
-						$file = $zip->getFromName('/databaseExport.xml');
-						echo $file;
-					}
-				`,
+		code:
+			migration +
+			` readFileFromZipArchive('${importPath}', '${databaseExportPath}');`,
 	});
 	if (databaseFromZipFileReadRequest.exitCode !== 0) {
 		throw databaseFromZipFileReadRequest.errors;
@@ -408,7 +406,7 @@ async function importFile() {
 
 	const databaseFile = new File(
 		[databaseFromZipFileContent],
-		'databaseExport.xml'
+		databaseExportName
 	);
 
 	const importerPageOneResponse = await workerThread.HTTPRequest({

src/wordpress-playground/migration.php

@@ -41,3 +41,13 @@ function generateZipFile($exportPath, $databasePath, $docRoot) {
         chmod($exportPath, 0777);
     }
 }
+
+function readFileFromZipArchive($pathToZip, $pathToFile) {
+    chmod($pathToZip, 0777);
+    $zip = new ZipArchive;
+    $res = $zip->open($pathToZip);
+    if ($res === TRUE) {
+        $file = $zip->getFromName($pathToFile);
+        echo $file;
+    }
+}