@usecannon/ganache/node_modules/abstract-leveldown/test/put-get-del-test.js

A library and cli to create a local blockchain for fast Ethereum development.

'use strict'

const verifyNotFoundError = require('./util').verifyNotFoundError
const assertAsync = require('./util').assertAsync
const testBuffer = Buffer.from('testbuffer')

let db

function makeGetDelErrorTests (test, testCommon, type, key, expectedError) {
  test('test get() with ' + type + ' causes error', function (t) {
    let async = false

    db.get(key, function (err) {
      t.ok(err, 'has error')
      t.ok(err instanceof Error)
      t.ok(err.message.match(expectedError), 'correct error message')
      t.ok(async, 'callback is asynchronous')
      t.end()
    })

    async = true
  })

  test('test del() with ' + type + ' causes error', function (t) {
    let async = false

    db.del(key, function (err) {
      t.ok(err, 'has error')
      t.ok(err instanceof Error)
      t.ok(err.message.match(expectedError), 'correct error message')
      t.ok(async, 'callback is asynchronous')
      t.end()
    })

    async = true
  })

  testCommon.getMany && test('test getMany() with ' + type + ' causes error', assertAsync.ctx(function (t) {
    // Add 1 assertion for every assertAsync()
    t.plan(2 * 4)

    db.getMany([key], assertAsync(function (err) {
      t.ok(err, 'has error')
      t.ok(err instanceof Error)
      t.ok(err.message.match(expectedError), 'correct error message')
    }))

    db.getMany(['valid', key], assertAsync(function (err) {
      t.ok(err, 'has error')
      t.ok(err instanceof Error)
      t.ok(err.message.match(expectedError), 'correct error message')
    }))
  }))
}

function makePutErrorTest (test, type, key, value, expectedError) {
  test('test put() with ' + type + ' causes error', function (t) {
    let async = false

    db.put(key, value, function (err) {
      t.ok(err, 'has error')
      t.ok(err instanceof Error)
      t.ok(err.message.match(expectedError), 'correct error message')
      t.ok(async, 'callback is asynchronous')
      t.end()
    })

    async = true
  })
}

function makePutGetDelSuccessfulTest (test, testCommon, type, key, value, expectedResult) {
  const hasExpectedResult = arguments.length === 6
  test('test put()/get()/del() with ' + type, function (t) {
    db.put(key, value, function (err) {
      t.error(err)
      db.get(key, function (err, _value) {
        t.error(err, 'no error, has key/value for `' + type + '`')

        let result

        if (!testCommon.encodings) {
          t.ok(Buffer.isBuffer(_value), 'is a Buffer')
          result = _value
        } else {
          t.is(typeof _value, 'string', 'is a string')
          result = _value
        }

        if (hasExpectedResult) {
          t.equal(result.toString(), expectedResult)
        } else {
          if (result != null) { result = _value.toString() }
          if (value != null) { value = value.toString() }
          t.equals(result, value)
        }
        db.del(key, function (err) {
          t.error(err, 'no error, deleted key/value for `' + type + '`')

          let async = false

          db.get(key, function (err, value) {
            t.ok(err, 'entry properly deleted')
            t.ok(verifyNotFoundError(err), 'should have correct error message')
            t.equal(typeof value, 'undefined', 'value is undefined')
            t.ok(async, 'callback is asynchronous')
            t.end()
          })

          async = true
        })
      })
    })
  })
}

function makeErrorKeyTest (test, testCommon, type, key, expectedError) {
  makeGetDelErrorTests(test, testCommon, type, key, expectedError)
  makePutErrorTest(test, type, key, 'foo', expectedError)
}

exports.setUp = function (test, testCommon) {
  test('setUp common', testCommon.setUp)
  test('setUp db', function (t) {
    db = testCommon.factory()
    db.open(t.end.bind(t))
  })
}

exports.errorKeys = function (test, testCommon) {
  makeErrorKeyTest(test, testCommon, 'null key', null, /key cannot be `null` or `undefined`/)
  makeErrorKeyTest(test, testCommon, 'undefined key', undefined, /key cannot be `null` or `undefined`/)
  makeErrorKeyTest(test, testCommon, 'empty String key', '', /key cannot be an empty String/)
  makeErrorKeyTest(test, testCommon, 'empty Buffer key', Buffer.alloc(0), /key cannot be an empty \w*Buffer/)
  makeErrorKeyTest(test, testCommon, 'empty Array key', [], /key cannot be an empty Array/)
}

exports.errorValues = function (test, testCommon) {
  makePutErrorTest(test, 'null value', 'key', null, /value cannot be `null` or `undefined`/)
  makePutErrorTest(test, 'undefined value', 'key', undefined, /value cannot be `null` or `undefined`/)
}

exports.nonErrorKeys = function (test, testCommon) {
  // valid falsey keys
  makePutGetDelSuccessfulTest(test, testCommon, '`0` key', 0, 'foo 0')

  // standard String key
  makePutGetDelSuccessfulTest(
    test
    , testCommon
    , 'long String key'
    , 'some long string that I\'m using as a key for this unit test, cross your fingers human, we\'re going in!'
    , 'foo'
  )

  if (testCommon.bufferKeys) {
    makePutGetDelSuccessfulTest(test, testCommon, 'Buffer key', testBuffer, 'foo')
  }

  // non-empty Array as a value
  makePutGetDelSuccessfulTest(test, testCommon, 'Array value', 'foo', [1, 2, 3, 4])
}

exports.nonErrorValues = function (test, testCommon) {
  // valid falsey values
  makePutGetDelSuccessfulTest(test, testCommon, '`false` value', 'foo false', false)
  makePutGetDelSuccessfulTest(test, testCommon, '`0` value', 'foo 0', 0)
  makePutGetDelSuccessfulTest(test, testCommon, '`NaN` value', 'foo NaN', NaN)

  // all of the following result in an empty-string value:
  makePutGetDelSuccessfulTest(test, testCommon, 'empty String value', 'foo', '', '')
  makePutGetDelSuccessfulTest(test, testCommon, 'empty Buffer value', 'foo', Buffer.alloc(0), '')

  // note that an implementation may return the value as an array
  makePutGetDelSuccessfulTest(test, testCommon, 'empty Array value', 'foo', [], '')

  // standard String value
  makePutGetDelSuccessfulTest(
    test
    , testCommon
    , 'long String value'
    , 'foo'
    , 'some long string that I\'m using as a key for this unit test, cross your fingers human, we\'re going in!'
  )

  // standard Buffer value
  makePutGetDelSuccessfulTest(test, testCommon, 'Buffer value', 'foo', testBuffer)

  // non-empty Array as a key
  makePutGetDelSuccessfulTest(test, testCommon, 'Array key', [1, 2, 3, 4], 'foo')
}

exports.tearDown = function (test, testCommon) {
  test('tearDown', function (t) {
    db.close(testCommon.tearDown.bind(null, t))
  })
}

exports.all = function (test, testCommon) {
  exports.setUp(test, testCommon)
  exports.errorKeys(test, testCommon)
  exports.errorValues(test, testCommon)
  exports.nonErrorKeys(test, testCommon)
  exports.nonErrorValues(test, testCommon)
  exports.tearDown(test, testCommon)
}