Detect npm and pnpm for apps validation

.nextchanges/cli/apps-validate-package-managers.md

@@ -0,0 +1 @@
+* Select npm or pnpm from `packageManager` declarations and lockfiles for `apps validate` and project validation during `apps deploy`. ([#6892](https://github.com/databricks/cli/pull/6892))

acceptance/apps/validate/app/package.json

@@ -0,0 +1 @@
+{}

acceptance/apps/validate/bin/npm

@@ -0,0 +1,7 @@
+#!/bin/sh
+printf '%s %s\n' "${0##*/}" "$*" >> commands.log
+if [ "$*" = "${VALIDATION_TEST_FAIL:-}" ]; then
+    echo "validation stdout"
+    echo "validation stderr" >&2
+    exit 17
+fi

acceptance/apps/validate/bin/npm.cmd

@@ -0,0 +1,7 @@
+@echo off
+echo %~n0 %*>>commands.log
+if "%*"=="%VALIDATION_TEST_FAIL%" (
+    echo validation stdout
+    echo validation stderr 1>&2
+    exit /b 17
+)

acceptance/apps/validate/bin/pnpm

@@ -0,0 +1,7 @@
+#!/bin/sh
+printf '%s %s\n' "${0##*/}" "$*" >> commands.log
+if [ "$*" = "${VALIDATION_TEST_FAIL:-}" ]; then
+    echo "validation stdout"
+    echo "validation stderr" >&2
+    exit 17
+fi

acceptance/apps/validate/bin/pnpm.cmd

@@ -0,0 +1,7 @@
+@echo off
+echo %~n0 %*>>commands.log
+if "%*"=="%VALIDATION_TEST_FAIL%" (
+    echo validation stdout
+    echo validation stderr 1>&2
+    exit /b 17
+)

acceptance/apps/validate/bom/package.json

@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "build": "node -e \"console.log('BOM build ran'); process.exit(17)\""
+  }
+}

acceptance/apps/validate/conflicting/package.json

@@ -0,0 +1 @@
+{}

acceptance/apps/validate/databricks.yml

@@ -0,0 +1,2 @@
+bundle:
+  name: validate-app

acceptance/apps/validate/invalid/package.json

@@ -0,0 +1 @@
+{

acceptance/apps/validate/lifecycle/add-build/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "validation-add-build",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "node ../update-manifest.cjs",
+    "typegen": "node ../update-manifest.cjs"
+  }
+}

acceptance/apps/validate/lifecycle/invalidated/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "validation-invalidated-manifest",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "node ../update-manifest.cjs",
+    "typegen": "node ../update-manifest.cjs"
+  }
+}

acceptance/apps/validate/lifecycle/remove-build/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "validation-remove-build",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "node ../update-manifest.cjs",
+    "typegen": "node ../update-manifest.cjs",
+    "build": "node -e \"process.exit(17)\""
+  }
+}

acceptance/apps/validate/lifecycle/update-manifest.cjs

@@ -0,0 +1,17 @@
+const fs = require("node:fs");
+
+if (process.env.npm_lifecycle_event === process.env.VALIDATION_UPDATE_STEP) {
+  const manifest = JSON.parse(fs.readFileSync("package.json", "utf8"));
+  switch (process.env.VALIDATION_UPDATE_ACTION) {
+    case "add":
+      manifest.scripts.build = "node -e \"console.log('added build ran'); process.exit(17)\"";
+      break;
+    case "remove":
+      delete manifest.scripts.build;
+      break;
+    case "invalidate":
+      fs.writeFileSync("package.json", "{");
+      return;
+  }
+  fs.writeFileSync("package.json", JSON.stringify(manifest));
+}

acceptance/apps/validate/metadata-npm/databricks.yml

@@ -0,0 +1,2 @@
+bundle:
+  name: validation-metadata-npm

acceptance/apps/validate/metadata-npm/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "validation-metadata-npm",
+  "version": "1.0.0",
+  "packageManager": "npm@10.9.2",
+  "scripts": {
+    "build": "node -e \"console.log('declared npm build ran'); process.exit(17)\""
+  }
+}

acceptance/apps/validate/non-runnable/package.json

@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "typegen": "",
+    "typecheck": null,
+    "test": "",
+    "//": ["a comment"],
+    "build": "node -e \"console.log('non-runnable entries ignored'); process.exit(17)\""
+  }
+}

acceptance/apps/validate/null/package.json

@@ -0,0 +1 @@
+null

acceptance/apps/validate/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DATABRICKS_BUNDLE_ENGINE = ["direct"]

acceptance/apps/validate/output.txt

@@ -0,0 +1,196 @@
+
+=== Validate the directory selected by --path
+>>> withdir app [CLI] apps validate --path ..
+Validating project using pnpm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+✅ Building ([DURATION])
+✅ Running tests ([DURATION])
+✅ All validation checks passed ([DURATION])
+
+=== Skip tests
+>>> [CLI] apps validate --skip-tests
+Validating project using pnpm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+✅ Building ([DURATION])
+⏭️  Skipped Running tests
+✅ All validation checks passed ([DURATION])
+
+=== Report a failed script
+>>> VALIDATION_TEST_FAIL=run --if-present test musterr [CLI] apps validate
+Validating project using pnpm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+✅ Building ([DURATION])
+Error: tests failed (duration: [DURATION])
+❌ Running tests failed ([DURATION])
+validation failed (exit code 17)
+Stdout:
+validation stdout
+
+Stderr:
+validation stderr
+
+Error: validation failed
+
+=== Deploy validates with the same package manager before uploading
+>>> VALIDATION_TEST_FAIL=run --if-present build musterr [CLI] apps deploy
+Validating project using pnpm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+Error: build failed (duration: [DURATION])
+❌ Building failed ([DURATION])
+validation failed (exit code 17)
+Stdout:
+validation stdout
+
+Stderr:
+validation stderr
+
+Error: validation failed - fix errors before deploying
+
+=== Commands executed in the project directory
+>>> cat commands.log
+pnpm install
+pnpm run --if-present typegen
+pnpm run --if-present lint:ast-grep
+pnpm run --if-present typecheck
+pnpm run --if-present build
+pnpm run --if-present test
+pnpm install
+pnpm run --if-present typegen
+pnpm run --if-present lint:ast-grep
+pnpm run --if-present typecheck
+pnpm run --if-present build
+pnpm install
+pnpm run --if-present typegen
+pnpm run --if-present lint:ast-grep
+pnpm run --if-present typecheck
+pnpm run --if-present build
+pnpm run --if-present test
+pnpm install
+pnpm run --if-present typegen
+pnpm run --if-present lint:ast-grep
+pnpm run --if-present typecheck
+pnpm run --if-present build
+
+=== Warn but continue on conflicting lockfiles
+>>> [CLI] apps validate --path conflicting
+Warn: found conflicting package managers; using npm from package-lock.json and ignoring pnpm-lock.yaml
+Validating project using npm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+✅ Building ([DURATION])
+✅ Running tests ([DURATION])
+✅ All validation checks passed ([DURATION])
+
+=== Warn but continue on unsupported lockfiles
+>>> [CLI] apps validate --path unsupported
+Warn: ignoring unsupported lockfile yarn.lock; apps validation uses npm or pnpm
+Validating project using npm...
+✅ Installing dependencies ([DURATION])
+✅ Generating types ([DURATION])
+✅ Running AST-grep lint ([DURATION])
+✅ Type checking ([DURATION])
+✅ Building ([DURATION])
+✅ Running tests ([DURATION])
+✅ All validation checks passed ([DURATION])
+
+=== Validate npm workspace scripts without root scripts
+>>> grep -x workspace build ran LOG.workspaces
+workspace build ran
+
+>>> grep -F validation failed (exit code 17) LOG.workspaces
+validation failed (exit code 17)
+
+=== Deploy rejects a failing npm workspace build
+>>> grep -x workspace build ran LOG.workspaces-deploy
+workspace build ran
+
+>>> grep -F validation failed - fix errors before deploying LOG.workspaces-deploy
+Error: validation failed - fix errors before deploying
+
+=== Use declared npm despite a pnpm lockfile
+>>> grep -x declared npm build ran LOG.metadata-npm
+declared npm build ran
+
+>>> grep -F validation failed (exit code 17) LOG.metadata-npm
+validation failed (exit code 17)
+
+=== Deploy honors the declared package manager
+>>> grep -x declared npm build ran LOG.metadata-npm-deploy
+declared npm build ran
+
+>>> grep -F validation failed - fix errors before deploying LOG.metadata-npm-deploy
+Error: validation failed - fix errors before deploying
+
+=== Reject a missing package.json
+>>> musterr [CLI] apps validate --path missing
+Error: no supported project type detected (looking for package.json)
+
+=== Report native manifest errors with dependencies absent
+>>> grep -x Error: validation failed LOG.invalid-absent
+Error: validation failed
+
+=== Report native manifest errors with dependencies present
+>>> grep -x Error: validation failed LOG.invalid-present
+Error: validation failed
+
+=== Reject a null manifest through the package manager
+>>> grep -x Error: validation failed LOG.null
+Error: validation failed
+
+=== Run scripts from a manifest with a UTF-8 BOM
+>>> grep -x BOM build ran LOG.bom
+BOM build ran
+
+>>> grep -F validation failed (exit code 17) LOG.bom
+validation failed (exit code 17)
+
+=== Let the package manager ignore non-runnable script entries
+>>> grep -x non-runnable entries ignored LOG.non-runnable
+non-runnable entries ignored
+
+>>> grep -F validation failed (exit code 17) LOG.non-runnable
+validation failed (exit code 17)
+
+=== Run a build added by install
+>>> grep -x added build ran LOG.add-build-install
+added build ran
+
+>>> grep -F validation failed (exit code 17) LOG.add-build-install
+validation failed (exit code 17)
+
+=== Skip a build removed by install
+>>> grep -F All validation checks passed LOG.remove-build-install
+✅ All validation checks passed ([DURATION])
+
+=== Report native errors after install invalidates the manifest
+>>> grep -x Error: validation failed LOG.invalidated-install
+Error: validation failed
+
+=== Run a build added by typegen
+>>> grep -x added build ran LOG.add-build-typegen
+added build ran
+
+>>> grep -F validation failed (exit code 17) LOG.add-build-typegen
+validation failed (exit code 17)
+
+=== Skip a build removed by typegen
+>>> grep -F All validation checks passed LOG.remove-build-typegen
+✅ All validation checks passed ([DURATION])
+
+=== Report native errors after typegen invalidates the manifest
+>>> grep -x Error: validation failed LOG.invalidated-typegen
+Error: validation failed

acceptance/apps/validate/package.json

@@ -0,0 +1,6 @@
+{
+  "scripts": {
+    "build": "echo build",
+    "test": "echo test"
+  }
+}