chore(Tests): Improved tests

Author: seebeen

test/2-prepare-plugin.spec.ts

@@ -4,6 +4,7 @@ import fs from 'fs-extra';
 import { prepare } from '../lib/prepare.js';
 import * as contexts from './get-context.js';
 import { replaceVersions } from '../lib/utils/replace-versions.js';
+import { readDir, readFile } from './utils.js';
 
 function getWorkDir(suffix: string): string {
   const files = fs.readdirSync(os.tmpdir());
@@ -40,11 +41,9 @@ describe('Package preparation - cusom work directory', () => {
       },
       contexts.prepareContext,
     );
-    expect(
-      fs
-        .readFileSync(path.join(releasePath, 'plugin1', 'plugin1.php'), 'utf8')
-        .toString(),
-    ).not.toMatch(/0\.0\.0/);
+    expect(readFile(releasePath, 'plugin1', 'plugin1.php')).not.toMatch(
+      /0\.0\.0/,
+    );
   });
 
   it('Should fail on invalid plugin version', async () => {
@@ -79,9 +78,10 @@ describe('Package preparation - cusom work directory', () => {
       contexts.prepareContext,
     );
 
-    const versions = fs.readFileSync(
-      path.join(getWorkDir(workDir), 'plugin1/extra-versions.php'),
-      'utf8',
+    const versions = readFile(
+      getWorkDir(workDir),
+      'plugin1',
+      'extra-versions.php',
     );
 
     expect(versions).toMatch(/1\.0\.0/);
@@ -102,12 +102,9 @@ describe('Package preparation - cusom work directory', () => {
       contexts.prepareContext,
     );
 
-    const readme = fs.readFileSync(
-      path.join(releasePath, 'plugin-with-readme/readme.txt'),
-      'utf8',
+    expect(readFile(releasePath, 'plugin-with-readme', 'readme.txt')).toMatch(
+      /Stable tag: 1\.0\.0/,
     );
-
-    expect(readme).toMatch(/Stable tag: 1\.0\.0/);
   });
 
   it('Should change the readme.txt version in the rootdir', async () => {
@@ -124,12 +121,9 @@ describe('Package preparation - cusom work directory', () => {
       contexts.prepareContext,
     );
 
-    const readme = fs.readFileSync(
-      path.join(getWorkDir(workDir), 'root-readme/readme.txt'),
-      'utf8',
+    expect(readFile(getWorkDir(workDir), 'root-readme', 'readme.txt')).toMatch(
+      /Stable tag: 1\.0\.0/,
     );
-
-    expect(readme).toMatch(/Stable tag: 1\.0\.0/);
   });
 
   it('Should work with empty assets', async () => {
@@ -185,17 +179,10 @@ describe('Package preparation - default work directory', () => {
       contexts.prepareContext,
     );
 
-    const distFiles = fs.readdirSync(path.join(releasePath, 'dist-test'));
-    const vendorFiles = fs.readdirSync(
-      path.join(releasePath, 'dist-test', 'vendor'),
+    expect(readDir(true, releasePath, 'dist-test')).toStrictEqual(
+      new Set(['dist-test.php', 'test1.php', 'vendor', 'vendor/composer.php']),
     );
-    const versionExists = fs.existsSync(path.join(releasePath, 'VERSION'));
-
-    expect(distFiles).toHaveLength(3);
-    expect(distFiles).toStrictEqual(['dist-test.php', 'test1.php', 'vendor']);
-    expect(vendorFiles).toHaveLength(1);
-    expect(vendorFiles).toStrictEqual(['composer.php']);
-    expect(versionExists).toBe(false);
+    expect(fs.existsSync(path.join(releasePath, 'VERSION'))).toBe(false);
   });
 
   it('Should copy the assets files', async () => {
@@ -212,14 +199,7 @@ describe('Package preparation - default work directory', () => {
       contexts.prepareContext,
     );
 
-    const assets = new Set(
-      fs.readdirSync(path.join(releasePath, 'assets'), {
-        recursive: true,
-      }) as string[],
-    );
-
-    expect([...assets]).toHaveLength(6);
-    expect(assets).toEqual(
+    expect(readDir(true, releasePath, 'assets')).toEqual(
       new Set([
         'blueprints',
         'blueprints/blueprint.json',

test/3-publish-plugin.spec.ts

@@ -8,7 +8,7 @@ import { replaceVersions } from '../lib/utils/replace-versions.js';
 import { success } from '../lib/success.js';
 import SemanticReleaseError from '@semantic-release/error';
 import { publish } from '../lib/publish.js';
-import AdmZip, { IZipEntry } from 'adm-zip';
+import { readFile, readDir, readZip } from './utils.js';
 
 const pluginConfig: PluginConfig = {
   type: 'plugin',
@@ -25,31 +25,6 @@ const pluginConfig: PluginConfig = {
 let wDir: string;
 const env = process.env;
 
-function readZip(dir: string, file: string, pfx: RegExp = /.^/): Set<string> {
-  return new Set(
-    new AdmZip(path.join(dir, file))
-      .getEntries()
-      .map(({ entryName }) => entryName.replace(pfx, '').replace(/\/$/, ''))
-      .filter((e) => e !== '' && (pfx.source == '.^' || !e.match(/\//))),
-  );
-}
-
-function readDir(
-  root: string,
-  dir: string,
-  recursive: boolean = false,
-): Set<string> {
-  return new Set(
-    fs.readdirSync(path.join(root, dir), {
-      recursive,
-    }) as string[],
-  );
-}
-
-function readFile(root: string, file: string): string {
-  return fs.readFileSync(path.join(root, file), 'utf8');
-}
-
 beforeAll(async () => {
   wDir = fs.mkdtempSync('/tmp/wp-release-');
   pluginConfig.releasePath = wDir;
@@ -85,28 +60,22 @@ describe('Publish step', () => {
     await prepare(pluginConfig, contexts.publishContext);
     await publish(pluginConfig, contexts.publishContext);
 
-    expect(readFile(path.join(wDir, 'dist-test'), 'readme.txt')).toMatch(
+    expect(readFile(wDir, 'dist-test', 'readme.txt')).toMatch(
       /^Stable tag: 1.0.0$/gm,
     );
     expect(readZip(wDir, 'package.zip', /^dist-test\//)).toEqual(
-      readDir(wDir, 'dist-test'),
+      readDir(false, wDir, 'dist-test'),
     );
-    expect(readZip(wDir, 'assets.zip')).toEqual(readDir(wDir, 'assets', true));
+    expect(readZip(wDir, 'assets.zip')).toEqual(readDir(true, wDir, 'assets'));
     expect(readFile(wDir, 'VERSION')).toEqual('1.0.0');
-
-    // expect readZip(releasePath, 'assets.zip');
   });
 
   it('Should should remove folders on success', async () => {
     await success(pluginConfig, contexts.publishContext);
 
-    const files = fs.readdirSync(wDir).join(' ');
-
-    expect(files).toContain('package.zip');
-    expect(files).toContain('assets.zip');
-    expect(files).toContain('VERSION');
-    expect(files).not.toContain('dist-test');
-    expect(files).not.toContain('assets ');
+    expect(readDir(false, wDir)).toEqual(
+      new Set(['package.zip', 'assets.zip', 'VERSION']),
+    );
   });
 
   it('Should fail when no assets exist', async () => {

test/utils.ts

@@ -0,0 +1,28 @@
+import AdmZip from 'adm-zip';
+import fs from 'fs-extra';
+import * as path from 'node:path';
+
+export function readZip(
+  dir: string,
+  file: string,
+  pfx: RegExp = /.^/,
+): Set<string> {
+  return new Set(
+    new AdmZip(path.join(dir, file))
+      .getEntries()
+      .map(({ entryName }) => entryName.replace(pfx, '').replace(/\/$/, ''))
+      .filter((e) => e !== '' && (pfx.source == '.^' || !e.match(/\//))),
+  );
+}
+
+export function readDir(recursive = false, ...dirs: string[]): Set<string> {
+  return new Set(
+    fs.readdirSync(path.join(...dirs), {
+      recursive,
+    }) as string[],
+  );
+}
+
+export function readFile(...paths: string[]): string {
+  return fs.readFileSync(path.join(...paths), 'utf8');
+}