pnpm/packages/plugin-commands-setup/test/setup.test.ts

import fs from 'fs'
import path from 'path'

import { homedir } from 'os'
import { tempDir } from '@pnpm/prepare'
import { setup } from '@pnpm/plugin-commands-setup'

jest.mock('os', () => {
  const os = jest.requireActual('os')
  return {
    ...os,
    homedir: jest.fn(),
  }
})

let homeDir!: string
let pnpmHomeDir!: string

beforeEach(() => {
  homeDir = tempDir()
  pnpmHomeDir = path.join(homeDir, '.pnpm')
  homedir['mockReturnValue'](homeDir)
})

describe('Bash', () => {
  beforeAll(() => {
    process.env.SHELL = '/bin/bash'
  })
  it('should append to empty shell script', async () => {
    fs.writeFileSync('.bashrc', '', 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Appended new /)
    const bashRCContent = fs.readFileSync('.bashrc', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
  it('should create a shell script', async () => {
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Created /)
    const bashRCContent = fs.readFileSync('.bashrc', 'utf8')
    expect(bashRCContent).toEqual(`# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
  it('should make no changes to a shell script that already has the necessary configurations', async () => {
    fs.writeFileSync('.bashrc', `
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`, 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Configuration already up-to-date /)
    const bashRCContent = fs.readFileSync('.bashrc', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
  it('should fail if the shell already has PNPM_HOME set to a different directory', async () => {
    fs.writeFileSync('.bashrc', `
# pnpm
export PNPM_HOME="pnpm_home"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`, 'utf8')
    await expect(
      setup.handler({ pnpmHomeDir })
    ).rejects.toThrowError(/The config file at/)
  })
  it('should not fail if setup is forced', async () => {
    fs.writeFileSync('.bashrc', `
# pnpm
export PNPM_HOME="pnpm_home"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`, 'utf8')
    const output = await setup.handler({ force: true, pnpmHomeDir })
    expect(output).toMatch(/^Replaced /)
    const bashRCContent = fs.readFileSync('.bashrc', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
})

describe('Zsh', () => {
  beforeAll(() => {
    process.env.SHELL = '/bin/zsh'
  })
  it('should append to empty shell script', async () => {
    fs.writeFileSync('.zshrc', '', 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Appended new /)
    const bashRCContent = fs.readFileSync('.zshrc', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
  it('should make no changes to a shell script that already has the necessary configurations', async () => {
    fs.writeFileSync('.zshrc', `
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`, 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Configuration already up-to-date /)
    const bashRCContent = fs.readFileSync('.zshrc', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
export PNPM_HOME="${pnpmHomeDir}"
export PATH="$PNPM_HOME:$PATH"
# pnpm end`)
  })
})

describe('Fish', () => {
  beforeAll(() => {
    process.env.SHELL = '/bin/fish'
  })
  it('should append to empty shell script', async () => {
    fs.mkdirSync('.config/fish', { recursive: true })
    fs.writeFileSync('.config/fish/config.fish', '', 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Appended new /)
    const bashRCContent = fs.readFileSync('.config/fish/config.fish', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
set -gx PNPM_HOME "${pnpmHomeDir}"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`)
  })
  it('should create a shell script', async () => {
    fs.mkdirSync('.config/fish', { recursive: true })
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Created /)
    const bashRCContent = fs.readFileSync('.config/fish/config.fish', 'utf8')
    expect(bashRCContent).toEqual(`# pnpm
set -gx PNPM_HOME "${pnpmHomeDir}"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`)
  })
  it('should make no changes to a shell script that already has the necessary configurations', async () => {
    fs.mkdirSync('.config/fish', { recursive: true })
    fs.writeFileSync('.config/fish/config.fish', `
# pnpm
set -gx PNPM_HOME "${pnpmHomeDir}"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`, 'utf8')
    const output = await setup.handler({ pnpmHomeDir })
    expect(output).toMatch(/^Configuration already up-to-date /)
    const bashRCContent = fs.readFileSync('.config/fish/config.fish', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
set -gx PNPM_HOME "${pnpmHomeDir}"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`)
  })
  it('should fail if the shell already has PNPM_HOME set to a different directory', async () => {
    fs.mkdirSync('.config/fish', { recursive: true })
    fs.writeFileSync('.config/fish/config.fish', `
# pnpm
set -gx PNPM_HOME "pnpm_home"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`, 'utf8')
    await expect(
      setup.handler({ pnpmHomeDir })
    ).rejects.toThrowError(/The config file at/)
  })
  it('should not fail if setup is forced', async () => {
    fs.mkdirSync('.config/fish', { recursive: true })
    fs.writeFileSync('.config/fish/config.fish', `
# pnpm
set -gx PNPM_HOME "pnpm_home"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`, 'utf8')
    const output = await setup.handler({ force: true, pnpmHomeDir })
    expect(output).toMatch(/^Replaced /)
    const bashRCContent = fs.readFileSync('.config/fish/config.fish', 'utf8')
    expect(bashRCContent).toEqual(`
# pnpm
set -gx PNPM_HOME "${pnpmHomeDir}"
set -gx PATH "$PNPM_HOME" $PATH
# pnpm end`)
  })
})