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

CLI tool for Bee

import { existsSync, unlinkSync, writeFileSync } from 'fs'
import { LeafCommand } from 'furious-commander'
import type { Upload } from '../../src/command/upload'
import { toMatchLinesInOrder } from '../custom-matcher'
import { describeCommand, invokeTestCli } from '../utility'
import { getStampOption } from '../utility/stamp'

const SUCCESSFUL_SYNC_PATTERN = [
  ['Data has been sent to the Bee node successfully!'],
  ['Waiting for file chunks to be synced on Swarm network...'],
  ['Data has been synced on Swarm network'],
  ['Uploading was successful!'],
]

expect.extend({
  toMatchLinesInOrder,
})

function actUpload(command: { runnable?: LeafCommand | undefined }): [string, string] {
  const uploadCommand = command.runnable as Upload
  const ref = uploadCommand.result.getOrThrow().toHex()
  const his = uploadCommand.historyAddress.getOrThrow().toHex()

  return [ref, his]
}

describeCommand('Test Upload command', ({ consoleMessages, hasMessageContaining }) => {
  if (existsSync('test/data/8mb.bin')) {
    unlinkSync('test/data/8mb.bin')
  }

  writeFileSync('test/data/8mb.bin', Buffer.alloc(8_000_000))

  it('should upload testpage folder', async () => {
    const commandKey = 'upload'
    const uploadFolderPath = `${__dirname}/../testpage`
    const commandBuilder = await invokeTestCli([commandKey, uploadFolderPath, ...getStampOption()])

    expect(commandBuilder.initedCommands[0].command.name).toBe('upload')
    const command = commandBuilder.initedCommands[0].command as Upload
    expect(command.result.getOrThrow().toHex().length).toBe(64)
  })

  it('should upload file', async () => {
    const commandKey = 'upload'
    const uploadFolderPath = `${__dirname}/../testpage/images/swarm.png`
    const commandBuilder = await invokeTestCli([commandKey, uploadFolderPath, ...getStampOption()])

    expect(commandBuilder.initedCommands[0].command.name).toBe('upload')
    const command = commandBuilder.initedCommands[0].command as Upload
    expect(command.result.getOrThrow().toHex().length).toBe(64)
  })

  it('should upload file and encrypt', async () => {
    const commandBuilder = await invokeTestCli(['upload', 'README.md', '--encrypt', ...getStampOption()])
    const uploadCommand = commandBuilder.runnable as Upload
    expect(uploadCommand.result.getOrThrow().toHex()).toHaveLength(128)
  })

  it('should upload file with act', async () => {
    const commandBuilder = await invokeTestCli(['upload', 'README.md', '--act', ...getStampOption()])
    const [ref, his] = actUpload(commandBuilder)
    expect(ref).toHaveLength(64)
    expect(his).toHaveLength(64)
  })

  it('should upload file with act and history', async () => {
    const commandBuilder1 = await invokeTestCli(['upload', 'README.md', '--act', ...getStampOption()])
    const [ref1, his1] = actUpload(commandBuilder1)
    expect(ref1).toHaveLength(64)
    expect(his1).toHaveLength(64)

    // Upload same file with the same history address
    const commandBuilder2 = await invokeTestCli([
      'upload',
      'README.md',
      '--act',
      '--act-history-address',
      his1,
      ...getStampOption(),
    ])
    const [ref2, his2] = actUpload(commandBuilder2)
    expect(ref2).toHaveLength(64)
    expect(his2).toHaveLength(64)
    expect(ref1).toBe(ref2) // Same reference
    expect(his1).toBe(his2) // Same history address

    // Upload another file with the same history address
    const commandBuilder3 = await invokeTestCli([
      'upload',
      'test/message.txt',
      '--act',
      '--act-history-address',
      his1,
      ...getStampOption(),
    ])
    const [ref3, his3] = actUpload(commandBuilder3)
    expect(ref3).toHaveLength(64)
    expect(his3).toHaveLength(64)
    expect(ref1).not.toBe(ref3) // Not same reference
    expect(his1).toBe(his3) // Same history address
  })

  it('should upload folder and encrypt', async () => {
    const commandBuilder = await invokeTestCli(['upload', 'test/testpage', '--encrypt', ...getStampOption()])
    const uploadCommand = commandBuilder.runnable as Upload
    expect(uploadCommand.result.getOrThrow().toHex()).toHaveLength(128)
  })

  it('should not allow --encrypt for gateways', async () => {
    await invokeTestCli([
      'upload',
      'README.md',
      '--bee-api-url',
      'https://api.gateway.ethswarm.org',
      '--encrypt',
      ...getStampOption(),
    ])
    expect(hasMessageContaining('does not support encryption')).toBeTruthy()
  })

  it('should not allow --pin for gateways', async () => {
    await invokeTestCli([
      'upload',
      'README.md',
      '--bee-api-url',
      'https://api.gateway.ethswarm.org',
      '--pin',
      ...getStampOption(),
    ])
    expect(hasMessageContaining('does not support pinning')).toBeTruthy()
  })

  it('should not allow sync for gateways', async () => {
    await invokeTestCli([
      'upload',
      'README.md',
      '--sync',
      '--bee-api-url',
      'https://api.gateway.ethswarm.org',
      '--encrypt',
      ...getStampOption(),
    ])
    expect(hasMessageContaining('does not support syncing')).toBeTruthy()
  })

  it('should succeed with --sync <1MB', async () => {
    await invokeTestCli(['upload', 'README.md', '--sync', '-v', ...getStampOption()])
    expect(consoleMessages).toMatchLinesInOrder(SUCCESSFUL_SYNC_PATTERN)
  })

  it('should succeed with --sync >1MB', async () => {
    await invokeTestCli(['upload', 'docs/stamp-buy.gif', '--sync', '-v', ...getStampOption()])
    expect(consoleMessages).toMatchLinesInOrder(SUCCESSFUL_SYNC_PATTERN)
  })

  it('should succeed with --sync and --encrypt <1MB', async () => {
    await invokeTestCli(['upload', 'README.md', '--sync', '--encrypt', '-v', ...getStampOption()])
    expect(consoleMessages).toMatchLinesInOrder(SUCCESSFUL_SYNC_PATTERN)
  })

  it('should succeed with --sync and --encrypt >1MB', async () => {
    await invokeTestCli(['upload', 'docs/stamp-buy.gif', '--sync', '--encrypt', '-v', ...getStampOption()])
    expect(consoleMessages).toMatchLinesInOrder(SUCCESSFUL_SYNC_PATTERN)
  })

  it('should not print double trailing slashes', async () => {
    await invokeTestCli(['upload', 'README.md', '--bee-api-url', 'http://localhost:1633/', ...getStampOption()])
    expect(hasMessageContaining(':1633/bzz')).toBeTruthy()
    expect(hasMessageContaining('//bzz')).toBeFalsy()
  })

  it('should be able to upload text file', async () => {
    await invokeTestCli(['upload', 'test/message.txt', ...getStampOption()])
    expect(consoleMessages[0]).toContain('Swarm hash')
  })
})