sencho/backend/src/__tests__/self-update-compose.test.ts

/**
 * Pure-unit coverage for the compose image handling that powers pinned
 * self-update (GitHub issue: a version-pinned compose image could never update
 * because recreate reused the running image). Split across the pure helper
 * module and the three self-update argv builders that carry the repin handoff:
 *   - classifyImagePin / buildTargetImageRef / isValidImageRef,
 *   - resolveServiceImageFromContents (reverse -f precedence),
 *   - patchComposeServiceImage (comment-preserving round-trip),
 *   - buildComposeReadArgs (throwaway cat container),
 *   - the composeCopy branch of buildSelfUpdateComposeCmd,
 *   - the repinWritable branch of buildSelfUpdateRunArgs.
 */
import { describe, expect, it } from 'vitest';
import {
  classifyImagePin,
  buildTargetImageRef,
  isRepinBlocked,
  isValidImageRef,
  resolveServiceImageFromContents,
  patchComposeServiceImage,
} from '../helpers/selfUpdateCompose';
import {
  buildComposeReadArgs,
  buildSelfUpdateComposeCmd,
  buildSelfUpdateRunArgs,
  shQuote,
} from '../services/SelfUpdateService';

describe('isRepinBlocked', () => {
  it('blocks digest and unknown pins only', () => {
    expect(isRepinBlocked('digest')).toBe(true);
    expect(isRepinBlocked('unknown')).toBe(true);
    expect(isRepinBlocked('semver')).toBe(false);
    expect(isRepinBlocked('floating')).toBe(false);
  });
});

describe('classifyImagePin', () => {
  it('classifies an explicit semver tag (with and without v prefix) as semver', () => {
    expect(classifyImagePin('saelix/sencho:0.93.3')).toBe('semver');
    expect(classifyImagePin('saelix/sencho:v1.2.3')).toBe('semver');
    expect(classifyImagePin('ghcr.io/studio-saelix/sencho:1.0.0-rc.1')).toBe('semver');
  });

  it('classifies latest, implicit, and other moving tags as floating', () => {
    expect(classifyImagePin('saelix/sencho:latest')).toBe('floating');
    expect(classifyImagePin('saelix/sencho')).toBe('floating'); // implicit latest
    expect(classifyImagePin('saelix/sencho:dev')).toBe('floating');
    expect(classifyImagePin('saelix/sencho:edge')).toBe('floating');
  });

  it('does not mistake a registry port for a tag', () => {
    // The colon before the last slash is a registry port, not a tag separator,
    // so an untagged image on a custom-port registry is floating, not semver.
    expect(classifyImagePin('registry.example.com:5000/sencho')).toBe('floating');
    expect(classifyImagePin('registry.example.com:5000/sencho:0.93.3')).toBe('semver');
  });

  it('classifies a digest pin as digest', () => {
    expect(classifyImagePin('saelix/sencho@sha256:abc123')).toBe('digest');
    expect(classifyImagePin('saelix/sencho:0.93.3@sha256:abc123')).toBe('digest');
  });

  it('classifies interpolated, empty, or blank references as unknown', () => {
    expect(classifyImagePin('saelix/sencho:${SENCHO_TAG}')).toBe('unknown');
    expect(classifyImagePin('${SENCHO_IMAGE}')).toBe('unknown');
    expect(classifyImagePin('')).toBe('unknown');
    expect(classifyImagePin('   ')).toBe('unknown');
  });
});

describe('buildTargetImageRef', () => {
  it('swaps only the tag and keeps the registry and repository', () => {
    expect(buildTargetImageRef('saelix/sencho:0.93.3', '0.94.0')).toBe('saelix/sencho:0.94.0');
    expect(buildTargetImageRef('ghcr.io/studio-saelix/sencho:1.0.0', '1.1.0')).toBe(
      'ghcr.io/studio-saelix/sencho:1.1.0',
    );
  });

  it('preserves a v prefix on the current tag', () => {
    expect(buildTargetImageRef('saelix/sencho:v0.93.3', '0.94.0')).toBe('saelix/sencho:v0.94.0');
  });

  it('preserves a -dev repository variant (only the tag is replaced)', () => {
    expect(buildTargetImageRef('ghcr.io/studio-saelix/sencho-dev:0.93.3', '0.94.0')).toBe(
      'ghcr.io/studio-saelix/sencho-dev:0.94.0',
    );
  });

  it('drops any digest suffix on the current ref', () => {
    expect(buildTargetImageRef('saelix/sencho:0.93.3@sha256:abc123', '0.94.0')).toBe(
      'saelix/sencho:0.94.0',
    );
  });

  it('adds a tag when the current ref has none', () => {
    expect(buildTargetImageRef('saelix/sencho', '0.94.0')).toBe('saelix/sencho:0.94.0');
    expect(buildTargetImageRef('registry.example.com:5000/sencho', '0.94.0')).toBe(
      'registry.example.com:5000/sencho:0.94.0',
    );
  });
});

describe('isValidImageRef', () => {
  it('accepts plausible registry/repo:tag and digest references', () => {
    expect(isValidImageRef('saelix/sencho:0.93.3')).toBe(true);
    expect(isValidImageRef('ghcr.io/studio-saelix/sencho-dev:v1.2.3')).toBe(true);
    expect(isValidImageRef('registry.example.com:5000/sencho@sha256:abc')).toBe(true);
  });

  it('rejects empty, whitespace, and control-character references', () => {
    expect(isValidImageRef('')).toBe(false);
    expect(isValidImageRef('saelix/sencho :0.93.3')).toBe(false);
    expect(isValidImageRef('saelix/sencho\n')).toBe(false);
  });

  it('rejects references with shell metacharacters or a leading separator', () => {
    expect(isValidImageRef('saelix/sencho;rm -rf /')).toBe(false);
    expect(isValidImageRef('$(touch pwned)')).toBe(false);
    expect(isValidImageRef(':leadingcolon')).toBe(false);
  });

  it('rejects an implausibly long reference', () => {
    expect(isValidImageRef('a'.repeat(513))).toBe(false);
  });
});

describe('resolveServiceImageFromContents', () => {
  const base = 'services:\n  sencho:\n    image: saelix/sencho:0.93.3\n';

  it('returns the service image and classifies its pin', () => {
    const resolved = resolveServiceImageFromContents([{ filePath: '/c/base.yml', content: base }], 'sencho');
    expect(resolved).toEqual({
      filePath: '/c/base.yml',
      imageRef: 'saelix/sencho:0.93.3',
      fileContent: base,
      pinKind: 'semver',
    });
  });

  it('lets a later -f override win (reverse precedence)', () => {
    // Docker Compose merges later -f files over earlier ones, so the resolver
    // must scan in reverse and return the highest-precedence declaration.
    const override = 'services:\n  sencho:\n    image: saelix/sencho:latest\n';
    const resolved = resolveServiceImageFromContents(
      [
        { filePath: '/c/base.yml', content: base },
        { filePath: '/c/override.yml', content: override },
      ],
      'sencho',
    );
    expect(resolved?.filePath).toBe('/c/override.yml');
    expect(resolved?.imageRef).toBe('saelix/sencho:latest');
    expect(resolved?.pinKind).toBe('floating');
  });

  it('falls back to the base file when the override does not set the image', () => {
    // A common override only tweaks ports/env; it must not shadow the base image.
    const override = 'services:\n  sencho:\n    ports:\n      - "1852:1852"\n';
    const resolved = resolveServiceImageFromContents(
      [
        { filePath: '/c/base.yml', content: base },
        { filePath: '/c/override.yml', content: override },
      ],
      'sencho',
    );
    expect(resolved?.filePath).toBe('/c/base.yml');
    expect(resolved?.imageRef).toBe('saelix/sencho:0.93.3');
  });

  it('skips a malformed override and resolves from the next readable file', () => {
    const malformed = 'services:\n  sencho:\n  image: : : bad';
    const resolved = resolveServiceImageFromContents(
      [
        { filePath: '/c/base.yml', content: base },
        { filePath: '/c/broken.yml', content: malformed },
      ],
      'sencho',
    );
    expect(resolved?.filePath).toBe('/c/base.yml');
  });

  it('returns null when no file declares a string image for the service', () => {
    const noImage = 'services:\n  sencho:\n    build: .\n';
    expect(resolveServiceImageFromContents([{ filePath: '/c/x.yml', content: noImage }], 'sencho')).toBeNull();
    expect(resolveServiceImageFromContents([{ filePath: '/c/x.yml', content: base }], 'other')).toBeNull();
  });
});

describe('patchComposeServiceImage', () => {
  it('rewrites only the target service image and preserves comments and other keys', () => {
    const content = [
      '# Sencho self-hosted',
      'services:',
      '  sencho:',
      '    image: saelix/sencho:0.93.3 # pinned',
      '    ports:',
      '      - "1852:1852"',
      '  db:',
      '    image: postgres:16',
      '',
    ].join('\n');
    const patched = patchComposeServiceImage(content, 'sencho', 'saelix/sencho:0.94.0');
    expect(patched).toContain('image: saelix/sencho:0.94.0');
    expect(patched).not.toContain('saelix/sencho:0.93.3');
    // Comments, sibling service, and unrelated keys survive the round-trip.
    expect(patched).toContain('# Sencho self-hosted');
    expect(patched).toContain('image: postgres:16');
    expect(patched).toContain('- "1852:1852"');
  });

  it('throws when the service has no image to patch (never silently no-ops)', () => {
    const content = 'services:\n  sencho:\n    build: .\n';
    expect(() => patchComposeServiceImage(content, 'sencho', 'saelix/sencho:0.94.0')).toThrow(/no image/i);
  });
});

describe('buildComposeReadArgs', () => {
  it('emits a throwaway root cat container that mounts the working dir read-only', () => {
    const args = buildComposeReadArgs('/opt/sencho', 'saelix/sencho:0.93.3', '/opt/sencho/docker-compose.yml');
    expect(args).toEqual([
      'run', '--rm',
      '--user', 'root',
      '--entrypoint', 'cat',
      '-v', '/opt/sencho:/opt/sencho:ro',
      '-w', '/opt/sencho',
      'saelix/sencho:0.93.3',
      '/opt/sencho/docker-compose.yml',
    ]);
  });

  it('keeps operator paths as discrete argv data (execFile spawns no shell)', () => {
    const args = buildComposeReadArgs('/srv/$(touch pwned)', 'img', '/srv/$(touch pwned)/compose.yml');
    expect(args).toContain('/srv/$(touch pwned):/srv/$(touch pwned):ro');
    expect(args[args.length - 1]).toBe('/srv/$(touch pwned)/compose.yml');
  });
});

describe('buildSelfUpdateComposeCmd (repin copy branch)', () => {
  const fFlags = ['-f', '/opt/sencho/docker-compose.yml'];
  const stderrTmp = '/tmp/_sencho_err';
  const errorFile = '/app/data/.sencho-update-error';

  it('copies the staged compose file onto the host before recreate', () => {
    const cmd = buildSelfUpdateComposeCmd(fFlags, 'sencho', stderrTmp, errorFile, false, {
      stagedPath: '/app/data/.sencho-compose-patch',
      targetPath: '/opt/sencho/docker-compose.yml',
    });
    // The copy runs before the recreate so a failed write never half-applies.
    expect(cmd.indexOf('cp ')).toBeLessThan(cmd.indexOf('up -d --force-recreate'));
    expect(cmd).toContain(
      `cp ${shQuote('/app/data/.sencho-compose-patch')} ${shQuote('/opt/sencho/docker-compose.yml')}`,
    );
  });

  it('aborts before recreate when the copy fails and records the error', () => {
    const cmd = buildSelfUpdateComposeCmd(fFlags, 'sencho', stderrTmp, errorFile, false, {
      stagedPath: '/app/data/.sencho-compose-patch',
      targetPath: '/opt/sencho/docker-compose.yml',
    });
    // A failed copy writes the error file and exits 1 before any recreate.
    expect(cmd).toContain('exit 1');
    expect(cmd.indexOf('exit 1')).toBeLessThan(cmd.indexOf('up -d --force-recreate'));
    expect(cmd).toContain('Failed to write the updated compose file');
  });

  it('shell-quotes the copy paths so metacharacters cannot break the command', () => {
    const cmd = buildSelfUpdateComposeCmd(fFlags, 'sencho', stderrTmp, errorFile, false, {
      stagedPath: '/app/data/x; rm -rf /',
      targetPath: '/opt/sencho/y; echo pwned',
    });
    expect(cmd).toContain(shQuote('/app/data/x; rm -rf /'));
    expect(cmd).toContain(shQuote('/opt/sencho/y; echo pwned'));
    expect(cmd).not.toContain('cp /app/data/x; rm -rf /');
  });

  it('omits the copy step entirely when no composeCopy is supplied', () => {
    const cmd = buildSelfUpdateComposeCmd(fFlags, 'sencho', stderrTmp, errorFile, false);
    expect(cmd).not.toContain('cp ');
    expect(cmd).not.toContain('Failed to write the updated compose file');
  });
});

describe('buildSelfUpdateRunArgs (repinWritable branch)', () => {
  const COMPOSE = 'COMPOSE_CMD';

  it('mounts the working dir read-write only when a repin is staged', () => {
    const args = buildSelfUpdateRunArgs(
      { workingDir: '/opt/sencho', imageName: 'img', dataDirHost: '/opt/sencho/data', hostBindMounts: [], repinWritable: true },
      COMPOSE,
    );
    expect(args).toContain('/opt/sencho:/opt/sencho:rw');
    expect(args).not.toContain('/opt/sencho:/opt/sencho:ro');
  });

  it('keeps the working dir read-only when no repin is staged (minimal write scope)', () => {
    const args = buildSelfUpdateRunArgs(
      { workingDir: '/opt/sencho', imageName: 'img', dataDirHost: '/opt/sencho/data', hostBindMounts: [], repinWritable: false },
      COMPOSE,
    );
    expect(args).toContain('/opt/sencho:/opt/sencho:ro');
    expect(args).not.toContain('/opt/sencho:/opt/sencho:rw');
  });
});