test: cover init modules and pipeline

.changeset/wild-readers-battle.md

@@ -0,0 +1,5 @@
+---
+"@perfect-abstractions/compose-cli": patch
+---
+
+Add compose init test coverage and reorganize adapters by interface.

.github/workflows/cli.yml

@@ -68,6 +68,9 @@ jobs:
       - name: Build TypeScript
         run: npm run cli@build
 
+      - name: Run tests
+        run: npm run cli@test
+
       - name: Smoke test Foundry counter base
         run: |
           set -euo pipefail

cli/src/adapters/foundryAdapter.ts → cli/src/adapters/IFrameworkAdapter/foundryAdapter/adapter.ts

@@ -1,48 +1,20 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import { ComposeContext } from "../context/types";
+import { ComposeContext } from "../../../context/types";
 import {
   ConfigOptions,
   IFrameworkAdapter,
   SolidityAstSource,
-} from "./interface/IFrameworkAdapter";
-import { writeFileIfMissing } from "../utils/files";
-import { runCommand } from "../utils/exec";
+} from "../interface";
+import { writeFileIfMissing } from "../../../utils/files";
+import { runCommand } from "../../../utils/exec";
 import {
   composePackageSubpath,
   isComposePackagePath,
-} from "../utils/soliditySources";
-import { CLI_ROOT } from "../utils/cliRoot";
-import { isSourceUnitAst, listJsonFiles, uniqueAstSources } from "../utils/solidityAst";
-
-function ensureTomlSectionSettings(
-  content: string,
-  section: string,
-  settings: Record<string, string>,
-): string {
-  const lines = content.replace(/\r\n/g, "\n").split("\n");
-  if (lines.at(-1) === "") lines.pop();
-
-  let sectionIndex = lines.findIndex((line) => line.trim() === `[${section}]`);
-  if (sectionIndex === -1) {
-    if (lines.length > 0 && lines.at(-1)?.trim() !== "") lines.push("");
-    sectionIndex = lines.length;
-    lines.push(`[${section}]`);
-  }
-
-  let sectionEnd = lines.findIndex(
-    (line, index) => index > sectionIndex && /^\s*\[[^\]]+\]\s*$/.test(line),
-  );
-  if (sectionEnd === -1) sectionEnd = lines.length;
-
-  const sectionLines = lines.slice(sectionIndex + 1, sectionEnd);
-  const missingSettings = Object.entries(settings)
-    .filter(([key]) => !sectionLines.some((line) => new RegExp(`^\\s*${key}\\s*=`).test(line)))
-    .map(([key, value]) => `${key} = ${value}`);
-
-  lines.splice(sectionEnd, 0, ...missingSettings);
-  return `${lines.join("\n")}\n`;
-}
+} from "../../../utils/soliditySources";
+import { CLI_ROOT } from "../../../utils/cliRoot";
+import { isSourceUnitAst, listJsonFiles, uniqueAstSources } from "../../../utils/solidityAst";
+import { ensureTomlSectionSettings } from "./helpers";
 
 /** Framework adapter for Foundry-based Diamond projects. */
 const adapter: IFrameworkAdapter = {

cli/src/adapters/IFrameworkAdapter/foundryAdapter/helpers.ts

@@ -0,0 +1,29 @@
+/** Adds missing settings to a TOML section without overwriting existing values. */
+export function ensureTomlSectionSettings(
+  content: string,
+  section: string,
+  settings: Record<string, string>,
+): string {
+  const lines = content.replace(/\r\n/g, "\n").split("\n");
+  if (lines.at(-1) === "") lines.pop();
+
+  let sectionIndex = lines.findIndex((line) => line.trim() === `[${section}]`);
+  if (sectionIndex === -1) {
+    if (lines.length > 0 && lines.at(-1)?.trim() !== "") lines.push("");
+    sectionIndex = lines.length;
+    lines.push(`[${section}]`);
+  }
+
+  let sectionEnd = lines.findIndex(
+    (line, index) => index > sectionIndex && /^\s*\[[^\]]+\]\s*$/.test(line),
+  );
+  if (sectionEnd === -1) sectionEnd = lines.length;
+
+  const sectionLines = lines.slice(sectionIndex + 1, sectionEnd);
+  const missingSettings = Object.entries(settings)
+    .filter(([key]) => !sectionLines.some((line) => new RegExp(`^\\s*${key}\\s*=`).test(line)))
+    .map(([key, value]) => `${key} = ${value}`);
+
+  lines.splice(sectionEnd, 0, ...missingSettings);
+  return `${lines.join("\n")}\n`;
+}

cli/src/adapters/hardhatAdapter.ts → cli/src/adapters/IFrameworkAdapter/hardhatAdapter/adapter.ts

@@ -1,43 +1,21 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import { ComposeContext } from "../context/types";
+import { ComposeContext } from "../../../context/types";
 import {
   ConfigOptions,
   IFrameworkAdapter,
   SolidityAstSource,
-} from "./interface/IFrameworkAdapter";
-import { writeFileIfMissing } from "../utils/files";
-import { runCommand } from "../utils/exec";
+} from "../interface";
+import { writeFileIfMissing } from "../../../utils/files";
+import { runCommand } from "../../../utils/exec";
 import {
   composePackageSubpath,
   isComposePackagePath,
-} from "../utils/soliditySources";
-import { ScaffoldingModule } from "../modules/scaffolding/module";
-import { CLI_ROOT } from "../utils/cliRoot";
-import { isSourceUnitAst, listJsonFiles, uniqueAstSources } from "../utils/solidityAst";
-
-/** Converts a Hardhat compiler source name into its readable filesystem path. */
-export function resolveHardhatAstSourcePath(projectRoot: string, sourceName: string): string {
-  const segments = sourceName.replace(/\\/g, "/").split("/");
-
-  if (segments[0] === "project") {
-    return path.resolve(projectRoot, ...segments.slice(1));
-  }
-
-  if (segments[0] === "npm") {
-    const packageNameIndex = segments[1]?.startsWith("@") ? 2 : 1;
-    const versionedPackageName = segments[packageNameIndex] ?? "";
-    const versionSeparator = versionedPackageName.lastIndexOf("@");
-    if (versionSeparator > 0) {
-      segments[packageNameIndex] = versionedPackageName.slice(0, versionSeparator);
-    }
-    return path.resolve(projectRoot, "node_modules", ...segments.slice(1));
-  }
-
-  return path.isAbsolute(sourceName)
-    ? path.normalize(sourceName)
-    : path.resolve(projectRoot, sourceName);
-}
+} from "../../../utils/soliditySources";
+import { ScaffoldingModule } from "../../../modules/scaffolding/module";
+import { CLI_ROOT } from "../../../utils/cliRoot";
+import { isSourceUnitAst, listJsonFiles, uniqueAstSources } from "../../../utils/solidityAst";
+import { resolveHardhatAstSourcePath } from "./helpers";
 
 /** Framework adapter for Hardhat-based Diamond projects. */
 const adapter: IFrameworkAdapter = {

cli/src/adapters/IFrameworkAdapter/hardhatAdapter/helpers.ts

@@ -0,0 +1,24 @@
+import path from "node:path";
+
+/** Converts a Hardhat compiler source name into its readable filesystem path. */
+export function resolveHardhatAstSourcePath(projectRoot: string, sourceName: string): string {
+  const segments = sourceName.replace(/\\/g, "/").split("/");
+
+  if (segments[0] === "project") {
+    return path.resolve(projectRoot, ...segments.slice(1));
+  }
+
+  if (segments[0] === "npm") {
+    const packageNameIndex = segments[1]?.startsWith("@") ? 2 : 1;
+    const versionedPackageName = segments[packageNameIndex] ?? "";
+    const versionSeparator = versionedPackageName.lastIndexOf("@");
+    if (versionSeparator > 0) {
+      segments[packageNameIndex] = versionedPackageName.slice(0, versionSeparator);
+    }
+    return path.resolve(projectRoot, "node_modules", ...segments.slice(1));
+  }
+
+  return path.isAbsolute(sourceName)
+    ? path.normalize(sourceName)
+    : path.resolve(projectRoot, sourceName);
+}

cli/src/adapters/hashingAdapter.ts → cli/src/adapters/IHashingAdapter/adapter.ts

@@ -1,5 +1,5 @@
 import { keccak256, stringToBytes, type Hex } from "viem";
-import { IHashingAdapter } from "./interface/IHashingAdapter";
+import { IHashingAdapter } from "./interface";
 
 /** Adapter providing keccak256 hashing over UTF-8 strings, returning a hex digest. */
 export const HashingAdapter: IHashingAdapter = {

cli/src/adapters/interface/IHashingAdapter.ts → cli/src/adapters/IHashingAdapter/interface.ts

@@ -9,4 +9,4 @@ export interface IHashingAdapter {
    * @returns The keccak256 hex digest
    */
   keccak256(value: string): Hex;
-}
+}

cli/src/adapters/rpc/adapter.ts → cli/src/adapters/IRPCAdapter/adapter.ts

@@ -8,7 +8,7 @@ import {
   type Hex,
   type ReadContractParameters,
 } from "viem";
-import type { IRPCAdapter, RPCReadContractOptions } from "../interface/IRPCAdapter";
+import type { IRPCAdapter, RPCReadContractOptions } from "./interface";
 import { requestError, RPCAdapterError } from "./errors";
 import { retryRPC } from "./retry";
 import type { RPCAdapterOptions } from "./types";

cli/src/modules/compile/module.ts

@@ -1,5 +1,5 @@
 import fs from "node:fs";
-import { IFrameworkAdapter } from "../../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../../adapters/IFrameworkAdapter/interface";
 import { getNewestSourceMtime, getOldestArtifactMtime } from "./utils";
 
 export const CompileModule = {

cli/src/modules/inspect/module.ts

@@ -5,7 +5,7 @@ import { DependencyKey } from "../../resolver/dependencyKey";
 import { DependencyResolver } from "../../resolver/dependencyResolver";
 import { resolveChainConfig } from "../../utils/chainConfig";
 import { findFileAncestor } from "../../utils/files";
-import { RPCAdapterError } from "../../adapters/rpc/errors";
+import { RPCAdapterError } from "../../adapters/IRPCAdapter/errors";
 import { showInspect } from "./output";
 import { DIAMOND_LOUPE_ABI } from "./diamondLoupeAbi";
 import { toFacetInfo } from "./facetFormatter";

cli/src/modules/lockFile/module.ts

@@ -2,7 +2,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import { type Hex } from "viem";
 import { ComposeContext } from "../../context/types";
-import { IHashingAdapter } from "../../adapters/interface/IHashingAdapter";
+import { IHashingAdapter } from "../../adapters/IHashingAdapter/interface";
 import { atomicWriteFile, findFileAncestor } from "../../utils/files";
 import { ComposeLock, DiamondDeployment } from "./types";
 import { validateLockFile } from "./validators";

cli/src/modules/scaffolding/module.ts

@@ -1,6 +1,6 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import { IFrameworkAdapter } from "../../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../../adapters/IFrameworkAdapter/interface";
 import { ComposeContext, ModuleState } from "../../context/types";
 import { VERSION } from "../../utils/metadata";
 import { copyFileIfMissing, parsePackageName, resolveLocalSolidityImportClosure, toPosixPath } from "../../utils/files";

cli/src/modules/validation/astSelectors.ts

@@ -1,4 +1,4 @@
-import { SolidityAstSource } from "../../adapters/interface/IFrameworkAdapter";
+import { SolidityAstSource } from "../../adapters/IFrameworkAdapter/interface";
 import { matchesAstSource } from "./astIdentity";
 import { FacetReference, FacetScanResult, FunctionInfo } from "./types";
 

cli/src/modules/validation/module.ts

@@ -1,5 +1,5 @@
 import { ComposeContext } from "../../context/types";
-import { SolidityAstSource } from "../../adapters/interface/IFrameworkAdapter";
+import { SolidityAstSource } from "../../adapters/IFrameworkAdapter/interface";
 import { DiamondValidationScope, FacetReference, SelectorCollisionDeps } from "./types";
 import { matchesAstSource } from "./astIdentity";
 import { scanFacetSelectorsFromAst } from "./astSelectors";
@@ -22,7 +22,7 @@ import {
 } from "./state";
 import { showReport, showSuccess } from "./output";
 import { getResolvedFacetSources, resolveFacetSources } from "./sourceResolution";
-import { IFrameworkAdapter } from "../../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../../adapters/IFrameworkAdapter/interface";
 
 /**
  * Validates facet scans for selector export guidance and collision-free layouts.

cli/src/modules/validation/sourceResolution.ts

@@ -1,4 +1,4 @@
-import { IFrameworkAdapter } from "../../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../../adapters/IFrameworkAdapter/interface";
 import { ComposeContext, ModuleState } from "../../context/types";
 import { ScaffoldMapEntry } from "../scaffolding/types";
 import { ResolvedFacetSource, ResolvedFacetSourceResult } from "./types";

cli/src/modules/validation/types.ts

@@ -1,4 +1,4 @@
-import { IHashingAdapter } from "../../adapters/interface/IHashingAdapter";
+import { IHashingAdapter } from "../../adapters/IHashingAdapter/interface";
 
 export type FunctionInfo = {
   name: string;

cli/src/modules/validation/validators.ts

@@ -1,4 +1,4 @@
-import { IHashingAdapter } from "../../adapters/interface/IHashingAdapter";
+import { IHashingAdapter } from "../../adapters/IHashingAdapter/interface";
 import { isArrayPrefix } from "../../utils/arrays";
 import {
   FacetScanResult,

cli/src/modules/validation/virtualStorageLayout.ts

@@ -1,5 +1,5 @@
 import { keccak256, stringToBytes, toHex } from "viem";
-import { SolidityAstSource } from "../../adapters/interface/IFrameworkAdapter";
+import { SolidityAstSource } from "../../adapters/IFrameworkAdapter/interface";
 import { matchesAstSource } from "./astIdentity";
 import {
   DiamondValidationScope,

cli/src/pipelines/buildPipeline.ts

@@ -3,7 +3,7 @@ import { CompileModule } from "../modules/compile/module";
 import { FrameworkModule } from "../modules/framework/module";
 import { DependencyKey } from "../resolver/dependencyKey";
 import { DependencyResolver } from "../resolver/dependencyResolver";
-import { IFrameworkAdapter } from "../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../adapters/IFrameworkAdapter/interface";
 
 export const BuildPipeline = {
   async execute(ctx: ComposeContext): Promise<ComposeContext> {

cli/src/pipelines/initPipeline.ts

@@ -10,7 +10,7 @@ import { DeployGenerationModule } from "../modules/deployGeneration/module";
 import { TestGenerationModule } from "../modules/testGeneration/module";
 import { DependencyKey } from "../resolver/dependencyKey";
 import { DependencyResolver } from "../resolver/dependencyResolver";
-import { IFrameworkAdapter } from "../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../adapters/IFrameworkAdapter/interface";
 import { BasesCatalog } from "../modules/config/types";
 
 /**

cli/src/pipelines/validatePipeline.ts

@@ -1,4 +1,4 @@
-import { IFrameworkAdapter } from "../adapters/interface/IFrameworkAdapter";
+import { IFrameworkAdapter } from "../adapters/IFrameworkAdapter/interface";
 import { ComposeContext } from "../context/types";
 import { ValidationModule } from "../modules/validation/module";
 import { DependencyKey } from "../resolver/dependencyKey";

cli/src/resolver/dependencyRegistry.ts

@@ -1,12 +1,12 @@
 import {
   HashingAdapter,
-} from "../adapters/hashingAdapter";
-import { IHashingAdapter } from "../adapters/interface/IHashingAdapter";
-import { IFrameworkAdapter } from "../adapters/interface/IFrameworkAdapter";
-import { foundryAdapter } from "../adapters/foundryAdapter";
-import { hardhatAdapter } from "../adapters/hardhatAdapter";
-import type { IRPCAdapter } from "../adapters/interface/IRPCAdapter";
-import { createRPCAdapter } from "../adapters/rpc/adapter";
+} from "../adapters/IHashingAdapter/adapter";
+import { IHashingAdapter } from "../adapters/IHashingAdapter/interface";
+import { IFrameworkAdapter } from "../adapters/IFrameworkAdapter/interface";
+import { foundryAdapter } from "../adapters/IFrameworkAdapter/foundryAdapter/adapter";
+import { hardhatAdapter } from "../adapters/IFrameworkAdapter/hardhatAdapter/adapter";
+import type { IRPCAdapter } from "../adapters/IRPCAdapter/interface";
+import { createRPCAdapter } from "../adapters/IRPCAdapter/adapter";
 import { resolveChainConfig } from "../utils/chainConfig";
 import { DependencyKey } from "./dependencyKey";
 

cli/src/utils/chainConfig.ts

@@ -1,6 +1,6 @@
 import fs from "node:fs/promises";
 import { findFileAncestor } from "./files";
-import { RPCAdapterError } from "../adapters/rpc/errors";
+import { RPCAdapterError } from "../adapters/IRPCAdapter/errors";
 
 export type ResolvedChainConfig = {
   /** Name used to select the chain in compose.json. */

cli/src/utils/solidityAst.ts

@@ -3,7 +3,7 @@ import path from "node:path";
 import {
   SolidityAstSource,
   SoliditySourceUnitAst,
-} from "../adapters/interface/IFrameworkAdapter";
+} from "../adapters/IFrameworkAdapter/interface";
 
 /** Recursively lists JSON files below an adapter output directory. */
 export async function listJsonFiles(root: string): Promise<string[]> {

cli/test/adapters/IFrameworkAdapter/canonicalAst.ts

@@ -1,4 +1,4 @@
-import { SoliditySourceUnitAst } from "../../../src/adapters/interface/IFrameworkAdapter";
+import { SoliditySourceUnitAst } from "../../../src/adapters/IFrameworkAdapter/interface";
 
 /** Sorts AST object keys recursively so expected fixtures are stable and reviewable. */
 export function canonicalizeAst(ast: SoliditySourceUnitAst): unknown {

cli/test/adapters/IFrameworkAdapter/foundryAdapter/foundryAdapter.test.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 import { describe, expect, it } from "vitest";
-import { foundryAdapter } from "../../../../src/adapters/foundryAdapter";
+import { foundryAdapter } from "../../../../src/adapters/IFrameworkAdapter/foundryAdapter/adapter";
 import { canonicalizeAst } from "../canonicalAst";
 import { createFoundryAdapterFixtureHarness } from "./harness";
 

cli/test/adapters/IFrameworkAdapter/foundryAdapter/project/foundry.toml

@@ -2,3 +2,4 @@
 src = "src"
 out = "out"
 solc = "0.8.30"
+evm_version = "prague"

cli/test/adapters/IFrameworkAdapter/hardhatAdapter/hardhatAdapter.test.ts

@@ -1,10 +1,8 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 import { beforeAll, describe, expect, it } from "vitest";
-import {
-  hardhatAdapter,
-  resolveHardhatAstSourcePath,
-} from "../../../../src/adapters/hardhatAdapter";
+import { hardhatAdapter } from "../../../../src/adapters/IFrameworkAdapter/hardhatAdapter/adapter";
+import { resolveHardhatAstSourcePath } from "../../../../src/adapters/IFrameworkAdapter/hardhatAdapter/helpers";
 import { canonicalizeAst } from "../canonicalAst";
 import {
   createHardhatAdapterFixtureHarness,

cli/test/adapters/hashingAdapter.test.ts → cli/test/adapters/IHashingAdapter/adapter.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { HashingAdapter } from "../../src/adapters/hashingAdapter";
+import { HashingAdapter } from "../../../src/adapters/IHashingAdapter/adapter";
 
 /**
  * Tests HashingAdapter against the full Keccak-256 digest of a Solidity signature.

cli/test/adapters/rpcAdapter.test.ts → cli/test/adapters/IRPCAdapter/adapter.test.ts

@@ -30,7 +30,7 @@ vi.mock("viem", () => ({
   withRetry: mocks.withRetry,
 }));
 
-import { createRPCAdapter } from "../../src/adapters/rpc/adapter";
+import { createRPCAdapter } from "../../../src/adapters/IRPCAdapter/adapter";
 
 type MockClient = {
   chain: { id: number };