test_binary.py

# Copyright 2009-2010 10gen, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tests for the Binary wrapper."""

import unittest
import sys
try:
    import uuid
    should_test_uuid = True
except ImportError:
    should_test_uuid = False
sys.path[0:0] = [""]

from bson.binary import Binary, UUIDLegacy
from nose.plugins.skip import SkipTest
from test_connection import get_connection


class TestBinary(unittest.TestCase):

    def setUp(self):
        pass

    def test_binary(self):
        a_string = "hello world"
        a_binary = Binary("hello world")
        self.assert_(a_binary.startswith("hello"))
        self.assert_(a_binary.endswith("world"))
        self.assert_(isinstance(a_binary, Binary))
        self.assertFalse(isinstance(a_string, Binary))

    def test_exceptions(self):
        self.assertRaises(TypeError, Binary, None)
        self.assertRaises(TypeError, Binary, u"hello")
        self.assertRaises(TypeError, Binary, 5)
        self.assertRaises(TypeError, Binary, 10.2)
        self.assertRaises(TypeError, Binary, "hello", None)
        self.assertRaises(TypeError, Binary, "hello", "100")
        self.assertRaises(ValueError, Binary, "hello", -1)
        self.assertRaises(ValueError, Binary, "hello", 256)
        self.assert_(Binary("hello", 0))
        self.assert_(Binary("hello", 255))

    def test_subtype(self):
        a = Binary("hello")
        self.assertEqual(a.subtype, 0)
        b = Binary("hello", 2)
        self.assertEqual(b.subtype, 2)
        c = Binary("hello", 100)
        self.assertEqual(c.subtype, 100)

    def test_equality(self):
        b = Binary("hello")
        c = Binary("hello", 100)
        self.assertNotEqual(b, c)
        self.assertEqual(c, Binary("hello", 100))
        self.assertEqual(b, Binary("hello"))
        self.assertNotEqual(b, Binary("hello "))
        self.assertNotEqual("hello", Binary("hello"))

    def test_repr(self):
        a = Binary("hello world")
        self.assertEqual(repr(a), "Binary('hello world', 0)")
        b = Binary("hello world", 2)
        self.assertEqual(repr(b), "Binary('hello world', 2)")
        c = Binary("\x08\xFF")
        self.assertEqual(repr(c), "Binary('\\x08\\xff', 0)")
        d = Binary("\x08\xFF", 2)
        self.assertEqual(repr(d), "Binary('\\x08\\xff', 2)")
        e = Binary("test", 100)
        self.assertEqual(repr(e), "Binary('test', 100)")

    def test_uuid_queries(self):
        if not should_test_uuid:
            raise SkipTest()

        c = get_connection()
        coll = c.pymongo_test.test
        coll.drop()

        uu = uuid.uuid4()
        coll.insert({'uuid': uuid.uuid4()})
        coll.insert({'uuid': uuid.uuid4()})
        coll.insert({'uuid': Binary(uu.bytes, 3)})

        # Test UUIDLegacy queries.
        self.assertEquals(0, coll.find({'uuid': uu}).count())
        cur = coll.find({'uuid': UUIDLegacy(uu)})
        self.assertEquals(1, cur.count())
        retrieved = cur.next()['uuid']
        self.assertEquals(uu, retrieved)

        # Test regular UUID queries.
        coll.insert({'uuid': uu})
        cur = coll.find({'uuid': uu})
        self.assertEquals(1, cur.count())
        self.assertEquals(uu, cur.next()['uuid'])

        # Test both.
        cur = coll.find({'uuid': {'$in': [uu, UUIDLegacy(uu)]}})
        self.assertEquals(2, cur.count())
        coll.drop()


if __name__ == "__main__":
    unittest.main()