git-workspace-bare 0.1.1 → 0.3.1

package/test/completion.js

@@ -0,0 +1,180 @@
+import test from 'brittle'
+import fs from 'bare-fs'
+import os from 'bare-os'
+import path from 'bare-path'
+import setup from './helpers.js'
+
+test('completion works before init and only offers flags accepted at that position', (t) => {
+  const { cli, ok } = setup(t, { initialize: false })
+  t.is(ok('--complete', ''), 'add\ncompletion\nhook\ninit\nlist\npull\nremove\nrename\nstatus\n')
+  t.is(ok('--complete', 're'), 'remove\nrename\n')
+  t.is(ok('--complete', '--'), '--help\n--version\n')
+  t.is(ok('--complete', 'remove', '-'), '--help\n--no-hooks\n-h\n')
+  t.is(ok('--complete', 'pull', '--'), '--dry-run\n--help\n--no-hooks\n')
+  t.is(ok('--complete', 'hook', ''), 'list\n')
+  t.is(ok('--complete', 'hook', 'list', ''), '')
+  t.is(ok('--complete', 'pull', '--dry-run', '-h'), '-h\n')
+  t.is(ok('--complete', 'completion', ''), 'bash\n')
+  t.is(ok('--complete', 'completion', 'ba'), 'bash\n')
+  for (const words of [
+    ['remove', ''],
+    ['add', ''],
+    ['init', ''],
+    ['list', ''],
+    ['status', ''],
+    ['unknown', ''],
+    ['remove', '--help', ''],
+    ['--version', ''],
+    ['add', '--', '-'],
+    ['completion', 'bash', '']
+  ]) {
+    t.alike(cli('--complete', ...words), { status: 0, stdout: '', stderr: '' }, words.join(' '))
+  }
+  t.is(cli('completion', 'zsh').status, 1, 'unsupported shell explained')
+  t.ok(cli('completion', 'zsh').stderr.includes('Supported completion shell: bash'))
+  t.absent(ok('-h').includes('--complete'), 'internal protocol hidden from help')
+})
+
+test('completion reads registered names, including missing checkouts, without changing state', (t) => {
+  const { cli, ok, git, registry, root, home } = setup(t)
+  ok('add', 'owner/repo@feature/jobs')
+  fs.writeFileSync(path.join(root, 'tracked.txt'), 'local changes\n')
+  git('-C', root, 'add', 'tracked.txt')
+  const contents = fs.readFileSync(registry, 'utf8')
+  const config = fs.readFileSync(path.join(home, '.config/git-workspace/config.json'), 'utf8')
+  const index = fs.readFileSync(path.join(root, '.git/index'))
+  const directory = path.dirname(registry)
+  const head = git('-C', directory, 'rev-parse', 'HEAD')
+  const applied = git('-C', directory, 'rev-parse', 'refs/git-workspace/applied')
+  t.is(ok('--complete', 'remove', ''), 'owner/repo\nowner/repo@feature/jobs\n')
+  t.is(ok('--complete', 'rename', 'owner/repo@fea'), 'owner/repo@feature/jobs\n')
+  t.is(ok('--complete', 'add', 'owner/'), 'owner/repo\n')
+  t.is(ok('--complete', 'rename', 'owner/repo@feature/jobs', ''), 'owner/repo@\n')
+  t.is(ok('--complete', 'rename', 'owner/repo@feature/jobs', 'owner/repo@n'), '')
+  t.is(ok('--complete', 'rename', 'owner/repo', ''), '', 'root target is free-form')
+  t.is(ok('--complete', 'remove', 'owner/repo', ''), '', 'no extra arguments suggested')
+  t.is(ok('--complete', 'remove', 'owner/repo', '-h'), '-h\n')
+  t.is(fs.readFileSync(registry, 'utf8'), contents)
+  t.is(fs.readFileSync(path.join(home, '.config/git-workspace/config.json'), 'utf8'), config)
+  t.alike(fs.readFileSync(path.join(root, '.git/index')), index)
+  t.is(fs.readFileSync(path.join(root, 'tracked.txt'), 'utf8'), 'local changes\n')
+  t.is(git('-C', directory, 'rev-parse', 'HEAD'), head)
+  t.is(git('-C', directory, 'rev-parse', 'refs/git-workspace/applied'), applied)
+  fs.renameSync(root + '@feature', root + '@saved')
+  t.is(ok('--complete', 'remove', 'owner/repo@'), 'owner/repo@feature/jobs\n')
+  fs.writeFileSync(registry, '{invalid')
+  t.alike(cli('--complete', 'remove', ''), { status: 0, stdout: '', stderr: '' })
+  t.is(
+    ok('--complete', 'remove', '-'),
+    '--help\n--no-hooks\n-h\n',
+    'flags still work with invalid manifest'
+  )
+})
+
+test('add completes local and cached origin branches without fetching or accepting unsupported names', (t) => {
+  const { cli, ok, git, root } = setup(t)
+  ok('add', 'owner/repo')
+  const head = git('-C', root, 'rev-parse', 'HEAD')
+  git('-C', root, 'branch', 'feature/local')
+  git('-C', root, 'branch', 'feature/duplicate')
+  git('-C', root, 'branch', 'unsupported+name')
+  git('-C', root, 'update-ref', 'refs/remotes/origin/feature/remote', head)
+  git('-C', root, 'update-ref', 'refs/remotes/origin/feature/duplicate', head)
+  git('-C', root, 'update-ref', 'refs/remotes/other/feature/foreign', head)
+  git('-C', root, 'tag', 'feature/tag')
+  t.is(
+    ok('--complete', 'add', 'owner/repo@fea'),
+    'owner/repo@feature/duplicate\nowner/repo@feature/local\nowner/repo@feature/remote\n'
+  )
+  t.is(
+    ok('--complete', 'add', 'owner/repo@'),
+    'owner/repo@feature/duplicate\nowner/repo@feature/local\nowner/repo@feature/remote\nowner/repo@main\n',
+    'origin HEAD excluded and local/remote duplicates combined'
+  )
+  t.is(ok('--complete', 'add', 'owner/repo@feature/l'), 'owner/repo@feature/local\n')
+  t.is(ok('--complete', 'add', 'other/repo@'), '')
+  t.absent(fs.existsSync(path.join(root, '.git/FETCH_HEAD')), 'no fetch performed')
+  fs.renameSync(root, root + '-saved')
+  t.alike(cli('--complete', 'add', 'owner/repo@'), { status: 0, stdout: '', stderr: '' })
+})
+
+function shellCompletion(t, context) {
+  const { run, home } = context
+  // A PATH containing spaces also verifies installation paths are quoted.
+  const bin = path.join(home, 'completion bin')
+  fs.mkdirSync(bin)
+  const runner = fs.realpathSync(new URL('./fixtures/cli.js', import.meta.url))
+  const fixture = fs.realpathSync(new URL('./fixtures/completion.bash', import.meta.url))
+  const quote = (value) => "'" + value.replaceAll("'", "'\\''") + "'"
+  const shim = path.join(bin, 'git-workspace')
+  fs.writeFileSync(
+    shim,
+    `#!/bin/sh\nexec ${quote(os.execPath())} ${quote(runner)} ${quote(home)} "$@"\n`
+  )
+  fs.chmodSync(shim, 0o755)
+  return (words, gitCompletion = '') => {
+    const result = run('bash', ['--noprofile', '--norc', fixture, bin, gitCompletion, ...words])
+    t.is(result.status, 0, result.stderr || 'Bash completion succeeded')
+    t.is(result.stderr, '', 'completion is quiet')
+    return result.stdout
+  }
+}
+
+test('generated Bash completion works standalone, preserves branch prefixes, and supports Bash 3.2', (t) => {
+  const context = setup(t)
+  const { ok, root, git } = context
+  ok('add', 'owner/repo@feature/jobs')
+  git('-C', root, 'branch', 'feature/new')
+  const complete = shellCompletion(t, context)
+  t.is(complete(['git-workspace', 're']), 'remove \nrename \n')
+  t.is(complete(['git-workspace', 'add', 'owner/r']), 'owner/repo\n', 'root has no trailing space')
+  t.is(complete(['git-workspace', 'remove', 'owner/repo@fea']), 'owner/repo@feature/jobs \n')
+  t.is(complete(['git-workspace', 'add', 'owner/repo@feature/n']), 'owner/repo@feature/new \n')
+  t.is(complete(['git-workspace', 'rename', 'owner/repo@feature/jobs', '']), 'owner/repo@\n')
+  t.is(complete(['git-workspace', 'completion', '']), 'bash \n')
+})
+
+test('Bash integrates with real Git completion, including Git global options', (t) => {
+  const context = setup(t)
+  const { git, ok, root } = context
+  const exec = git('--exec-path')
+  const gitCompletion = [
+    path.resolve(exec, '../../share/git-core/git-completion.bash'),
+    path.resolve(exec, '../../share/bash-completion/completions/git'),
+    '/usr/share/bash-completion/completions/git',
+    '/usr/share/git-core/git-completion.bash'
+  ].find((file) => fs.existsSync(file))
+  if (!gitCompletion) {
+    t.comment('Git Bash completion is not installed; standalone adapter is tested separately')
+    return
+  }
+  ok('add', 'owner/repo@feature/jobs')
+  git('-C', root, 'branch', 'feature/new')
+  const complete = shellCompletion(t, context)
+  t.is(complete(['git', 'workspace', 're'], gitCompletion), 'remove \nrename \n')
+  t.is(
+    complete(['git', 'workspace', 'add', 'owner/r'], gitCompletion),
+    'owner/repo\n',
+    'root has no trailing space'
+  )
+  t.is(
+    complete(['git', 'workspace', 'remove', 'owner/repo@fea'], gitCompletion),
+    'owner/repo@feature/jobs \n'
+  )
+  t.is(
+    complete(['git', '-C', '/', 'workspace', 'add', 'owner/repo@feature/n'], gitCompletion),
+    'owner/repo@feature/new \n'
+  )
+  t.is(
+    complete(
+      ['git', '-c', 'color.ui=false', 'workspace', 'rename', 'owner/repo@feature/jobs', ''],
+      gitCompletion
+    ),
+    'owner/repo@\n'
+  )
+  t.ok(
+    complete(['git', 'sta'], gitCompletion).includes('status'),
+    'standard Git completion preserved'
+  )
+  t.ok(complete(['git', 'work'], gitCompletion).includes('workspace'), 'Git discovers the command')
+})

package/test/fixtures/checkpoint.js

@@ -0,0 +1,14 @@
+import os from 'bare-os'
+import process from 'bare-process'
+
+const home = Bare.argv.splice(2, 1)[0]
+os.homedir = () => home
+const { default: checkpoint, readCheckpoint } = await import('../../lib/checkpoint.js')
+try {
+  console.log(
+    Bare.argv.includes('--show') ? readCheckpoint() || 'No applied checkpoint' : checkpoint()
+  )
+} catch (err) {
+  console.error(err.message)
+  process.exitCode = 1
+}

package/test/fixtures/completion.bash

@@ -0,0 +1,28 @@
+# Drive the same completion functions that Bash invokes on Tab.
+completion_bin=$1
+git_completion=$2
+shift 2
+export PATH="$completion_bin:$PATH"
+
+if [ -n "$git_completion" ]; then
+    source "$git_completion" || exit 1
+    git_before=$(complete -p git)
+fi
+completion_script=$(command git-workspace completion bash) || exit 1
+eval "$completion_script" || exit 1
+
+COMP_WORDS=("$@")
+COMP_CWORD=$(( ${#COMP_WORDS[@]} - 1 ))
+COMP_LINE="${COMP_WORDS[*]}"
+COMP_POINT=${#COMP_LINE}
+COMP_TYPE=9
+COMPREPLY=()
+if [ "${COMP_WORDS[0]}" = git ]; then
+    [ "$(complete -p git)" = "$git_before" ] || exit 1
+    __git_func_wrap __git_main
+else
+    _git_workspace_direct
+fi
+for candidate in "${COMPREPLY[@]}"; do
+    printf '%s\n' "$candidate"
+done

package/test/helpers.js

@@ -15,19 +15,58 @@ export default function setup(t, { initialize = true } = {}) {
   fs.mkdirSync(path.join(temporary, 'hooks'))
   fs.writeFileSync(config, '')
 
+  // A private PATH prevents tests from running hooks installed on the developer's machine.
+  const bin = path.join(temporary, 'bin')
+  fs.mkdirSync(bin)
+  const gitPath = spawnSync('which', ['git']).stdout.toString().trim()
+  fs.symlinkSync(gitPath, path.join(bin, 'git'))
+  fs.symlinkSync(os.execPath(), path.join(bin, 'bare'))
+  for (const name of [
+    'bash',
+    'sh',
+    'env',
+    'which',
+    'cat',
+    'dirname',
+    'basename',
+    'sed',
+    'tr',
+    'sort',
+    'cut',
+    'grep',
+    'head',
+    'mkdir',
+    'rm',
+    'uname',
+    'pwd',
+    'perl',
+    'sleep',
+    'touch',
+    'wc',
+    'awk',
+    'ln'
+  ]) {
+    const executable = ['/bin', '/usr/bin']
+      .map((directory) => path.join(directory, name))
+      .find((file) => fs.existsSync(file))
+    if (executable) fs.symlinkSync(executable, path.join(bin, name))
+  }
+
   const env = { ...process.env }
   for (const key of Object.keys(env)) {
     if (key.startsWith('GIT_')) delete env[key]
   }
   Object.assign(env, {
+    PATH: bin,
+    GIT_WORKSPACE_HOOK: '',
     GIT_CONFIG_NOSYSTEM: '1',
     GIT_CONFIG_GLOBAL: config,
     GIT_ALLOW_PROTOCOL: 'file',
     GIT_TERMINAL_PROMPT: '0'
   })
 
-  function run(file, args) {
-    const result = spawnSync(file, args, { cwd: temporary, env })
+  function run(file, args, { env: overrides = {} } = {}) {
+    const result = spawnSync(file, args, { cwd: temporary, env: { ...env, ...overrides } })
     if (result.error) throw result.error
     return {
       status: result.status,
@@ -68,11 +107,30 @@ export default function setup(t, { initialize = true } = {}) {
     return result.stdout
   }
 
+  const checkpointRunner = fs.realpathSync(new URL('./fixtures/checkpoint.js', import.meta.url))
+  function checkAt(directory, ...args) {
+    return run(os.execPath(), [checkpointRunner, directory, ...args])
+  }
+  function check(...args) {
+    return checkAt(home, ...args)
+  }
+  function checked(...args) {
+    const result = check(...args)
+    if (result.status !== 0) throw new Error(result.stderr)
+    return result.stdout
+  }
+
   if (initialize) ok('init', 'owner/workspace')
 
   return {
+    bin,
+    env,
+    run,
     cli,
     cliAt,
+    check,
+    checkAt,
+    checked,
     ok,
     git,
     home,