test(end-to-end): restructure e2e tests

Author: Xunnamius

test/end-to-end/e2e.test.ts test/end-to-end/e2e-docs.test.tstest/end-to-end/e2e.test.ts renamed to test/end-to-end/e2e-docs.test.ts

@@ -24,7 +24,7 @@ import {
 } from 'testverse:util.ts';
 
 const shortIdentifier = packageName.split('/').at(-1)!;
-const TEST_IDENTIFIER = `${shortIdentifier}-e2e`;
+const TEST_IDENTIFIER = `${shortIdentifier}-e2e-docs`;
 const debug = createDebugLogger({ namespace: shortIdentifier }).extend(TEST_IDENTIFIER);
 const nodeVersion = process.env.XPIPE_MATRIX_NODE_VERSION || process.version;
 
@@ -215,3 +215,38 @@ export async function handler(argv) {
     );
   });
 });
+
+describe('./docs/features.md', () => {
+  test("it's yargs all the way down", async () => {
+    expect.hasAssertions();
+  });
+
+  test('run your tool safely and consistently', async () => {
+    expect.hasAssertions();
+  });
+
+  test('convention over configuration', async () => {
+    expect.hasAssertions();
+  });
+
+  test('simple comprehensive error handling and reporting', async () => {
+    expect.hasAssertions();
+  });
+  test('a pleasant testing experience', async () => {
+    expect.hasAssertions();
+  });
+
+  test('built-in debug integration for runtime insights', async () => {
+    expect.hasAssertions();
+  });
+
+  test('extensive intellisense support', async () => {
+    expect.hasAssertions();
+  });
+});
+
+describe('./docs/getting-started.md', () => {
+  test('todo', async () => {
+    expect.hasAssertions();
+  });
+});

test/end-to-end/e2e-examples.test.ts

@@ -0,0 +1,72 @@
+// * These tests run through the entire process of acquiring this software,
+// * using its features as described in the examples documentation, and dealing
+// * with its error conditions across a variety of runtimes (e.g. the currently
+// * maintained node versions).
+// *
+// * Typically, these tests involve the use of deep mock fixtures and/or Docker
+// * containers, and are built to run in GitHub Actions CI pipelines; some can
+// * also be run locally.
+
+import { toAbsolutePath, toDirname, toPath } from '@-xun/fs';
+import { readXPackageJsonAtRoot } from '@-xun/project';
+import { runnerFactory } from '@-xun/run';
+import { createDebugLogger } from 'rejoinder';
+
+import { exports as packageExports, name as packageName } from 'rootverse:package.json';
+
+import {
+  dummyFilesFixture,
+  dummyNpmPackageFixture,
+  ensurePackageHasBeenBuilt,
+  mockFixturesFactory,
+  npmCopyPackageFixture,
+  reconfigureJestGlobalsToSkipTestsInThisFileIfRequested
+} from 'testverse:util.ts';
+
+const shortIdentifier = packageName.split('/').at(-1)!;
+const TEST_IDENTIFIER = `${shortIdentifier}-e2e-examples`;
+const debug = createDebugLogger({ namespace: shortIdentifier }).extend(TEST_IDENTIFIER);
+const nodeVersion = process.env.XPIPE_MATRIX_NODE_VERSION || process.version;
+
+debug(`nodeVersion: "${nodeVersion}" (process.version=${process.version})`);
+
+reconfigureJestGlobalsToSkipTestsInThisFileIfRequested({ it: true, test: true });
+
+beforeAll(async () => {
+  await ensurePackageHasBeenBuilt(
+    toDirname(toAbsolutePath(require.resolve('rootverse:package.json'))),
+    packageName,
+    packageExports
+  );
+});
+
+const packageRoot = toPath(toAbsolutePath(__dirname), '../..');
+const withMockedFixture = mockFixturesFactory(
+  [dummyNpmPackageFixture, dummyFilesFixture, npmCopyPackageFixture],
+  {
+    performCleanup: true,
+    initialVirtualFiles: {
+      'package.json': JSON.stringify(
+        {
+          name: 'dummy-pkg',
+          version: '0.0.1',
+          type: 'module'
+        },
+        undefined,
+        2
+      )
+    },
+    packageUnderTest: {
+      root: packageRoot,
+      attributes: { cjs: true },
+      json: readXPackageJsonAtRoot.sync(packageRoot, { useCached: true })
+    },
+    identifier: TEST_IDENTIFIER
+  }
+);
+
+describe('./examples', () => {
+  test('example-todo', async () => {
+    expect.hasAssertions();
+  });
+});