Florian Charlier
2c4bb38835
This technical module can be used to configure onboarding panels flows at company or global level (required for new Appointment onboarding, see ENT PR). This implementation, which should be able to support the migration of the other onboardings, separates the closed state from the completion state (allowing to know that steps are not completed even though the panel is closed). Basic tree and form view are included. Adding an onboarding with this module requires to provide records data for the models: - `onboarding.onboarding` + action to close the panel - `onboarding.onboarding.step` + actions for the 'opening' and 'saving' of each step. See related ENT PR for the `appointment` example, in particular `onboarding_data.xml` and `onboarding_onboarding.py` Several python tests are also included. Misc. In base, we slightly refresh the wording/style of the modal closing the onboarding panel. Task-2852375 Part of Task-2900763 Part-of: odoo/odoo#97105
133 lines
6.4 KiB
Python
133 lines
6.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
from odoo.addons.onboarding.tests.common import TestOnboardingCommon
|
|
|
|
|
|
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.onboarding_1_step_1.action_set_just_done()
|
|
# 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.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_id': self.onboarding_1.id,
|
|
'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_id': self.onboarding_1.id,
|
|
'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 to per-company
|
|
self.onboarding_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.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
|
|
self.assert_step_is_not_done(self.onboarding_1_step_1)
|
|
self.assert_onboarding_is_not_done(self.onboarding_1)
|
|
|
|
# But no change for company 1
|
|
self.assert_step_is_done(self.onboarding_1_step_1.with_company(self.company_1))
|
|
self.assert_onboarding_is_done(self.onboarding_1.with_company(self.company_1))
|
|
|
|
self.onboarding_1_step_1.action_set_just_done()
|
|
self.assert_step_is_done(self.onboarding_1_step_1)
|
|
self.assert_onboarding_is_not_done(self.onboarding_1)
|
|
self.onboarding_1_step_2.with_company(self.company_2).action_set_just_done()
|
|
self.assert_step_is_done(self.onboarding_1_step_2)
|
|
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 onboarding to per-company resets completions 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 to per-company
|
|
self.onboarding_1.is_per_company = True
|
|
# Required after progress reset (simulate role of controller)
|
|
self.onboarding_1._search_or_create_progress()
|
|
|
|
self.assert_onboarding_is_not_done(self.onboarding_1)
|