initial commit 2

5 files changed, 368 insertions, 0 deletions

diff --git a/addons/website_livechat/tests/__init__.py b/addons/website_livechat/tests/__init__.py
new file mode 100644
index 00000000..df6e5c81
--- /dev/null
+++ b/addons/website_livechat/tests/__init__.py
@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+from . import common
+from . import test_ui
+from . import test_livechat_basic_flow
+from . import test_livechat_request
diff --git a/addons/website_livechat/tests/common.py b/addons/website_livechat/tests/common.py
new file mode 100644
index 00000000..9cc162ff
--- /dev/null
+++ b/addons/website_livechat/tests/common.py
@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import fields, tests
+
+
+class TestLivechatCommon(tests.TransactionCase):
+    def setUp(self):
+        super(TestLivechatCommon, self).setUp()
+        self.base_datetime = fields.Datetime.from_string("2019-11-11 21:30:00")
+
+        self.operator = self.env['res.users'].create({
+            'name': 'Operator Michel',
+            'login': 'operator',
+            'email': 'operator@example.com',
+            'password': "ideboulonate",
+            'livechat_username': 'El Deboulonnator',
+        })
+
+        self.livechat_channel = self.env['im_livechat.channel'].create({
+            'name': 'The basic channel',
+            'user_ids': [(6, 0, [self.operator.id])]
+        })
+
+        self.max_sessions_per_operator = 5
+        visitor_vals = {
+            'lang_id': self.env.ref('base.lang_en').id,
+            'country_id': self.env.ref('base.be').id,
+            'website_id': self.env.ref('website.default_website').id,
+        }
+        self.visitors = self.env['website.visitor'].create([{
+            'lang_id': self.env.ref('base.lang_en').id,
+            'country_id': self.env.ref('base.de').id,
+            'website_id': self.env.ref('website.default_website').id,
+            'partner_id': self.env.ref('base.user_demo').partner_id.id,
+        }] + [visitor_vals]*self.max_sessions_per_operator)
+        self.visitor_demo, self.visitor = self.visitors[0], self.visitors[1]
+
+        base_url = self.env['ir.config_parameter'].sudo().get_param('web.base.url')
+
+        self.open_chat_url = base_url + "/im_livechat/get_session"
+        self.open_chat_params = {'params': {
+            'channel_id': self.livechat_channel.id,
+            'anonymous_name': "Wrong Name"
+        }}
+
+        self.send_feedback_url = base_url + "/im_livechat/feedback"
+        self.leave_session_url = base_url + "/im_livechat/visitor_leave_session"
+
+        # override the get_available_users to return only Michel as available
+        operators = self.operator
+        def get_available_users(self):
+            return operators
+        self.patch(type(self.env['im_livechat.channel']), '_get_available_users', get_available_users)
+
+        # override the _get_visitor_from_request to return self.visitor
+        self.target_visitor = self.visitor
+        def get_visitor_from_request(self_mock, **kwargs):
+            return self.target_visitor
+        self.patch(type(self.env['website.visitor']), '_get_visitor_from_request', get_visitor_from_request)
+
+    def _send_message(self, channel, email_from, body, author_id=False):
+        # As bus is unavailable in test mode, we cannot call /mail/chat_post route to post a message.
+        # Instead, we post directly the message on the given channel.
+        channel.with_context(mail_create_nosubscribe=True) \
+            .message_post(author_id=author_id, email_from=email_from, body=body,
+                          message_type='comment', subtype_id=self.env.ref('mail.mt_comment').id)
+
+    def _send_rating(self, channel, visitor, rating_value, reason=False):
+        channel_messages_count = len(channel.message_ids)
+
+        rating_to_emoji = {1: "😞", 3: "😐", 5: "😊"}
+        self.opener.post(url=self.send_feedback_url, json={'params': {
+            'uuid': channel.uuid,
+            'rate': rating_value,
+            'reason': reason,
+        }})
+        res_model_id = self.env['ir.model'].sudo().search([('model', '=', channel._name)], limit=1).id
+        rating = self.env['rating.rating'].search([('res_id', '=', channel.id), ('res_model_id', '=', res_model_id)])
+        self.assertEqual(rating.rating, rating_value, "The rating is not correct.")
+
+        message = "Rating: %s" % rating_to_emoji[rating_value]
+        if reason:
+            message += " \n%s" % reason
+
+        self._send_message(channel, visitor.display_name, message, author_id=False)
+        self.assertEqual(len(channel.message_ids), channel_messages_count + 1)
diff --git a/addons/website_livechat/tests/test_livechat_basic_flow.py b/addons/website_livechat/tests/test_livechat_basic_flow.py
new file mode 100644
index 00000000..ea99c7ff
--- /dev/null
+++ b/addons/website_livechat/tests/test_livechat_basic_flow.py
@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import datetime
+
+from odoo import tests, _
+from odoo.addons.website_livechat.tests.common import TestLivechatCommon
+
+
+@tests.tagged('post_install', '-at_install')
+class TestLivechatBasicFlowHttpCase(tests.HttpCase, TestLivechatCommon):
+    def test_visitor_banner_history(self):
+        # create visitor history
+        self.env['website.track'].create([{
+            'page_id': self.env.ref('website.homepage_page').id,
+            'visitor_id': self.visitor.id,
+            'visit_datetime': self.base_datetime,
+        }, {
+            'page_id': self.env.ref('website.contactus_page').id,
+            'visitor_id': self.visitor.id,
+            'visit_datetime': self.base_datetime - datetime.timedelta(minutes=10),
+        }, {
+            'page_id': self.env.ref('website.homepage_page').id,
+            'visitor_id': self.visitor.id,
+            'visit_datetime': self.base_datetime - datetime.timedelta(minutes=20),
+        }])
+
+        handmade_history = "%s (21:10) → %s (21:20) → %s (21:30)" % (
+            self.env.ref('website.homepage_page').name,
+            self.env.ref('website.contactus_page').name,
+            self.env.ref('website.homepage_page').name,
+        )
+        history = self.env['mail.channel']._get_visitor_history(self.visitor)
+
+        self.assertEqual(history, handmade_history)
+
+    def test_livechat_username(self):
+        # Open a new live chat
+        res = self.opener.post(url=self.open_chat_url, json=self.open_chat_params)
+        self.assertEqual(res.status_code, 200)
+        channel_1 = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)], limit=1)
+
+        # Check Channel naming
+        self.assertEqual(channel_1.name, "%s %s" % (self.visitor.display_name, self.operator.livechat_username))
+        channel_1.unlink()
+
+        # Remove livechat_username
+        self.operator.livechat_username = False
+
+        # Open a new live chat
+        res = self.opener.post(url=self.open_chat_url, json=self.open_chat_params)
+        self.assertEqual(res.status_code, 200)
+        channel_2 = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)], limit=1)
+
+        # Check Channel naming
+        self.assertEqual(channel_2.name, "%s %s" % (self.visitor.display_name, self.operator.name))
+
+    def test_basic_flow_with_rating(self):
+        channel = self._common_basic_flow()
+
+        self._send_rating(channel, self.visitor, 5, "This deboulonnage was fine but not topitop.")
+
+        channel._close_livechat_session()
+
+        self.assertEqual(len(channel.message_ids), 4)
+        self.assertEqual(channel.message_ids[0].author_id, self.env.ref('base.partner_root'), "Odoobot must be the sender of the 'has left the conversation' message.")
+        self.assertEqual(channel.message_ids[0].body, "<p>%s has left the conversation.</p>" % self.visitor.display_name)
+        self.assertEqual(channel.livechat_active, False, "The livechat session must be inactive as the visitor sent his feedback.")
+
+    def test_basic_flow_without_rating(self):
+        channel = self._common_basic_flow()
+
+        # has left the conversation
+        channel._close_livechat_session()
+        self.assertEqual(len(channel.message_ids), 3)
+        self.assertEqual(channel.message_ids[0].author_id, self.env.ref('base.partner_root'), "Odoobot must be the author the message.")
+        self.assertEqual(channel.message_ids[0].body, "<p>%s has left the conversation.</p>" % self.visitor.display_name)
+        self.assertEqual(channel.livechat_active, False, "The livechat session must be inactive since visitor has left the conversation.")
+
+    def _common_basic_flow(self):
+        # Open a new live chat
+        res = self.opener.post(url=self.open_chat_url, json=self.open_chat_params)
+        self.assertEqual(res.status_code, 200)
+
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)], limit=1)
+
+        # Check Channel and Visitor naming
+        self.assertEqual(self.visitor.display_name, "%s #%s" % (_("Website Visitor"), self.visitor.id))
+        self.assertEqual(channel.name, "%s %s" % (self.visitor.display_name, self.operator.livechat_username))
+
+        # Post Message from visitor
+        self._send_message(channel, self.visitor.display_name, "Message from Visitor")
+
+        self.assertEqual(len(channel.message_ids), 1)
+        self.assertEqual(channel.message_ids[0].author_id.id, False, "The author of the message is not a partner.")
+        self.assertEqual(channel.message_ids[0].email_from, self.visitor.display_name, "The sender's email should be the visitor's email.")
+        self.assertEqual(channel.message_ids[0].body, "<p>Message from Visitor</p>")
+        self.assertEqual(channel.livechat_active, True, "The livechat session must be active as the visitor did not left the conversation yet.")
+
+        # Post message from operator
+        self._send_message(channel, self.operator.email, "Message from Operator", author_id=self.operator.partner_id.id)
+
+        self.assertEqual(len(channel.message_ids), 2)
+        self.assertEqual(channel.message_ids[0].author_id, self.operator.partner_id, "The author of the message should be the operator.")
+        self.assertEqual(channel.message_ids[0].email_from, self.operator.email, "The sender's email should be the operator's email.")
+        self.assertEqual(channel.message_ids[0].body, "<p>Message from Operator</p>")
+        self.assertEqual(channel.livechat_active, True, "The livechat session must be active as the visitor did not left the conversation yet.")
+
+        return channel
diff --git a/addons/website_livechat/tests/test_livechat_request.py b/addons/website_livechat/tests/test_livechat_request.py
new file mode 100644
index 00000000..f50780da
--- /dev/null
+++ b/addons/website_livechat/tests/test_livechat_request.py
@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import tests
+from odoo.addons.website_livechat.tests.common import TestLivechatCommon
+
+
+@tests.tagged('post_install', '-at_install')
+class TestLivechatRequestHttpCase(tests.HttpCase, TestLivechatCommon):
+    def test_livechat_request_complete_flow(self):
+        self._clean_livechat_sessions()
+
+        # Send first chat request - Open chat from operator side
+        channel_1 = self._common_chat_request_flow()
+        # Visitor Rates the conversation (Good)
+        self._send_rating(channel_1, self.visitor, 5)
+
+        # Operator Re-Send a chat request
+        channel_2 = self._common_chat_request_flow()
+        # Visitor Rates the conversation (Bad)
+        self._send_rating(channel_2, self.visitor, 1, "Stop bothering me! I hate you </3 !")
+
+    def test_cancel_chat_request_on_visitor_demand(self):
+        self._clean_livechat_sessions()
+
+        self.operator_b = self.env['res.users'].create({
+            'name': 'Operator Marc',
+            'login': 'operator_b',
+            'email': 'operatormarc@example.com',
+            'password': "operatormarc",
+            'livechat_username': "Marco'r El",
+        })
+
+        # Open Chat Request
+        self.visitor.with_user(self.operator_b).action_send_chat_request()
+        chat_request = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)])
+        self.assertEqual(chat_request.livechat_operator_id, self.operator_b.partner_id, "Operator for active livechat session must be Operator Marc")
+
+        # Click on livechatbutton at client side
+        res = self.opener.post(url=self.open_chat_url, json=self.open_chat_params)
+        self.assertEqual(res.status_code, 200)
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id),
+                                                   ('livechat_active', '=', True)])
+
+        # Check that the chat request has been canceled.
+        chat_request.invalidate_cache()
+        self.assertEqual(chat_request.livechat_active, False, "The livechat request must be inactive as the visitor started himself a livechat session.")
+        self.assertEqual(len(channel), 1)
+        self.assertEqual(channel.livechat_operator_id, self.operator.partner_id, "Operator for active livechat session must be Michel Operator")
+
+    def _common_chat_request_flow(self):
+        self.visitor.with_user(self.operator).action_send_chat_request()
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)])
+        self.assertEqual(len(channel), 1)
+        self.assertEqual(channel.livechat_operator_id, self.operator.partner_id, "Michel Operator should be the operator of this channel.")
+        self.assertEqual(len(channel.message_ids), 0)
+
+        # Operator Sends message
+        self._send_message(channel, self.operator.email, "Hello Again !", author_id=self.operator.partner_id.id)
+        self.assertEqual(len(channel.message_ids), 1)
+
+        # Visitor Answers
+        self._send_message(channel, self.visitor.display_name, "Answer from Visitor")
+        self.assertEqual(len(channel.message_ids), 2)
+
+        # Visitor Leave the conversation
+        channel._close_livechat_session()
+        self.assertEqual(len(channel.message_ids), 3)
+        self.assertEqual(channel.message_ids[0].author_id, self.env.ref('base.partner_root'), "Odoobot must be the sender of the 'has left the conversation' message.")
+        self.assertEqual(channel.message_ids[0].body, "<p>%s has left the conversation.</p>" % self.visitor.display_name)
+        self.assertEqual(channel.livechat_active, False, "The livechat session must be inactive as the visitor sent his feedback.")
+
+        return channel
+
+    def _clean_livechat_sessions(self):
+        # clean every possible mail channel linked to the visitor
+        active_channels = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor.id), ('livechat_active', '=', True)])
+        for active_channel in active_channels:
+            active_channel._close_livechat_session()
diff --git a/addons/website_livechat/tests/test_ui.py b/addons/website_livechat/tests/test_ui.py
new file mode 100644
index 00000000..cf8336c1
--- /dev/null
+++ b/addons/website_livechat/tests/test_ui.py
@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import tests, _
+from odoo.addons.website_livechat.tests.common import TestLivechatCommon
+
+
+@tests.tagged('post_install', '-at_install')
+class TestLivechatUI(tests.HttpCase, TestLivechatCommon):
+    def setUp(self):
+        super(TestLivechatUI, self).setUp()
+        self.visitor_tour = self.env['website.visitor'].create({
+            'name': 'Visitor Tour',
+            'website_id': self.env.ref('website.default_website').id,
+        })
+        self.target_visitor = self.visitor_tour
+
+    def test_complete_rating_flow_ui(self):
+        self.start_tour("/", 'website_livechat_complete_flow_tour')
+        self._check_end_of_rating_tours()
+
+    def test_happy_rating_flow_ui(self):
+        self.start_tour("/", 'website_livechat_happy_rating_tour')
+        self._check_end_of_rating_tours()
+
+    def test_ok_rating_flow_ui(self):
+        self.start_tour("/", 'website_livechat_ok_rating_tour')
+        self._check_end_of_rating_tours()
+
+    def test_bad_rating_flow_ui(self):
+        self.start_tour("/", 'website_livechat_sad_rating_tour')
+        self._check_end_of_rating_tours()
+
+    def test_no_rating_flow_ui(self):
+        self.start_tour("/", 'website_livechat_no_rating_tour')
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id)])
+        self.assertEqual(len(channel), 1, "There can only be one channel created for 'Visitor Tour'.")
+        self.assertEqual(channel.livechat_active, False, 'Livechat must be inactive after closing the chat window.')
+
+    def test_no_rating_no_close_flow_ui(self):
+        self.start_tour("/", 'website_livechat_no_rating_no_close_tour')
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id)])
+        self.assertEqual(len(channel), 1, "There can only be one channel created for 'Visitor Tour'.")
+        self.assertEqual(channel.livechat_active, True, 'Livechat must be active while the chat window is not closed.')
+
+    def test_empty_chat_request_flow_no_rating_no_close_ui(self):
+        # Open an empty chat request
+        self.visitor_tour.with_user(self.operator).action_send_chat_request()
+        chat_request = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id), ('livechat_active', '=', True)])
+
+        # Visitor ask a new livechat session before the operator start to send message in chat request session
+        self.start_tour("/", 'website_livechat_no_rating_no_close_tour')
+
+        # Visitor's session must be active (gets the priority)
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id), ('livechat_active', '=', True)])
+        self.assertEqual(len(channel), 1, "There can only be one channel created for 'Visitor Tour'.")
+        self.assertEqual(channel.livechat_active, True, 'Livechat must be active while the chat window is not closed.')
+
+        # Check that the chat request has been canceled.
+        chat_request.invalidate_cache()
+        self.assertEqual(chat_request.livechat_active, False, "The livechat request must be inactive as the visitor started himself a livechat session.")
+
+    def test_chat_request_flow_with_rating_ui(self):
+        # Open a chat request
+        self.visitor_tour.with_user(self.operator).action_send_chat_request()
+        chat_request = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id), ('livechat_active', '=', True)])
+
+        # Operator send a message to the visitor
+        self._send_message(chat_request, self.operator.email, "Hello my friend !", author_id=self.operator.partner_id.id)
+        self.assertEqual(len(chat_request.message_ids), 1, "Number of messages incorrect.")
+
+        # Visitor comes to the website and receives the chat request
+        self.start_tour("/", 'website_livechat_chat_request_part_1_no_close_tour')
+
+        # Check that the current session is the chat request
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=', self.visitor_tour.id), ('livechat_active', '=', True)])
+        self.assertEqual(len(channel), 1, "There can only be one channel created for 'Visitor Tour'.")
+        self.assertEqual(channel, chat_request, "The active livechat session must be the chat request one.")
+
+        # Visitor reload the page and continues the chat with the operator normally
+        self.start_tour("/", 'website_livechat_chat_request_part_2_end_session_tour')
+        self._check_end_of_rating_tours()
+
+    def _check_end_of_rating_tours(self):
+        channel = self.env['mail.channel'].search([('livechat_visitor_id', '=',  self.visitor_tour.id)])
+        self.assertEqual(len(channel), 1, "There can only be one channel created for 'Visitor Tour'.")
+        self.assertEqual(channel.livechat_active, False, 'Livechat must be inactive after rating.')