[ADD] util/report: util.add_report

[diagnoza]

Add a new function that replaces util.add_to_migration_reports.

The new function can automatically parse the provided data as a list of records. It can also limit the number of displayed records to prevent the upgrade report from growing too large.

The structure of the note is now defined within the function itself, standardizing its appearance.

Example usage

More examples will follow in odoo/upgrade, replacing the existing use of util.add_to_migration_reports.

Example 1

cr.execute(
        """
        SELECT p.id, p.name, p.city, p.comment, p.company_id, com.name FROM res_partner p
          JOIN res_company com
            ON p.company_id = com.id
        """
    )

summary = """
    This is a test of the utility method that is displaying a list of rows
    returned by an SQL query. The number of displayed rows is limited.
    """
row_format = "Partner with id {partner_link} works at company {company_link} in {city}, ({comment})"
columns = ("id", "name", "city", "comment", "company_id", "company_name")
links = {"company_link": ("res.company", "company_id", "company_name"), "partner_link": ("res.partner", "id", "name")}
util.add_report(header="Test of the new utility method", summary=summary, row_format=row_format, columns=columns, links=links, data=cr.fetchall())

Example 2

util.add_report(header="Simple note", summary="A detailed description of the change.")

Example 3

msg = """
This is some text in **bold**.  

This is a line  
that should break.

- Item one
- Item two
    - Sub-item

And some _italic_ text.
"""
util.add_report(header="MD note", summary=msg, report_format="md")

Example 4

msg = """
This is some text in **bold**.

| This is a line
| that should break.

* Item one
* Item two

  * Sub-item

And some *italic* text.
"""
util.add_report(header="RST note", summary=msg, report_format="rst")

Remaining details to discuss

1. The introduction of env var to control limit.
2. Enforce/assert the use of tuples instead of lists. Currently, it's possible to pass a list for columns (instead of a tuple) or a dictionary of lists for links (instead of a dictionary of tuples).
3. How to handle depreciation of add_to_migration_reports.
4. Indentation of the ir.ui.view record corresponding to the note is sometimes incorrect (previously there was the same issue):

[robodoo]

[KangOl]

upgradeci retry with always only crm

[aj-fuentes]

I think we can do some simplification here. Some suggestions below. Note that none of the suggestions were tested, take it as a guide.

[aj-fuentes]

Looks better. Please adapt the documentation to the same format we use elsewhere in this repo. Some suggestions above.

[KangOl]

It will fail. column doesn't have the expected type.

(a.k.a tests are missing)

[KangOl]

If we want to promote the usage of this new function, I would rename the function, so it appears with the good name in documentation, and alias the old name for compatibility.

Suggested change

	report = add_to_migration_reports
	add_to_migration_reports = report

[diagnoza]

I had to pass the default arguments as regular ones, because of how the tested method is called in test_report_with_list. Simply leaving them out would obviously result in

Traceback (most recent call last):
  File "/home/odoo/src/upgrade-util/src/testing.py", line 174, in wrapped
    return func(self, *args)
TypeError: TestReportUtils.test_report_with_list() missing 2 required positional arguments: 'category' and 'expected'

Passing them as None also wouldn't work, because since Python differentiates between "no argument passed" and None, they would actually be set to None instead of taking the default value. And if we pass category=None, then add_to_migration_reports will break on running len(None).