# -*- coding: iso-8859-1 -*-

# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""unit tests for module cubicweb.server.repository"""

from __future__ import with_statement

import os

import sys

import threading

import time

from copy import deepcopy

from datetime import datetime

from logilab.common.testlib import TestCase, unittest_main

from yams.constraints import UniqueConstraint

from cubicweb import (BadConnectionId, RepositoryError, ValidationError,

                      UnknownEid, AuthenticationError)

from cubicweb.selectors import is_instance

from cubicweb.schema import CubicWebSchema, RQLConstraint

from cubicweb.dbapi import connect, multiple_connections_unfix

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb.devtools.repotest import tuplify

from cubicweb.server import repository, hook

from cubicweb.server.sqlutils import SQL_PREFIX

from cubicweb.server.hook import Hook

from cubicweb.server.sources import native

# start name server anyway, process will fail if already running

os.system('pyro-ns >/dev/null 2>/dev/null &')

class RepositoryTC(CubicWebTC):

    """ singleton providing access to a persistent storage for entities

    and relation

    """

    def test_fill_schema(self):

        origshema = self.repo.schema

        try:

            self.repo.schema = CubicWebSchema(self.repo.config.appid)

            self.repo.config._cubes = None # avoid assertion error

            self.repo.config.repairing = True # avoid versions checking

            self.repo.fill_schema()

            table = SQL_PREFIX + 'CWEType'

            namecol = SQL_PREFIX + 'name'

            finalcol = SQL_PREFIX + 'final'

            self.session.set_pool()

            cu = self.session.system_sql('SELECT %s FROM %s WHERE %s is NULL' % (

                namecol, table, finalcol))

            self.assertEquals(cu.fetchall(), [])

            cu = self.session.system_sql('SELECT %s FROM %s WHERE %s=%%(final)s ORDER BY %s'

                                         % (namecol, table, finalcol, namecol), {'final': 'TRUE'})

            self.assertEquals(cu.fetchall(), [(u'Boolean',), (u'Bytes',),

                                              (u'Date',), (u'Datetime',),

                                              (u'Decimal',),(u'Float',),

                                              (u'Int',),

                                              (u'Interval',), (u'Password',),

                                              (u'String',), (u'Time',)])

        finally:

            self.repo.set_schema(origshema)

    def test_schema_has_owner(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        self.failIf(repo.execute(cnxid, 'CWEType X WHERE NOT X owned_by U'))

        self.failIf(repo.execute(cnxid, 'CWRType X WHERE NOT X owned_by U'))

        self.failIf(repo.execute(cnxid, 'CWAttribute X WHERE NOT X owned_by U'))

        self.failIf(repo.execute(cnxid, 'CWRelation X WHERE NOT X owned_by U'))

        self.failIf(repo.execute(cnxid, 'CWConstraint X WHERE NOT X owned_by U'))

        self.failIf(repo.execute(cnxid, 'CWConstraintType X WHERE NOT X owned_by U'))

    def test_connect(self):

        self.assert_(self.repo.connect(self.admlogin, password=self.admpassword))

        self.assertRaises(AuthenticationError,

                          self.repo.connect, self.admlogin, password='nimportnawak')

        self.assertRaises(AuthenticationError,

                          self.repo.connect, self.admlogin, password=None)

        self.assertRaises(AuthenticationError,

                          self.repo.connect, None, password=None)

        self.assertRaises(AuthenticationError,

                          self.repo.connect, self.admlogin)

        self.assertRaises(AuthenticationError,

                          self.repo.connect, None)

    def test_execute(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        repo.execute(cnxid, 'Any X')

        repo.execute(cnxid, 'Any X where X is Personne')

        repo.execute(cnxid, 'Any X where X is Personne, X nom ~= "to"')

        repo.execute(cnxid, 'Any X WHERE X has_text %(text)s', {'text': u'\xe7a'})

        repo.close(cnxid)

    def test_login_upassword_accent(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        repo.execute(cnxid, 'INSERT CWUser X: X login %(login)s, X upassword %(passwd)s, X in_group G WHERE G name "users"',

                     {'login': u"barnab�", 'passwd': u"h�h�h�".encode('UTF8')})

        repo.commit(cnxid)

        repo.close(cnxid)

        self.assert_(repo.connect(u"barnab�", password=u"h�h�h�".encode('UTF8')))

    def test_invalid_entity_rollback(self):

        cnxid = self.repo.connect(self.admlogin, password=self.admpassword)

        # no group

        self.repo.execute(cnxid,

                          'INSERT CWUser X: X login %(login)s, X upassword %(passwd)s',

                          {'login': u"tutetute", 'passwd': 'tutetute'})

        self.assertRaises(ValidationError, self.repo.commit, cnxid)

        self.failIf(self.repo.execute(cnxid, 'CWUser X WHERE X login "tutetute"'))

    def test_close(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        self.assert_(cnxid)

        repo.close(cnxid)

        self.assertRaises(BadConnectionId, repo.execute, cnxid, 'Any X')

    def test_invalid_cnxid(self):

        self.assertRaises(BadConnectionId, self.repo.execute, 0, 'Any X')

        self.assertRaises(BadConnectionId, self.repo.close, None)

    def test_shared_data(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        repo.set_shared_data(cnxid, 'data', 4)

        cnxid2 = repo.connect(self.admlogin, password=self.admpassword)

        self.assertEquals(repo.get_shared_data(cnxid, 'data'), 4)

        self.assertEquals(repo.get_shared_data(cnxid2, 'data'), None)

        repo.set_shared_data(cnxid2, 'data', 5)

        self.assertEquals(repo.get_shared_data(cnxid, 'data'), 4)

        self.assertEquals(repo.get_shared_data(cnxid2, 'data'), 5)

        repo.get_shared_data(cnxid2, 'data', pop=True)

        self.assertEquals(repo.get_shared_data(cnxid, 'data'), 4)

        self.assertEquals(repo.get_shared_data(cnxid2, 'data'), None)

        repo.close(cnxid)

        repo.close(cnxid2)

        self.assertRaises(BadConnectionId, repo.get_shared_data, cnxid, 'data')

        self.assertRaises(BadConnectionId, repo.get_shared_data, cnxid2, 'data')

        self.assertRaises(BadConnectionId, repo.set_shared_data, cnxid, 'data', 1)

        self.assertRaises(BadConnectionId, repo.set_shared_data, cnxid2, 'data', 1)

    def test_check_session(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        self.assertEquals(repo.check_session(cnxid), None)

        repo.close(cnxid)

        self.assertRaises(BadConnectionId, repo.check_session, cnxid)

    def test_transaction_base(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        # check db state

        result = repo.execute(cnxid, 'Personne X')

        self.assertEquals(result.rowcount, 0)

        # rollback entity insertion

        repo.execute(cnxid, "INSERT Personne X: X nom 'bidule'")

        result = repo.execute(cnxid, 'Personne X')

        self.assertEquals(result.rowcount, 1)

        repo.rollback(cnxid)

        result = repo.execute(cnxid, 'Personne X')

        self.assertEquals(result.rowcount, 0, result.rows)

        # commit

        repo.execute(cnxid, "INSERT Personne X: X nom 'bidule'")

        repo.commit(cnxid)

        result = repo.execute(cnxid, 'Personne X')

        self.assertEquals(result.rowcount, 1)

    def test_transaction_base2(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        # rollback relation insertion

        repo.execute(cnxid, "SET U in_group G WHERE U login 'admin', G name 'guests'")

        result = repo.execute(cnxid, "Any U WHERE U in_group G, U login 'admin', G name 'guests'")

        self.assertEquals(result.rowcount, 1)

        repo.rollback(cnxid)

        result = repo.execute(cnxid, "Any U WHERE U in_group G, U login 'admin', G name 'guests'")

        self.assertEquals(result.rowcount, 0, result.rows)

    def test_transaction_base3(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        # rollback state change which trigger TrInfo insertion

        session = repo._get_session(cnxid)

        session.set_pool()

        user = session.user

        user.cw_adapt_to('IWorkflowable').fire_transition('deactivate')

        rset = repo.execute(cnxid, 'TrInfo T WHERE T wf_info_for X, X eid %(x)s', {'x': user.eid})

        self.assertEquals(len(rset), 1)

        repo.rollback(cnxid)

        rset = repo.execute(cnxid, 'TrInfo T WHERE T wf_info_for X, X eid %(x)s', {'x': user.eid})

        self.assertEquals(len(rset), 0)

    def test_transaction_interleaved(self):

        self.skip('implement me')

    def test_close_kill_processing_request(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        repo.execute(cnxid, 'INSERT CWUser X: X login "toto", X upassword "tutu", X in_group G WHERE G name "users"')

        repo.commit(cnxid)

        # close has to be in the thread due to sqlite limitations

        def close_in_a_few_moment():

            time.sleep(0.1)

            repo.close(cnxid)

        t = threading.Thread(target=close_in_a_few_moment)

        t.start()

        def run_transaction():

            repo.execute(cnxid, 'DELETE CWUser X WHERE X login "toto"')

            repo.commit(cnxid)

        try:

            ex = self.assertRaises(Exception, run_transaction)

            self.assertEquals(str(ex), 'try to access pool on a closed session')

        finally:

            t.join()

    def test_initial_schema(self):

        schema = self.repo.schema

        # check order of attributes is respected

        self.assertListEquals([r.type for r in schema.eschema('CWAttribute').ordered_relations()

                               if not r.type in ('eid', 'is', 'is_instance_of', 'identity',

                                                 'creation_date', 'modification_date', 'cwuri',

                                                 'owned_by', 'created_by',

                                                 'update_permission', 'read_permission',

                                                 'in_basket')],

                              ['relation_type',

                               'from_entity', 'to_entity',

                               'constrained_by',

                               'cardinality', 'ordernum',

                               'indexed', 'fulltextindexed', 'internationalizable',

                               'defaultval', 'description', 'description_format'])

        self.assertEquals(schema.eschema('CWEType').main_attribute(), 'name')

        self.assertEquals(schema.eschema('State').main_attribute(), 'name')

        constraints = schema.rschema('name').rdef('CWEType', 'String').constraints

        self.assertEquals(len(constraints), 2)

        for cstr in constraints[:]:

            if isinstance(cstr, UniqueConstraint):

                constraints.remove(cstr)

                break

        else:

            self.fail('unique constraint not found')

        sizeconstraint = constraints[0]

        self.assertEquals(sizeconstraint.min, None)

        self.assertEquals(sizeconstraint.max, 64)

        constraints = schema.rschema('relation_type').rdef('CWAttribute', 'CWRType').constraints

        self.assertEquals(len(constraints), 1)

        cstr = constraints[0]

        self.assert_(isinstance(cstr, RQLConstraint))

        self.assertEquals(cstr.restriction, 'O final TRUE')

        ownedby = schema.rschema('owned_by')

        self.assertEquals(ownedby.objects('CWEType'), ('CWUser',))

    def test_pyro(self):

        import Pyro

        Pyro.config.PYRO_MULTITHREADED = 0

        done = []

        # the client part has to be in the thread due to sqlite limitations

        t = threading.Thread(target=self._pyro_client, args=(done,))

        try:

            daemon = self.repo.pyro_register()

            t.start()

            while not done:

                daemon.handleRequests(1.0)

            t.join(1)

            if t.isAlive():

                self.fail('something went wrong, thread still alive')

        finally:

            repository.pyro_unregister(self.repo.config)

            from logilab.common import pyro_ext

            pyro_ext._DAEMONS.clear()

    def _pyro_client(self, done):

        cnx = connect(self.repo.config.appid, u'admin', password='gingkow',

                      initlog=False) # don't reset logging configuration

        try:

            cnx.load_appobjects(subpath=('entities',))

            # check we can get the schema

            schema = cnx.get_schema()

            self.failUnless(cnx.vreg)

            self.failUnless('etypes'in cnx.vreg)

            self.assertEquals(schema.__hashmode__, None)

            cu = cnx.cursor()

            rset = cu.execute('Any U,G WHERE U in_group G')

            user = iter(rset.entities()).next()

            self.failUnless(user._cw)

            self.failUnless(user._cw.vreg)

            from cubicweb.entities import authobjs

            self.assertIsInstance(user._cw.user, authobjs.CWUser)

            cnx.close()

            done.append(True)

        finally:

            # connect monkey patch some method by default, remove them

            multiple_connections_unfix()

    def test_internal_api(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        session = repo._get_session(cnxid, setpool=True)

        self.assertEquals(repo.type_and_source_from_eid(1, session),

                          ('CWGroup', 'system', None))

        self.assertEquals(repo.type_from_eid(1, session), 'CWGroup')

        self.assertEquals(repo.source_from_eid(1, session).uri, 'system')

        self.assertEquals(repo.eid2extid(repo.system_source, 1, session), None)

        class dummysource: uri = 'toto'

        self.assertRaises(UnknownEid, repo.eid2extid, dummysource, 1, session)

    def test_public_api(self):

        self.assertEquals(self.repo.get_schema(), self.repo.schema)

        self.assertEquals(self.repo.source_defs(), {'system': {'adapter': 'native', 'uri': 'system'}})

        # .properties() return a result set

        self.assertEquals(self.repo.properties().rql, 'Any K,V WHERE P is CWProperty,P pkey K, P value V, NOT P for_user U')

    def test_session_api(self):

        repo = self.repo

        cnxid = repo.connect(self.admlogin, password=self.admpassword)

        self.assertEquals(repo.user_info(cnxid), (5, 'admin', set([u'managers']), {}))

        self.assertEquals(repo.describe(cnxid, 1), (u'CWGroup', u'system', None))

        repo.close(cnxid)

        self.assertRaises(BadConnectionId, repo.user_info, cnxid)

        self.assertRaises(BadConnectionId, repo.describe, cnxid, 1)

    def test_shared_data_api(self):