@ethersphere/swarm-cli/test/command/pinning.spec.ts

CLI tool for Bee

import { Reference } from '@ethersphere/bee-js'
import { FORMATTED_ERROR } from '../../src/command/root-command/printer'
import { Upload } from '../../src/command/upload'
import { describeCommand, invokeTestCli } from '../utility'
import { getStampOption } from '../utility/stamp'

async function uploadAndGetHash(path: string, indexDocument?: string): Promise<Reference> {
  const extras = indexDocument ? ['--index-document', indexDocument] : []
  const builder = await invokeTestCli(['upload', path, ...getStampOption(), ...extras])

  return (builder.runnable as Upload).result.getOrThrow()
}

describeCommand(
  'Test Pinning command',
  ({ consoleMessages, getLastMessage, hasMessageContaining }) => {
    it('should pin a collection with index.html index document', async () => {
      const hash = await uploadAndGetHash('test/testpage')
      await invokeTestCli(['pinning', 'pin', hash.toHex()])
      expect(hasMessageContaining('Pinned successfully')).toBeTruthy()
    })

    it('should pin a collection with no index document', async () => {
      const hash = await uploadAndGetHash('test/command')
      await invokeTestCli(['pinning', 'pin', hash.toHex()])
      expect(hasMessageContaining('Pinned successfully')).toBeTruthy()
    })

    it('should pin a collection with explicit index document', async () => {
      const hash = await uploadAndGetHash('test/command', 'pinning.spec.ts')
      await invokeTestCli(['pinning', 'pin', hash.toHex()])
      expect(hasMessageContaining('Pinned successfully')).toBeTruthy()
    })

    it('should list less pinned items after unpinning', async () => {
      const hash = await uploadAndGetHash('test/command')
      consoleMessages.length = 0
      await invokeTestCli(['pinning', 'list'])
      const containsHash = consoleMessages.some(message => message.includes(hash.toHex()))
      expect(containsHash).toBe(true)
      const countOfItemsBefore = consoleMessages.length
      expect(countOfItemsBefore).toBeGreaterThanOrEqual(1)
      consoleMessages.length = 0
      await invokeTestCli(['pinning', 'unpin', hash.toHex()])
      expect(consoleMessages.length).toBe(1)
      expect(consoleMessages[0]).toContain('Unpinned successfully')
      consoleMessages.length = 0
      await invokeTestCli(['pinning', 'list'])
      const containsHashAfterUnpin = consoleMessages.some(message => message.includes(hash.toHex()))
      expect(containsHashAfterUnpin).toBe(false)
      const countOfItemsAfter = consoleMessages.length
      expect(countOfItemsAfter).toBeLessThan(countOfItemsBefore)
    })

    it.skip('should print custom 404 when pinning chunk that does not exist', async () => {
      await invokeTestCli(['pinning', 'pin', 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'])
      expect(consoleMessages).toStrictEqual([
        FORMATTED_ERROR + ' Bee responded with HTTP 404 (Not Found).',
        '',
        'The error message is: No root chunk found with address ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
        '',
        'There may be additional information in the Bee logs.',
      ])
    })

    it('should print custom 404 when unpinning chunk that does not exist', async () => {
      await invokeTestCli(['pinning', 'unpin', 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'])
      expect(consoleMessages).toStrictEqual([
        FORMATTED_ERROR + ' Bee responded with HTTP 404 (Not Found).',
        '',
        'The error message is: No root chunk found with address ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
        '',
        'There may be additional information in the Bee logs.',
      ])
    })

    it.skip('should allow reuploading pinned file', async () => {
      const invocation = await invokeTestCli(['upload', 'README.md', '--pin', ...getStampOption()])
      const upload = invocation.runnable as Upload
      const hash = upload.result.getOrThrow()
      await invokeTestCli(['pinning', 'reupload', hash.toHex()])
      expect(getLastMessage()).toBe('Reuploaded successfully.')
    })

    it.skip('should allow reuploading pinned folder', async () => {
      const invocation = await invokeTestCli(['upload', 'test', '--pin', 'false', '--yes', ...getStampOption()])
      const upload = invocation.runnable as Upload
      const hash = upload.result.getOrThrow()
      await invokeTestCli(['pinning', 'reupload', hash.toHex()])
      expect(getLastMessage()).toBe('Reuploaded successfully.')
    })

    it('should reupload all pinned content', async () => {
      await invokeTestCli(['pinning', 'reupload-all'])
      expect(getLastMessage()).toMatch(/Reuploaded \d+ out of \d+ pinned root chunks/)
    })
  },
  { configFileName: 'pinning' },
)