Merge pull request #1539 from thewtex/pixi-native-builds

fix(pixi): repair multi-line cmake task commands broken by pixi 0.70

Author: thewtex

packages/core/typescript/create-itk-wasm/package.json

@@ -17,7 +17,8 @@
     "build:watch": "tsc --pretty --watch",
     "lint": "prettier --check .",
     "lint:fix": "prettier --write .",
-    "test": "pnpm test:help && pnpm test:defaultPipeline && pnpm test:imagePipeline && pnpm test:meshPipeline && pnpm test:polyDataPipeline",
+    "test": "pnpm test:pixiToml && pnpm test:help && pnpm test:defaultPipeline && pnpm test:imagePipeline && pnpm test:meshPipeline && pnpm test:polyDataPipeline",
+    "test:pixiToml": "node dist/test-pixi-toml.js",
     "test:defaultPipeline": "shx rm -rf test/default && node dist/create-itk-wasm.js -o test/default -n \"default-pipeline\" -a \"Test Monkey\" -d \"Default pipeline description\" --pipeline-name default-pipeline --pipeline-description \"Default pipeline description\" -r \"http://test.repo\" --pipeline-inputs \"default-input:string:A default input\" --pipeline-parameters \"a-double-param:double:A double param\" --pipeline-outputs \"a-json-output:JsonCompatible:A JSON compatible output\" --no-input && cd test/default && pixi run build && pixi run test",
     "test:imagePipeline": "shx rm -rf test/image && node dist/create-itk-wasm.js -o test/image -n \"image-pipeline\" -a \"Test Monkey\" -d \"Image pipeline description\" --pipeline-name image-pipeline --pipeline-description \"Image pipeline description\" -r \"http://test.repo\" --pipeline-inputs \"input-image:Image:An input image\" --pipeline-parameters \"a-float-param:float:A float param\" --pipeline-outputs \"output-image:Image:An output image\" --pipeline-dispatch Image --no-input --build-and-test",
     "test:meshPipeline": "shx rm -rf test/mesh && node dist/create-itk-wasm.js -o test/mesh -n \"mesh-pipeline\" -a \"Test Monkey\" -d \"Mesh pipeline description\" --pipeline-name mesh-pipeline --pipeline-description \"Mesh pipeline description\" -r \"http://test.repo\" --pipeline-inputs \"input-mesh:Mesh:An input mesh\" --pipeline-parameters \"a-float-param:float:A float param\" --pipeline-outputs \"output-mesh:Mesh:An output mesh\" --pipeline-dispatch Mesh --no-input --build-and-test",

packages/core/typescript/create-itk-wasm/src/generate/pixi-toml.ts

@@ -204,21 +204,21 @@ outputs = ["native/ITK/LICENSE"]
 description = "Fetch ITK's source code"
 
 [feature.native.tasks.configure-itk]
-cmd = '''cmake -B$ITK_WASM_ITK_BUILD_DIR -S$ITK_WASM_ITK_SOURCE_DIR -GNinja
-  -DCMAKE_CXX_STANDARD:STRING=20
-  -DCMAKE_BUILD_TYPE:STRING=Debug
-  -DBUILD_EXAMPLES:BOOL=OFF
-  -DBUILD_TESTING:BOOL=OFF
-  -DBUILD_SHARED_LIBS:BOOL=OFF
-  -DBUILD_STATIC_LIBS:BOOL=ON
-  -DITK_LEGACY_REMOVE:BOOL=ON
-  -DITK_BUILD_DEFAULT_MODULES:BOOL=ON
-  -DITKGroup_IO:BOOL=ON
-  -DH5_HAVE_GETPWUID:BOOL=OFF
-  -DModule_MeshToPolyData:BOOL=ON
-  -DDO_NOT_BUILD_ITK_TEST_DRIVER:BOOL=ON
-  -DOPJ_USE_THREAD:BOOL=OFF
-  -DNO_FLOAT_EXCEPTIONS:BOOL=ON
+cmd = '''cmake -B$ITK_WASM_ITK_BUILD_DIR -S$ITK_WASM_ITK_SOURCE_DIR -GNinja \\
+  -DCMAKE_CXX_STANDARD:STRING=20 \\
+  -DCMAKE_BUILD_TYPE:STRING=Debug \\
+  -DBUILD_EXAMPLES:BOOL=OFF \\
+  -DBUILD_TESTING:BOOL=OFF \\
+  -DBUILD_SHARED_LIBS:BOOL=OFF \\
+  -DBUILD_STATIC_LIBS:BOOL=ON \\
+  -DITK_LEGACY_REMOVE:BOOL=ON \\
+  -DITK_BUILD_DEFAULT_MODULES:BOOL=ON \\
+  -DITKGroup_IO:BOOL=ON \\
+  -DH5_HAVE_GETPWUID:BOOL=OFF \\
+  -DModule_MeshToPolyData:BOOL=ON \\
+  -DDO_NOT_BUILD_ITK_TEST_DRIVER:BOOL=ON \\
+  -DOPJ_USE_THREAD:BOOL=OFF \\
+  -DNO_FLOAT_EXCEPTIONS:BOOL=ON \\
   -DITK_MSVC_STATIC_RUNTIME_LIBRARY=ON'''
 depends-on = ["clone-itk"]
 # Note: pixi does not seem to reliably support activation environmental variables in task inputs / outputs
@@ -244,12 +244,12 @@ outputs = ["native/ITK-Wasm/LICENSE"]
 description = "Fetch ITK's source code"
 
 [feature.native.tasks.configure-itk-wasm]
-cmd = '''cmake -B$ITK_WASM_NATIVE_WORKSPACE/ITK-Wasm-build
-  -S$ITK_WASM_NATIVE_WORKSPACE/ITK-Wasm
-  -GNinja
-  -DITK_DIR:PATH=$ITK_WASM_ITK_BUILD_DIR
-  -DBUILD_TESTING:BOOL=OFF
-  -DCMAKE_CXX_STANDARD:STRING=20
+cmd = '''cmake -B$ITK_WASM_NATIVE_WORKSPACE/ITK-Wasm-build \\
+  -S$ITK_WASM_NATIVE_WORKSPACE/ITK-Wasm \\
+  -GNinja \\
+  -DITK_DIR:PATH=$ITK_WASM_ITK_BUILD_DIR \\
+  -DBUILD_TESTING:BOOL=OFF \\
+  -DCMAKE_CXX_STANDARD:STRING=20 \\
   -DCMAKE_BUILD_TYPE:STRING=Debug'''
 depends-on = ["build-itk", "clone-itk-wasm"]
 outputs = ["native/ITK-Wasm-build/CMakeFiles/"]
@@ -261,10 +261,10 @@ depends-on = ["configure-itk-wasm"]
 description = "Build ITK-Wasm"
 
 [feature.native.tasks.configure-native]
-cmd = '''cmake -B$ITK_WASM_NATIVE_WORKSPACE/${project.name}-build -S. -GNinja
-  -DITK_DIR:PATH=$ITK_WASM_ITK_BUILD_DIR
-  -DBUILD_TESTING:BOOL=ON
-  -DCMAKE_CXX_STANDARD:STRING=20
+cmd = '''cmake -B$ITK_WASM_NATIVE_WORKSPACE/${project.name}-build -S. -GNinja \\
+  -DITK_DIR:PATH=$ITK_WASM_ITK_BUILD_DIR \\
+  -DBUILD_TESTING:BOOL=ON \\
+  -DCMAKE_CXX_STANDARD:STRING=20 \\
   -DCMAKE_BUILD_TYPE:STRING=Debug'''
 depends-on = ["build-itk-wasm"]
 description = "Configure native build"

packages/core/typescript/create-itk-wasm/src/test-pixi-toml.ts

@@ -0,0 +1,102 @@
+// Regression test for the generated pixi.toml task commands.
+//
+// Recent pixi (>= 0.70) parses multi-line `cmd` strings with deno_task_shell,
+// where a bare newline terminates a command. A multi-line `cmd` must therefore
+// continue each line explicitly (e.g. with a trailing `\` or `&&`); otherwise
+// the trailing lines run as separate, bogus commands and the task fails with
+// "command not found" (exit code 127). See the `configure-itk*` cmake tasks.
+//
+// This test generates a pixi.toml with the real generator and asserts that no
+// multi-line command relies on a bare newline as a separator.
+
+import assert from 'node:assert/strict'
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+
+import generatePixiToml from './generate/pixi-toml.js'
+import type ProjectSpec from './project-spec.js'
+
+// Shell tokens that legitimately continue a command onto the next line.
+const CONTINUATIONS = ['\\', '&&', '||', '|', '&']
+
+function endsWithContinuation(line: string): boolean {
+  const trimmed = line.trimEnd()
+  return CONTINUATIONS.some((token) => trimmed.endsWith(token))
+}
+
+function generateSampleToml(): string {
+  const directory = fs.mkdtempSync(
+    path.join(os.tmpdir(), 'create-itk-wasm-test-')
+  )
+  try {
+    const project: ProjectSpec = {
+      name: 'test-pipeline',
+      directory,
+      packageDescription: 'A test pipeline',
+      author: 'Test Author',
+      repositoryUrl: 'https://example.com/repo'
+    }
+    generatePixiToml(project)
+    return fs.readFileSync(path.join(directory, 'pixi.toml'), 'utf8')
+  } finally {
+    fs.rmSync(directory, { recursive: true, force: true })
+  }
+}
+
+function run(): void {
+  const toml = generateSampleToml()
+
+  // Every triple-quoted (multi-line) command in the manifest.
+  const multilineCmd = /cmd = '''([\s\S]*?)'''/g
+  const blocks = [...toml.matchAll(multilineCmd)].map((match) => match[1])
+
+  assert.ok(
+    blocks.length > 0,
+    'Expected the generated pixi.toml to contain multi-line commands; the test fixture may be stale.'
+  )
+
+  const offenders: string[] = []
+  for (const block of blocks) {
+    const lines = block.split('\n')
+    // Every line except the last must continue onto the next one.
+    lines.slice(0, -1).forEach((line) => {
+      if (line.trim() !== '' && !endsWithContinuation(line)) {
+        offenders.push(line.trim())
+      }
+    })
+  }
+
+  assert.deepEqual(
+    offenders,
+    [],
+    `Generated pixi.toml has multi-line cmd line(s) without a continuation token ` +
+      `(${CONTINUATIONS.join(' ')}); pixi >= 0.70 would run these as separate commands:\n` +
+      offenders.map((line) => `  - ${line}`).join('\n')
+  )
+
+  // Sanity check: the cmake configure tasks that originally regressed are
+  // present and use backslash continuation on their opening line.
+  for (const task of [
+    'configure-itk',
+    'configure-itk-wasm',
+    'configure-native'
+  ]) {
+    const header = `[feature.native.tasks.${task}]`
+    assert.ok(
+      toml.includes(header),
+      `Expected generated pixi.toml to define ${header}`
+    )
+  }
+  assert.match(
+    toml,
+    /cmd = '''cmake -B\$ITK_WASM_ITK_BUILD_DIR -S\$ITK_WASM_ITK_SOURCE_DIR -GNinja \\\n/,
+    'Expected configure-itk to continue its first line with a trailing backslash'
+  )
+
+  console.log(
+    `pixi.toml generation test passed (${blocks.length} multi-line commands checked).`
+  )
+}
+
+run()