"""

Basic TestCases for BTree and hash DBs, with and without a DBEnv, with

various DB flags, etc.

"""

import os

import errno

import string

from pprint import pprint

import unittest

import time

from test_all import db, test_support, verbose, get_new_environment_path, \

        get_new_database_path

DASH = '-'

#----------------------------------------------------------------------

class VersionTestCase(unittest.TestCase):

    def test00_version(self):

        info = db.version()

        if verbose:

            print '\n', '-=' * 20

            print 'bsddb.db.version(): %s' % (info, )

            print db.DB_VERSION_STRING

            print '-=' * 20

        self.assertEqual(info, (db.DB_VERSION_MAJOR, db.DB_VERSION_MINOR,

                        db.DB_VERSION_PATCH))

#----------------------------------------------------------------------

class BasicTestCase(unittest.TestCase):

    dbtype       = db.DB_UNKNOWN  # must be set in derived class

    dbopenflags  = 0

    dbsetflags   = 0

    dbmode       = 0660

    dbname       = None

    useEnv       = 0

    envflags     = 0

    envsetflags  = 0

    _numKeys      = 1002    # PRIVATE.  NOTE: must be an even value

    def setUp(self):

        if self.useEnv:

            self.homeDir=get_new_environment_path()

            try:

                self.env = db.DBEnv()

                self.env.set_lg_max(1024*1024)

                self.env.set_tx_max(30)

                self.env.set_tx_timestamp(int(time.time()))

                self.env.set_flags(self.envsetflags, 1)

                self.env.open(self.homeDir, self.envflags | db.DB_CREATE)

                self.filename = "test"

            # Yes, a bare except is intended, since we're re-raising the exc.

            except:

                test_support.rmtree(self.homeDir)

                raise

        else:

            self.env = None

            self.filename = get_new_database_path()

        # create and open the DB

        self.d = db.DB(self.env)

        self.d.set_flags(self.dbsetflags)

        if self.dbname:

            self.d.open(self.filename, self.dbname, self.dbtype,

                        self.dbopenflags|db.DB_CREATE, self.dbmode)

        else:

            self.d.open(self.filename,   # try out keyword args

                        mode = self.dbmode,

                        dbtype = self.dbtype,

                        flags = self.dbopenflags|db.DB_CREATE)

        self.populateDB()

    def tearDown(self):

        self.d.close()

        if self.env is not None:

            self.env.close()

            test_support.rmtree(self.homeDir)

        else:

            os.remove(self.filename)

    def populateDB(self, _txn=None):

        d = self.d

        for x in range(self._numKeys//2):

            key = '%04d' % (self._numKeys - x)  # insert keys in reverse order

            data = self.makeData(key)

            d.put(key, data, _txn)

        d.put('empty value', '', _txn)

        for x in range(self._numKeys//2-1):

            key = '%04d' % x  # and now some in forward order

            data = self.makeData(key)

            d.put(key, data, _txn)

        if _txn:

            _txn.commit()

        num = len(d)

        if verbose:

            print "created %d records" % num

    def makeData(self, key):

        return DASH.join([key] * 5)

    #----------------------------------------

    def test01_GetsAndPuts(self):

        d = self.d

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test01_GetsAndPuts..." % self.__class__.__name__

        for key in ['0001', '0100', '0400', '0700', '0999']:

            data = d.get(key)

            if verbose:

                print data

        self.assertEqual(d.get('0321'), '0321-0321-0321-0321-0321')

        # By default non-existant keys return None...

        self.assertEqual(d.get('abcd'), None)

        # ...but they raise exceptions in other situations.  Call

        # set_get_returns_none() to change it.

        try:

            d.delete('abcd')

        except db.DBNotFoundError, val:

            import sys

            if sys.version_info[0] < 3 :

                self.assertEqual(val[0], db.DB_NOTFOUND)

            else :

                self.assertEqual(val.args[0], db.DB_NOTFOUND)

            if verbose: print val

        else:

            self.fail("expected exception")

        d.put('abcd', 'a new record')

        self.assertEqual(d.get('abcd'), 'a new record')

        d.put('abcd', 'same key')

        if self.dbsetflags & db.DB_DUP:

            self.assertEqual(d.get('abcd'), 'a new record')

        else:

            self.assertEqual(d.get('abcd'), 'same key')

        try:

            d.put('abcd', 'this should fail', flags=db.DB_NOOVERWRITE)

        except db.DBKeyExistError, val:

            import sys

            if sys.version_info[0] < 3 :

                self.assertEqual(val[0], db.DB_KEYEXIST)

            else :

                self.assertEqual(val.args[0], db.DB_KEYEXIST)

            if verbose: print val

        else:

            self.fail("expected exception")

        if self.dbsetflags & db.DB_DUP:

            self.assertEqual(d.get('abcd'), 'a new record')

        else:

            self.assertEqual(d.get('abcd'), 'same key')

        d.sync()

        d.close()

        del d

        self.d = db.DB(self.env)

        if self.dbname:

            self.d.open(self.filename, self.dbname)

        else:

            self.d.open(self.filename)

        d = self.d

        self.assertEqual(d.get('0321'), '0321-0321-0321-0321-0321')

        if self.dbsetflags & db.DB_DUP:

            self.assertEqual(d.get('abcd'), 'a new record')

        else:

            self.assertEqual(d.get('abcd'), 'same key')

        rec = d.get_both('0555', '0555-0555-0555-0555-0555')

        if verbose:

            print rec

        self.assertEqual(d.get_both('0555', 'bad data'), None)

        # test default value

        data = d.get('bad key', 'bad data')

        self.assertEqual(data, 'bad data')

        # any object can pass through

        data = d.get('bad key', self)

        self.assertEqual(data, self)

        s = d.stat()

        self.assertEqual(type(s), type({}))

        if verbose:

            print 'd.stat() returned this dictionary:'

            pprint(s)

    #----------------------------------------

    def test02_DictionaryMethods(self):

        d = self.d

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test02_DictionaryMethods..." % \

                  self.__class__.__name__

        for key in ['0002', '0101', '0401', '0701', '0998']:

            data = d[key]

            self.assertEqual(data, self.makeData(key))

            if verbose:

                print data

        self.assertEqual(len(d), self._numKeys)

        keys = d.keys()

        self.assertEqual(len(keys), self._numKeys)

        self.assertEqual(type(keys), type([]))

        d['new record'] = 'a new record'

        self.assertEqual(len(d), self._numKeys+1)

        keys = d.keys()

        self.assertEqual(len(keys), self._numKeys+1)

        d['new record'] = 'a replacement record'

        self.assertEqual(len(d), self._numKeys+1)

        keys = d.keys()

        self.assertEqual(len(keys), self._numKeys+1)

        if verbose:

            print "the first 10 keys are:"

            pprint(keys[:10])

        self.assertEqual(d['new record'], 'a replacement record')

# We check also the positional parameter

        self.assertEqual(d.has_key('0001', None), 1)

# We check also the keyword parameter

        self.assertEqual(d.has_key('spam', txn=None), 0)

        items = d.items()

        self.assertEqual(len(items), self._numKeys+1)

        self.assertEqual(type(items), type([]))

        self.assertEqual(type(items[0]), type(()))

        self.assertEqual(len(items[0]), 2)

        if verbose:

            print "the first 10 items are:"

            pprint(items[:10])

        values = d.values()

        self.assertEqual(len(values), self._numKeys+1)

        self.assertEqual(type(values), type([]))

        if verbose:

            print "the first 10 values are:"

            pprint(values[:10])

    #----------------------------------------

    def test03_SimpleCursorStuff(self, get_raises_error=0, set_raises_error=0):

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test03_SimpleCursorStuff (get_error %s, set_error %s)..." % \

                  (self.__class__.__name__, get_raises_error, set_raises_error)

        if self.env and self.dbopenflags & db.DB_AUTO_COMMIT:

            txn = self.env.txn_begin()

        else:

            txn = None

        c = self.d.cursor(txn=txn)

        rec = c.first()

        count = 0

        while rec is not None:

            count = count + 1

            if verbose and count % 100 == 0:

                print rec

            try:

                rec = c.next()

            except db.DBNotFoundError, val:

                if get_raises_error:

                    import sys

                    if sys.version_info[0] < 3 :

                        self.assertEqual(val[0], db.DB_NOTFOUND)

                    else :

                        self.assertEqual(val.args[0], db.DB_NOTFOUND)

                    if verbose: print val

                    rec = None

                else:

                    self.fail("unexpected DBNotFoundError")

            self.assertEqual(c.get_current_size(), len(c.current()[1]),

                    "%s != len(%r)" % (c.get_current_size(), c.current()[1]))

        self.assertEqual(count, self._numKeys)

        rec = c.last()

        count = 0

        while rec is not None:

            count = count + 1

            if verbose and count % 100 == 0:

                print rec

            try:

                rec = c.prev()

            except db.DBNotFoundError, val:

                if get_raises_error:

                    import sys

                    if sys.version_info[0] < 3 :

                        self.assertEqual(val[0], db.DB_NOTFOUND)

                    else :

                        self.assertEqual(val.args[0], db.DB_NOTFOUND)

                    if verbose: print val

                    rec = None

                else:

                    self.fail("unexpected DBNotFoundError")

        self.assertEqual(count, self._numKeys)

        rec = c.set('0505')

        rec2 = c.current()

        self.assertEqual(rec, rec2)

        self.assertEqual(rec[0], '0505')

        self.assertEqual(rec[1], self.makeData('0505'))

        self.assertEqual(c.get_current_size(), len(rec[1]))

        # make sure we get empty values properly

        rec = c.set('empty value')

        self.assertEqual(rec[1], '')

        self.assertEqual(c.get_current_size(), 0)

        try:

            n = c.set('bad key')

        except db.DBNotFoundError, val:

            import sys

            if sys.version_info[0] < 3 :

                self.assertEqual(val[0], db.DB_NOTFOUND)

            else :

                self.assertEqual(val.args[0], db.DB_NOTFOUND)

            if verbose: print val

        else:

            if set_raises_error:

                self.fail("expected exception")

            if n != None:

                self.fail("expected None: %r" % (n,))

        rec = c.get_both('0404', self.makeData('0404'))

        self.assertEqual(rec, ('0404', self.makeData('0404')))

        try:

            n = c.get_both('0404', 'bad data')

        except db.DBNotFoundError, val:

            import sys

            if sys.version_info[0] < 3 :

                self.assertEqual(val[0], db.DB_NOTFOUND)

            else :

                self.assertEqual(val.args[0], db.DB_NOTFOUND)

            if verbose: print val

        else:

            if get_raises_error:

                self.fail("expected exception")

            if n != None:

                self.fail("expected None: %r" % (n,))

        if self.d.get_type() == db.DB_BTREE:

            rec = c.set_range('011')

            if verbose:

                print "searched for '011', found: ", rec

            rec = c.set_range('011',dlen=0,doff=0)

            if verbose:

                print "searched (partial) for '011', found: ", rec

            if rec[1] != '': self.fail('expected empty data portion')

            ev = c.set_range('empty value')

            if verbose:

                print "search for 'empty value' returned", ev

            if ev[1] != '': self.fail('empty value lookup failed')

        c.set('0499')

        c.delete()

        try:

            rec = c.current()

        except db.DBKeyEmptyError, val:

            if get_raises_error:

                import sys

                if sys.version_info[0] < 3 :

                    self.assertEqual(val[0], db.DB_KEYEMPTY)

                else :

                    self.assertEqual(val.args[0], db.DB_KEYEMPTY)

                if verbose: print val

            else:

                self.fail("unexpected DBKeyEmptyError")

        else:

            if get_raises_error:

                self.fail('DBKeyEmptyError exception expected')

        c.next()

        c2 = c.dup(db.DB_POSITION)

        self.assertEqual(c.current(), c2.current())

        c2.put('', 'a new value', db.DB_CURRENT)

        self.assertEqual(c.current(), c2.current())

        self.assertEqual(c.current()[1], 'a new value')

        c2.put('', 'er', db.DB_CURRENT, dlen=0, doff=5)

        self.assertEqual(c2.current()[1], 'a newer value')

        c.close()

        c2.close()

        if txn:

            txn.commit()

        # time to abuse the closed cursors and hope we don't crash

        methods_to_test = {

            'current': (),

            'delete': (),

            'dup': (db.DB_POSITION,),

            'first': (),

            'get': (0,),

            'next': (),

            'prev': (),

            'last': (),

            'put':('', 'spam', db.DB_CURRENT),

            'set': ("0505",),

        }

        for method, args in methods_to_test.items():

            try:

                if verbose:

                    print "attempting to use a closed cursor's %s method" % \

                          method

                # a bug may cause a NULL pointer dereference...

                apply(getattr(c, method), args)

            except db.DBError, val:

                import sys

                if sys.version_info[0] < 3 :

                    self.assertEqual(val[0], 0)

                else :

                    self.assertEqual(val.args[0], 0)

                if verbose: print val

            else:

                self.fail("no exception raised when using a buggy cursor's"

                          "%s method" % method)

        #

        # free cursor referencing a closed database, it should not barf:

        #

        oldcursor = self.d.cursor(txn=txn)

        self.d.close()

        # this would originally cause a segfault when the cursor for a

        # closed database was cleaned up.  it should not anymore.

        # SF pybsddb bug id 667343

        del oldcursor

    def test03b_SimpleCursorWithoutGetReturnsNone0(self):

        # same test but raise exceptions instead of returning None

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test03b_SimpleCursorStuffWithoutGetReturnsNone..." % \

                  self.__class__.__name__

        old = self.d.set_get_returns_none(0)

        self.assertEqual(old, 2)

        self.test03_SimpleCursorStuff(get_raises_error=1, set_raises_error=1)

    def test03b_SimpleCursorWithGetReturnsNone1(self):

        # same test but raise exceptions instead of returning None

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test03b_SimpleCursorStuffWithoutGetReturnsNone..." % \

                  self.__class__.__name__

        old = self.d.set_get_returns_none(1)

        self.test03_SimpleCursorStuff(get_raises_error=0, set_raises_error=1)

    def test03c_SimpleCursorGetReturnsNone2(self):

        # same test but raise exceptions instead of returning None

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test03c_SimpleCursorStuffWithoutSetReturnsNone..." % \

                  self.__class__.__name__

        old = self.d.set_get_returns_none(1)

        self.assertEqual(old, 2)

        old = self.d.set_get_returns_none(2)

        self.assertEqual(old, 1)

        self.test03_SimpleCursorStuff(get_raises_error=0, set_raises_error=0)

    #----------------------------------------

    def test04_PartialGetAndPut(self):

        d = self.d

        if verbose:

            print '\n', '-=' * 30

            print "Running %s.test04_PartialGetAndPut..." % \

                  self.__class__.__name__

        key = "partialTest"

        data = "1" * 1000 + "2" * 1000

        d.put(key, data)

        self.assertEqual(d.get(key), data)

        self.assertEqual(d.get(key, dlen=20, doff=990),

                ("1" * 10) + ("2" * 10))

        d.put("partialtest2", ("1" * 30000) + "robin" )

        self.assertEqual(d.get("partialtest2", dlen=5, doff=30000), "robin")