Test case skip documentation

Optimizing Odoo Testing with Test Skip Documentation


​In software development, testing plays a crucial role in ensuring the quality and reliability of the product. Odoo, a popular open-source ERP system, is no exception. When working on an Odoo project, it's essential to have an efficient and well-documented testing process. One useful technique is leveraging test skip documentation, which allows you to skip certain tests temporarily while maintaining a record of the reasons behind skipping them. In this blog post, we will explore how you can utilize test skip documentation in Python for Odoo testing, along with some practical examples.

Why Use Test Skip Documentation?

  • Flexibility: During the development cycle, there may be instances where certain tests become irrelevant or need to be temporarily skipped due to various reasons such as incomplete features, dependencies, or known issues. Test skip documentation provides a flexible way to skip tests without losing track of why they were skipped.
  • Collaboration:  When working in a team, test skip documentation helps in communicating the reasons for skipping tests to other developers or quality assurance personnel. It ensures that everyone is on the same page and avoids confusion or duplication of efforts.
  • Regression Testing: When the skipped tests are ready to be re-enabled, having proper documentation saves time by providing insights into why they were initially skipped. This information helps in performing targeted regression testing, ensuring that the reintroduction of the skipped tests does not introduce any unexpected issues.

Implementing Test Skip Documentation in Python for Odoo:

Using the @skip decorator: Python provides the unit test module for writing tests. You can utilize the @skip decorator to mark individual test cases or test classes for skipping. Here's an example:

import unittest

class MyTestCase(unittest.TestCase):

@unittest.skip("Reason: This test is currently incomplete")
def test_something(self):
# Test logic goes here

def test_another_thing(self):
# Test logic goes here

In this example, the test_something method is temporarily skipped using the @skip decorator with a reason provided. The test_another_thing method will still be executed.

Utilizing custom annotations: Odoo allows you to create custom test decorators or annotations to provide more context-specific skipping. Here's an example:

from odoo.tests.common import TransactionCase
from odoo.tools import mute_logger

def skip_incomplete_test(method):
"""Decorator to skip incomplete test cases."""
return method

class MyTestCase(TransactionCase):

def test_something(self):
# Test logic goes here

def test_another_thing(self):
# Test logic goes here

In this example, the custom skip_incomplete_test decorator is used to skip tests specifically related to the 'module_name' Odoo module. The decorator suppresses log messages from that module during test execution.

How do skip methods of core ODOO from particular modules?

  • You can also skip the method from the core ODOO test cases.
  • Also, use for avoiding the test methods.

To skip the test method follow the below steps:

​- Create a new 'test_case_skip.py' file in the tests folder and import it to the __init__.py.


from odoo.addons.$MODULE_NAME.tests.$TEST_FILENAME import $CLASSNAME
$CLASSNAME.$METHOD_NAME = lambda self: None

You can also skip the multiple test method in one file.


  • If you are using the skip test case make sure you skip the test method of that module that is added in depending on your custom module.
  •  The sequence also matters when you skip the test case methods.

Share this post
Coding standards for odoo modules
Importance of Coding Standards in Collaborative Software Development