# -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. from psycopg2 import IntegrityError from odoo import Command from odoo.addons.onboarding.tests.common import TestOnboardingCommon from odoo.exceptions import ValidationError from odoo.tools import mute_logger class TestOnboarding(TestOnboardingCommon): def test_onboarding_completion_global(self): # Completing onboarding as company_1 self.assertEqual(self.env.company, self.company_1) self.assertDictEqual( self.onboarding_1.current_progress_id._get_and_update_onboarding_state(), {self.onboarding_1_step_1.id: 'not_done', self.onboarding_1_step_2.id: 'not_done'}) self.assertEqual(self.onboarding_1_step_1.action_set_just_done(), self.onboarding_1_step_1, "The onboarding step just validated should have been returned.") # Test completed step state consolidation from `just_done` to `done` self.assertDictEqual( self.onboarding_1.current_progress_id._get_and_update_onboarding_state(), {self.onboarding_1_step_1.id: 'just_done', self.onboarding_1_step_2.id: 'not_done'}) self.assertDictEqual( self.onboarding_1.current_progress_id._get_and_update_onboarding_state(), {self.onboarding_1_step_1.id: 'done', self.onboarding_1_step_2.id: 'not_done'}) self.assert_step_is_done(self.onboarding_1_step_1, self.company_2) self.assertFalse(self.onboarding_1_step_1.action_set_just_done(), "The onboarding step already validated should not have been returned.") self.assert_onboarding_is_not_done(self.onboarding_1, self.company_2) self.onboarding_1_step_2.action_set_just_done() self.assert_step_is_done(self.onboarding_1_step_2, self.company_2) self.assert_onboarding_is_done(self.onboarding_1, self.company_2) # Once onboarding is done, a key 'onboarding_state' is added to the rendering values self.assertDictEqual( self.onboarding_1.current_progress_id._get_and_update_onboarding_state(), {self.onboarding_1_step_1.id: 'done', self.onboarding_1_step_2.id: 'just_done', 'onboarding_state': 'just_done'}) # Consolidate values self.assertDictEqual( self.onboarding_1.current_progress_id._get_and_update_onboarding_state(), {self.onboarding_1_step_1.id: 'done', self.onboarding_1_step_2.id: 'done', 'onboarding_state': 'done'}) self.onboarding_1.current_progress_id.action_close() self.assertTrue(self.onboarding_1.current_progress_id.is_onboarding_closed) # Adding new step resets onboarding state to 'not_done' even if closed onboarding_1_step_3 = self.env['onboarding.onboarding.step'].create({ 'title': 'Test Onboarding 1 - Step 3', 'onboarding_ids': [self.onboarding_1.id], 'is_per_company': False, 'panel_step_open_action_name': 'action_fake_open_onboarding_step', }) self.assert_step_is_not_done(onboarding_1_step_3) self.assert_onboarding_is_not_done(self.onboarding_1) # Completing it sets onboarding state to done again onboarding_1_step_3.action_set_just_done() self.assert_onboarding_is_done(self.onboarding_1) # If a company is added, onboarding is 'done' company_3 = self.env.company.create({ 'currency_id': self.env.ref('base.EUR').id, 'name': 'Another Test Company', }) self.assert_onboarding_is_done(self.onboarding_1.with_company(company_3)) # Adding new step resets onboarding state to 'not_done' self.env['onboarding.onboarding.step'].create({ 'title': 'Test Onboarding 1 - Step 4', 'onboarding_ids': [self.onboarding_1.id], 'is_per_company': False, 'panel_step_open_action_name': 'action_fake_open_onboarding_step', }) # Closing the panel still allows to track if all steps are completed self.onboarding_1.action_close() self.assertTrue(self.onboarding_1.current_progress_id.is_onboarding_closed) self.assert_onboarding_is_not_done(self.onboarding_1) def test_onboarding_completion_per_company(self): """Checks the behavior of onboarding and step states in multi-company setting: the onboarding state has to track the completion of each of its steps, global and per-company, to determine if whether it is completed. """ # Completing onboarding as company_1 self.assertEqual(self.env.company, self.company_1) # Updating onboarding (and steps) to per-company self.onboarding_1_step_1.is_per_company = True # Required after progress reset (simulate role of controller) self.onboarding_1._search_or_create_progress() self.onboarding_1_step_1.action_set_just_done() self.assert_step_is_done(self.onboarding_1_step_1) self.assertFalse(self.onboarding_1_step_2.is_per_company) self.onboarding_1_step_2.action_set_just_done() self.assert_onboarding_is_done(self.onboarding_1) # Completing onboarding as existing company_2 self.activate_company(self.company_2) # First access from company_2 self.onboarding_1._search_or_create_progress() # Blank state for company 2 for step 1 self.assert_step_is_not_done(self.onboarding_1_step_1) # But step 2 is done self.assert_step_is_done(self.onboarding_1_step_2) self.assert_onboarding_is_not_done(self.onboarding_1) self.onboarding_1_step_1.action_set_just_done() self.assert_step_is_done(self.onboarding_1_step_1) self.assert_onboarding_is_done(self.onboarding_1) # is_onboarding_closed status is also company-independent self.onboarding_1.action_close() self.assertTrue(self.onboarding_1.current_progress_id.is_onboarding_closed) self.assertFalse(self.onboarding_1.with_company(self.company_1).current_progress_id.is_onboarding_closed) def test_onboarding_to_company_change(self): """ Checks that changing an onboarding step to per-company resets completion states.""" # Completing onboarding as company_1 self.assertEqual(self.env.company, self.company_1) self.onboarding_1_step_1.action_set_just_done() self.onboarding_1_step_2.action_set_just_done() self.assert_onboarding_is_done(self.onboarding_1) # Updating onboarding step 1 to per-company self.onboarding_1_step_1.is_per_company = True self.assertTrue(self.onboarding_1.is_per_company) # Required after progress reset (simulate role of controller) self.onboarding_1._search_or_create_progress() self.assert_onboarding_is_not_done(self.onboarding_1) def test_onboarding_shared_steps(self): self.onboarding_2_step_2.action_set_just_done() self.assert_step_is_done(self.onboarding_2_step_2) # Completing common step is also required to be "done" self.assert_onboarding_is_not_done(self.onboarding_2) self.onboarding_1_step_1.action_set_just_done() self.assert_onboarding_is_not_done(self.onboarding_1) self.assert_onboarding_is_done(self.onboarding_2) @mute_logger('odoo.sql_db') def test_progress_no_company_uniqueness(self): """Check that there cannot be two progress records created for the same onboarding when it is configured to be completed only once for the whole db and not per-company (is_per_company=False). NB: Postgresql UNIQUE constraint failures raise IntegrityErrors. """ self.assertFalse(self.onboarding_1.current_progress_id.company_id) with self.assertRaises(IntegrityError): self.env['onboarding.progress'].create({ 'onboarding_id': self.onboarding_1.id, 'company_id': False }) @mute_logger('odoo.sql_db') def test_progress_per_company_uniqueness(self): """Check that there cannot be two progress records created for the same company and the same onboarding when the onboarding is configured to be completed per-company. See also ``test_progress_no_company_uniqueness`` """ # Updating onboarding to per-company self.onboarding_1_step_1.is_per_company = True # Create an onboarding_progress (simulate role of controller) self.onboarding_1._search_or_create_progress() with self.assertRaises(IntegrityError): self.env['onboarding.progress'].create({ 'onboarding_id': self.onboarding_1.id, 'company_id': self.env.company.id }) def test_onboarding_step_without_onboarding(self): self.step_initially_w_o_onboarding = self.env['onboarding.onboarding.step'].create({ 'title': 'Step Initially Without Onboarding', }) self.assertEqual(self.step_initially_w_o_onboarding.current_step_state, 'not_done') self.step_initially_w_o_onboarding.action_set_just_done() self.assert_step_is_done(self.step_initially_w_o_onboarding) self.onboarding_3 = self.env['onboarding.onboarding'].create({ 'name': 'Test Onboarding 3', 'route_name': 'onboarding3', }) self.onboarding_3._search_or_create_progress() with self.assertRaises(ValidationError): self.step_initially_w_o_onboarding.onboarding_ids = [Command.link(self.onboarding_3.id)] self.step_initially_w_o_onboarding.write({ 'panel_step_open_action_name': 'action_fake_open_onboarding_step' }) self.step_initially_w_o_onboarding.onboarding_ids = [Command.link(self.onboarding_3.id)] with self.subTest('Progress records are recreated for companies with completed steps'): # Onboarding is done as only step was already done by company 1 self.assert_onboarding_is_done(self.onboarding_3) # Not by company 2 self.onboarding_3.with_company(self.company_2)._search_or_create_progress() self.assert_onboarding_is_not_done(self.onboarding_3.with_company(self.company_2)) # But it can self.step_initially_w_o_onboarding.with_company(self.company_2).action_set_just_done() self.assert_onboarding_is_done(self.onboarding_3.with_company(self.company_2))