OCA / reporting-engine / 54

pending completion

Build # 54

Build Type

Pull #21

travis-ci

Committed by

Yajo

Commit Message

<a href="https://github.com/OCA/reporting-engine/commit/<a class=hub.com/OCA/reporting-engine/commit/8c55c9207716ad0540c12e6687db2b45db52fc0d">8c55c9207<a href="https://github.com/OCA/reporting-engine/commit/8c55c9207716ad0540c12e6687db2b45db52fc0d">&quot;&gt;Clean AGPL garbage preserving copyright.

See https://github.com/odoo/odoo/commit/</a><a class="double-link" href="https://github.com/OCA/reporting-engine/commit/<a class="double-link" href="https://github.com/OCA/reporting-engine/commit/0bd454534818941bc3216025ebe3dcac3d78c19d">0bd454534</a>">0bd454534</a><a href="https://github.com/OCA/reporting-engine/commit/8c55c9207716ad0540c12e6687db2b45db52fc0d">.

Pull Request Pull Request #21: Report xml

Run Details

71 of 71 new or added lines in 3 files covered. (100.0%)

87 of 249 relevant lines covered (34.94%)

0.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

43.14

/report_xml/models.py

# -*- encoding: utf-8 -*-
# Copyright (C) 2014-2015  Grupo ESOC <www.grupoesoc.es>

import logging
from lxml import etree
from openerp import api, fields, models


_logger = logging.getLogger(__name__)


class ReportAction(models.Model):
    _inherit = "ir.actions.report.xml"

    report_type = fields.Selection(selection_add=[("qweb-xml", "XML")])

    def _lookup_report(self, cr, name):
        """Enable ``qweb-xml`` report lookup."""
        try:
            super(ReportAction, self)._lookup_report(cr, name)
        except Exception as ex:
            # Somebody thought it was a good idea to use standard exceptions
            if "qweb-xml" not in ex.message:
                raise ex
            else:
                cr.execute(
                    "SELECT * FROM ir_act_report_xml WHERE report_name=%s",
                    (name,))
                return cr.dictfetchone()["report_name"]

    @api.model
    def render_report(self, res_ids, name, data):
        """Special handling for ``qweb-xml`` reports."""
        if data.get("report_type") == u"qweb-xml":
            new_report = self._lookup_report(name)
            recs = self.env[self.env.context["active_model"]].browse(res_ids)
            result = self.env["report"].get_html(recs, new_report, data=data)

            # XML with spaces before the <?xml tag will fail, and trailing ones
            # do nothing, so let's strip them and make everyone happier
            result = (result.strip(), "xml")
        else:
            result = super(ReportAction, self).render_report(
                res_ids, name, data)

        return result


class ReportGenerator(models.Model):
    _inherit = "report"

    @api.model
    def _get_report_from_name(self, report_name):
        """Allow to view ``qweb-xml`` reports as web pages."""
        try:
            super(ReportGenerator, self)._get_report_from_name(report_name)
        except IndexError:
            return self.env["ir.actions.report.xml"].search(
                [("report_type", "=", "qweb-xml"),
                 ("report_name", "=", report_name)])[0]


class XSDCheckedReport(models.AbstractModel):
    """Check XML report against a XSD schema before downloading it.

    This is an Abstract Model to be inherited by the real report models, which
    must implement :meth:`.xsd` and have a ``_name`` in the form
    ``report.<module>.<report_name>``.
    """
    _name = "report_xml.xsd_checked_report"
    _description = "Base model for reports that need XSD checking"

    @api.multi
    def xsd(self):
        """Return the XSD schema contents."""
        raise NotImplementedError

    @api.multi
    def render_html(self, data=None):
        """Return the XML report after checking it against an XSD.

        If ``context`` contains a dict called ``docargs``, it will be used as
        the Qweb context. The special key ``docs`` will be added to ``docargs``
        automatically if missing.
        """
        # Qweb context
        docargs = self.env.context.get("docargs", dict())
        if "docs" not in docargs:
            docargs["docs"] = (self.env[self.env.context["active_model"]]
                               .browse(self.env.context["active_ids"]))

        # Load XSD
        xsd = etree.XML(self.xsd())
        _logger.debug("XSD schema contents: %s", etree.tostring(xsd))
        xsd = etree.XMLSchema(xsd)
        parser = etree.XMLParser(schema=xsd)

        # Generate XML report
        result = (self.env["report"]
                  .render(self._name[len("report."):], docargs)
                  .strip())

        # Validate XML with XSD
        try:
            etree.fromstring(result, parser)
        except Exception as error:
            _logger.error(result)
            raise error

        return result

1	# -- encoding: utf-8 --
2	# Copyright (C) 2014-2015 Grupo ESOC <www.grupoesoc.es>
3
4	import logging	2✔
5	from lxml import etree	2✔
6	from openerp import api, fields, models	2✔
7
8
9	_logger = logging.getLogger(__name__)	2✔
10
11
12	class ReportAction(models.Model):	2✔
13	_inherit = "ir.actions.report.xml"	2✔
14
15	report_type = fields.Selection(selection_add=[("qweb-xml", "XML")])	2✔
16
17	def _lookup_report(self, cr, name):	2✔
18	"""Enable ``qweb-xml`` report lookup."""
19	try:	×
20	super(ReportAction, self)._lookup_report(cr, name)	×
21	except Exception as ex:	×
22	# Somebody thought it was a good idea to use standard exceptions
23	if "qweb-xml" not in ex.message:	×
24	raise ex	×
25	else:
26	cr.execute(	×
27	"SELECT * FROM ir_act_report_xml WHERE report_name=%s",
28	(name,))
29	return cr.dictfetchone()["report_name"]	×
30
31	@api.model	2✔
32	def render_report(self, res_ids, name, data):
33	"""Special handling for ``qweb-xml`` reports."""
34	if data.get("report_type") == u"qweb-xml":	×
35	new_report = self._lookup_report(name)	×
36	recs = self.env[self.env.context["active_model"]].browse(res_ids)	×
37	result = self.env["report"].get_html(recs, new_report, data=data)	×
38
39	# XML with spaces before the <?xml tag will fail, and trailing ones
40	# do nothing, so let's strip them and make everyone happier
41	result = (result.strip(), "xml")	×
42	else:
43	result = super(ReportAction, self).render_report(	×
44	res_ids, name, data)
45
46	return result	×
47
48
49	class ReportGenerator(models.Model):	2✔
50	_inherit = "report"	2✔
51
52	@api.model	2✔
53	def _get_report_from_name(self, report_name):
54	"""Allow to view ``qweb-xml`` reports as web pages."""
55	try:	2✔
56	super(ReportGenerator, self)._get_report_from_name(report_name)	2✔
57	except IndexError:	2✔
58	return self.env["ir.actions.report.xml"].search(	2✔
59	[("report_type", "=", "qweb-xml"),
60	("report_name", "=", report_name)])[0]
61
62
63	class XSDCheckedReport(models.AbstractModel):	2✔
64	"""Check XML report against a XSD schema before downloading it.
65
66	This is an Abstract Model to be inherited by the real report models, which
67	must implement :meth:`.xsd` and have a ``_name`` in the form
68	``report.<module>.<report_name>``.
69	"""
70	_name = "report_xml.xsd_checked_report"	2✔
71	_description = "Base model for reports that need XSD checking"	2✔
72
73	@api.multi	2✔
74	def xsd(self):
75	"""Return the XSD schema contents."""
76	raise NotImplementedError	×
77
78	@api.multi	2✔
79	def render_html(self, data=None):	2✔
80	"""Return the XML report after checking it against an XSD.
81
82	If ``context`` contains a dict called ``docargs``, it will be used as
83	the Qweb context. The special key ``docs`` will be added to ``docargs``
84	automatically if missing.
85	"""
86	# Qweb context
87	docargs = self.env.context.get("docargs", dict())	×
88	if "docs" not in docargs:	×
89	docargs["docs"] = (self.env[self.env.context["active_model"]]	×
90	.browse(self.env.context["active_ids"]))
91
92	# Load XSD
93	xsd = etree.XML(self.xsd())	×
94	_logger.debug("XSD schema contents: %s", etree.tostring(xsd))	×
95	xsd = etree.XMLSchema(xsd)	×
96	parser = etree.XMLParser(schema=xsd)	×
97
98	# Generate XML report
99	result = (self.env["report"]	×
100	.render(self._name[len("report."):], docargs)
101	.strip())
102
103	# Validate XML with XSD
104	try:	×
105	etree.fromstring(result, parser)	×
106	except Exception as error:	×
107	_logger.error(result)	×
108	raise error	×
109
110	return result	×

OCA / reporting-engine / 54

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous