@verdaccio/e2e-cli 3.0.0 → 3.2.0

package/build/scenarios/index.d.ts

@@ -0,0 +1,9 @@
+import { TestDefinition } from '../types';
+import { installMultipleDepsScenario } from './install-multiple-deps';
+import { metadataScenario } from './metadata';
+import { minimumReleaseAgeScenario } from './minimum-release-age';
+import { searchScenario } from './search';
+import { tarballsScenario } from './tarballs';
+import { uplinkFailureScenario } from './uplink-failure';
+export declare const allScenarios: TestDefinition[];
+export { installMultipleDepsScenario, minimumReleaseAgeScenario, searchScenario, tarballsScenario, metadataScenario, uplinkFailureScenario, };

package/build/scenarios/install-multiple-deps.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const installMultipleDepsScenario: TestDefinition;

package/build/scenarios/metadata.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const metadataScenario: TestDefinition;

package/build/scenarios/minimum-release-age.d.ts

@@ -0,0 +1,11 @@
+import { PackageManagerAdapter, TestDefinition } from '../types';
+/**
+ * True only for pnpm versions that actually enforce minimumReleaseAge.
+ *
+ * The cooldown is honored in pnpm 11.1.0+, but it is silently ignored in
+ * 11.0.0 / 11.0.1 (and the 11.0.0 release candidates) — those versions install
+ * brand-new packages regardless of the configured cooldown. We scope this
+ * scenario to pnpm 11.1.0 and newer so it doesn't false-fail on that regression.
+ */
+export declare function isPnpm11Plus(adapter: PackageManagerAdapter): boolean;
+export declare const minimumReleaseAgeScenario: TestDefinition;

package/build/scenarios/search.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const searchScenario: TestDefinition;

package/build/scenarios/tarballs.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const tarballsScenario: TestDefinition;

package/build/scenarios/uplink-failure.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const uplinkFailureScenario: TestDefinition;

package/build/tests/audit.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const auditTest: TestDefinition;

package/build/tests/ci.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const ciTest: TestDefinition;

package/build/tests/deprecate.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const deprecateTest: TestDefinition;

package/build/tests/dist-tags.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const distTagsTest: TestDefinition;

package/build/tests/index.d.ts

@@ -0,0 +1,15 @@
+import { allScenarios, installMultipleDepsScenario, metadataScenario, minimumReleaseAgeScenario, searchScenario, tarballsScenario, uplinkFailureScenario } from '../scenarios';
+import { TestDefinition } from '../types';
+import { auditTest } from './audit';
+import { ciTest } from './ci';
+import { deprecateTest } from './deprecate';
+import { distTagsTest } from './dist-tags';
+import { infoTest } from './info';
+import { installTest } from './install';
+import { loginTest } from './login';
+import { pingTest } from './ping';
+import { publishTest } from './publish';
+import { searchTest } from './search';
+import { unpublishTest } from './unpublish';
+export declare const allTests: TestDefinition[];
+export { publishTest, installTest, ciTest, auditTest, infoTest, deprecateTest, distTagsTest, loginTest, pingTest, searchTest, unpublishTest, installMultipleDepsScenario, minimumReleaseAgeScenario, tarballsScenario, metadataScenario, searchScenario, uplinkFailureScenario, allScenarios, };

package/build/tests/info.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const infoTest: TestDefinition;

package/build/tests/install.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const installTest: TestDefinition;

package/build/tests/login.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const loginTest: TestDefinition;

package/build/tests/ping.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const pingTest: TestDefinition;

package/build/tests/publish.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const publishTest: TestDefinition;

package/build/tests/search.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const searchTest: TestDefinition;

package/build/tests/unpublish.d.ts

@@ -0,0 +1,2 @@
+import { TestDefinition } from '../types';
+export declare const unpublishTest: TestDefinition;

package/build/types.d.ts

@@ -0,0 +1,91 @@
+import { SpawnOptions } from 'child_process';
+export type ExecOutput = {
+    stdout: string;
+    stderr: string;
+};
+export type ExecFn = (options: SpawnOptions, ...args: string[]) => Promise<ExecOutput>;
+export type TestContext = {
+    registryUrl: string;
+    token: string;
+    port: number;
+    exec: ExecFn;
+    adapter: PackageManagerAdapter;
+    /** Unique suffix for package names to avoid conflicts across runs */
+    runId: string;
+    /** Report a sub-test step. Runs the callback and reports pass/fail. */
+    subTest: (label: string, fn: () => Promise<void>) => Promise<void>;
+};
+export type SubTestResult = {
+    label: string;
+    passed: boolean;
+    duration: number;
+    error?: string;
+};
+export type TestResult = {
+    name: string;
+    passed: boolean;
+    duration: number;
+    error?: string;
+    subTests?: SubTestResult[];
+};
+export type SuiteResult = {
+    adapter: string;
+    tests: TestResult[];
+    passed: number;
+    failed: number;
+    skipped: number;
+    duration: number;
+};
+export type TestDefinition = {
+    name: string;
+    run: (ctx: TestContext) => Promise<void>;
+    /** Commands required for this test (e.g. 'deprecate', 'search'). Skipped if adapter doesn't support them. */
+    requires?: string[];
+    /**
+     * Minimum timeout (ms) for this test. The effective timeout is the larger of
+     * this and the CLI-level --timeout. Use for long scenarios (large tarballs,
+     * uplink failure simulation) that outgrow the default per-test budget.
+     */
+    timeout?: number;
+    /**
+     * Predicate to gate a test to specific adapters/versions. Returns false to skip.
+     * Use for tests that only make sense on a particular package manager or version
+     * (e.g. pnpm-only settings). Evaluated after the `requires` check.
+     */
+    appliesTo?: (adapter: PackageManagerAdapter) => boolean;
+};
+export interface PackageManagerAdapter {
+    /** Display name, e.g. "npm@10" */
+    name: string;
+    /** Package manager type: npm, pnpm, yarn-modern, bun, deno */
+    type: 'npm' | 'pnpm' | 'yarn-modern' | 'bun' | 'deno';
+    /** Resolved path to the binary */
+    bin: string;
+    /** Commands this PM supports */
+    supports: Set<string>;
+    /** Build --registry args */
+    registryArg(url: string): string[];
+    /** Build --prefix / --cwd args */
+    prefixArg(folder: string): string[];
+    /** Execute a command with this PM */
+    exec(options: SpawnOptions, ...args: string[]): Promise<ExecOutput>;
+    /** Prepare a temp project for testing. Returns path to temp folder. */
+    prepareProject(packageName: string, version: string, registryUrl: string, port: number, token: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): Promise<{
+        tempFolder: string;
+    }>;
+    /** Import a Verdaccio yarn plugin into a project (yarn-modern only) */
+    importPlugin?(cwd: string, pluginName: string): Promise<void>;
+}
+export type CliOptions = {
+    registry: string;
+    pm?: string[];
+    test?: string[];
+    concurrency: number;
+    timeout: number;
+    token?: string;
+    verbose: boolean;
+    /** Port of the mock uplink used by scenario:uplink-failure (also E2E_UPLINK_PORT) */
+    uplinkPort?: number;
+    /** Print the recommended registry config for the full battery and exit */
+    printConfig?: boolean;
+};

package/build/utils/e2e-config.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Recommended Verdaccio config for running the full e2e-cli battery,
+ * printed by `verdaccio-e2e --print-config`. It is what the consuming repos'
+ * CI jobs and scripts/run-e2e.sh feed to `verdaccio --config`:
+ *
+ *   - max_body_size raised so scenario:tarballs can publish ~30 MB packages
+ *     (Verdaccio's default is 10mb)
+ *   - an `e2emock` uplink + `e2e-uplink-*` package pattern wired to the mock
+ *     uplink server that scenario:uplink-failure starts on E2E_UPLINK_PORT
+ *     (short timeout so the "slow uplink" case completes quickly; high
+ *     max_fails so simulated failures don't trip the circuit breaker for
+ *     later sub-tests)
+ *   - NO npmjs uplink: the whole suite publishes every package it consumes,
+ *     so the registry under test never talks to the outside world and the
+ *     battery runs fully offline (and deterministically in CI)
+ *
+ * Relative paths (storage/htpasswd) resolve next to the config file, so write
+ * it into a disposable directory.
+ */
+export declare const DEFAULT_UPLINK_PORT = 4874;
+export declare function buildE2EConfig(uplinkPort?: number): string;

package/build/utils/http-client.d.ts

@@ -0,0 +1,49 @@
+export type PackumentResponse = {
+    status: number;
+    headers: Headers;
+    /** Parsed JSON body, or undefined when the response is not JSON (e.g. 304) */
+    body?: any;
+};
+export type TarballDownload = {
+    status: number;
+    headers: Headers;
+    /** Total bytes received */
+    bytes: number;
+    /** hex-encoded sha1 of the received bytes (matches dist.shasum) */
+    sha1: string;
+    /** `sha512-<base64>` of the received bytes (matches dist.integrity) */
+    integrity: string;
+};
+export type FetchPackumentOptions = {
+    /** Request the abbreviated (install) metadata format */
+    abbreviated?: boolean;
+    /** Send If-None-Match with this value */
+    etag?: string;
+    /** Bearer token */
+    token?: string;
+};
+export declare const ABBREVIATED_ACCEPT = "application/vnd.npm.install-v1+json";
+/**
+ * Registry URL for a package name. Scoped names are encoded with the same
+ * `%2f` form npm clients use: `@scope%2fname`.
+ */
+export declare function packumentUrl(registryUrl: string, pkgName: string): string;
+export declare function fetchPackument(registryUrl: string, pkgName: string, options?: FetchPackumentOptions): Promise<PackumentResponse>;
+export type DownloadTarballOptions = {
+    signal?: AbortSignal;
+    token?: string;
+    /** Called after the first chunk of the body arrives (useful to abort mid-stream) */
+    onFirstChunk?: () => void;
+    /** Called after every chunk with the total bytes received so far (useful to abort at a threshold) */
+    onChunk?: (bytesReceived: number) => void;
+};
+/**
+ * Download a tarball fully, computing sha1/sha512 integrity on the fly.
+ * Rejects with the underlying error when aborted or the connection drops.
+ */
+export declare function downloadTarball(url: string, options?: DownloadTarballOptions): Promise<TarballDownload>;
+/** Compute npm-style dist values (shasum/integrity) for a buffer. */
+export declare function computeDist(buffer: Buffer): {
+    shasum: string;
+    integrity: string;
+};

package/build/utils/index.d.ts

@@ -0,0 +1,4 @@
+export { exec, setVerbose } from './process';
+export { createTempFolder, getPackageJSON, getREADME, prepareGenericEmptyProject } from './project';
+export { createUser, pingRegistry } from './registry-client';
+export { normalizeInfo, parseInfoJson } from './info';

package/build/utils/info.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Normalize the parsed output of `npm/pnpm info <pkg> --json`.
+ *
+ * npm 12+ wraps the result in a single-element JSON array
+ * (e.g. `[{ "name": "verdaccio", ... }]`) for both full-packument and
+ * version-specific queries, whereas older npm versions return a bare object.
+ * When multiple results match a range, the array holds one entry per match;
+ * the last entry is the highest (latest) version, which is what the tests want.
+ *
+ * Returns the bare object as-is for backward compatibility.
+ */
+export declare function normalizeInfo(parsed: any): any;
+/** Parse `info --json` stdout and normalize to a single info object. */
+export declare function parseInfoJson(stdout: string): any;

package/build/utils/mock-uplink.d.ts

@@ -0,0 +1,47 @@
+export type UplinkMode = 
+/** Serve packuments and tarballs normally */
+'ok'
+/** Send tarball headers + half the body, then destroy the socket */
+ | 'drop-mid-stream'
+/** Delay every response long enough to trip the registry's uplink timeout */
+ | 'slow'
+/** Respond 500 to everything */
+ | 'error-500';
+type MockPackage = {
+    name: string;
+    version: string;
+    tarball: Buffer;
+    shasum: string;
+    integrity: string;
+};
+/**
+ * Minimal controllable npm uplink used by scenario:uplink-failure.
+ *
+ * The registry under test is configured (see --print-config) to proxy the
+ * `e2e-uplink-*` package pattern to this server, so the scenario can flip the
+ * uplink between healthy, dropping connections mid-tarball, slow, and down.
+ */
+export declare class MockUplink {
+    readonly port: number;
+    mode: UplinkMode;
+    requests: string[];
+    private server?;
+    private packages;
+    private searchResults;
+    constructor(port: number);
+    /** Register a package served by this uplink; tarball is random (incompressible) bytes. */
+    addPackage(name: string, tarballBytes?: number): MockPackage;
+    /** Register a result served by the /-/v1/search endpoint. */
+    addSearchResult(name: string, version?: string): void;
+    /**
+     * npmjs-faithful /-/v1/search: filters by `text` substring, applies
+     * `from`/`size` itself (like registry.npmjs.org does) and reports the real
+     * `total` of matches. Mimicking the upstream offsetting is what exposes
+     * double pagination in the registry under test.
+     */
+    private searchResponse;
+    private packument;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+}
+export {};

package/build/utils/pending-checks.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Pending contract checks pin registry behavior that is correct per the
+ * npmjs contract but still red against some published Verdaccio versions.
+ * They are off by default; E2E_PENDING_CONTRACT_CHECKS enables them:
+ *
+ *   E2E_PENDING_CONTRACT_CHECKS=true              → all scenarios
+ *   E2E_PENDING_CONTRACT_CHECKS=tarballs          → one scenario
+ *   E2E_PENDING_CONTRACT_CHECKS=tarballs,search   → a list
+ *
+ * Flip the default once the registry-side fixes are published everywhere.
+ */
+export declare function pendingContractChecksEnabled(scenario: string): boolean;

package/build/utils/process.d.ts

@@ -0,0 +1,11 @@
+import { SpawnOptions } from 'child_process';
+import { ExecOutput } from '../types';
+export declare function setVerbose(v: boolean): void;
+/**
+ * Always-on scenario tracing, printed inline with the test output in the same
+ * style as the verbose `$ <command>` lines — so a red scenario explains what
+ * it actually saw (statuses, headers, bodies, timings) in any run, CI or
+ * local, without a reproduction. Accepts util.format tokens (%s %d %j %o).
+ */
+export declare function trace(fmt: string, ...args: unknown[]): void;
+export declare function exec(options: SpawnOptions, cmd: string, args: string[]): Promise<ExecOutput>;

package/build/utils/project.d.ts

@@ -0,0 +1,6 @@
+export declare function createTempFolder(prefix: string): Promise<string>;
+export declare function getPackageJSON(packageName: string, version?: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): string;
+export declare function getREADME(packageName: string): string;
+export declare function prepareGenericEmptyProject(packageName: string, version: string, port: number, token: string, registryDomain: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): Promise<{
+    tempFolder: string;
+}>;

package/build/utils/publish.d.ts

@@ -0,0 +1,17 @@
+import { TestContext } from '../types';
+/** Build a minimal valid npm package tarball (package/package.json inside). */
+export declare function buildPackageTarball(pkgName: string, version: string, dependencies?: Record<string, string>): Buffer;
+/**
+ * Publish straight through the registry HTTP API (same PUT an npm client
+ * sends). Used for adapters that cannot publish themselves (eg. deno) so
+ * every fixture still comes from the registry under test — never from an
+ * external registry.
+ */
+export declare function publishViaHttp(ctx: TestContext, pkgName: string, version?: string, dependencies?: Record<string, string>): Promise<void>;
+/**
+ * Publish a package to the registry under test so later steps (install, ci,
+ * audit, info, search…) can consume it without ever touching an external
+ * registry — the whole suite must be runnable offline. Uses the package
+ * manager when it can publish, the raw HTTP API otherwise (eg. deno).
+ */
+export declare function publishLocalPackage(ctx: TestContext, pkgName: string, version?: string, dependencies?: Record<string, string>): Promise<void>;

package/build/utils/registry-client.d.ts

@@ -0,0 +1,15 @@
+export type RegistryAuth = {
+    token: string;
+    user: string;
+};
+/**
+ * Creates a user on the registry and returns the auth token.
+ * Uses a unique username per run to avoid 409 conflicts.
+ * Works against any running Verdaccio instance with htpasswd auth.
+ */
+export declare function createUser(registryUrl: string, user?: string, password?: string): Promise<RegistryAuth>;
+/**
+ * Ping the registry to check it's alive.
+ * Uses @verdaccio/registry-cli ping.
+ */
+export declare function pingRegistry(registryUrl: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/e2e-cli",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "type": "module",
   "license": "MIT",
   "description": "CLI tool to run Verdaccio e2e tests against any running registry",
@@ -11,11 +11,7 @@
   },
   "files": [
     "build",
-    "bin",
-    "Cargo.lock",
-    "Cargo.toml",
-    "scripts",
-    "src"
+    "bin"
   ],
   "bin": {
     "verdaccio-e2e": "./bin/e2e-cli.js"
@@ -30,14 +26,20 @@
       "types": "./build/index.d.ts"
     }
   },
-  "dependencies": {},
-  "devDependencies": {},
+  "dependencies": {
+    "@verdaccio/registry-cli": "^1.1.0",
+    "debug": "4.4.3",
+    "get-port": "7.2.0",
+    "js-yaml": "5.2.3"
+  },
+  "devDependencies": {
+    "@types/debug": "4.1.13",
+    "@types/js-yaml": "4.0.9",
+    "@types/node": "26.2.0",
+    "vite": "8.2.1"
+  },
   "scripts": {
-    "build": "cargo build --release && node scripts/build-js-package.mjs",
-    "postinstall": "cargo build --release && node scripts/build-js-package.mjs",
-    "clean": "rimraf build target",
-    "fmt:check": "cargo fmt -- --check",
-    "clippy": "cargo clippy --all-targets -- -D warnings",
-    "docs": "cargo doc --no-deps"
+    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.build.json",
+    "clean": "rimraf build"
   }
 }