scripts/rust/pack-cli.test.mjs

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import assert from 'node:assert/strict';
import { execFileSync } from 'node:child_process';
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import test from 'node:test';
import { packNativeCli } from './pack-cli.mjs';

test('native archives carry the CLI and authored desktop app without a terminal sidecar', async () => {
  const root = await mkdtemp(join(tmpdir(), 'maka-shell-package-'));
  const previous = process.cwd();
  try {
    const app = join(root, 'products/maka/desktop-shell/app');
    await mkdir(join(app, 'icons'), { recursive: true });
    await writeFile(
      join(app, 'gpui-shell.json'),
      '{"id":"org.apache.maka.desktop","name":"Maka","version":"0.1.0","entry":"main.js"}',
    );
    const png = Buffer.alloc(33);
    Buffer.from('\x89PNG\r\n\x1a\n', 'latin1').copy(png);
    png.write('IHDR', 12, 'latin1');
    png.writeUInt32BE(1024, 16);
    png.writeUInt32BE(1024, 20);
    await mkdir(join(root, 'assets'));
    await writeFile(join(root, 'assets/logo.png'), png);
    await writeFile(join(app, 'main.js'), 'authored source application');
    await writeFile(join(app, 'icons/logo.svg'), '<svg>source icon</svg>');
    await mkdir(join(root, 'packages/cli'), { recursive: true });
    for (const name of ['LICENSE', 'NOTICE', 'THIRD_PARTY_NOTICES.txt'])
      await writeFile(join(root, name), 'reviewed ' + name);
    for (const name of ['README.md', 'README.zh-CN.md'])
      await writeFile(join(root, 'packages/cli', name), 'package documentation');
    await mkdir(join(root, 'build/app'), { recursive: true });
    await writeFile(join(root, 'build/app/main.js'), 'stale generated application');
    await writeFile(join(root, 'build/app/stale.js'), 'must not ship');
    for (const name of [
      'maka',
      'maka.exe',
      'maka-desktop-shell',
      'maka-desktop-shell.exe',
      'maka-service.exe',
      'maka-python-worker',
      'maka-python-worker.exe',
    ])
      await writeFile(join(root, 'build', name), name + ' bytes');
    // Exercise the actual external validator call without executing foreign-target
    // stub bytes. Distribution's real archive/PE parser has its own Rust tests.
    await writeFile(
      join(root, 'host'),
      String.raw`
      const assert = require('node:assert/strict');
      const { execFileSync } = require('node:child_process');
      const args = process.argv.slice(2);
      assert.equal(args[0], 'fetch');
      const value = (name) => args[args.indexOf(name) + 1];
      const archive = value('--archive');
      const files = execFileSync('tar', ['-tzf', archive], {encoding:'utf8'}).trim().split('\n');
      const windows = value('--target') === 'win32-x64';
      assert.ok(!files.includes('package/bin/maka-terminal-shell'));
      assert.ok(!files.includes('package/bin/maka-terminal-shell.exe'));
      const macos = value('--target') === 'darwin-arm64';
      const bundle = 'package/bin/Maka.app/Contents/';
      const app = macos ? bundle + 'Resources/app/' : 'package/bin/app/';
      const shell = macos ? bundle + 'MacOS/maka-desktop-shell' : 'package/bin/' + (windows ? 'maka-desktop-shell.exe' : 'maka-desktop-shell');
      assert.equal(execFileSync('tar', ['-xOf', archive, shell], {encoding:'utf8'}), shell.split('/').pop() + ' bytes');
      if (process.platform !== 'win32') assert.match(execFileSync('tar', ['-tvzf', archive, shell], {encoding:'utf8'}), /^-rwx/);
      assert.equal(files.includes('package/bin/maka-service.exe'), windows);
      assert.ok(files.includes('package/bin/' + (windows ? 'maka-python-worker.exe' : 'maka-python-worker')));
      assert.equal(files.some((file) => file.startsWith('package/bin/Maka.app/')), macos);
      assert.equal(files.some((file) => file.startsWith('package/bin/app/')), !macos);
      assert.equal(files.includes('package/bin/maka-desktop-shell'), !macos && !windows);
      assert.ok(!files.includes('package/bin/maka-desktop'));
      assert.ok(!files.includes(app + 'stale.js'));
      assert.equal(execFileSync('tar', ['-xOf', archive, app + 'main.js'], {encoding:'utf8'}), 'authored source application');
      assert.equal(execFileSync('tar', ['-xOf', archive, app + 'icons/logo.svg'], {encoding:'utf8'}), '<svg>source icon</svg>');
      if (macos) {
        assert.match(execFileSync('tar', ['-xOf', archive, bundle + 'Info.plist'], {encoding:'utf8'}), /<key>CFBundleIdentifier<\/key>\n  <string>org.apache.maka.desktop<\/string>/);
        assert.equal(execFileSync('tar', ['-xOf', archive, bundle + 'Resources/Maka.icns']).subarray(0, 4).toString(), 'icns');
      }
      assert.equal(execFileSync('tar', ['-xOf', archive, 'package/THIRD_PARTY_NOTICES.txt'], {encoding:'utf8'}), 'reviewed THIRD_PARTY_NOTICES.txt');
    `,
    );
    process.chdir(root);
    for (const target of ['darwin-arm64', 'linux-x64-gnu', 'win32-x64']) {
      const result = await packNativeCli({
        target,
        version: '0.2.0-rust-preview.fixture',
        binary: join(root, 'build', target === 'win32-x64' ? 'maka.exe' : 'maka'),
        notices: join(root, 'THIRD_PARTY_NOTICES.txt'),
        validator: process.execPath,
        output: join(root, 'output'),
        repositoryRoot: root,
      });
      const receipt = JSON.parse(await readFile(join(root, 'output', target + '.json'), 'utf8'));
      assert.equal(receipt.integrity, result.integrity);
      const main = execFileSync('tar', [
        '-xOf',
        result.archive,
        target === 'darwin-arm64'
          ? 'package/bin/Maka.app/Contents/Resources/app/main.js'
          : 'package/bin/app/main.js',
      ]);
      assert.equal(main.toString(), 'authored source application');
    }
  } finally {
    process.chdir(previous);
    await rm(root, { recursive: true, force: true });
  }
});