# 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/>.

from __future__ import with_statement

from cubicweb import ValidationError

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb.server.session import security_enabled

def add_wf(self, etype, name=None, default=False):

    if name is None:

        name = etype

    return self.shell().add_workflow(name, etype, default=default,

                                     ensure_workflowable=False)

def parse_hist(wfhist):

    return [(ti.previous_state.name, ti.new_state.name,

             ti.transition and ti.transition.name, ti.comment)

            for ti in wfhist]

class WorkflowBuildingTC(CubicWebTC):

    def test_wf_construction(self):

        wf = add_wf(self, 'Company')

        foo = wf.add_state(u'foo', initial=True)

        bar = wf.add_state(u'bar')

        self.assertEqual(wf.state_by_name('bar').eid, bar.eid)

        self.assertEqual(wf.state_by_name('barrr'), None)

        baz = wf.add_transition(u'baz', (foo,), bar, ('managers',))

        self.assertEqual(wf.transition_by_name('baz').eid, baz.eid)

        self.assertEqual(len(baz.require_group), 1)

        self.assertEqual(baz.require_group[0].name, 'managers')

    def test_duplicated_state(self):

        wf = add_wf(self, 'Company')

        wf.add_state(u'foo', initial=True)

        self.commit()

        wf.add_state(u'foo')

        with self.assertRaises(ValidationError) as cm:

            self.commit()

        self.assertEqual({'name-subject': 'workflow already has a state of that name'},

                         cm.exception.errors)

        # no pb if not in the same workflow

        wf2 = add_wf(self, 'Company')

        foo = wf2.add_state(u'foo', initial=True)

        self.commit()

        # gnark gnark

        bar = wf.add_state(u'bar')

        self.commit()

        bar.set_attributes(name=u'foo')

        with self.assertRaises(ValidationError) as cm:

            self.commit()

        self.assertEqual({'name-subject': 'workflow already has a state of that name'},

                         cm.exception.errors)

    def test_duplicated_transition(self):

        wf = add_wf(self, 'Company')

        foo = wf.add_state(u'foo', initial=True)

        bar = wf.add_state(u'bar')

        wf.add_transition(u'baz', (foo,), bar, ('managers',))

        wf.add_transition(u'baz', (bar,), foo)

        with self.assertRaises(ValidationError) as cm:

            self.commit()

        self.assertEqual(cm.exception.errors, {'name-subject': 'workflow already have a transition of that name'})

        # no pb if not in the same workflow

        wf2 = add_wf(self, 'Company')

        foo = wf.add_state(u'foo', initial=True)

        bar = wf.add_state(u'bar')

        wf.add_transition(u'baz', (foo,), bar, ('managers',))

        self.commit()

        # gnark gnark

        biz = wf.add_transition(u'biz', (bar,), foo)

        self.commit()

        biz.set_attributes(name=u'baz')

        with self.assertRaises(ValidationError) as cm:

            self.commit()

        self.assertEqual(cm.exception.errors, {'name-subject': 'workflow already have a transition of that name'})

class WorkflowTC(CubicWebTC):

    def setup_database(self):

        req = self.request()

        rschema = self.schema['in_state']

        for rdef in rschema.rdefs.values():

            self.assertEqual(rdef.cardinality, '1*')

        self.member = self.create_user(req, 'member')

    def test_workflow_base(self):

        req = self.request()

        e = self.create_user(req, 'toto')

        iworkflowable = e.cw_adapt_to('IWorkflowable')

        self.assertEqual(iworkflowable.state, 'activated')

        iworkflowable.change_state('deactivated', u'deactivate 1')

        self.commit()

        iworkflowable.change_state('activated', u'activate 1')

        self.commit()

        iworkflowable.change_state('deactivated', u'deactivate 2')

        self.commit()

        e.cw_clear_relation_cache('wf_info_for', 'object')

        self.assertEqual([tr.comment for tr in e.reverse_wf_info_for],

                          ['deactivate 1', 'activate 1', 'deactivate 2'])

        self.assertEqual(iworkflowable.latest_trinfo().comment, 'deactivate 2')

    def test_possible_transitions(self):

        user = self.execute('CWUser X').get_entity(0, 0)

        iworkflowable = user.cw_adapt_to('IWorkflowable')

        trs = list(iworkflowable.possible_transitions())

        self.assertEqual(len(trs), 1)

        self.assertEqual(trs[0].name, u'deactivate')

        self.assertEqual(trs[0].destination(None).name, u'deactivated')

        # test a std user get no possible transition

        cnx = self.login('member')

        # fetch the entity using the new session

        trs = list(cnx.user().cw_adapt_to('IWorkflowable').possible_transitions())

        self.assertEqual(len(trs), 0)

        cnx.close()

    def _test_manager_deactivate(self, user):

        iworkflowable = user.cw_adapt_to('IWorkflowable')

        user.cw_clear_relation_cache('in_state', 'subject')

        self.assertEqual(len(user.in_state), 1)

        self.assertEqual(iworkflowable.state, 'deactivated')

        trinfo = iworkflowable.latest_trinfo()

        self.assertEqual(trinfo.previous_state.name, 'activated')

        self.assertEqual(trinfo.new_state.name, 'deactivated')

        self.assertEqual(trinfo.comment, 'deactivate user')

        self.assertEqual(trinfo.comment_format, 'text/plain')

        return trinfo

    def test_change_state(self):

        user = self.user()

        iworkflowable = user.cw_adapt_to('IWorkflowable')

        iworkflowable.change_state('deactivated', comment=u'deactivate user')

        trinfo = self._test_manager_deactivate(user)

        self.assertEqual(trinfo.transition, None)

    def test_set_in_state_bad_wf(self):

        wf = add_wf(self, 'CWUser')

        s = wf.add_state(u'foo', initial=True)

        self.commit()

        with security_enabled(self.session, write=False):

            with self.assertRaises(ValidationError) as cm:

                self.session.execute('SET X in_state S WHERE X eid %(x)s, S eid %(s)s',

                                     {'x': self.user().eid, 's': s.eid})

            self.assertEqual(cm.exception.errors, {'in_state-subject': "state doesn't belong to entity's workflow. "

                                      "You may want to set a custom workflow for this entity first."})

    def test_fire_transition(self):

        user = self.user()

        iworkflowable = user.cw_adapt_to('IWorkflowable')

        iworkflowable.fire_transition('deactivate', comment=u'deactivate user')

        user.cw_clear_all_caches()

        self.assertEqual(iworkflowable.state, 'deactivated')

        self._test_manager_deactivate(user)

        trinfo = self._test_manager_deactivate(user)

        self.assertEqual(trinfo.transition.name, 'deactivate')

    def test_goback_transition(self):

        req = self.request()

        wf = self.session.user.cw_adapt_to('IWorkflowable').current_workflow

        asleep = wf.add_state('asleep')

        wf.add_transition('rest', (wf.state_by_name('activated'),

                                   wf.state_by_name('deactivated')),

                          asleep)

        wf.add_transition('wake up', asleep)

        user = self.create_user(req, 'stduser')

        iworkflowable = user.cw_adapt_to('IWorkflowable')

        iworkflowable.fire_transition('rest')

        self.commit()

        iworkflowable.fire_transition('wake up')

        self.commit()

        self.assertEqual(iworkflowable.state, 'activated')

        iworkflowable.fire_transition('deactivate')

        self.commit()

        iworkflowable.fire_transition('rest')

        self.commit()

        iworkflowable.fire_transition('wake up')

        self.commit()

        user.cw_clear_all_caches()

        self.assertEqual(iworkflowable.state, 'deactivated')

    # XXX test managers can change state without matching transition

    def _test_stduser_deactivate(self):

        ueid = self.member.eid

        req = self.request()

        self.create_user(req, 'tutu')

        cnx = self.login('tutu')

        req = self.request()

        iworkflowable = req.entity_from_eid(self.member.eid).cw_adapt_to('IWorkflowable')

        with self.assertRaises(ValidationError) as cm:

            iworkflowable.fire_transition('deactivate')

        self.assertEqual(cm.exception.errors, {'by_transition-subject': "transition may not be fired"})

        cnx.close()

        cnx = self.login('member')

        req = self.request()

        iworkflowable = req.entity_from_eid(self.member.eid).cw_adapt_to('IWorkflowable')

        iworkflowable.fire_transition('deactivate')

        cnx.commit()

        with self.assertRaises(ValidationError) as cm:

            iworkflowable.fire_transition('activate')

        self.assertEqual(cm.exception.errors, {'by_transition-subject': "transition may not be fired"})

        cnx.close()

    def test_fire_transition_owned_by(self):

        self.execute('INSERT RQLExpression X: X exprtype "ERQLExpression", '

                     'X expression "X owned_by U", T condition X '

                     'WHERE T name "deactivate"')

        self._test_stduser_deactivate()

    def test_fire_transition_has_update_perm(self):

        self.execute('INSERT RQLExpression X: X exprtype "ERQLExpression", '

                     'X expression "U has_update_permission X", T condition X '

                     'WHERE T name "deactivate"')

        self._test_stduser_deactivate()

    def test_swf_base(self):

        """subworkflow

        +-----------+  tr1   +-----------+

        | swfstate1 | ------>| swfstate2 |

        +-----------+        +-----------+

                  |  tr2  +-----------+

                  `------>| swfstate3 |

                          +-----------+

        main workflow

        +--------+  swftr1             +--------+

        | state1 | -------[swfstate2]->| state2 |

        +--------+     |               +--------+

                       |               +--------+

                       `-[swfstate3]-->| state3 |

                                       +--------+

        """

        # sub-workflow

        swf = add_wf(self, 'CWGroup', name='subworkflow')

        swfstate1 = swf.add_state(u'swfstate1', initial=True)

        swfstate2 = swf.add_state(u'swfstate2')

        swfstate3 = swf.add_state(u'swfstate3')

        tr1 = swf.add_transition(u'tr1', (swfstate1,), swfstate2)

        tr2 = swf.add_transition(u'tr2', (swfstate1,), swfstate3)

        # main workflow

        mwf = add_wf(self, 'CWGroup', name='main workflow', default=True)

        state1 = mwf.add_state(u'state1', initial=True)

        state2 = mwf.add_state(u'state2')

        state3 = mwf.add_state(u'state3')

        swftr1 = mwf.add_wftransition(u'swftr1', swf, state1,

                                      [(swfstate2, state2), (swfstate3, state3)])

        self.assertEqual(swftr1.destination(None).eid, swfstate1.eid)

        # workflows built, begin test

        group = self.request().create_entity('CWGroup', name=u'grp1')

        self.commit()

        iworkflowable = group.cw_adapt_to('IWorkflowable')

        self.assertEqual(iworkflowable.current_state.eid, state1.eid)

        self.assertEqual(iworkflowable.current_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.main_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.subworkflow_input_transition(), None)

        iworkflowable.fire_transition('swftr1', u'go')

        self.commit()

        group.cw_clear_all_caches()

        self.assertEqual(iworkflowable.current_state.eid, swfstate1.eid)

        self.assertEqual(iworkflowable.current_workflow.eid, swf.eid)

        self.assertEqual(iworkflowable.main_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.subworkflow_input_transition().eid, swftr1.eid)

        iworkflowable.fire_transition('tr1', u'go')

        self.commit()

        group.cw_clear_all_caches()

        self.assertEqual(iworkflowable.current_state.eid, state2.eid)

        self.assertEqual(iworkflowable.current_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.main_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.subworkflow_input_transition(), None)

        # force back to swfstate1 is impossible since we can't any more find

        # subworkflow input transition

        with self.assertRaises(ValidationError) as cm:

            iworkflowable.change_state(swfstate1, u'gadget')

        self.assertEqual(cm.exception.errors, {'to_state-subject': "state doesn't belong to entity's workflow"})

        self.rollback()

        # force back to state1

        iworkflowable.change_state('state1', u'gadget')

        iworkflowable.fire_transition('swftr1', u'au')

        group.cw_clear_all_caches()

        iworkflowable.fire_transition('tr2', u'chapeau')

        self.commit()

        group.cw_clear_all_caches()

        self.assertEqual(iworkflowable.current_state.eid, state3.eid)

        self.assertEqual(iworkflowable.current_workflow.eid, mwf.eid)

        self.assertEqual(iworkflowable.main_workflow.eid, mwf.eid)

        self.assertListEqual(parse_hist(iworkflowable.workflow_history),

                              [('state1', 'swfstate1', 'swftr1', 'go'),

                               ('swfstate1', 'swfstate2', 'tr1', 'go'),

                               ('swfstate2', 'state2', 'swftr1', 'exiting from subworkflow subworkflow'),

                               ('state2', 'state1', None, 'gadget'),

                               ('state1', 'swfstate1', 'swftr1', 'au'),

                               ('swfstate1', 'swfstate3', 'tr2', 'chapeau'),

                               ('swfstate3', 'state3', 'swftr1', 'exiting from subworkflow subworkflow'),

                               ])

    def test_swf_exit_consistency(self):

        # sub-workflow

        swf = add_wf(self, 'CWGroup', name='subworkflow')

        swfstate1 = swf.add_state(u'swfstate1', initial=True)

        swfstate2 = swf.add_state(u'swfstate2')

        tr1 = swf.add_transition(u'tr1', (swfstate1,), swfstate2)

        # main workflow

        mwf = add_wf(self, 'CWGroup', name='main workflow', default=True)

        state1 = mwf.add_state(u'state1', initial=True)

        state2 = mwf.add_state(u'state2')

        state3 = mwf.add_state(u'state3')

        mwf.add_wftransition(u'swftr1', swf, state1,

                             [(swfstate2, state2), (swfstate2, state3)])

        with self.assertRaises(ValidationError) as cm:

            self.commit()

        self.assertEqual(cm.exception.errors, {'subworkflow_exit-subject': u"can't have multiple exits on the same state"})

    def test_swf_fire_in_a_row(self):

        # sub-workflow

        subwf = add_wf(self, 'CWGroup', name='subworkflow')

        xsigning = subwf.add_state('xsigning', initial=True)

        xaborted = subwf.add_state('xaborted')

        xsigned = subwf.add_state('xsigned')

        xabort = subwf.add_transition('xabort', (xsigning,), xaborted)

        xsign = subwf.add_transition('xsign', (xsigning,), xsigning)