# Convert ACDB file into UCDB file (XML format)
+acdb2xml -i aggregate.acdb -o ucdb.xml
+
+# Convert UCDB file into Cobertura format
+pyedaa-ucis export --ucdb ucdb.xml --cobertura cobertura.xml
+Note
+Branch coverage isn’t supported yet.
+‘pyEDAA.UCIS Service Program’ to query and transform data to/from UCIS to any other format.
+usage: pyedaa-ucis {help,version,export} ...
+Cobertura (statement coverage - Java oriented format)
Export data from UCDB.
+usage: pyedaa-ucis export [-h] [--ucdb UCDBFile] [--cobertura CoberturaFile]
+ [--merge-instances]
+show this help message and exit
+UCDB file in UCIS format (XML).
+Cobertura code coverage file (XML).
+Merge statement coverage data for all instances of the same design unit.
+Display help page(s) for the given command name.
+usage: pyedaa-ucis help [-h] [Command]
+Print help page(s) for a command.
+show this help message and exit
+Display version information.
+usage: pyedaa-ucis version [-h]
+show this help message and exit
+| + | + |
|---|---|
Package |
+Version |
+License |
+Dependencies |
+
|---|---|---|---|
| + | ≥1.9.5 |
++ | None |
+
| + | ≥2.5.1 |
++ | + | +
Additional Python packages needed for testing, code coverage collection and static type checking. These packages are +only needed for developers or on a CI server, thus sub-dependencies are not evaluated further.
+Manually Installing Test Requirements
+Use the tests/requirements.txt file to install all dependencies via pip3. The file will recursively install
+the mandatory dependencies too.
pip3 install -U -r tests/requirements.txt
+Dependency List
+Package |
+Version |
+License |
+Dependencies |
+
|---|---|---|---|
| + | ≥7.0.1 |
++ | Not yet evaluated. |
+
| + | ≥3.0.0 |
++ | Not yet evaluated. |
+
| + | ≥6.3 |
++ | Not yet evaluated. |
+
| + | ≥0.931 |
++ | Not yet evaluated. |
+
| + | ≥4.8 |
++ | Not yet evaluated. |
+
Additional Python packages needed for documentation generation. These packages are only needed for developers or on a +CI server, thus sub-dependencies are not evaluated further.
+Manually Installing Documentation Requirements
+Use the doc/requirements.txt file to install all dependencies via pip3. The file will recursively install
+the mandatory dependencies too.
pip3 install -U -r doc/requirements.txt
+Dependency List
+Package |
+Version |
+License |
+Dependencies |
+
|---|---|---|---|
| + | ≥1.9.5 |
++ | None |
+
| + | ≥4.4.0 |
++ | Not yet evaluated. |
+
| + | ≥0.5.2 |
++ | Not yet evaluated. |
+
| + | ≥0.0.6 |
++ | Not yet evaluated. |
+
| + | ≥1.17.0 |
++ | Not yet evaluated. |
+
Additional Python packages needed for installation package generation. These packages are only needed for developers or +on a CI server, thus sub-dependencies are not evaluated further.
+Manually Installing Packaging Requirements
+Use the build/requirements.txt file to install all dependencies via pip3. The file will recursively
+install the mandatory dependencies too.
pip3 install -U -r build/requirements.txt
+Dependency List
+Package |
+Version |
+License |
+Dependencies |
+
|---|---|---|---|
| + | ≥1.9.5 |
++ | None |
+
| + | any |
++ | Not yet evaluated. |
+
Additional Python packages needed for publishing the generated installation package to e.g, PyPI or any equivalent +services. These packages are only needed for maintainers or on a CI server, thus sub-dependencies are not evaluated +further.
+Manually Installing Publishing Requirements
+Use the dist/requirements.txt file to install all dependencies via pip3. The file will recursively
+install the mandatory dependencies too.
pip3 install -U -r dist/requirements.txt
+Dependency List
+Package |
+Version |
+License |
+Dependencies |
+
|---|---|---|---|
| + | any |
++ | Not yet evaluated. |
+
| + | any |
++ | Not yet evaluated. |
+
Note
+This is a local copy of the Creative Commons - Attribution 4.0 International (CC BY 4.0).
+Attention
+This CC BY 4.0 license applies only to the documentation of this project.
+Creative Commons Corporation (“Creative Commons”) is not a law firm and does not +provide legal services or legal advice. Distribution of Creative Commons public +licenses does not create a lawyer-client or other relationship. Creative Commons +makes its licenses and related information available on an “as-is” basis. +Creative Commons gives no warranties regarding its licenses, any material +licensed under their terms and conditions, or any related information. Creative +Commons disclaims all liability for damages resulting from their use to the +fullest extent possible.
+ +Creative Commons Attribution 4.0 International Public License
+By exercising the Licensed Rights (defined below), You accept and agree to be +bound by the terms and conditions of this Creative Commons Attribution 4.0 +International Public License (“Public License”). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions.
+Adapted Material means material subject to Copyright and Similar +Rights that is derived from or based upon the Licensed Material and in +which the Licensed Material is translated, altered, arranged, transformed, or +otherwise modified in a manner requiring permission under the Copyright and +Similar Rights held by the Licensor. For purposes of this Public License, +where the Licensed Material is a musical work, performance, or sound +recording, Adapted Material is always produced where the Licensed Material +is synched in timed relation with a moving image.
Adapter’s License means the license You apply to Your Copyright and +Similar Rights in Your contributions to Adapted Material in accordance with +the terms and conditions of this Public License.
Copyright and Similar Rights means copyright and/or similar rights +closely related to copyright including, without limitation, performance, +broadcast, sound recording, and Sui Generis Database Rights, without regard +to how the rights are labeled or categorized. For purposes of this Public +License, the rights specified in Section 2(b)(1)-(2) are not Copyright and +Similar Rights.
Effective Technological Measures means those measures that, in the +absence of proper authority, may not be circumvented under laws fulfilling +obligations under Article 11 of the WIPO Copyright Treaty adopted on +December 20, 1996, and/or similar international agreements.
Exceptions and Limitations means fair use, fair dealing, and/or any +other exception or limitation to Copyright and Similar Rights that applies to +Your use of the Licensed Material.
Licensed Material means the artistic or literary work, database, or +other material to which the Licensor applied this Public License.
Licensed Rights means the rights granted to You subject to the terms +and conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license.
Licensor means the individual(s) or entity(ies) granting rights under +this Public License.
Share means to provide material to the public by any means or process +that requires permission under the Licensed Rights, such as reproduction, +public display, public performance, distribution, dissemination, +communication, or importation, and to make material available to the public +including in ways that members of the public may access the material from a +place and at a time individually chosen by them.
Sui Generis Database Rights means rights other than copyright +resulting from Directive 96/9/EC of the European Parliament and of the +Council of 11 March 1996 on the legal protection of databases, as amended +and/or succeeded, as well as other essentially equivalent rights anywhere +in the world.
You means the individual or entity exercising the Licensed Rights +under this Public License. Your has a corresponding meaning.
License grant.
+Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, +non-exclusive, irrevocable license to exercise the Licensed Rights in the +Licensed Material to:
++++
+- +
reproduce and Share the Licensed Material, in whole or in part; and
- +
produce, reproduce, and Share Adapted Material.
Exceptions and Limitations. For the avoidance of doubt, where +Exceptions and Limitations apply to Your use, this Public License does not +apply, and You do not need to comply with its terms and conditions.
Term. The term of this Public License is specified in Section 6(a).
Media and formats; technical modifications allowed. The Licensor +authorizes You to exercise the Licensed Rights in all media and formats +whether now known or hereafter created, and to make technical +modifications necessary to do so. The Licensor waives and/or agrees not to +assert any right or authority to forbid You from making technical +modifications necessary to exercise the Licensed Rights, including +technical modifications necessary to circumvent Effective Technological +Measures. For purposes of this Public License, simply making modifications +authorized by this Section 2(a)(4) never produces Adapted Material.
Downstream recipients.
++++
+- +
Offer from the Licensor – Licensed Material. Every recipient of +the Licensed Material automatically receives an offer from the +Licensor to exercise the Licensed Rights under the terms and +conditions of this Public License.
- +
No downstream restrictions. You may not offer or impose any +additional or different terms or conditions on, or apply any Effective +Technological Measures to, the Licensed Material if doing so restricts +exercise of the Licensed Rights by any recipient of the Licensed +Material.
No endorsement. Nothing in this Public License constitutes or may +be construed as permission to assert or imply that You are, or that Your +use of the Licensed Material is, connected with, or sponsored, endorsed, +or granted official status by, the Licensor or others designated to +receive attribution as provided in Section 3(a)(1)(A)(i).
Other rights.
+Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar +personality rights; however, to the extent possible, the Licensor waives +and/or agrees not to assert any such rights held by the Licensor to the +limited extent necessary to allow You to exercise the Licensed Rights, but +not otherwise.
Patent and trademark rights are not licensed under this Public License.
To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or +through a collecting society under any voluntary or waivable statutory or +compulsory licensing scheme. In all other cases the Licensor expressly +reserves any right to collect such royalties.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+Attribution.
+If You Share the Licensed Material (including in modified form), You must:
++++
+- +
retain the following if it is supplied by the Licensor with the +Licensed Material:
+++
+- +
identification of the creator(s) of the Licensed Material and any +others designated to receive attribution, in any reasonable manner +requested by the Licensor (including by pseudonym if designated);
- +
a copyright notice;
- +
a notice that refers to this Public License;
- +
a notice that refers to the disclaimer of warranties;
- +
a URI or hyperlink to the Licensed Material to the extent reasonably +practicable;
+
+- +
indicate if You modified the Licensed Material and retain an +indication of any previous modifications; and
- +
indicate the Licensed Material is licensed under this Public License, +and include the text of, or the URI or hyperlink to, this Public +License.
You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed +Material. For example, it may be reasonable to satisfy the conditions by +providing a URI or hyperlink to a resource that includes the required +information.
If requested by the Licensor, You must remove any of the information +required by Section 3(a)(1)(A) to the extent reasonably practicable.
If You Share Adapted Material You produce, the Adapter’s License You apply +must not prevent recipients of the Adapted Material from complying with +this Public License.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your +use of the Licensed Material:
+for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database;
if You include all or a substantial portion of the database contents in a +database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual +contents) is Adapted Material; and
You must comply with the conditions in Section 3(a) if You Share all or a +substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights.
+Unless otherwise separately undertaken by the Licensor, to the extent +possible, the Licensor offers the Licensed Material as-is and as-available, +and makes no representations or warranties of any kind concerning the +Licensed Material, whether express, implied, statutory, or other. This +includes, without limitation, warranties of title, merchantability, +fitness for a particular purpose, non-infringement, absence of latent or +other defects, accuracy, or the presence or absence of errors, whether or +not known or discoverable. Where disclaimers of warranties are not allowed +in full or in part, this disclaimer may not apply to You.
To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or +otherwise for any direct, special, indirect, incidental, consequential, +punitive, exemplary, or other losses, costs, expenses, or damages arising +out of this Public License or use of the Licensed Material, even if the +Licensor has been advised of the possibility of such losses, costs, expenses, +or damages. Where a limitation of liability is not allowed in full or in +part, this limitation may not apply to You.
The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most +closely approximates an absolute disclaimer and waiver of all liability.
This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically.
Where Your right to use the Licensed Material has terminated under +Section 6(a), it reinstates:
+automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or
upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the +Licensor may have to seek remedies for Your violations of this Public License.
+For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License.
Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed.
Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License.
For the avoidance of doubt, this Public License does not, and shall not be +interpreted to, reduce, limit, restrict, or impose conditions on any use of +the Licensed Material that could lawfully be made without permission under +this Public License.
To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent +necessary to make it enforceable. If the provision cannot be reformed, it +shall be severed from this Public License without affecting the +enforceability of the remaining terms and conditions.
No term or condition of this Public License will be waived and no failure to +comply consented to unless expressly agreed to by the Licensor.
Nothing in this Public License constitutes or may be interpreted as a +limitation upon, or waiver of, any privileges and immunities that apply to +the Licensor or You, including from the legal processes of any jurisdiction +or authority.
Creative Commons is not a party to its public licenses. Notwithstanding, +Creative Commons may elect to apply one of its public licenses to material it +publishes and in those instances will be considered the “Licensor.” Except for +the limited purpose of indicating that material is shared under a Creative +Commons public license or as otherwise permitted by the Creative Commons +policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark “Creative Commons” +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For the +avoidance of doubt, this paragraph does not form part of the public licenses.
+Creative Commons may be contacted at creativecommons.org
+pip3 install pyEDAA.UCIS
+pip3 install -U pyEDAA.UCIS
+pip3 uninstall pyEDAA.UCIS
+pip3 install .
+setup.py (legacy)¶See sections above on how to use PIP.
+setup.py¶setup.py install
+Note
+This is a local copy of the Apache License Version 2.0.
+Attention
+This Apache License, 2.0 applies to all source and configuration files of project, except documentation.
+Version 2.0, January 2004
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that +entity. For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether +by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.
+“Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and +configuration files.
+“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object +code, generated documentation, and conversions to other media types.
+“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is +included in or attached to the work (an example is provided in the Appendix below).
+“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative +Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to +submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication +sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue +tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is +conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such +license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of +their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim +or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then +any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions:
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source +form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the +Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE +file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, +alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise +complies with the conditions stated in this License.
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any +separate license agreement you may have executed with Licensor regarding such Contributions.
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable +and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, +MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and +assume any risks associated with Your exercise of permissions under this License.
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or +consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages +for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been +advised of the possibility of such damages.
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other +liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole +responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+Appendix: How to apply the Apache License to your work
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets “[]” replaced with your own identifying +information. (Don’t include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or +class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives.
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+# ==================================================================================================================== #
+# _____ ____ _ _ _ _ ____ ___ ____ #
+# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+# |_| |___/ #
+# ==================================================================================================================== #
+# Authors: #
+# Patrick Lehmann #
+# Artur Porebski (Aldec Inc.) #
+# Michal Pacula (Aldec Inc.) #
+# #
+# License: #
+# ==================================================================================================================== #
+# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+# #
+# Licensed under the Apache License, Version 2.0 (the "License"); #
+# you may not use this file except in compliance with the License. #
+# You may obtain a copy of the License at #
+# #
+# http://www.apache.org/licenses/LICENSE-2.0 #
+# #
+# Unless required by applicable law or agreed to in writing, software #
+# distributed under the License is distributed on an "AS IS" BASIS, #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+# See the License for the specific language governing permissions and #
+# limitations under the License. #
+# #
+# SPDX-License-Identifier: Apache-2.0 #
+# ==================================================================================================================== #
+#
+"""
+Tools to extract data from UCDB files.
+
+.. rubric:: Usage
+
+First export/convert the Aldec Coverage Database (ACDB) into UCDB (Universal Coverage Database) format. The
+helper program ``acdb2xml`` (part of Active-HDL or Riviera-PRO installation) can be used.
+
+.. code-block::
+
+ acdb2xml -i aggregate.acdb -o ucdb.xml
+
+At next use this layer's service program to convert from UCDB to Cobertura format.
+
+.. code-block::
+
+ pyedaa-ucis export --ucdb ucdb.xml --cobertura cobertura.xml
+"""
+from argparse import RawDescriptionHelpFormatter
+from pathlib import Path
+from textwrap import dedent
+
+from pyAttributes.ArgParseAttributes import ArgParseMixin, DefaultAttribute, CommandAttribute, ArgumentAttribute, SwitchArgumentAttribute
+
+from pyTooling.Decorators import export
+
+from pyEDAA.UCIS import __version__, __copyright__, __license__
+from pyEDAA.UCIS.UCDB import Parser
+from pyEDAA.UCIS.Cobertura import CoberturaException
+
+
+
+[docs]
+@export
+class ProgramBase():
+ """Base-class for all program classes."""
+
+ programTitle = "UCDB Service Program"
+
+ def __init__(self) -> None:
+ pass
+
+ def _PrintHeadline(self) -> None:
+ """Print the programs headline."""
+ print("{line}".format(line="=" * 120))
+ print("{headline: ^120s}".format(headline=self.programTitle))
+ print("{line}".format(line="=" * 120))
+
+
+
+
+[docs]
+@export
+class Program(ProgramBase, ArgParseMixin):
+ """Program class to implement the command line interface (CLI) using commands and options."""
+
+ def __init__(self) -> None:
+ super().__init__()
+
+ # Call the constructor of the ArgParseMixin
+ ArgParseMixin.__init__(
+ self,
+ prog="pyedaa-ucis",
+ description=dedent('''\
+ 'pyEDAA.UCIS Service Program' to query and transform data to/from UCIS to any other format.
+ '''),
+ epilog=dedent("""\
+ Currently the following output formats are supported:
+ * Cobertura (statement coverage - Java oriented format)
+ """),
+ formatter_class=RawDescriptionHelpFormatter,
+ add_help=False
+ )
+
+# @CommonSwitchArgumentAttribute("-q", "--quiet", dest="quiet", help="Reduce messages to a minimum.")
+# @CommonSwitchArgumentAttribute("-v", "--verbose", dest="verbose", help="Print out detailed messages.")
+# @CommonSwitchArgumentAttribute("-d", "--debug", dest="debug", help="Enable debug mode.")
+ def Run(self) -> None:
+ ArgParseMixin.Run(self)
+
+
+[docs]
+ @DefaultAttribute()
+ def HandleDefault(self, _) -> None:
+ """Handle program calls without any command."""
+ self._PrintHeadline()
+ self._PrintHelp()
+
+
+
+[docs]
+ @CommandAttribute("help", help="Display help page(s) for the given command name.", description="Display help page(s) for the given command name.")
+ @ArgumentAttribute(metavar="Command", dest="Command", type=str, nargs="?", help="Print help page(s) for a command.")
+ def HandleHelp(self, args) -> None:
+ """Handle program calls with command ``help``."""
+ self._PrintHeadline()
+ self._PrintHelp(args.Command)
+
+
+
+[docs]
+ @CommandAttribute("version", help="Display version information.", description="Display version information.")
+ def HandleVersion(self, _) -> None:
+ """Handle program calls with command ``version``."""
+ self._PrintHeadline()
+ self._PrintVersion()
+
+
+
+[docs]
+ @CommandAttribute("export", help="Export data from UCDB.", description="Export data from UCDB.")
+ @ArgumentAttribute("--ucdb", metavar='UCDBFile', dest="ucdb", type=str, help="UCDB file in UCIS format (XML).")
+ @ArgumentAttribute("--cobertura", metavar='CoberturaFile', dest="cobertura", type=str, help="Cobertura code coverage file (XML).")
+ @SwitchArgumentAttribute("--merge-instances", dest="mergeInstances", help="Merge statement coverage data for all instances of the same design unit.")
+ def HandleExport(self, args) -> None:
+ """Handle program calls with command ``export``."""
+ self._PrintHeadline()
+
+ returnCode = 0
+ if args.ucdb is None:
+ print(f"Option '--ucdb <UCDBFile' is missing.")
+ returnCode = 3
+ if args.cobertura is None:
+ print(f"Option '--cobertura <CoberturaFile' is missing.")
+ returnCode = 3
+
+ if returnCode != 0:
+ exit(returnCode)
+
+ print(f"Exporting code coverage information from UCDB file to Cobertura format ...")
+
+ ucdbPath = Path(args.ucdb)
+ if not ucdbPath.exists():
+ raise FileNotFoundError(f"UCDB databse file '{ucdbPath}' not found.")
+
+ coberturaPath = Path(args.cobertura)
+
+ print(f" IN -> UCIS (XML): {ucdbPath}")
+ print(f" OUT <- Cobertura (XML): {coberturaPath}")
+
+ parser = Parser(ucdbPath, args.mergeInstances)
+ model = parser.getCoberturaModel()
+
+ with coberturaPath.open('w') as file:
+ file.write(model.getXml().decode("utf-8"))
+
+ print()
+
+ try:
+ lineCoverage = model.linesCovered / model.linesValid * 100
+ except ZeroDivisionError:
+ lineCoverage = 100
+
+ try:
+ statementCoverage = parser.statementsCovered / parser.statementsCount * 100
+ except ZeroDivisionError:
+ statementCoverage = 100
+
+ print(dedent(f"""\
+ [DONE] Export and conversion complete.
+ Line coverage: {lineCoverage} %
+ Statement coverage: {statementCoverage} %
+ """)
+ )
+
+
+ def _PrintVersion(self):
+ """Helper function to print the version information."""
+ print(dedent(f"""\
+ Copyright: {__copyright__}
+ License: {__license__}
+ Version: v{__version__}
+ """)
+ )
+
+ def _PrintHelp(self, command: str=None):
+ """Helper function to print the command line parsers help page(s)."""
+ if (command is None):
+ self.MainParser.print_help()
+ elif (command == "help"):
+ print("This is a recursion ...")
+ else:
+ try:
+ self.SubParsers[command].print_help()
+ except KeyError:
+ print(f"Command {command} is unknown.")
+
+
+
+
+[docs]
+@export
+def main():
+ """
+ Entrypoint to start program execution.
+
+ This function should be called either from:
+ * ``if __name__ == "__main__":`` or
+ * ``console_scripts`` entry point configured via ``setuptools`` in ``setup.py``.
+
+ This function creates an instance of :class:`Program` in a ``try ... except`` environment. Any exception caught is
+ formatted and printed before the program returns with a non-zero exit code.
+ """
+ program = Program()
+ try:
+ program.Run()
+ except FileNotFoundError as ex:
+ print()
+ print(f"[ERROR] {ex}")
+ exit(1)
+ except CoberturaException as ex:
+ print()
+ print(f"[INTERNAL ERROR] {ex}")
+ exit(1)
+
+
+
+if __name__ == "__main__":
+ main()
+
+# ==================================================================================================================== #
+# _____ ____ _ _ _ _ ____ ___ ____ #
+# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+# |_| |___/ #
+# ==================================================================================================================== #
+# Authors: #
+# Artur Porebski (Aldec Inc.) #
+# Michal Pacula (Aldec Inc.) #
+# #
+# License: #
+# ==================================================================================================================== #
+# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+# #
+# Licensed under the Apache License, Version 2.0 (the "License"); #
+# you may not use this file except in compliance with the License. #
+# You may obtain a copy of the License at #
+# #
+# http://www.apache.org/licenses/LICENSE-2.0 #
+# #
+# Unless required by applicable law or agreed to in writing, software #
+# distributed under the License is distributed on an "AS IS" BASIS, #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+# See the License for the specific language governing permissions and #
+# limitations under the License. #
+# #
+# SPDX-License-Identifier: Apache-2.0 #
+# ==================================================================================================================== #
+#
+"""
+Data model of the Cobertura format.
+
+.. mermaid::
+
+ flowchart LR
+ Coverage --> Package --> Class --> Statement
+
+"""
+from time import time
+from typing import Dict, Set
+
+from lxml import etree
+from pyTooling.Decorators import export
+
+
+
+[docs]
+@export
+class CoberturaException(Exception):
+ """Base-class for other Cobertura exceptions"""
+
+
+
+
+[docs]
+@export
+class DuplicatedLineNumber(CoberturaException):
+ """Raised when statement with specified line number already exists in Cobertura class"""
+
+
+
+
+[docs]
+@export
+class DuplicatedClassName(CoberturaException):
+ """Raised when class with specified name already exists in Cobertura package"""
+
+
+
+
+[docs]
+@export
+class DuplicatedPackageName(CoberturaException):
+ """Raised when package with specified name already exists in Cobertura coverage"""
+
+
+
+
+[docs]
+@export
+class Class:
+ """Represents a code element in the Cobertura coverage data model (Java-focused)."""
+
+ name: str
+ sourceFile: str
+ lines: Dict[int, int]
+ linesValid: int
+ linesCovered: int
+
+ def __init__(self, name: str, sourceFile: str):
+ self.name = name
+ self.sourceFile = sourceFile
+ self.lines = {}
+ self.linesValid = 0
+ self.linesCovered = 0
+
+ def addStatement(self, line: int, hits: int) -> None:
+ if line in self.lines.keys():
+ raise DuplicatedLineNumber(f"Duplicated line number: {line}")
+
+ self.lines[line] = hits
+ self.linesValid += 1
+
+ if hits:
+ self.linesCovered += 1
+
+ def getXmlNode(self) -> etree._Element:
+ classNode = etree.Element("class")
+ classNode.attrib["name"] = self.sourceFile
+ classNode.attrib["filename"] = self.sourceFile
+ classNode.attrib["complexity"] = "0"
+ classNode.attrib["branch-rate"] = "0"
+
+ try:
+ rate = self.linesCovered / self.linesValid
+ except ZeroDivisionError:
+ rate = 1.0
+
+ classNode.attrib["line-rate"] = f"{rate:.16g}"
+
+ classNode.append(etree.Element("methods"))
+ linesNode = etree.SubElement(classNode, "lines")
+
+ for line in self.lines:
+ etree.SubElement(
+ linesNode,
+ "line",
+ number=str(line),
+ hits=str(self.lines[line]),
+ )
+
+ return classNode
+
+
+
+
+[docs]
+@export
+class Package:
+ """Represents a grouping element in the Cobertura coverage data model (Java-focused)."""
+
+ name: str
+ classes: Dict[str, Class]
+ linesValid: int
+ linesCovered: int
+
+ def __init__(self, name: str):
+ self.name = name
+ self.classes = {}
+ self.linesValid = 0
+ self.linesCovered = 0
+
+ def addClass(self, coberturaClass: Class):
+ if coberturaClass.name in self.classes:
+ raise DuplicatedClassName(f"Duplicated class name: '{coberturaClass.name}'.")
+
+ self.classes[coberturaClass.name] = coberturaClass
+
+ def refreshStatistics(self) -> None:
+ self.linesValid = 0
+ self.linesCovered = 0
+
+ for coberturaClass in self.classes.values():
+ self.linesCovered += coberturaClass.linesCovered
+ self.linesValid += coberturaClass.linesValid
+
+ def getXmlNode(self) -> etree._Element:
+ classesNode = etree.Element("classes")
+ packageNode = etree.Element("package")
+ packageNode.attrib["name"] = self.name
+ packageNode.attrib["complexity"] = "0"
+ packageNode.attrib["branch-rate"] = "0"
+
+ try:
+ rate = self.linesCovered / self.linesValid
+ except ZeroDivisionError:
+ rate = 1.0
+
+ packageNode.attrib["line-rate"] = f"{rate:.16g}"
+
+ packageNode.append(classesNode)
+
+ for coberturaClass in self.classes.values():
+ classesNode.append(coberturaClass.getXmlNode())
+
+ return packageNode
+
+
+
+
+[docs]
+@export
+class Coverage:
+ """Represents the root element in the Cobertura coverage data model (Java-focused)."""
+
+ sources: Set
+ packages: Dict[str, Package]
+ linesValid: int
+ linesCovered: int
+
+ def __init__(self):
+ self.sources = set()
+ self.packages = {}
+ self.linesValid = 0
+ self.linesCovered = 0
+
+ def addSource(self, source: str) -> None:
+ self.sources.add(source)
+
+ def addPackage(self, package: Package) -> None:
+ if package.name in self.packages:
+ raise DuplicatedPackageName(f"Duplicated package name: '{package.name}'.")
+
+ self.packages[package.name] = package
+
+ def refreshStatistics(self) -> None:
+ self.linesValid = 0
+ self.linesCovered = 0
+
+ for package in self.packages.values():
+ package.refreshStatistics()
+ self.linesCovered += package.linesCovered
+ self.linesValid += package.linesValid
+
+ def getXml(self) -> bytes:
+ self.refreshStatistics()
+
+ coverageNode = etree.Element("coverage")
+ coverageNode.attrib["version"] = "5.5"
+ coverageNode.attrib["timestamp"] = str(int(time()))
+ coverageNode.attrib["branches-valid"] = "0"
+ coverageNode.attrib["branches-covered"] = "0"
+ coverageNode.attrib["branch-rate"] = "0"
+ coverageNode.attrib["complexity"] = "0"
+
+ sourcesNode = etree.Element("sources")
+
+ for source in self.sources:
+ etree.SubElement(sourcesNode, "source").text = source
+
+ coverageNode.append(sourcesNode)
+
+ packagesNode = etree.Element("packages")
+
+ for package in self.packages.values():
+ packagesNode.append(package.getXmlNode())
+
+ coverageNode.append(packagesNode)
+
+ coverageNode.attrib["lines-valid"] = str(self.linesValid)
+ coverageNode.attrib["lines-covered"] = str(self.linesCovered)
+
+ try:
+ rate = self.linesCovered / self.linesValid
+ except ZeroDivisionError:
+ rate = 1.0
+
+ coverageNode.attrib["line-rate"] = f"{rate:.16g}"
+
+ return etree.tostring(
+ coverageNode, pretty_print=True, encoding="utf-8", xml_declaration=True
+ )
+
+
+# ==================================================================================================================== #
+# _____ ____ _ _ _ _ ____ ___ ____ #
+# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+# |_| |___/ #
+# ==================================================================================================================== #
+# Authors: #
+# Artur Porebski (Aldec Inc.) #
+# Michal Pacula (Aldec Inc.) #
+# #
+# License: #
+# ==================================================================================================================== #
+# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+# #
+# Licensed under the Apache License, Version 2.0 (the "License"); #
+# you may not use this file except in compliance with the License. #
+# You may obtain a copy of the License at #
+# #
+# http://www.apache.org/licenses/LICENSE-2.0 #
+# #
+# Unless required by applicable law or agreed to in writing, software #
+# distributed under the License is distributed on an "AS IS" BASIS, #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+# See the License for the specific language governing permissions and #
+# limitations under the License. #
+# #
+# SPDX-License-Identifier: Apache-2.0 #
+# ==================================================================================================================== #
+#
+"""Data model of the UCDB format."""
+from collections import namedtuple, defaultdict
+from itertools import groupby
+from operator import attrgetter
+from pathlib import Path
+from typing import List, Tuple, Dict, DefaultDict
+
+from lxml import etree
+from pyTooling.Decorators import export
+
+from pyEDAA.UCIS.Cobertura import Class, Coverage, Package
+
+
+UCDB_EXCLUDE_PRAGMA = 0x00000020
+UCDB_EXCLUDE_FILE = 0x00000040
+UCDB_EXCLUDE_INST = 0x00000080
+UCDB_EXCLUDE_AUTO = 0x00000100
+
+UCDB_EXCLUDED = (
+ UCDB_EXCLUDE_FILE | UCDB_EXCLUDE_PRAGMA | UCDB_EXCLUDE_INST | UCDB_EXCLUDE_AUTO
+)
+
+StatementData = namedtuple(
+ "StatementData",
+ ["file", "line", "index", "instance", "hits"],
+)
+
+
+
+[docs]
+@export
+class UcdbParserException(Exception):
+ """Base-class for other UCDB Parser exceptions"""
+
+
+
+
+[docs]
+@export
+class InternalErrorOccurred(UcdbParserException):
+ """Raised when internal error occurred"""
+
+
+
+
+[docs]
+@export
+class Parser:
+ _mergeInstances: bool
+ _tree: etree._ElementTree
+ _nsmap: Dict
+ _coverage: Coverage
+ statementsCount: int
+ statementsCovered: int
+
+ def __init__(self, ucdbFile: Path, mergeInstances: bool):
+ self._mergeInstances = mergeInstances
+
+ with ucdbFile.open("r") as filename:
+ self._tree = etree.parse(filename)
+
+ self._nsmap = {
+ k: v for (k, v) in self._tree.getroot().nsmap.items() if k is not None
+ }
+
+ self._coverage = Coverage()
+
+ self.statementsCount = 0
+ self.statementsCovered = 0
+
+ def getCoberturaModel(self) -> Coverage:
+ self._parseStatementCoverage()
+
+ return self._coverage
+
+ def _groupByIndex(self, statements: List[StatementData]) -> List[StatementData]:
+ groupedStmts = []
+
+ sortedStmts = sorted(statements, key=attrgetter("index"))
+ for index, stmts in groupby(sortedStmts, key=attrgetter("index")):
+ hit = any((stmt.hits for stmt in stmts))
+
+ groupedStmts.append(
+ StatementData(
+ file=statements[0].file,
+ line=statements[0].line,
+ index=index,
+ instance="",
+ hits=hit,
+ )
+ )
+
+ return groupedStmts
+
+ def _parseStatementCoverage(self) -> None:
+ scopes = self._tree.xpath(
+ "/ux:ucdb/ux:scope[.//ux:bin[@type='STMTBIN']]", namespaces=self._nsmap
+ )
+
+ if not isinstance(scopes, list):
+ raise InternalErrorOccurred(f"Unexpected type: '{scopes.__class__.__name__}'.")
+
+ nodes: List[etree._Element] = []
+
+ for scopeNode in scopes:
+ if not isinstance(scopeNode, etree._Element):
+ raise InternalErrorOccurred(f"Unexpected type: '{scopeNode.__class__.__name__}'.")
+
+ typeName = scopeNode.get("type")
+
+ if typeName is None:
+ raise InternalErrorOccurred("Unexpected 'None' value.")
+
+ if typeName.startswith("DU_"):
+ continue
+
+ statementBins = scopeNode.xpath(".//ux:bin[@type='STMTBIN']", namespaces=self._nsmap)
+
+ if not isinstance(statementBins, list):
+ raise InternalErrorOccurred(f"Unexpected type: '{statementBins.__class__.__name__}'.")
+
+ for statementBin in statementBins:
+ if not isinstance(statementBin, etree._Element):
+ raise InternalErrorOccurred(f"Unexpected type: '{statementBin.__class__.__name__}'.")
+
+ nodes.append(statementBin)
+
+ statements: DefaultDict[str, DefaultDict[int, List]] = defaultdict(lambda: defaultdict(list))
+
+ for node in nodes:
+ workdir, stmtData = self._parseStatementNode(node)
+ self._coverage.addSource(workdir)
+
+ flags = node.get("flags")
+
+ if flags is None:
+ raise InternalErrorOccurred("Unexpected 'None' value.")
+
+ if int(flags, 16) & UCDB_EXCLUDED:
+ _ = statements[stmtData.file]
+ continue
+
+ statements[stmtData.file][stmtData.line].append(stmtData)
+
+ for file, lines in statements.items():
+ package = Package(file)
+ coberturaClass = Class(file, file)
+ package.addClass(coberturaClass)
+ self._coverage.addPackage(package)
+
+ for line, lineStmts in lines.items():
+ if self._mergeInstances:
+ lineStmts = self._groupByIndex(lineStmts)
+
+ self.statementsCount += len(lineStmts)
+
+ covered = len(list(filter(attrgetter("hits"), lineStmts)))
+ hit = int(covered == len(lineStmts))
+
+ self.statementsCovered += covered
+
+ coberturaClass.addStatement(line, hit)
+
+ def _parseStatementNode(self, node) -> Tuple[str, StatementData]:
+ srcNode = node.find("./ux:src", namespaces=self._nsmap)
+ workdir = srcNode.get("workdir")
+
+ instancePath = ".".join(
+ (scope.get("name") for scope in node.iterancestors("{*}scope"))
+ )
+
+ stmtIndex = int(
+ node.find("./ux:attr[@key='#SINDEX#']", namespaces=self._nsmap).text
+ )
+
+ count = int(node.find("./ux:count", namespaces=self._nsmap).text)
+
+ stmtData = StatementData(
+ file=srcNode.get("file"),
+ line=int(srcNode.get("line")),
+ index=stmtIndex,
+ instance=instancePath,
+ hits=count,
+ )
+
+ return workdir, stmtData
+
+' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/_static/work-in-progress.png b/_static/work-in-progress.png new file mode 100644 index 00000000..a8475fa0 Binary files /dev/null and b/_static/work-in-progress.png differ diff --git a/coverage/coverage_html.js b/coverage/coverage_html.js new file mode 100644 index 00000000..59348828 --- /dev/null +++ b/coverage/coverage_html.js @@ -0,0 +1,624 @@ +// Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +// For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +// Coverage.py HTML report browser code. +/*jslint browser: true, sloppy: true, vars: true, plusplus: true, maxerr: 50, indent: 4 */ +/*global coverage: true, document, window, $ */ + +coverage = {}; + +// General helpers +function debounce(callback, wait) { + let timeoutId = null; + return function(...args) { + clearTimeout(timeoutId); + timeoutId = setTimeout(() => { + callback.apply(this, args); + }, wait); + }; +}; + +function checkVisible(element) { + const rect = element.getBoundingClientRect(); + const viewBottom = Math.max(document.documentElement.clientHeight, window.innerHeight); + const viewTop = 30; + return !(rect.bottom < viewTop || rect.top >= viewBottom); +} + +function on_click(sel, fn) { + const elt = document.querySelector(sel); + if (elt) { + elt.addEventListener("click", fn); + } +} + +// Helpers for table sorting +function getCellValue(row, column = 0) { + const cell = row.cells[column] // nosemgrep: eslint.detect-object-injection + if (cell.childElementCount == 1) { + const child = cell.firstElementChild + if (child instanceof HTMLTimeElement && child.dateTime) { + return child.dateTime + } else if (child instanceof HTMLDataElement && child.value) { + return child.value + } + } + return cell.innerText || cell.textContent; +} + +function rowComparator(rowA, rowB, column = 0) { + let valueA = getCellValue(rowA, column); + let valueB = getCellValue(rowB, column); + if (!isNaN(valueA) && !isNaN(valueB)) { + return valueA - valueB + } + return valueA.localeCompare(valueB, undefined, {numeric: true}); +} + +function sortColumn(th) { + // Get the current sorting direction of the selected header, + // clear state on other headers and then set the new sorting direction + const currentSortOrder = th.getAttribute("aria-sort"); + [...th.parentElement.cells].forEach(header => header.setAttribute("aria-sort", "none")); + if (currentSortOrder === "none") { + th.setAttribute("aria-sort", th.dataset.defaultSortOrder || "ascending"); + } else { + th.setAttribute("aria-sort", currentSortOrder === "ascending" ? "descending" : "ascending"); + } + + const column = [...th.parentElement.cells].indexOf(th) + + // Sort all rows and afterwards append them in order to move them in the DOM + Array.from(th.closest("table").querySelectorAll("tbody tr")) + .sort((rowA, rowB) => rowComparator(rowA, rowB, column) * (th.getAttribute("aria-sort") === "ascending" ? 1 : -1)) + .forEach(tr => tr.parentElement.appendChild(tr) ); +} + +// Find all the elements with data-shortcut attribute, and use them to assign a shortcut key. +coverage.assign_shortkeys = function () { + document.querySelectorAll("[data-shortcut]").forEach(element => { + document.addEventListener("keypress", event => { + if (event.target.tagName.toLowerCase() === "input") { + return; // ignore keypress from search filter + } + if (event.key === element.dataset.shortcut) { + element.click(); + } + }); + }); +}; + +// Create the events for the filter box. +coverage.wire_up_filter = function () { + // Cache elements. + const table = document.querySelector("table.index"); + const table_body_rows = table.querySelectorAll("tbody tr"); + const no_rows = document.getElementById("no_rows"); + + // Observe filter keyevents. + document.getElementById("filter").addEventListener("input", debounce(event => { + // Keep running total of each metric, first index contains number of shown rows + const totals = new Array(table.rows[0].cells.length).fill(0); + // Accumulate the percentage as fraction + totals[totals.length - 1] = { "numer": 0, "denom": 0 }; // nosemgrep: eslint.detect-object-injection + + // Hide / show elements. + table_body_rows.forEach(row => { + if (!row.cells[0].textContent.includes(event.target.value)) { + // hide + row.classList.add("hidden"); + return; + } + + // show + row.classList.remove("hidden"); + totals[0]++; + + for (let column = 1; column < totals.length; column++) { + // Accumulate dynamic totals + cell = row.cells[column] // nosemgrep: eslint.detect-object-injection + if (column === totals.length - 1) { + // Last column contains percentage + const [numer, denom] = cell.dataset.ratio.split(" "); + totals[column]["numer"] += parseInt(numer, 10); // nosemgrep: eslint.detect-object-injection + totals[column]["denom"] += parseInt(denom, 10); // nosemgrep: eslint.detect-object-injection + } else { + totals[column] += parseInt(cell.textContent, 10); // nosemgrep: eslint.detect-object-injection + } + } + }); + + // Show placeholder if no rows will be displayed. + if (!totals[0]) { + // Show placeholder, hide table. + no_rows.style.display = "block"; + table.style.display = "none"; + return; + } + + // Hide placeholder, show table. + no_rows.style.display = null; + table.style.display = null; + + const footer = table.tFoot.rows[0]; + // Calculate new dynamic sum values based on visible rows. + for (let column = 1; column < totals.length; column++) { + // Get footer cell element. + const cell = footer.cells[column]; // nosemgrep: eslint.detect-object-injection + + // Set value into dynamic footer cell element. + if (column === totals.length - 1) { + // Percentage column uses the numerator and denominator, + // and adapts to the number of decimal places. + const match = /\.([0-9]+)/.exec(cell.textContent); + const places = match ? match[1].length : 0; + const { numer, denom } = totals[column]; // nosemgrep: eslint.detect-object-injection + cell.dataset.ratio = `${numer} ${denom}`; + // Check denom to prevent NaN if filtered files contain no statements + cell.textContent = denom + ? `${(numer * 100 / denom).toFixed(places)}%` + : `${(100).toFixed(places)}%`; + } else { + cell.textContent = totals[column]; // nosemgrep: eslint.detect-object-injection + } + } + })); + + // Trigger change event on setup, to force filter on page refresh + // (filter value may still be present). + document.getElementById("filter").dispatchEvent(new Event("input")); +}; + +coverage.INDEX_SORT_STORAGE = "COVERAGE_INDEX_SORT_2"; + +// Loaded on index.html +coverage.index_ready = function () { + coverage.assign_shortkeys(); + coverage.wire_up_filter(); + document.querySelectorAll("[data-sortable] th[aria-sort]").forEach( + th => th.addEventListener("click", e => sortColumn(e.target)) + ); + + // Look for a localStorage item containing previous sort settings: + const stored_list = localStorage.getItem(coverage.INDEX_SORT_STORAGE); + + if (stored_list) { + const {column, direction} = JSON.parse(stored_list); + const th = document.querySelector("[data-sortable]").tHead.rows[0].cells[column]; // nosemgrep: eslint.detect-object-injection + th.setAttribute("aria-sort", direction === "ascending" ? "descending" : "ascending"); + th.click() + } + + // Watch for page unload events so we can save the final sort settings: + window.addEventListener("unload", function () { + const th = document.querySelector('[data-sortable] th[aria-sort="ascending"], [data-sortable] [aria-sort="descending"]'); + if (!th) { + return; + } + localStorage.setItem(coverage.INDEX_SORT_STORAGE, JSON.stringify({ + column: [...th.parentElement.cells].indexOf(th), + direction: th.getAttribute("aria-sort"), + })); + }); + + on_click(".button_prev_file", coverage.to_prev_file); + on_click(".button_next_file", coverage.to_next_file); + + on_click(".button_show_hide_help", coverage.show_hide_help); +}; + +// -- pyfile stuff -- + +coverage.LINE_FILTERS_STORAGE = "COVERAGE_LINE_FILTERS"; + +coverage.pyfile_ready = function () { + // If we're directed to a particular line number, highlight the line. + var frag = location.hash; + if (frag.length > 2 && frag[1] === "t") { + document.querySelector(frag).closest(".n").classList.add("highlight"); + coverage.set_sel(parseInt(frag.substr(2), 10)); + } else { + coverage.set_sel(0); + } + + on_click(".button_toggle_run", coverage.toggle_lines); + on_click(".button_toggle_mis", coverage.toggle_lines); + on_click(".button_toggle_exc", coverage.toggle_lines); + on_click(".button_toggle_par", coverage.toggle_lines); + + on_click(".button_next_chunk", coverage.to_next_chunk_nicely); + on_click(".button_prev_chunk", coverage.to_prev_chunk_nicely); + on_click(".button_top_of_page", coverage.to_top); + on_click(".button_first_chunk", coverage.to_first_chunk); + + on_click(".button_prev_file", coverage.to_prev_file); + on_click(".button_next_file", coverage.to_next_file); + on_click(".button_to_index", coverage.to_index); + + on_click(".button_show_hide_help", coverage.show_hide_help); + + coverage.filters = undefined; + try { + coverage.filters = localStorage.getItem(coverage.LINE_FILTERS_STORAGE); + } catch(err) {} + + if (coverage.filters) { + coverage.filters = JSON.parse(coverage.filters); + } + else { + coverage.filters = {run: false, exc: true, mis: true, par: true}; + } + + for (cls in coverage.filters) { + coverage.set_line_visibilty(cls, coverage.filters[cls]); // nosemgrep: eslint.detect-object-injection + } + + coverage.assign_shortkeys(); + coverage.init_scroll_markers(); + coverage.wire_up_sticky_header(); + + document.querySelectorAll("[id^=ctxs]").forEach( + cbox => cbox.addEventListener("click", coverage.expand_contexts) + ); + + // Rebuild scroll markers when the window height changes. + window.addEventListener("resize", coverage.build_scroll_markers); +}; + +coverage.toggle_lines = function (event) { + const btn = event.target.closest("button"); + const category = btn.value + const show = !btn.classList.contains("show_" + category); + coverage.set_line_visibilty(category, show); + coverage.build_scroll_markers(); + coverage.filters[category] = show; + try { + localStorage.setItem(coverage.LINE_FILTERS_STORAGE, JSON.stringify(coverage.filters)); + } catch(err) {} +}; + +coverage.set_line_visibilty = function (category, should_show) { + const cls = "show_" + category; + const btn = document.querySelector(".button_toggle_" + category); + if (btn) { + if (should_show) { + document.querySelectorAll("#source ." + category).forEach(e => e.classList.add(cls)); + btn.classList.add(cls); + } + else { + document.querySelectorAll("#source ." + category).forEach(e => e.classList.remove(cls)); + btn.classList.remove(cls); + } + } +}; + +// Return the nth line div. +coverage.line_elt = function (n) { + return document.getElementById("t" + n)?.closest("p"); +}; + +// Set the selection. b and e are line numbers. +coverage.set_sel = function (b, e) { + // The first line selected. + coverage.sel_begin = b; + // The next line not selected. + coverage.sel_end = (e === undefined) ? b+1 : e; +}; + +coverage.to_top = function () { + coverage.set_sel(0, 1); + coverage.scroll_window(0); +}; + +coverage.to_first_chunk = function () { + coverage.set_sel(0, 1); + coverage.to_next_chunk(); +}; + +coverage.to_prev_file = function () { + window.location = document.getElementById("prevFileLink").href; +} + +coverage.to_next_file = function () { + window.location = document.getElementById("nextFileLink").href; +} + +coverage.to_index = function () { + location.href = document.getElementById("indexLink").href; +} + +coverage.show_hide_help = function () { + const helpCheck = document.getElementById("help_panel_state") + helpCheck.checked = !helpCheck.checked; +} + +// Return a string indicating what kind of chunk this line belongs to, +// or null if not a chunk. +coverage.chunk_indicator = function (line_elt) { + const classes = line_elt?.className; + if (!classes) { + return null; + } + const match = classes.match(/\bshow_\w+\b/); + if (!match) { + return null; + } + return match[0]; +}; + +coverage.to_next_chunk = function () { + const c = coverage; + + // Find the start of the next colored chunk. + var probe = c.sel_end; + var chunk_indicator, probe_line; + while (true) { + probe_line = c.line_elt(probe); + if (!probe_line) { + return; + } + chunk_indicator = c.chunk_indicator(probe_line); + if (chunk_indicator) { + break; + } + probe++; + } + + // There's a next chunk, `probe` points to it. + var begin = probe; + + // Find the end of this chunk. + var next_indicator = chunk_indicator; + while (next_indicator === chunk_indicator) { + probe++; + probe_line = c.line_elt(probe); + next_indicator = c.chunk_indicator(probe_line); + } + c.set_sel(begin, probe); + c.show_selection(); +}; + +coverage.to_prev_chunk = function () { + const c = coverage; + + // Find the end of the prev colored chunk. + var probe = c.sel_begin-1; + var probe_line = c.line_elt(probe); + if (!probe_line) { + return; + } + var chunk_indicator = c.chunk_indicator(probe_line); + while (probe > 1 && !chunk_indicator) { + probe--; + probe_line = c.line_elt(probe); + if (!probe_line) { + return; + } + chunk_indicator = c.chunk_indicator(probe_line); + } + + // There's a prev chunk, `probe` points to its last line. + var end = probe+1; + + // Find the beginning of this chunk. + var prev_indicator = chunk_indicator; + while (prev_indicator === chunk_indicator) { + probe--; + if (probe <= 0) { + return; + } + probe_line = c.line_elt(probe); + prev_indicator = c.chunk_indicator(probe_line); + } + c.set_sel(probe+1, end); + c.show_selection(); +}; + +// Returns 0, 1, or 2: how many of the two ends of the selection are on +// the screen right now? +coverage.selection_ends_on_screen = function () { + if (coverage.sel_begin === 0) { + return 0; + } + + const begin = coverage.line_elt(coverage.sel_begin); + const end = coverage.line_elt(coverage.sel_end-1); + + return ( + (checkVisible(begin) ? 1 : 0) + + (checkVisible(end) ? 1 : 0) + ); +}; + +coverage.to_next_chunk_nicely = function () { + if (coverage.selection_ends_on_screen() === 0) { + // The selection is entirely off the screen: + // Set the top line on the screen as selection. + + // This will select the top-left of the viewport + // As this is most likely the span with the line number we take the parent + const line = document.elementFromPoint(0, 0).parentElement; + if (line.parentElement !== document.getElementById("source")) { + // The element is not a source line but the header or similar + coverage.select_line_or_chunk(1); + } else { + // We extract the line number from the id + coverage.select_line_or_chunk(parseInt(line.id.substring(1), 10)); + } + } + coverage.to_next_chunk(); +}; + +coverage.to_prev_chunk_nicely = function () { + if (coverage.selection_ends_on_screen() === 0) { + // The selection is entirely off the screen: + // Set the lowest line on the screen as selection. + + // This will select the bottom-left of the viewport + // As this is most likely the span with the line number we take the parent + const line = document.elementFromPoint(document.documentElement.clientHeight-1, 0).parentElement; + if (line.parentElement !== document.getElementById("source")) { + // The element is not a source line but the header or similar + coverage.select_line_or_chunk(coverage.lines_len); + } else { + // We extract the line number from the id + coverage.select_line_or_chunk(parseInt(line.id.substring(1), 10)); + } + } + coverage.to_prev_chunk(); +}; + +// Select line number lineno, or if it is in a colored chunk, select the +// entire chunk +coverage.select_line_or_chunk = function (lineno) { + var c = coverage; + var probe_line = c.line_elt(lineno); + if (!probe_line) { + return; + } + var the_indicator = c.chunk_indicator(probe_line); + if (the_indicator) { + // The line is in a highlighted chunk. + // Search backward for the first line. + var probe = lineno; + var indicator = the_indicator; + while (probe > 0 && indicator === the_indicator) { + probe--; + probe_line = c.line_elt(probe); + if (!probe_line) { + break; + } + indicator = c.chunk_indicator(probe_line); + } + var begin = probe + 1; + + // Search forward for the last line. + probe = lineno; + indicator = the_indicator; + while (indicator === the_indicator) { + probe++; + probe_line = c.line_elt(probe); + indicator = c.chunk_indicator(probe_line); + } + + coverage.set_sel(begin, probe); + } + else { + coverage.set_sel(lineno); + } +}; + +coverage.show_selection = function () { + // Highlight the lines in the chunk + document.querySelectorAll("#source .highlight").forEach(e => e.classList.remove("highlight")); + for (let probe = coverage.sel_begin; probe < coverage.sel_end; probe++) { + coverage.line_elt(probe).querySelector(".n").classList.add("highlight"); + } + + coverage.scroll_to_selection(); +}; + +coverage.scroll_to_selection = function () { + // Scroll the page if the chunk isn't fully visible. + if (coverage.selection_ends_on_screen() < 2) { + const element = coverage.line_elt(coverage.sel_begin); + coverage.scroll_window(element.offsetTop - 60); + } +}; + +coverage.scroll_window = function (to_pos) { + window.scroll({top: to_pos, behavior: "smooth"}); +}; + +coverage.init_scroll_markers = function () { + // Init some variables + coverage.lines_len = document.querySelectorAll("#source > p").length; + + // Build html + coverage.build_scroll_markers(); +}; + +coverage.build_scroll_markers = function () { + const temp_scroll_marker = document.getElementById("scroll_marker") + if (temp_scroll_marker) temp_scroll_marker.remove(); + // Don't build markers if the window has no scroll bar. + if (document.body.scrollHeight <= window.innerHeight) { + return; + } + + const marker_scale = window.innerHeight / document.body.scrollHeight; + const line_height = Math.min(Math.max(3, window.innerHeight / coverage.lines_len), 10); + + let previous_line = -99, last_mark, last_top; + + const scroll_marker = document.createElement("div"); + scroll_marker.id = "scroll_marker"; + document.getElementById("source").querySelectorAll( + "p.show_run, p.show_mis, p.show_exc, p.show_exc, p.show_par" + ).forEach(element => { + const line_top = Math.floor(element.offsetTop * marker_scale); + const line_number = parseInt(element.querySelector(".n a").id.substr(1)); + + if (line_number === previous_line + 1) { + // If this solid missed block just make previous mark higher. + last_mark.style.height = `${line_top + line_height - last_top}px`; + } else { + // Add colored line in scroll_marker block. + last_mark = document.createElement("div"); + last_mark.id = `m${line_number}`; + last_mark.classList.add("marker"); + last_mark.style.height = `${line_height}px`; + last_mark.style.top = `${line_top}px`; + scroll_marker.append(last_mark); + last_top = line_top; + } + + previous_line = line_number; + }); + + // Append last to prevent layout calculation + document.body.append(scroll_marker); +}; + +coverage.wire_up_sticky_header = function () { + const header = document.querySelector("header"); + const header_bottom = ( + header.querySelector(".content h2").getBoundingClientRect().top - + header.getBoundingClientRect().top + ); + + function updateHeader() { + if (window.scrollY > header_bottom) { + header.classList.add("sticky"); + } else { + header.classList.remove("sticky"); + } + } + + window.addEventListener("scroll", updateHeader); + updateHeader(); +}; + +coverage.expand_contexts = function (e) { + var ctxs = e.target.parentNode.querySelector(".ctxs"); + + if (!ctxs.classList.contains("expanded")) { + var ctxs_text = ctxs.textContent; + var width = Number(ctxs_text[0]); + ctxs.textContent = ""; + for (var i = 1; i < ctxs_text.length; i += width) { + key = ctxs_text.substring(i, i + width).trim(); + ctxs.appendChild(document.createTextNode(contexts[key])); + ctxs.appendChild(document.createElement("br")); + } + ctxs.classList.add("expanded"); + } +}; + +document.addEventListener("DOMContentLoaded", () => { + if (document.body.classList.contains("indexfile")) { + coverage.index_ready(); + } else { + coverage.pyfile_ready(); + } +}); diff --git a/coverage/d_17bd492d087794b9_CLI_py.html b/coverage/d_17bd492d087794b9_CLI_py.html new file mode 100644 index 00000000..e87f49f2 --- /dev/null +++ b/coverage/d_17bd492d087794b9_CLI_py.html @@ -0,0 +1,275 @@ + + + + ++ « prev + ^ index + » next + + coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+ +1# ==================================================================================================================== #
+2# _____ ____ _ _ _ _ ____ ___ ____ #
+3# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+4# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+5# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+7# |_| |___/ #
+8# ==================================================================================================================== #
+9# Authors: #
+10# Patrick Lehmann #
+11# #
+12# License: #
+13# ==================================================================================================================== #
+14# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+15# #
+16# Licensed under the Apache License, Version 2.0 (the "License"); #
+17# you may not use this file except in compliance with the License. #
+18# You may obtain a copy of the License at #
+19# #
+20# http://www.apache.org/licenses/LICENSE-2.0 #
+21# #
+22# Unless required by applicable law or agreed to in writing, software #
+23# distributed under the License is distributed on an "AS IS" BASIS, #
+24# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+25# See the License for the specific language governing permissions and #
+26# limitations under the License. #
+27# #
+28# SPDX-License-Identifier: Apache-2.0 #
+29# ==================================================================================================================== #
+30#
+31"""Testcase for CLI tests."""
+32import sys
+33from io import StringIO
+34from unittest import TestCase
+35from unittest.mock import patch
+ +37from pyEDAA.UCIS.CLI import Program, main
+ + +40if __name__ == "__main__": # pragma: no cover 40 ↛ 41line 40 didn't jump to line 41, because the condition on line 40 was never true
+41 print("ERROR: you called a testcase declaration file as an executable module.")
+42 print("Use: 'python -m unitest <testcase module>'")
+43 exit(1)
+ + +46PROGRAM = "pyedaa-ucis"
+ +48class Help(TestCase):
+49 _program: Program
+ +51 def setUp(self) -> None:
+52 self._program = Program()
+ +54 @patch('sys.stderr', new_callable=StringIO)
+55 @patch('sys.stdout', new_callable=StringIO)
+56 def test_NoOptions(self, stdoutStream: StringIO, stderrStream: StringIO):
+57 sys.argv = [PROGRAM]
+ +59 self._program.Run()
+ +61 stdout = stdoutStream.getvalue()
+62 stderr = stderrStream.getvalue()
+63 self.assertIn("UCDB Service Program", stdout)
+64 self.assertIn(f"usage: {PROGRAM}", stdout)
+65 self.assertEqual("", stderr)
+ +67 @patch('sys.stderr', new_callable=StringIO)
+68 @patch('sys.stdout', new_callable=StringIO)
+69 def test_HelpCommand(self, stdoutStream: StringIO, stderrStream: StringIO):
+70 sys.argv = [PROGRAM, "help"]
+ +72 self._program.Run()
+ +74 stdout = stdoutStream.getvalue()
+75 stderr = stderrStream.getvalue()
+76 self.assertIn("UCDB Service Program", stdout)
+77 self.assertIn(f"usage: {PROGRAM}", stdout)
+78 self.assertEqual("", stderr)
+ +80 @patch('sys.stderr', new_callable=StringIO)
+81 @patch('sys.stdout', new_callable=StringIO)
+82 def test_HelpForExport(self, stdoutStream: StringIO, stderrStream: StringIO):
+83 sys.argv = [PROGRAM, "help", "export"]
+ +85 self._program.Run()
+ +87 stdout = stdoutStream.getvalue()
+88 stderr = stderrStream.getvalue()
+89 self.assertIn("UCDB Service Program", stdout)
+90 self.assertIn(f"usage: {PROGRAM}", stdout)
+91 self.assertEqual("", stderr)
+ +93 @patch('sys.stderr', new_callable=StringIO)
+94 @patch('sys.stdout', new_callable=StringIO)
+95 def test_UnknownCommand(self, stdoutStream: StringIO, stderrStream: StringIO):
+96 sys.argv = [PROGRAM, "expand"]
+ +98 with self.assertRaises(SystemExit) as ex:
+99 self._program.Run()
+ +101 self.assertEqual(2, ex.exception.code)
+ +103 stdout = stdoutStream.getvalue()
+104 stderr = stderrStream.getvalue()
+105 self.assertEqual("", stdout)
+106 self.assertIn(f"usage: {PROGRAM}", stderr)
+ +108 @patch('sys.stderr', new_callable=StringIO)
+109 @patch('sys.stdout', new_callable=StringIO)
+110 def test_HelpCommandUnknownCommand(self, stdoutStream: StringIO, stderrStream: StringIO):
+111 sys.argv = [PROGRAM, "help", "expand"]
+ +113 self._program.Run()
+ +115 stdout = stdoutStream.getvalue()
+116 stderr = stderrStream.getvalue()
+117 self.assertIn("Command expand is unknown.", stdout)
+118 self.assertEqual("", stderr)
+ + +121class Version(TestCase):
+122 _program: Program
+ +124 def setUp(self) -> None:
+125 self._program = Program()
+ +127 @patch('sys.stderr', new_callable=StringIO)
+128 @patch('sys.stdout', new_callable=StringIO)
+129 def test_VersionCommand(self, stdoutStream: StringIO, stderrStream: StringIO):
+130 sys.argv = [PROGRAM, "version"]
+ +132 self._program.Run()
+ +134 stdout = stdoutStream.getvalue()
+135 stderr = stderrStream.getvalue()
+136 self.assertIn("UCDB Service Program", stdout)
+137 self.assertIn("Version:", stdout)
+138 self.assertEqual("", stderr)
+ + +141class Export(TestCase):
+142 _program: Program
+ +144 def setUp(self) -> None:
+145 self._program = Program()
+ +147 @patch('sys.stderr', new_callable=StringIO)
+148 @patch('sys.stdout', new_callable=StringIO)
+149 def test_ExportCommandNoFilenames(self, stdoutStream: StringIO, stderrStream: StringIO):
+150 sys.argv = [PROGRAM, "export"]
+ +152 with self.assertRaises(SystemExit) as ex:
+153 self._program.Run()
+ +155 self.assertEqual(3, ex.exception.code)
+ +157 stdout = stdoutStream.getvalue()
+158 stderr = stderrStream.getvalue()
+159 self.assertIn("UCDB Service Program", stdout)
+160 self.assertEqual("", stderr)
+ +162 @patch('sys.stderr', new_callable=StringIO)
+163 @patch('sys.stdout', new_callable=StringIO)
+164 def test_ExportCommandWithFilenames(self, stdoutStream: StringIO, stderrStream: StringIO):
+165 sys.argv = [PROGRAM, "export", "--ucdb", "file1.xml", "--cobertura", "file2.xml"]
+ +167 with self.assertRaises(SystemExit) as ex:
+168 main()
+ +170 self.assertEqual(1, ex.exception.code)
+ +172 stdout = stdoutStream.getvalue()
+173 stderr = stderrStream.getvalue()
+174 self.assertIn("UCDB Service Program", stdout)
+175 self.assertIn("ERROR", stdout)
+176 self.assertEqual("", stderr)
++ « prev + ^ index + » next + + coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+ +1# ==================================================================================================================== #
+2# _____ ____ _ _ _ _ ____ ___ ____ #
+3# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+4# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+5# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+7# |_| |___/ #
+8# ==================================================================================================================== #
+9# Authors: #
+10# Patrick Lehmann #
+11# #
+12# License: #
+13# ==================================================================================================================== #
+14# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+15# #
+16# Licensed under the Apache License, Version 2.0 (the "License"); #
+17# you may not use this file except in compliance with the License. #
+18# You may obtain a copy of the License at #
+19# #
+20# http://www.apache.org/licenses/LICENSE-2.0 #
+21# #
+22# Unless required by applicable law or agreed to in writing, software #
+23# distributed under the License is distributed on an "AS IS" BASIS, #
+24# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+25# See the License for the specific language governing permissions and #
+26# limitations under the License. #
+27# #
+28# SPDX-License-Identifier: Apache-2.0 #
+29# ==================================================================================================================== #
+30#
+31"""Testcase for UCDB file conversions."""
+32from pathlib import Path
+33from unittest import TestCase
+ +35from pyEDAA.UCIS.UCDB import Parser
+ + +38if __name__ == "__main__": # pragma: no cover 38 ↛ 39line 38 didn't jump to line 39, because the condition on line 38 was never true
+39 print("ERROR: you called a testcase declaration file as an executable module.")
+40 print("Use: 'python -m unitest <testcase module>'")
+41 exit(1)
+ + +44class ExportAndConvert(TestCase):
+45 def test_UCDB2Cobertura(self):
+46 ucdbPath = Path("tests/data/ucdb.xml")
+47 coberturaPath = Path("tests/data/cobertura.xml")
+ +49 parser = Parser(ucdbPath, False)
+50 model = parser.getCoberturaModel()
+ +52 coberturaContent = model.getXml()
+ +54 self.assertIsNotNone(coberturaContent)
+ +56 parser = Parser(ucdbPath, True)
+57 model = parser.getCoberturaModel()
+ +59 coberturaContent = model.getXml()
+ +61 self.assertIsNotNone(coberturaContent)
+ + +64class CoverageValues(TestCase):
+65 def _parseUCDB(self, ucdbPath, mergeInstances):
+66 parser = Parser(ucdbPath, mergeInstances)
+67 model = parser.getCoberturaModel()
+68 model.getXml()
+ +70 return parser, model
+ +72 def test_multipleInstances(self):
+73 ucdbPath = Path("tests/data/ucdb000_multiple_instances.xml")
+ +75 (parser, model) = self._parseUCDB(
+76 ucdbPath,
+77 False,
+78 )
+ +80 self.assertEqual(15, parser.statementsCount)
+81 self.assertEqual(14, parser.statementsCovered)
+82 self.assertEqual(7, model.linesValid)
+83 self.assertEqual(6, model.linesCovered)
+ +85 (parser, model) = self._parseUCDB(
+86 ucdbPath,
+87 True,
+88 )
+ +90 self.assertEqual(9, parser.statementsCount)
+91 self.assertEqual(8, parser.statementsCovered)
+92 self.assertEqual(7, model.linesValid)
+93 self.assertEqual(6, model.linesCovered)
+ +95 def test_allExcluded(self):
+96 ucdbPath = Path("tests/data/ucdb001_all_excluded.xml")
+ +98 (parser, model) = self._parseUCDB(
+99 ucdbPath,
+100 False,
+101 )
+ +103 self.assertEqual(0, parser.statementsCount)
+104 self.assertEqual(0, parser.statementsCovered)
+105 self.assertEqual(0, model.linesValid)
+106 self.assertEqual(0, model.linesCovered)
+ +108 (parser, model) = self._parseUCDB(
+109 ucdbPath,
+110 True,
+111 )
+ +113 self.assertEqual(0, parser.statementsCount)
+114 self.assertEqual(0, parser.statementsCovered)
+115 self.assertEqual(0, model.linesValid)
+116 self.assertEqual(0, model.linesCovered)
+ +118 def test_partiallyExcluded(self):
+119 ucdbPath = Path("tests/data/ucdb002_partially_excluded.xml")
+ +121 (parser, model) = self._parseUCDB(
+122 ucdbPath,
+123 False,
+124 )
+ +126 self.assertEqual(5, parser.statementsCount)
+127 self.assertEqual(4, parser.statementsCovered)
+128 self.assertEqual(5, model.linesValid)
+129 self.assertEqual(4, model.linesCovered)
+ +131 (parser, model) = self._parseUCDB(
+132 ucdbPath,
+133 True,
+134 )
+ +136 self.assertEqual(5, parser.statementsCount)
+137 self.assertEqual(4, parser.statementsCovered)
+138 self.assertEqual(5, model.linesValid)
+139 self.assertEqual(4, model.linesCovered)
++ « prev + ^ index + » next + + coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+ +1# ==================================================================================================================== #
+2# _____ ____ _ _ _ _ ____ ___ ____ #
+3# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+4# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+5# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+7# |_| |___/ #
+8# ==================================================================================================================== #
+9# Authors: #
+10# Artur Porebski (Aldec Inc.) #
+11# Michal Pacula (Aldec Inc.) #
+12# #
+13# License: #
+14# ==================================================================================================================== #
+15# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+16# #
+17# Licensed under the Apache License, Version 2.0 (the "License"); #
+18# you may not use this file except in compliance with the License. #
+19# You may obtain a copy of the License at #
+20# #
+21# http://www.apache.org/licenses/LICENSE-2.0 #
+22# #
+23# Unless required by applicable law or agreed to in writing, software #
+24# distributed under the License is distributed on an "AS IS" BASIS, #
+25# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+26# See the License for the specific language governing permissions and #
+27# limitations under the License. #
+28# #
+29# SPDX-License-Identifier: Apache-2.0 #
+30# ==================================================================================================================== #
+31#
+32"""
+33Data model of the Cobertura format.
+ +35.. mermaid::
+ +37 flowchart LR
+38 Coverage --> Package --> Class --> Statement
+ +40"""
+41from time import time
+42from typing import Dict, Set
+ +44from lxml import etree
+45from pyTooling.Decorators import export
+ + +48@export
+49class CoberturaException(Exception):
+50 """Base-class for other Cobertura exceptions"""
+ + +53@export
+54class DuplicatedLineNumber(CoberturaException):
+55 """Raised when statement with specified line number already exists in Cobertura class"""
+ + +58@export
+59class DuplicatedClassName(CoberturaException):
+60 """Raised when class with specified name already exists in Cobertura package"""
+ + +63@export
+64class DuplicatedPackageName(CoberturaException):
+65 """Raised when package with specified name already exists in Cobertura coverage"""
+ + +68@export
+69class Class:
+70 """Represents a code element in the Cobertura coverage data model (Java-focused)."""
+ +72 name: str
+73 sourceFile: str
+74 lines: Dict[int, int]
+75 linesValid: int
+76 linesCovered: int
+ +78 def __init__(self, name: str, sourceFile: str):
+79 self.name = name
+80 self.sourceFile = sourceFile
+81 self.lines = {}
+82 self.linesValid = 0
+83 self.linesCovered = 0
+ +85 def addStatement(self, line: int, hits: int) -> None:
+86 if line in self.lines.keys(): 86 ↛ 87line 86 didn't jump to line 87, because the condition on line 86 was never true
+87 raise DuplicatedLineNumber(f"Duplicated line number: {line}")
+ +89 self.lines[line] = hits
+90 self.linesValid += 1
+ +92 if hits:
+93 self.linesCovered += 1
+ +95 def getXmlNode(self) -> etree._Element:
+96 classNode = etree.Element("class")
+97 classNode.attrib["name"] = self.sourceFile
+98 classNode.attrib["filename"] = self.sourceFile
+99 classNode.attrib["complexity"] = "0"
+100 classNode.attrib["branch-rate"] = "0"
+ +102 try:
+103 rate = self.linesCovered / self.linesValid
+104 except ZeroDivisionError:
+105 rate = 1.0
+ +107 classNode.attrib["line-rate"] = f"{rate:.16g}"
+ +109 classNode.append(etree.Element("methods"))
+110 linesNode = etree.SubElement(classNode, "lines")
+ +112 for line in self.lines:
+113 etree.SubElement(
+114 linesNode,
+115 "line",
+116 number=str(line),
+117 hits=str(self.lines[line]),
+118 )
+ +120 return classNode
+ + +123@export
+124class Package:
+125 """Represents a grouping element in the Cobertura coverage data model (Java-focused)."""
+ +127 name: str
+128 classes: Dict[str, Class]
+129 linesValid: int
+130 linesCovered: int
+ +132 def __init__(self, name: str):
+133 self.name = name
+134 self.classes = {}
+135 self.linesValid = 0
+136 self.linesCovered = 0
+ +138 def addClass(self, coberturaClass: Class):
+139 if coberturaClass.name in self.classes: 139 ↛ 140line 139 didn't jump to line 140, because the condition on line 139 was never true
+140 raise DuplicatedClassName(f"Duplicated class name: '{coberturaClass.name}'.")
+ +142 self.classes[coberturaClass.name] = coberturaClass
+ +144 def refreshStatistics(self) -> None:
+145 self.linesValid = 0
+146 self.linesCovered = 0
+ +148 for coberturaClass in self.classes.values():
+149 self.linesCovered += coberturaClass.linesCovered
+150 self.linesValid += coberturaClass.linesValid
+ +152 def getXmlNode(self) -> etree._Element:
+153 classesNode = etree.Element("classes")
+154 packageNode = etree.Element("package")
+155 packageNode.attrib["name"] = self.name
+156 packageNode.attrib["complexity"] = "0"
+157 packageNode.attrib["branch-rate"] = "0"
+ +159 try:
+160 rate = self.linesCovered / self.linesValid
+161 except ZeroDivisionError:
+162 rate = 1.0
+ +164 packageNode.attrib["line-rate"] = f"{rate:.16g}"
+ +166 packageNode.append(classesNode)
+ +168 for coberturaClass in self.classes.values():
+169 classesNode.append(coberturaClass.getXmlNode())
+ +171 return packageNode
+ + +174@export
+175class Coverage:
+176 """Represents the root element in the Cobertura coverage data model (Java-focused)."""
+ +178 sources: Set
+179 packages: Dict[str, Package]
+180 linesValid: int
+181 linesCovered: int
+ +183 def __init__(self):
+184 self.sources = set()
+185 self.packages = {}
+186 self.linesValid = 0
+187 self.linesCovered = 0
+ +189 def addSource(self, source: str) -> None:
+190 self.sources.add(source)
+ +192 def addPackage(self, package: Package) -> None:
+193 if package.name in self.packages: 193 ↛ 194line 193 didn't jump to line 194, because the condition on line 193 was never true
+194 raise DuplicatedPackageName(f"Duplicated package name: '{package.name}'.")
+ +196 self.packages[package.name] = package
+ +198 def refreshStatistics(self) -> None:
+199 self.linesValid = 0
+200 self.linesCovered = 0
+ +202 for package in self.packages.values():
+203 package.refreshStatistics()
+204 self.linesCovered += package.linesCovered
+205 self.linesValid += package.linesValid
+ +207 def getXml(self) -> bytes:
+208 self.refreshStatistics()
+ +210 coverageNode = etree.Element("coverage")
+211 coverageNode.attrib["version"] = "5.5"
+212 coverageNode.attrib["timestamp"] = str(int(time()))
+213 coverageNode.attrib["branches-valid"] = "0"
+214 coverageNode.attrib["branches-covered"] = "0"
+215 coverageNode.attrib["branch-rate"] = "0"
+216 coverageNode.attrib["complexity"] = "0"
+ +218 sourcesNode = etree.Element("sources")
+ +220 for source in self.sources:
+221 etree.SubElement(sourcesNode, "source").text = source
+ +223 coverageNode.append(sourcesNode)
+ +225 packagesNode = etree.Element("packages")
+ +227 for package in self.packages.values():
+228 packagesNode.append(package.getXmlNode())
+ +230 coverageNode.append(packagesNode)
+ +232 coverageNode.attrib["lines-valid"] = str(self.linesValid)
+233 coverageNode.attrib["lines-covered"] = str(self.linesCovered)
+ +235 try:
+236 rate = self.linesCovered / self.linesValid
+237 except ZeroDivisionError:
+238 rate = 1.0
+ +240 coverageNode.attrib["line-rate"] = f"{rate:.16g}"
+ +242 return etree.tostring(
+243 coverageNode, pretty_print=True, encoding="utf-8", xml_declaration=True
+244 )
++ « prev + ^ index + » next + + coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+ +1# ==================================================================================================================== #
+2# _____ ____ _ _ _ _ ____ ___ ____ #
+3# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+4# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+5# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+7# |_| |___/ #
+8# ==================================================================================================================== #
+9# Authors: #
+10# Artur Porebski (Aldec Inc.) #
+11# Michal Pacula (Aldec Inc.) #
+12# #
+13# License: #
+14# ==================================================================================================================== #
+15# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+16# #
+17# Licensed under the Apache License, Version 2.0 (the "License"); #
+18# you may not use this file except in compliance with the License. #
+19# You may obtain a copy of the License at #
+20# #
+21# http://www.apache.org/licenses/LICENSE-2.0 #
+22# #
+23# Unless required by applicable law or agreed to in writing, software #
+24# distributed under the License is distributed on an "AS IS" BASIS, #
+25# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+26# See the License for the specific language governing permissions and #
+27# limitations under the License. #
+28# #
+29# SPDX-License-Identifier: Apache-2.0 #
+30# ==================================================================================================================== #
+31#
+32"""Data model of the UCDB format."""
+33from collections import namedtuple, defaultdict
+34from itertools import groupby
+35from operator import attrgetter
+36from pathlib import Path
+37from typing import List, Tuple, Dict, DefaultDict
+ +39from lxml import etree
+40from pyTooling.Decorators import export
+ +42from pyEDAA.UCIS.Cobertura import Class, Coverage, Package
+ + +45UCDB_EXCLUDE_PRAGMA = 0x00000020
+46UCDB_EXCLUDE_FILE = 0x00000040
+47UCDB_EXCLUDE_INST = 0x00000080
+48UCDB_EXCLUDE_AUTO = 0x00000100
+ +50UCDB_EXCLUDED = (
+51 UCDB_EXCLUDE_FILE | UCDB_EXCLUDE_PRAGMA | UCDB_EXCLUDE_INST | UCDB_EXCLUDE_AUTO
+52)
+ +54StatementData = namedtuple(
+55 "StatementData",
+56 ["file", "line", "index", "instance", "hits"],
+57)
+ + +60@export
+61class UcdbParserException(Exception):
+62 """Base-class for other UCDB Parser exceptions"""
+ + +65@export
+66class InternalErrorOccurred(UcdbParserException):
+67 """Raised when internal error occurred"""
+ + +70@export
+71class Parser:
+72 _mergeInstances: bool
+73 _tree: etree._ElementTree
+74 _nsmap: Dict
+75 _coverage: Coverage
+76 statementsCount: int
+77 statementsCovered: int
+ +79 def __init__(self, ucdbFile: Path, mergeInstances: bool):
+80 self._mergeInstances = mergeInstances
+ +82 with ucdbFile.open("r") as filename:
+83 self._tree = etree.parse(filename)
+ +85 self._nsmap = {
+86 k: v for (k, v) in self._tree.getroot().nsmap.items() if k is not None
+87 }
+ +89 self._coverage = Coverage()
+ +91 self.statementsCount = 0
+92 self.statementsCovered = 0
+ +94 def getCoberturaModel(self) -> Coverage:
+95 self._parseStatementCoverage()
+ +97 return self._coverage
+ +99 def _groupByIndex(self, statements: List[StatementData]) -> List[StatementData]:
+100 groupedStmts = []
+ +102 sortedStmts = sorted(statements, key=attrgetter("index"))
+103 for index, stmts in groupby(sortedStmts, key=attrgetter("index")):
+104 hit = any((stmt.hits for stmt in stmts))
+ +106 groupedStmts.append(
+107 StatementData(
+108 file=statements[0].file,
+109 line=statements[0].line,
+110 index=index,
+111 instance="",
+112 hits=hit,
+113 )
+114 )
+ +116 return groupedStmts
+ +118 def _parseStatementCoverage(self) -> None:
+119 scopes = self._tree.xpath(
+120 "/ux:ucdb/ux:scope[.//ux:bin[@type='STMTBIN']]", namespaces=self._nsmap
+121 )
+ +123 if not isinstance(scopes, list): 123 ↛ 124line 123 didn't jump to line 124, because the condition on line 123 was never true
+124 raise InternalErrorOccurred(f"Unexpected type: '{scopes.__class__.__name__}'.")
+ +126 nodes: List[etree._Element] = []
+ +128 for scopeNode in scopes:
+129 if not isinstance(scopeNode, etree._Element): 129 ↛ 130line 129 didn't jump to line 130, because the condition on line 129 was never true
+130 raise InternalErrorOccurred(f"Unexpected type: '{scopeNode.__class__.__name__}'.")
+ +132 typeName = scopeNode.get("type")
+ +134 if typeName is None: 134 ↛ 135line 134 didn't jump to line 135, because the condition on line 134 was never true
+135 raise InternalErrorOccurred("Unexpected 'None' value.")
+ +137 if typeName.startswith("DU_"):
+138 continue
+ +140 statementBins = scopeNode.xpath(".//ux:bin[@type='STMTBIN']", namespaces=self._nsmap)
+ +142 if not isinstance(statementBins, list): 142 ↛ 143line 142 didn't jump to line 143, because the condition on line 142 was never true
+143 raise InternalErrorOccurred(f"Unexpected type: '{statementBins.__class__.__name__}'.")
+ +145 for statementBin in statementBins:
+146 if not isinstance(statementBin, etree._Element): 146 ↛ 147line 146 didn't jump to line 147, because the condition on line 146 was never true
+147 raise InternalErrorOccurred(f"Unexpected type: '{statementBin.__class__.__name__}'.")
+ +149 nodes.append(statementBin)
+ +151 statements: DefaultDict[str, DefaultDict[int, List]] = defaultdict(lambda: defaultdict(list))
+ +153 for node in nodes:
+154 workdir, stmtData = self._parseStatementNode(node)
+155 self._coverage.addSource(workdir)
+ +157 flags = node.get("flags")
+ +159 if flags is None: 159 ↛ 160line 159 didn't jump to line 160, because the condition on line 159 was never true
+160 raise InternalErrorOccurred("Unexpected 'None' value.")
+ +162 if int(flags, 16) & UCDB_EXCLUDED:
+163 _ = statements[stmtData.file]
+164 continue
+ +166 statements[stmtData.file][stmtData.line].append(stmtData)
+ +168 for file, lines in statements.items():
+169 package = Package(file)
+170 coberturaClass = Class(file, file)
+171 package.addClass(coberturaClass)
+172 self._coverage.addPackage(package)
+ +174 for line, lineStmts in lines.items():
+175 if self._mergeInstances:
+176 lineStmts = self._groupByIndex(lineStmts)
+ +178 self.statementsCount += len(lineStmts)
+ +180 covered = len(list(filter(attrgetter("hits"), lineStmts)))
+181 hit = int(covered == len(lineStmts))
+ +183 self.statementsCovered += covered
+ +185 coberturaClass.addStatement(line, hit)
+ +187 def _parseStatementNode(self, node) -> Tuple[str, StatementData]:
+188 srcNode = node.find("./ux:src", namespaces=self._nsmap)
+189 workdir = srcNode.get("workdir")
+ +191 instancePath = ".".join(
+192 (scope.get("name") for scope in node.iterancestors("{*}scope"))
+193 )
+ +195 stmtIndex = int(
+196 node.find("./ux:attr[@key='#SINDEX#']", namespaces=self._nsmap).text
+197 )
+ +199 count = int(node.find("./ux:count", namespaces=self._nsmap).text)
+ +201 stmtData = StatementData(
+202 file=srcNode.get("file"),
+203 line=int(srcNode.get("line")),
+204 index=stmtIndex,
+205 instance=instancePath,
+206 hits=count,
+207 )
+ +209 return workdir, stmtData
++ « prev + ^ index + » next + + coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+ +1# ==================================================================================================================== #
+2# _____ ____ _ _ _ _ ____ ___ ____ #
+3# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| #
+4# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ #
+5# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | #
+6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ #
+7# |_| |___/ #
+8# ==================================================================================================================== #
+9# Authors: #
+10# Patrick Lehmann #
+11# Artur Porebski (Aldec Inc.) #
+12# Michal Pacula (Aldec Inc.) #
+13# #
+14# License: #
+15# ==================================================================================================================== #
+16# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) #
+17# #
+18# Licensed under the Apache License, Version 2.0 (the "License"); #
+19# you may not use this file except in compliance with the License. #
+20# You may obtain a copy of the License at #
+21# #
+22# http://www.apache.org/licenses/LICENSE-2.0 #
+23# #
+24# Unless required by applicable law or agreed to in writing, software #
+25# distributed under the License is distributed on an "AS IS" BASIS, #
+26# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+27# See the License for the specific language governing permissions and #
+28# limitations under the License. #
+29# #
+30# SPDX-License-Identifier: Apache-2.0 #
+31# ==================================================================================================================== #
+32#
+33"""
+34Tools to extract data from UCDB files.
+ +36.. rubric:: Usage
+ +38First export/convert the Aldec Coverage Database (ACDB) into UCDB (Universal Coverage Database) format. The
+39helper program ``acdb2xml`` (part of Active-HDL or Riviera-PRO installation) can be used.
+ +41.. code-block::
+ +43 acdb2xml -i aggregate.acdb -o ucdb.xml
+ +45At next use this layer's service program to convert from UCDB to Cobertura format.
+ +47.. code-block::
+ +49 pyedaa-ucis export --ucdb ucdb.xml --cobertura cobertura.xml
+50"""
+51from argparse import RawDescriptionHelpFormatter
+52from pathlib import Path
+53from textwrap import dedent
+ +55from pyAttributes.ArgParseAttributes import ArgParseMixin, DefaultAttribute, CommandAttribute, ArgumentAttribute, SwitchArgumentAttribute
+ +57from pyTooling.Decorators import export
+ +59from pyEDAA.UCIS import __version__, __copyright__, __license__
+60from pyEDAA.UCIS.UCDB import Parser
+61from pyEDAA.UCIS.Cobertura import CoberturaException
+ + +64@export
+65class ProgramBase():
+66 """Base-class for all program classes."""
+ +68 programTitle = "UCDB Service Program"
+ +70 def __init__(self) -> None:
+71 pass
+ +73 def _PrintHeadline(self) -> None:
+74 """Print the programs headline."""
+75 print("{line}".format(line="=" * 120))
+76 print("{headline: ^120s}".format(headline=self.programTitle))
+77 print("{line}".format(line="=" * 120))
+ + +80@export
+81class Program(ProgramBase, ArgParseMixin):
+82 """Program class to implement the command line interface (CLI) using commands and options."""
+ +84 def __init__(self) -> None:
+85 super().__init__()
+ +87 # Call the constructor of the ArgParseMixin
+88 ArgParseMixin.__init__(
+89 self,
+90 prog="pyedaa-ucis",
+91 description=dedent('''\
+92 'pyEDAA.UCIS Service Program' to query and transform data to/from UCIS to any other format.
+93 '''),
+94 epilog=dedent("""\
+95 Currently the following output formats are supported:
+96 * Cobertura (statement coverage - Java oriented format)
+97 """),
+98 formatter_class=RawDescriptionHelpFormatter,
+99 add_help=False
+100 )
+ +102# @CommonSwitchArgumentAttribute("-q", "--quiet", dest="quiet", help="Reduce messages to a minimum.")
+103# @CommonSwitchArgumentAttribute("-v", "--verbose", dest="verbose", help="Print out detailed messages.")
+104# @CommonSwitchArgumentAttribute("-d", "--debug", dest="debug", help="Enable debug mode.")
+105 def Run(self) -> None:
+106 ArgParseMixin.Run(self)
+ +108 @DefaultAttribute()
+109 def HandleDefault(self, _) -> None:
+110 """Handle program calls without any command."""
+111 self._PrintHeadline()
+112 self._PrintHelp()
+ +114 @CommandAttribute("help", help="Display help page(s) for the given command name.", description="Display help page(s) for the given command name.")
+115 @ArgumentAttribute(metavar="Command", dest="Command", type=str, nargs="?", help="Print help page(s) for a command.")
+116 def HandleHelp(self, args) -> None:
+117 """Handle program calls with command ``help``."""
+118 self._PrintHeadline()
+119 self._PrintHelp(args.Command)
+ +121 @CommandAttribute("version", help="Display version information.", description="Display version information.")
+122 def HandleVersion(self, _) -> None:
+123 """Handle program calls with command ``version``."""
+124 self._PrintHeadline()
+125 self._PrintVersion()
+ +127 @CommandAttribute("export", help="Export data from UCDB.", description="Export data from UCDB.")
+128 @ArgumentAttribute("--ucdb", metavar='UCDBFile', dest="ucdb", type=str, help="UCDB file in UCIS format (XML).")
+129 @ArgumentAttribute("--cobertura", metavar='CoberturaFile', dest="cobertura", type=str, help="Cobertura code coverage file (XML).")
+130 @SwitchArgumentAttribute("--merge-instances", dest="mergeInstances", help="Merge statement coverage data for all instances of the same design unit.")
+131 def HandleExport(self, args) -> None:
+132 """Handle program calls with command ``export``."""
+133 self._PrintHeadline()
+ +135 returnCode = 0
+136 if args.ucdb is None:
+137 print(f"Option '--ucdb <UCDBFile' is missing.")
+138 returnCode = 3
+139 if args.cobertura is None:
+140 print(f"Option '--cobertura <CoberturaFile' is missing.")
+141 returnCode = 3
+ +143 if returnCode != 0:
+144 exit(returnCode)
+ +146 print(f"Exporting code coverage information from UCDB file to Cobertura format ...")
+ +148 ucdbPath = Path(args.ucdb)
+149 if not ucdbPath.exists(): 149 ↛ 152line 149 didn't jump to line 152, because the condition on line 149 was never false
+150 raise FileNotFoundError(f"UCDB databse file '{ucdbPath}' not found.")
+ +152 coberturaPath = Path(args.cobertura)
+ +154 print(f" IN -> UCIS (XML): {ucdbPath}")
+155 print(f" OUT <- Cobertura (XML): {coberturaPath}")
+ +157 parser = Parser(ucdbPath, args.mergeInstances)
+158 model = parser.getCoberturaModel()
+ +160 with coberturaPath.open('w') as file:
+161 file.write(model.getXml().decode("utf-8"))
+ +163 print()
+ +165 try:
+166 lineCoverage = model.linesCovered / model.linesValid * 100
+167 except ZeroDivisionError:
+168 lineCoverage = 100
+ +170 try:
+171 statementCoverage = parser.statementsCovered / parser.statementsCount * 100
+172 except ZeroDivisionError:
+173 statementCoverage = 100
+ +175 print(dedent(f"""\
+176 [DONE] Export and conversion complete.
+177 Line coverage: {lineCoverage} %
+178 Statement coverage: {statementCoverage} %
+179 """)
+180 )
+ +182 def _PrintVersion(self):
+183 """Helper function to print the version information."""
+184 print(dedent(f"""\
+185 Copyright: {__copyright__}
+186 License: {__license__}
+187 Version: v{__version__}
+188 """)
+189 )
+ +191 def _PrintHelp(self, command: str=None):
+192 """Helper function to print the command line parsers help page(s)."""
+193 if (command is None):
+194 self.MainParser.print_help()
+195 elif (command == "help"): 195 ↛ 196line 195 didn't jump to line 196, because the condition on line 195 was never true
+196 print("This is a recursion ...")
+197 else:
+198 try:
+199 self.SubParsers[command].print_help()
+200 except KeyError:
+201 print(f"Command {command} is unknown.")
+ + +204@export
+205def main():
+206 """
+207 Entrypoint to start program execution.
+ +209 This function should be called either from:
+210 * ``if __name__ == "__main__":`` or
+211 * ``console_scripts`` entry point configured via ``setuptools`` in ``setup.py``.
+ +213 This function creates an instance of :class:`Program` in a ``try ... except`` environment. Any exception caught is
+214 formatted and printed before the program returns with a non-zero exit code.
+215 """
+216 program = Program()
+217 try:
+218 program.Run()
+219 except FileNotFoundError as ex: 219 ↛ 223line 219 didn't jump to line 223
+220 print()
+221 print(f"[ERROR] {ex}")
+222 exit(1)
+223 except CoberturaException as ex:
+224 print()
+225 print(f"[INTERNAL ERROR] {ex}")
+226 exit(1)
+ + +229if __name__ == "__main__": 229 ↛ 230line 229 didn't jump to line 230, because the condition on line 229 was never true
+230 main()
++ coverage.py v7.3.4, + created at 2023-12-22 00:50 +0000 +
+| Module | +statements | +missing | +excluded | +branches | +partial | +coverage | +
|---|---|---|---|---|---|---|
| pyEDAA/UCIS/CLI/__init__.py | +100 | +23 | +0 | +22 | +4 | +76% | +
| pyEDAA/UCIS/Cobertura.py | +134 | +3 | +0 | +34 | +3 | +96% | +
| pyEDAA/UCIS/UCDB.py | +97 | +6 | +0 | +46 | +6 | +92% | +
| tests/unit/CLI.py | +106 | +3 | +0 | +8 | +1 | +96% | +
| tests/unit/UCDB.py | +62 | +3 | +0 | +2 | +1 | +94% | +
| Total | +507 | +38 | +0 | +112 | +15 | +91% | +
+ No items found using the specified filter. +
+2 files skipped due to complete coverage.
+
|
+
|
+
| + |
|
+
|
+
|
+
| + | + |
|
+
| + |
|
+ + |
|
+
|
+
|
+
+
Unified Coverage Interoperability Standard (UCIS).
+Parse UCDB files and provide a UCDB data model.
Export and convert code coverage information from UCDB to Cobertura format.
Also support flavors not following the Unified Coverage Interoperability Standard (UCIS).
Collect and merge code coverage with Active-HDL / Riviera-PRO and convert via UCDB format to Cobertura files, so +code coverage can be published to e.g. GitLab, Codacy or CodeCov.
Aldec Inc. provided bugfixes and enhancements to the original code contribution.
The initial script was released with EDA² branding.
Adjusted coding style.
Adjusted CLI interface to allow later extensions.
Added documentation and CI pipeline.
Aldec Inc. provied the initial UCDB to Cobertura conversion script.
Aldec Inc. gave permission to release the script as open source under Apache License, version 2.0.
This Python package (source code) is licensed under Apache License 2.0.
+The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).
Reference of all packages and modules:
+pyEDAA.UCISpyEDAA.UCIS.CLI
+pyEDAA.UCIS.Cobertura
+pyEDAA.UCIS.UCDB
+pyEDAA.UCIS.CLI¶Functions
+main():
+Entrypoint to start program execution.
Entrypoint to start program execution.
+if __name__ == "__main__": or
console_scripts entry point configured via setuptools in setup.py.
This function creates an instance of Program in a try ... except environment. Any exception caught is
+formatted and printed before the program returns with a non-zero exit code.
Classes
+ProgramBase:
+Base-class for all program classes.
Program:
+Program class to implement the command line interface (CLI) using commands and options.
pyEDAA.UCIS.Cobertura¶Classes
+Class:
+Represents a code element in the Cobertura coverage data model (Java-focused).
Package:
+Represents a grouping element in the Cobertura coverage data model (Java-focused).
Coverage:
+Represents the root element in the Cobertura coverage data model (Java-focused).
Represents a code element in the Cobertura coverage data model (Java-focused).
+Inheritance
+ +Represents a grouping element in the Cobertura coverage data model (Java-focused).
+Inheritance
+ +Represents the root element in the Cobertura coverage data model (Java-focused).
+Inheritance
+ +Exceptions
+CoberturaException:
+Base-class for other Cobertura exceptions
DuplicatedLineNumber:
+Raised when statement with specified line number already exists in Cobertura class
DuplicatedClassName:
+Raised when class with specified name already exists in Cobertura package
DuplicatedPackageName:
+Raised when package with specified name already exists in Cobertura coverage
Base-class for other Cobertura exceptions
+Inheritance
+ +Raised when statement with specified line number already exists in Cobertura class
+Inheritance
+ +pyEDAA.UCIS.UCDB¶Classes
+Parser:
+Undocumented.
Exceptions
+UcdbParserException:
+Base-class for other UCDB Parser exceptions
InternalErrorOccurred:
+Raised when internal error occurred
pyEDAA.UCIS¶Submodules
+pyEDAA.UCIS.CLI
+pyEDAA.UCIS.Cobertura
+pyEDAA.UCIS.UCDB
+pyEDAA.UCIS", "pyEDAA.UCIS.CLI", "pyEDAA.UCIS.Cobertura", "pyEDAA.UCIS.UCDB", "Static Type Checking Report"], "terms": {"\u00bd": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00bc": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u215b": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00be": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u215c": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u215d": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u215e": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "_": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00b5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03c9": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00aa": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00ba": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00b9": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00b2": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u00b3": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u212c": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2145": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u212d": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2102": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2146": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03dd": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2130": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2147": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2131": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u02c7": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u210f": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u210b": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2111": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2148": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2110": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2124": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2112": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2133": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2115": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2134": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u210c": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2119": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u210d": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u211a": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u211c": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u211b": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u211d": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03f5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03d5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03c5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03b5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03f0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03c6": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03d6": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03f1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03c2": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u03d1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "\u2128": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "convert": [0, 9], "acdb": 0, "file": [0, 1, 2, 6, 9], "ucdb": [0, 1, 4, 9, 11, 12], "xml": [0, 1, 4], "format": [0, 1, 3, 6, 9, 13], "acdb2xml": 0, "i": [0, 3, 6, 9, 13], "aggreg": 0, "o": 0, "cobertura": [0, 1, 4, 9, 11, 12], "pyedaa": [0, 5, 11], "uci": [0, 4, 5, 11], "export": [0, 9, 13], "isn": 0, "t": [0, 6], "support": [0, 1, 6, 9], "yet": [0, 2], "servic": [1, 2, 3, 6], "program": [1, 11, 12, 13], "queri": 1, "transform": [1, 3, 6], "data": [1, 9, 14], "from": [1, 3, 6, 13], "ani": [1, 2, 3, 6, 13], "other": [1, 6, 14, 15], "usag": 1, "current": 1, "follow": [1, 3, 6, 9], "output": 1, "ar": [1, 2, 3, 6], "statement": [1, 6, 14], "coverag": [1, 4, 9, 11, 12, 14], "java": [1, 14], "orient": 1, "h": 1, "ucdbfil": [1, 15], "coberturafil": 1, "merg": [1, 9], "instanc": [1, 3, 13], "show": 1, "thi": [1, 3, 6, 9, 13], "messag": 1, "exit": [1, 13], "code": [1, 2, 6, 13, 14], "all": [1, 2, 3, 6, 11, 13], "same": [1, 6], "design": [1, 3, 6], "unit": 1, "displai": [1, 3, 6], "page": [1, 6], "": [1, 3, 6], "given": 1, "name": [1, 6, 14], "print": [1, 6, 13], "inform": [1, 3, 6, 9], "librari": 2, "io": 2, "requir": [2, 3, 6], "version": [2, 6, 9, 13], "licens": 2, "pytool": 2, "1": 2, "9": [2, 3], "5": 2, "apach": [2, 9], "2": [2, 9], "0": [2, 9], "none": [2, 13], "pyattribut": [2, 13], "argcomplet": 2, "addit": [2, 3], "python": [2, 9], "need": [2, 3], "collect": [2, 3, 9], "static": 2, "These": 2, "develop": 2, "thu": 2, "sub": 2, "evalu": 2, "further": 2, "manual": 2, "instal": 2, "us": [2, 6, 13], "txt": 2, "via": [2, 9, 13], "pip3": [2, 5], "The": [2, 3, 6], "recurs": 2, "mandatori": 2, "too": 2, "u": [2, 5], "r": 2, "list": [2, 6], "pytest": [2, 7], "7": 2, "mit": 2, "Not": [2, 6], "cov": 2, "3": 2, "6": 2, "mypi": [2, 16], "931": 2, "lxml": 2, "4": [2, 9], "8": 2, "bsd": 2, "claus": 2, "gener": [2, 6, 7, 16], "doc": 2, "sphinx_btd_them": 2, "sphinx_fontawesom": 2, "gpl": 2, "sphinx_autodoc_typehint": 2, "17": 2, "build": 2, "wheel": 2, "e": [2, 9], "g": [2, 9], "pypi": 2, "equival": [2, 3], "maintain": [2, 9], "dist": 2, "twine": 2, "local": [3, 6], "copi": [3, 6], "cc": [3, 9], "BY": [3, 9], "appli": [3, 6], "onli": [3, 6], "document": [3, 6], "project": [3, 6], "corpor": 3, "law": [3, 6], "firm": 3, "doe": [3, 6], "provid": [3, 6], "legal": [3, 6], "advic": 3, "distribut": [3, 6], "creat": [3, 13], "lawyer": 3, "client": 3, "relationship": 3, "make": [3, 6], "its": [3, 6], "relat": 3, "avail": [3, 6], "an": [3, 6, 13], "basi": [3, 6], "give": [3, 6], "regard": [3, 6], "materi": 3, "under": [3, 6], "damag": [3, 6], "result": [3, 6], "fullest": 3, "extent": 3, "possibl": [3, 6], "standard": [3, 9], "set": 3, "creator": 3, "holder": 3, "mai": [3, 6], "share": [3, 6], "origin": [3, 6, 9], "work": [3, 6], "authorship": [3, 6], "subject": [3, 6], "copyright": 3, "certain": 3, "specifi": [3, 14], "below": [3, 6], "consider": 3, "purpos": [3, 6], "exhaust": 3, "do": [3, 6], "form": [3, 6], "part": [3, 6], "our": 3, "licensor": [3, 6], "intend": 3, "those": [3, 6], "author": [3, 6], "permiss": [3, 6, 9], "wai": 3, "otherwis": [3, 6], "restrict": 3, "irrevoc": [3, 6], "should": [3, 6, 13], "read": 3, "understand": 3, "thei": 3, "choos": [3, 6], "befor": [3, 13], "also": [3, 6, 9], "secur": 3, "necessari": 3, "so": [3, 9], "can": [3, 9], "reus": 3, "expect": 3, "clearli": 3, "mark": [3, 6], "includ": [3, 6], "except": [3, 6, 13, 14, 15], "more": [3, 6, 9], "By": 3, "one": [3, 6], "grant": 3, "If": [3, 6], "reason": [3, 6], "exampl": [3, 6], "becaus": 3, "applic": [3, 6], "regul": 3, "ha": [3, 6], "still": 3, "have": [3, 6], "A": [3, 6], "special": [3, 6], "request": 3, "ask": 3, "chang": [3, 6], "describ": [3, 6], "although": 3, "you": [3, 6], "encourag": 3, "respect": 3, "where": [3, 6], "exercis": [3, 6], "defin": [3, 6], "accept": 3, "agre": [3, 6], "bound": 3, "To": [3, 6], "contract": [3, 6], "your": [3, 6], "benefit": 3, "receiv": [3, 6], "adapt": 3, "mean": [3, 6], "similar": 3, "deriv": [3, 6], "base": [3, 6, 13, 14, 15], "upon": 3, "which": [3, 6], "translat": [3, 6], "alter": 3, "arrang": 3, "modifi": [3, 6], "manner": 3, "held": 3, "For": [3, 6], "music": 3, "perform": [3, 6], "sound": 3, "record": 3, "alwai": 3, "produc": 3, "synch": 3, "time": 3, "move": 3, "imag": 3, "contribut": [3, 9], "accord": 3, "close": 3, "without": [3, 6, 13], "broadcast": 3, "how": [3, 5, 6], "label": 3, "categor": 3, "b": 3, "effect": 3, "technolog": 3, "measur": 3, "absenc": 3, "proper": 3, "circumv": 3, "fulfil": 3, "oblig": [3, 6], "articl": 3, "11": 3, "wipo": 3, "treati": 3, "adopt": 3, "decemb": 3, "20": 3, "1996": 3, "agreement": [3, 6], "fair": 3, "deal": 3, "artist": 3, "literari": 3, "individu": [3, 6], "entiti": [3, 6], "process": 3, "reproduct": [3, 6], "dissemin": 3, "commun": [3, 6], "import": [3, 6], "member": 3, "access": 3, "place": [3, 6], "chosen": 3, "them": 3, "than": 3, "direct": [3, 6], "96": 3, "ec": 3, "european": 3, "parliament": 3, "council": 3, "march": 3, "protect": 3, "amend": 3, "succeed": 3, "well": 3, "essenti": 3, "anywher": 3, "world": 3, "correspond": 3, "herebi": [3, 6], "worldwid": [3, 6], "royalti": [3, 6], "free": [3, 6], "non": [3, 6, 13], "sublicens": [3, 6], "exclus": [3, 6], "reproduc": [3, 6], "whole": [3, 6], "avoid": 3, "doubt": 3, "compli": [3, 6], "media": [3, 6], "technic": 3, "modif": [3, 6], "allow": [3, 9], "whether": [3, 6], "now": 3, "known": 3, "hereaft": 3, "waiv": 3, "assert": [3, 6], "forbid": 3, "simpli": 3, "never": 3, "downstream": 3, "recipi": [3, 6], "offer": [3, 6], "everi": 3, "automat": 3, "No": 3, "impos": 3, "differ": [3, 6], "endors": 3, "noth": [3, 6], "constitut": [3, 6], "constru": [3, 6], "impli": [3, 6], "connect": 3, "sponsor": 3, "offici": 3, "statu": 3, "moral": 3, "integr": 3, "nor": 3, "privaci": 3, "person": 3, "howev": [3, 6], "patent": 3, "trademark": 3, "directli": 3, "through": [3, 6], "societi": 3, "voluntari": 3, "waivabl": 3, "statutori": 3, "compulsori": 3, "scheme": 3, "In": [3, 6], "case": 3, "expressli": 3, "reserv": 3, "made": [3, 6], "must": [3, 6], "retain": [3, 6], "suppli": 3, "identif": [3, 6], "pseudonym": 3, "notic": [3, 6], "refer": 3, "uri": 3, "hyperlink": 3, "practic": 3, "indic": [3, 6], "previou": 3, "text": [3, 6], "satisfi": 3, "medium": [3, 6], "context": 3, "resourc": 3, "remov": 3, "prevent": 3, "extract": 3, "substanti": 3, "portion": 3, "content": [3, 6], "supplement": 3, "replac": [3, 6], "unless": [3, 6], "separ": [3, 6], "undertaken": 3, "represent": 3, "kind": [3, 6], "concern": 3, "express": [3, 6], "titl": [3, 6], "merchant": [3, 6], "fit": [3, 6], "particular": [3, 6], "infring": [3, 6], "latent": 3, "defect": 3, "accuraci": 3, "presenc": 3, "error": [3, 15], "discover": 3, "full": 3, "event": [3, 6], "liabl": [3, 6], "theori": [3, 6], "neglig": [3, 6], "indirect": [3, 6], "incident": [3, 6], "consequenti": [3, 6], "punit": 3, "exemplari": 3, "loss": [3, 6], "cost": 3, "expens": 3, "aris": [3, 6], "out": [3, 6], "even": [3, 6], "been": [3, 6], "advis": [3, 6], "abov": [3, 5, 6], "shall": [3, 6], "most": 3, "approxim": 3, "absolut": 3, "waiver": 3, "here": 3, "fail": 3, "reinstat": 3, "date": [3, 6], "violat": 3, "cure": 3, "within": [3, 6], "30": 3, "dai": 3, "discoveri": 3, "affect": 3, "seek": 3, "remedi": 3, "stop": 3, "surviv": 3, "state": [3, 6], "herein": [3, 6], "independ": 3, "reduc": 3, "could": 3, "lawfulli": 3, "provis": 3, "deem": 3, "unenforc": 3, "reform": 3, "minimum": 3, "enforc": 3, "cannot": [3, 6], "sever": 3, "remain": [3, 6], "failur": [3, 6], "consent": 3, "privileg": 3, "immun": 3, "jurisdict": 3, "parti": [3, 6], "notwithstand": [3, 6], "elect": 3, "publish": [3, 9], "consid": 3, "permit": 3, "polici": 3, "creativecommon": 3, "org": [3, 6], "logo": 3, "prior": 3, "written": [3, 6], "unauthor": 3, "paragraph": 3, "contact": 3, "tbc": 4, "see": [5, 6], "section": [5, 6], "sourc": [6, 9, 13, 14, 15], "configur": [6, 13], "januari": 6, "2004": 6, "term": 6, "AND": 6, "condit": 6, "FOR": 6, "owner": 6, "union": 6, "act": 6, "control": 6, "common": [6, 9], "power": 6, "caus": 6, "manag": 6, "ii": 6, "ownership": 6, "fifti": 6, "percent": 6, "50": 6, "outstand": 6, "iii": 6, "benefici": 6, "prefer": 6, "softwar": 6, "object": 6, "mechan": 6, "compil": 6, "convers": [6, 9], "type": [6, 13], "attach": 6, "appendix": 6, "editori": 6, "revis": 6, "annot": 6, "elabor": 6, "repres": [6, 14], "mere": 6, "link": 6, "bind": 6, "interfac": [6, 9, 13], "thereof": 6, "intention": 6, "submit": 6, "inclus": 6, "behalf": 6, "electron": 6, "verbal": 6, "sent": 6, "mail": 6, "system": 6, "issu": 6, "track": 6, "discuss": 6, "improv": 6, "exclud": 6, "conspicu": 6, "write": 6, "contributor": 6, "whom": 6, "subsequ": 6, "incorpor": 6, "each": 6, "perpetu": 6, "charg": 6, "prepar": 6, "publicli": 6, "sell": 6, "transfer": 6, "claim": 6, "necessarili": 6, "alon": 6, "combin": 6, "wa": [6, 9], "institut": 6, "litig": 6, "against": 6, "cross": 6, "counterclaim": 6, "lawsuit": 6, "alleg": 6, "contributori": 6, "termin": 6, "meet": 6, "carri": 6, "promin": 6, "attribut": [6, 9], "pertain": 6, "readabl": 6, "contain": 6, "least": 6, "along": 6, "wherev": 6, "third": 6, "normal": 6, "appear": 6, "add": 6, "own": 6, "alongsid": 6, "addendum": 6, "explicitli": 6, "supersed": 6, "execut": [6, 13], "trade": 6, "product": 6, "customari": 6, "AS": 6, "OR": 6, "OF": 6, "either": [6, 13], "sole": 6, "respons": 6, "determin": 6, "appropri": 6, "assum": 6, "risk": 6, "associ": 6, "tort": 6, "deliber": 6, "grossli": 6, "charact": 6, "inabl": 6, "goodwil": 6, "stoppag": 6, "comput": 6, "malfunct": 6, "commerci": 6, "while": 6, "fee": 6, "indemn": 6, "right": 6, "consist": 6, "indemnifi": 6, "defend": 6, "hold": 6, "harmless": 6, "incur": 6, "boilerpl": 6, "field": 6, "enclos": 6, "bracket": 6, "identifi": 6, "don": 6, "comment": 6, "syntax": 6, "we": 6, "recommend": 6, "class": [6, 12, 13, 14, 15], "descript": 6, "easier": 6, "archiv": 6, "yyyi": 6, "complianc": 6, "obtain": 6, "http": 6, "www": 6, "specif": 6, "languag": 6, "govern": 6, "placehold": [7, 16], "unifi": 9, "interoper": 9, "pars": 9, "model": [9, 14], "flavor": 9, "activ": 9, "hdl": 9, "riviera": 9, "pro": 9, "gitlab": 9, "codaci": 9, "codecov": 9, "bugfix": 9, "enhanc": 9, "brand": 9, "adjust": 9, "style": 9, "cli": [9, 11, 12], "later": 9, "extens": 9, "ad": 9, "ci": 9, "pipelin": 9, "provi": 9, "gave": 9, "open": 9, "patrick": 9, "lehmann": 9, "artur": 9, "porebski": 9, "michal": 9, "pacula": 9, "unai": 9, "martinez": 9, "corral": 9, "packag": [9, 11, 12, 14], "accompani": 9, "creativ": 9, "modul": 11, "main": [11, 12, 13], "programbas": [11, 12, 13], "handledefault": [11, 12, 13], "handlehelp": [11, 12, 13], "handlevers": [11, 12, 13], "handleexport": [11, 12, 13], "coberturaexcept": [11, 12, 14], "duplicatedlinenumb": [11, 12, 14], "duplicatedclassnam": [11, 12, 14], "duplicatedpackagenam": [11, 12, 14], "parser": [11, 12, 15], "ucdbparserexcept": [11, 12, 15], "internalerroroccur": [11, 12, 15], "submodul": 12, "function": 13, "entrypoint": 13, "start": 13, "call": 13, "__name__": 13, "__main__": 13, "console_script": 13, "entri": 13, "point": 13, "setuptool": 13, "setup": 13, "py": 13, "try": 13, "environ": 13, "caught": 13, "return": 13, "zero": 13, "implement": 13, "command": 13, "line": [13, 14], "option": 13, "inherit": [13, 14, 15], "argparseattribut": 13, "argparsemixin": 13, "attributehelpermixin": 13, "handl": 13, "arg": 13, "help": 13, "element": 14, "focus": 14, "group": 14, "root": 14, "sourcefil": 14, "rais": [14, 15], "when": [14, 15], "number": 14, "alreadi": 14, "exist": 14, "undocu": 15, "mergeinst": 15, "intern": 15, "occur": 15}, "objects": {"pyEDAA.UCIS.CLI": [[13, 0, 1, "", "Program"], [13, 0, 1, "", "ProgramBase"], [13, 2, 1, "", "main"]], "pyEDAA.UCIS.CLI.Program": [[13, 1, 1, "", "HandleDefault"], [13, 1, 1, "", "HandleExport"], [13, 1, 1, "", "HandleHelp"], [13, 1, 1, "", "HandleVersion"]], "pyEDAA.UCIS.Cobertura": [[14, 0, 1, "", "Class"], [14, 3, 1, "", "CoberturaException"], [14, 0, 1, "", "Coverage"], [14, 3, 1, "", "DuplicatedClassName"], [14, 3, 1, "", "DuplicatedLineNumber"], [14, 3, 1, "", "DuplicatedPackageName"], [14, 0, 1, "", "Package"]], "pyEDAA.UCIS.UCDB": [[15, 3, 1, "", "InternalErrorOccurred"], [15, 0, 1, "", "Parser"], [15, 3, 1, "", "UcdbParserException"]], "pyedaa-ucis-export": [[1, 4, 1, "cmdoption-pyedaa-ucis-export-cobertura", "--cobertura"], [1, 4, 1, "cmdoption-pyedaa-ucis-export-h", "--help"], [1, 4, 1, "cmdoption-pyedaa-ucis-export-merge-instances", "--merge-instances"], [1, 4, 1, "cmdoption-pyedaa-ucis-export-ucdb", "--ucdb"], [1, 4, 1, "cmdoption-pyedaa-ucis-export-h", "-h"]], "pyedaa-ucis-help": [[1, 4, 1, "cmdoption-pyedaa-ucis-help-h", "--help"], [1, 4, 1, "cmdoption-pyedaa-ucis-help-h", "-h"], [1, 4, 1, "cmdoption-pyedaa-ucis-help-arg-command", "command"]], "pyedaa-ucis-version": [[1, 4, 1, "cmdoption-pyedaa-ucis-version-h", "--help"], [1, 4, 1, "cmdoption-pyedaa-ucis-version-h", "-h"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function", "3": "py:exception", "4": "std:cmdoption"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"], "3": ["py", "exception", "Python exception"], "4": ["std", "cmdoption", "program option"]}, "titleterms": {"code": [0, 9], "coverag": [0, 2, 7], "statement": 0, "branch": 0, "command": 1, "line": 1, "interfac": 1, "pyedaa": [1, 2, 9, 12, 13, 14, 15], "uci": [1, 2, 9, 12, 13, 14, 15], "export": 1, "help": 1, "version": 1, "depend": 2, "packag": 2, "unit": 2, "test": 2, "type": [2, 16], "check": [2, 16], "option": 2, "sphinx": 2, "document": [2, 9], "publish": 2, "ci": 2, "server": 2, "onli": 2, "creativ": 3, "common": 3, "attribut": 3, "4": [3, 6], "0": [3, 6], "intern": 3, "us": [3, 5, 9], "public": 3, "licens": [3, 6, 9], "section": 3, "1": [3, 6], "definit": [3, 6], "2": [3, 6], "scope": 3, "3": [3, 6], "condit": 3, "sui": 3, "generi": 3, "databas": 3, "right": 3, "5": [3, 6], "disclaim": [3, 6], "warranti": [3, 6], "limit": [3, 6], "liabil": [3, 6], "6": [3, 6], "term": 3, "termin": 3, "7": [3, 6], "other": 3, "8": [3, 6], "interpret": 3, "glossari": 4, "instal": 5, "updat": [5, 9], "pip": 5, "from": [5, 9], "pypi": 5, "uninstal": 5, "local": 5, "directori": 5, "setup": 5, "py": 5, "legaci": 5, "apach": 6, "grant": 6, "copyright": 6, "patent": 6, "redistribut": 6, "submiss": 6, "contribut": 6, "trademark": 6, "9": 6, "accept": 6, "addit": 6, "report": [7, 16], "index": [8, 10], "The": 9, "main": 9, "goal": 9, "case": 9, "new": 9, "jan": 9, "2022": 9, "aldec": 9, "inc": 9, "provid": 9, "releas": 9, "initi": 9, "under": 9, "eda\u00b2": 9, "oct": 9, "2021": 9, "script": 9, "contributor": 9, "python": [10, 11], "modul": 10, "class": 11, "refer": 11, "cli": 13, "cobertura": 14, "ucdb": 15, "static": 16}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Code Coverage": [[0, "code-coverage"]], "Statement Coverage": [[0, "statement-coverage"]], "Branch Coverage": [[0, "branch-coverage"]], "Command Line Interfaces": [[1, "command-line-interfaces"]], "pyedaa-ucis": [[1, "pyedaa-ucis"]], "pyedaa-ucis export": [[1, "pyedaa-ucis-export"]], "pyedaa-ucis help": [[1, "pyedaa-ucis-help"]], "pyedaa-ucis version": [[1, "pyedaa-ucis-version"]], "Dependency": [[2, "dependency"]], "pyEDAA.UCIS Package": [[2, "pyedaa-ucis-package"]], "Unit Testing / Coverage / Type Checking (Optional)": [[2, "unit-testing-coverage-type-checking-optional"]], "Sphinx Documentation (Optional)": [[2, "sphinx-documentation-optional"]], "Packaging (Optional)": [[2, "packaging-optional"]], "Publishing (CI-Server only)": [[2, "publishing-ci-server-only"]], "Creative Commons Attribution 4.0 International": [[3, "creative-commons-attribution-4-0-international"]], "Using Creative Commons Public Licenses": [[3, null]], "Section 1 \u2013 Definitions.": [[3, "section-1-definitions"]], "Section 2 \u2013 Scope.": [[3, "section-2-scope"]], "Section 3 \u2013 License Conditions.": [[3, "section-3-license-conditions"]], "Section 4 \u2013 Sui Generis Database Rights.": [[3, "section-4-sui-generis-database-rights"]], "Section 5 \u2013 Disclaimer of Warranties and Limitation of Liability.": [[3, "section-5-disclaimer-of-warranties-and-limitation-of-liability"]], "Section 6 \u2013 Term and Termination.": [[3, "section-6-term-and-termination"]], "Section 7 \u2013 Other Terms and Conditions.": [[3, "section-7-other-terms-and-conditions"]], "Section 8 \u2013 Interpretation.": [[3, "section-8-interpretation"]], "Glossary": [[4, "glossary"]], "Installation/Updates": [[5, "installation-updates"]], "Using PIP": [[5, "using-pip"]], "Installation from PyPI using PIP": [[5, "installation-from-pypi-using-pip"]], "Updating from PyPI using PIP": [[5, "updating-from-pypi-using-pip"]], "Uninstallation using PIP": [[5, "uninstallation-using-pip"]], "Installation from local directory using PIP": [[5, "installation-from-local-directory-using-pip"]], "Using setup.py (legacy)": [[5, "using-setup-py-legacy"]], "Installation using setup.py": [[5, "installation-using-setup-py"]], "Apache License 2.0": [[6, "apache-license-2-0"]], "1. Definitions.": [[6, "definitions"]], "2. Grant of Copyright License.": [[6, "grant-of-copyright-license"]], "3. Grant of Patent License.": [[6, "grant-of-patent-license"]], "4. Redistribution.": [[6, "redistribution"]], "5. Submission of Contributions.": [[6, "submission-of-contributions"]], "6. Trademarks.": [[6, "trademarks"]], "7. Disclaimer of Warranty.": [[6, "disclaimer-of-warranty"]], "8. Limitation of Liability.": [[6, "limitation-of-liability"]], "9. Accepting Warranty or Additional Liability.": [[6, "accepting-warranty-or-additional-liability"]], "Coverage Report": [[7, "coverage-report"]], "Index": [[8, "index"]], "The pyEDAA.UCIS Documentation": [[9, "the-pyedaa-ucis-documentation"]], "Main Goals": [[9, "main-goals"]], "Use Cases": [[9, "use-cases"]], "News": [[9, "news"]], "Jan. 2022 - Aldec Inc. Provided Updates": [[9, "jan-2022-aldec-inc-provided-updates"]], "Jan. 2022 - Release of Initial Code under EDA\u00b2": [[9, "jan-2022-release-of-initial-code-under-eda2"]], "Oct. 2021 - Initial Script from Aldec Inc.": [[9, "oct-2021-initial-script-from-aldec-inc"]], "Contributors": [[9, "contributors"]], "License": [[9, "license"]], "Python Module Index": [[10, "python-module-index"]], "Python Class Reference": [[11, "python-class-reference"]], "pyEDAA.UCIS": [[12, "pyedaa-ucis"]], "pyEDAA.UCIS.CLI": [[13, "pyedaa-ucis-cli"]], "pyEDAA.UCIS.Cobertura": [[14, "pyedaa-ucis-cobertura"]], "pyEDAA.UCIS.UCDB": [[15, "pyedaa-ucis-ucdb"]], "Static Type Checking Report": [[16, "static-type-checking-report"]]}, "indexentries": {"--cobertura": [[1, "cmdoption-pyedaa-ucis-export-cobertura"]], "--help": [[1, "cmdoption-pyedaa-ucis-export-h"], [1, "cmdoption-pyedaa-ucis-help-h"], [1, "cmdoption-pyedaa-ucis-version-h"]], "--merge-instances": [[1, "cmdoption-pyedaa-ucis-export-merge-instances"]], "--ucdb": [[1, "cmdoption-pyedaa-ucis-export-ucdb"]], "-h": [[1, "cmdoption-pyedaa-ucis-export-h"], [1, "cmdoption-pyedaa-ucis-help-h"], [1, "cmdoption-pyedaa-ucis-version-h"]], "command": [[1, "cmdoption-pyedaa-ucis-help-arg-command"]], "pyedaa-ucis-export command line option": [[1, "cmdoption-pyedaa-ucis-export-cobertura"], [1, "cmdoption-pyedaa-ucis-export-h"], [1, "cmdoption-pyedaa-ucis-export-merge-instances"], [1, "cmdoption-pyedaa-ucis-export-ucdb"]], "pyedaa-ucis-help command line option": [[1, "cmdoption-pyedaa-ucis-help-arg-command"], [1, "cmdoption-pyedaa-ucis-help-h"]], "pyedaa-ucis-version command line option": [[1, "cmdoption-pyedaa-ucis-version-h"]], "cobertura": [[4, "term-Cobertura"]], "coverage": [[4, "term-Coverage"]], "ucdb": [[4, "term-UCDB"]], "ucis": [[4, "term-UCIS"]], "xml": [[4, "term-XML"]], "handledefault() (pyedaa.ucis.cli.program method)": [[13, "pyEDAA.UCIS.CLI.Program.HandleDefault"]], "handleexport() (pyedaa.ucis.cli.program method)": [[13, "pyEDAA.UCIS.CLI.Program.HandleExport"]], "handlehelp() (pyedaa.ucis.cli.program method)": [[13, "pyEDAA.UCIS.CLI.Program.HandleHelp"]], "handleversion() (pyedaa.ucis.cli.program method)": [[13, "pyEDAA.UCIS.CLI.Program.HandleVersion"]], "program (class in pyedaa.ucis.cli)": [[13, "pyEDAA.UCIS.CLI.Program"]], "programbase (class in pyedaa.ucis.cli)": [[13, "pyEDAA.UCIS.CLI.ProgramBase"]], "main() (in module pyedaa.ucis.cli)": [[13, "pyEDAA.UCIS.CLI.main"]], "class (class in pyedaa.ucis.cobertura)": [[14, "pyEDAA.UCIS.Cobertura.Class"]], "coberturaexception": [[14, "pyEDAA.UCIS.Cobertura.CoberturaException"]], "coverage (class in pyedaa.ucis.cobertura)": [[14, "pyEDAA.UCIS.Cobertura.Coverage"]], "duplicatedclassname": [[14, "pyEDAA.UCIS.Cobertura.DuplicatedClassName"]], "duplicatedlinenumber": [[14, "pyEDAA.UCIS.Cobertura.DuplicatedLineNumber"]], "duplicatedpackagename": [[14, "pyEDAA.UCIS.Cobertura.DuplicatedPackageName"]], "package (class in pyedaa.ucis.cobertura)": [[14, "pyEDAA.UCIS.Cobertura.Package"]], "internalerroroccurred": [[15, "pyEDAA.UCIS.UCDB.InternalErrorOccurred"]], "parser (class in pyedaa.ucis.ucdb)": [[15, "pyEDAA.UCIS.UCDB.Parser"]], "ucdbparserexception": [[15, "pyEDAA.UCIS.UCDB.UcdbParserException"]]}})
\ No newline at end of file
diff --git a/typing/html/UCIS/CLI/__init__.py.html b/typing/html/UCIS/CLI/__init__.py.html
new file mode 100644
index 00000000..af0d4370
--- /dev/null
+++ b/typing/html/UCIS/CLI/__init__.py.html
@@ -0,0 +1,527 @@
+
+
+
+
+
+
+1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 + |
+# ==================================================================================================================== # +# _____ ____ _ _ _ _ ____ ___ ____ # +# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| # +# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ # +# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | # +# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ # +# |_| |___/ # +# ==================================================================================================================== # +# Authors: # +# Patrick Lehmann # +# Artur Porebski (Aldec Inc.) # +# Michal Pacula (Aldec Inc.) # +# # +# License: # +# ==================================================================================================================== # +# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); # +# you may not use this file except in compliance with the License. # +# You may obtain a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +# # +# SPDX-License-Identifier: Apache-2.0 # +# ==================================================================================================================== # +# +""" +Tools to extract data from UCDB files. + +.. rubric:: Usage + +First export/convert the Aldec Coverage Database (ACDB) into UCDB (Universal Coverage Database) format. The +helper program ``acdb2xml`` (part of Active-HDL or Riviera-PRO installation) can be used. + +.. code-block:: + + acdb2xml -i aggregate.acdb -o ucdb.xml + +At next use this layer's service program to convert from UCDB to Cobertura format. + +.. code-block:: + + pyedaa-ucis export --ucdb ucdb.xml --cobertura cobertura.xml +""" +from argparse import RawDescriptionHelpFormatter +from pathlib import Path +from textwrap import dedent + +from pyAttributes.ArgParseAttributes import ArgParseMixin, DefaultAttribute, CommandAttribute, ArgumentAttribute, SwitchArgumentAttribute + +from pyTooling.Decorators import export + +from pyEDAA.UCIS import __version__, __copyright__, __license__ +from pyEDAA.UCIS.UCDB import Parser +from pyEDAA.UCIS.Cobertura import CoberturaException + + +@export +class ProgramBase(): + """Base-class for all program classes.""" + + programTitle = "UCDB Service Program" + + def __init__(self) -> None: + pass + + def _PrintHeadline(self) -> None: + """Print the programs headline.""" + print("{line}".format(line="=" * 120)) + print("{headline: ^120s}".format(headline=self.programTitle)) + print("{line}".format(line="=" * 120)) + + +@export +class Program(ProgramBase, ArgParseMixin): + """Program class to implement the command line interface (CLI) using commands and options.""" + + def __init__(self) -> None: + super().__init__() + + # Call the constructor of the ArgParseMixin + ArgParseMixin.__init__( + self, + prog="pyedaa-ucis", + description=dedent('''\ + 'pyEDAA.UCIS Service Program' to query and transform data to/from UCIS to any other format. + '''), + epilog=dedent("""\ + Currently the following output formats are supported: + * Cobertura (statement coverage - Java oriented format) + """), + formatter_class=RawDescriptionHelpFormatter, + add_help=False + ) + +# @CommonSwitchArgumentAttribute("-q", "--quiet", dest="quiet", help="Reduce messages to a minimum.") +# @CommonSwitchArgumentAttribute("-v", "--verbose", dest="verbose", help="Print out detailed messages.") +# @CommonSwitchArgumentAttribute("-d", "--debug", dest="debug", help="Enable debug mode.") + def Run(self) -> None: + ArgParseMixin.Run(self) + + @DefaultAttribute() + def HandleDefault(self, _) -> None: + """Handle program calls without any command.""" + self._PrintHeadline() + self._PrintHelp() + + @CommandAttribute("help", help="Display help page(s) for the given command name.", description="Display help page(s) for the given command name.") + @ArgumentAttribute(metavar="Command", dest="Command", type=str, nargs="?", help="Print help page(s) for a command.") + def HandleHelp(self, args) -> None: + """Handle program calls with command ``help``.""" + self._PrintHeadline() + self._PrintHelp(args.Command) + + @CommandAttribute("version", help="Display version information.", description="Display version information.") + def HandleVersion(self, _) -> None: + """Handle program calls with command ``version``.""" + self._PrintHeadline() + self._PrintVersion() + + @CommandAttribute("export", help="Export data from UCDB.", description="Export data from UCDB.") + @ArgumentAttribute("--ucdb", metavar='UCDBFile', dest="ucdb", type=str, help="UCDB file in UCIS format (XML).") + @ArgumentAttribute("--cobertura", metavar='CoberturaFile', dest="cobertura", type=str, help="Cobertura code coverage file (XML).") + @SwitchArgumentAttribute("--merge-instances", dest="mergeInstances", help="Merge statement coverage data for all instances of the same design unit.") + def HandleExport(self, args) -> None: + """Handle program calls with command ``export``.""" + self._PrintHeadline() + + returnCode = 0 + if args.ucdb is None: + print(f"Option '--ucdb <UCDBFile' is missing.") + returnCode = 3 + if args.cobertura is None: + print(f"Option '--cobertura <CoberturaFile' is missing.") + returnCode = 3 + + if returnCode != 0: + exit(returnCode) + + print(f"Exporting code coverage information from UCDB file to Cobertura format ...") + + ucdbPath = Path(args.ucdb) + if not ucdbPath.exists(): + raise FileNotFoundError(f"UCDB databse file '{ucdbPath}' not found.") + + coberturaPath = Path(args.cobertura) + + print(f" IN -> UCIS (XML): {ucdbPath}") + print(f" OUT <- Cobertura (XML): {coberturaPath}") + + parser = Parser(ucdbPath, args.mergeInstances) + model = parser.getCoberturaModel() + + with coberturaPath.open('w') as file: + file.write(model.getXml().decode("utf-8")) + + print() + + try: + lineCoverage = model.linesCovered / model.linesValid * 100 + except ZeroDivisionError: + lineCoverage = 100 + + try: + statementCoverage = parser.statementsCovered / parser.statementsCount * 100 + except ZeroDivisionError: + statementCoverage = 100 + + print(dedent(f"""\ + [DONE] Export and conversion complete. + Line coverage: {lineCoverage} % + Statement coverage: {statementCoverage} % + """) + ) + + def _PrintVersion(self): + """Helper function to print the version information.""" + print(dedent(f"""\ + Copyright: {__copyright__} + License: {__license__} + Version: v{__version__} + """) + ) + + def _PrintHelp(self, command: str=None): + """Helper function to print the command line parsers help page(s).""" + if (command is None): + self.MainParser.print_help() + elif (command == "help"): + print("This is a recursion ...") + else: + try: + self.SubParsers[command].print_help() + except KeyError: + print(f"Command {command} is unknown.") + + +@export +def main(): + """ + Entrypoint to start program execution. + + This function should be called either from: + * ``if __name__ == "__main__":`` or + * ``console_scripts`` entry point configured via ``setuptools`` in ``setup.py``. + + This function creates an instance of :class:`Program` in a ``try ... except`` environment. Any exception caught is + formatted and printed before the program returns with a non-zero exit code. + """ + program = Program() + try: + program.Run() + except FileNotFoundError as ex: + print() + print(f"[ERROR] {ex}") + exit(1) + except CoberturaException as ex: + print() + print(f"[INTERNAL ERROR] {ex}") + exit(1) + + +if __name__ == "__main__": + main() + |
+
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 + |
+# ==================================================================================================================== # +# _____ ____ _ _ _ _ ____ ___ ____ # +# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| # +# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ # +# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | # +# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ # +# |_| |___/ # +# ==================================================================================================================== # +# Authors: # +# Artur Porebski (Aldec Inc.) # +# Michal Pacula (Aldec Inc.) # +# # +# License: # +# ==================================================================================================================== # +# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); # +# you may not use this file except in compliance with the License. # +# You may obtain a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +# # +# SPDX-License-Identifier: Apache-2.0 # +# ==================================================================================================================== # +# +""" +Data model of the Cobertura format. + +.. mermaid:: + + flowchart LR + Coverage --> Package --> Class --> Statement + +""" +from time import time +from typing import Dict, Set + +from lxml import etree +from pyTooling.Decorators import export + + +@export +class CoberturaException(Exception): + """Base-class for other Cobertura exceptions""" + + +@export +class DuplicatedLineNumber(CoberturaException): + """Raised when statement with specified line number already exists in Cobertura class""" + + +@export +class DuplicatedClassName(CoberturaException): + """Raised when class with specified name already exists in Cobertura package""" + + +@export +class DuplicatedPackageName(CoberturaException): + """Raised when package with specified name already exists in Cobertura coverage""" + + +@export +class Class: + """Represents a code element in the Cobertura coverage data model (Java-focused).""" + + name: str + sourceFile: str + lines: Dict[int, int] + linesValid: int + linesCovered: int + + def __init__(self, name: str, sourceFile: str): + self.name = name + self.sourceFile = sourceFile + self.lines = {} + self.linesValid = 0 + self.linesCovered = 0 + + def addStatement(self, line: int, hits: int) -> None: + if line in self.lines.keys(): + raise DuplicatedLineNumber(f"Duplicated line number: {line}") + + self.lines[line] = hits + self.linesValid += 1 + + if hits: + self.linesCovered += 1 + + def getXmlNode(self) -> etree._Element: + classNode = etree.Element("class") + classNode.attrib["name"] = self.sourceFile + classNode.attrib["filename"] = self.sourceFile + classNode.attrib["complexity"] = "0" + classNode.attrib["branch-rate"] = "0" + + try: + rate = self.linesCovered / self.linesValid + except ZeroDivisionError: + rate = 1.0 + + classNode.attrib["line-rate"] = f"{rate:.16g}" + + classNode.append(etree.Element("methods")) + linesNode = etree.SubElement(classNode, "lines") + + for line in self.lines: + etree.SubElement( + linesNode, + "line", + number=str(line), + hits=str(self.lines[line]), + ) + + return classNode + + +@export +class Package: + """Represents a grouping element in the Cobertura coverage data model (Java-focused).""" + + name: str + classes: Dict[str, Class] + linesValid: int + linesCovered: int + + def __init__(self, name: str): + self.name = name + self.classes = {} + self.linesValid = 0 + self.linesCovered = 0 + + def addClass(self, coberturaClass: Class): + if coberturaClass.name in self.classes: + raise DuplicatedClassName(f"Duplicated class name: '{coberturaClass.name}'.") + + self.classes[coberturaClass.name] = coberturaClass + + def refreshStatistics(self) -> None: + self.linesValid = 0 + self.linesCovered = 0 + + for coberturaClass in self.classes.values(): + self.linesCovered += coberturaClass.linesCovered + self.linesValid += coberturaClass.linesValid + + def getXmlNode(self) -> etree._Element: + classesNode = etree.Element("classes") + packageNode = etree.Element("package") + packageNode.attrib["name"] = self.name + packageNode.attrib["complexity"] = "0" + packageNode.attrib["branch-rate"] = "0" + + try: + rate = self.linesCovered / self.linesValid + except ZeroDivisionError: + rate = 1.0 + + packageNode.attrib["line-rate"] = f"{rate:.16g}" + + packageNode.append(classesNode) + + for coberturaClass in self.classes.values(): + classesNode.append(coberturaClass.getXmlNode()) + + return packageNode + + +@export +class Coverage: + """Represents the root element in the Cobertura coverage data model (Java-focused).""" + + sources: Set + packages: Dict[str, Package] + linesValid: int + linesCovered: int + + def __init__(self): + self.sources = set() + self.packages = {} + self.linesValid = 0 + self.linesCovered = 0 + + def addSource(self, source: str) -> None: + self.sources.add(source) + + def addPackage(self, package: Package) -> None: + if package.name in self.packages: + raise DuplicatedPackageName(f"Duplicated package name: '{package.name}'.") + + self.packages[package.name] = package + + def refreshStatistics(self) -> None: + self.linesValid = 0 + self.linesCovered = 0 + + for package in self.packages.values(): + package.refreshStatistics() + self.linesCovered += package.linesCovered + self.linesValid += package.linesValid + + def getXml(self) -> bytes: + self.refreshStatistics() + + coverageNode = etree.Element("coverage") + coverageNode.attrib["version"] = "5.5" + coverageNode.attrib["timestamp"] = str(int(time())) + coverageNode.attrib["branches-valid"] = "0" + coverageNode.attrib["branches-covered"] = "0" + coverageNode.attrib["branch-rate"] = "0" + coverageNode.attrib["complexity"] = "0" + + sourcesNode = etree.Element("sources") + + for source in self.sources: + etree.SubElement(sourcesNode, "source").text = source + + coverageNode.append(sourcesNode) + + packagesNode = etree.Element("packages") + + for package in self.packages.values(): + packagesNode.append(package.getXmlNode()) + + coverageNode.append(packagesNode) + + coverageNode.attrib["lines-valid"] = str(self.linesValid) + coverageNode.attrib["lines-covered"] = str(self.linesCovered) + + try: + rate = self.linesCovered / self.linesValid + except ZeroDivisionError: + rate = 1.0 + + coverageNode.attrib["line-rate"] = f"{rate:.16g}" + + return etree.tostring( + coverageNode, pretty_print=True, encoding="utf-8", xml_declaration=True + ) + |
+
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 + |
+# ==================================================================================================================== # +# _____ ____ _ _ _ _ ____ ___ ____ # +# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| # +# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ # +# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | # +# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ # +# |_| |___/ # +# ==================================================================================================================== # +# Authors: # +# Artur Porebski (Aldec Inc.) # +# Michal Pacula (Aldec Inc.) # +# # +# License: # +# ==================================================================================================================== # +# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); # +# you may not use this file except in compliance with the License. # +# You may obtain a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +# # +# SPDX-License-Identifier: Apache-2.0 # +# ==================================================================================================================== # +# +"""Data model of the UCDB format.""" +from collections import namedtuple, defaultdict +from itertools import groupby +from operator import attrgetter +from pathlib import Path +from typing import List, Tuple, Dict, DefaultDict + +from lxml import etree +from pyTooling.Decorators import export + +from pyEDAA.UCIS.Cobertura import Class, Coverage, Package + + +UCDB_EXCLUDE_PRAGMA = 0x00000020 +UCDB_EXCLUDE_FILE = 0x00000040 +UCDB_EXCLUDE_INST = 0x00000080 +UCDB_EXCLUDE_AUTO = 0x00000100 + +UCDB_EXCLUDED = ( + UCDB_EXCLUDE_FILE | UCDB_EXCLUDE_PRAGMA | UCDB_EXCLUDE_INST | UCDB_EXCLUDE_AUTO +) + +StatementData = namedtuple( + "StatementData", + ["file", "line", "index", "instance", "hits"], +) + + +@export +class UcdbParserException(Exception): + """Base-class for other UCDB Parser exceptions""" + + +@export +class InternalErrorOccurred(UcdbParserException): + """Raised when internal error occurred""" + + +@export +class Parser: + _mergeInstances: bool + _tree: etree._ElementTree + _nsmap: Dict + _coverage: Coverage + statementsCount: int + statementsCovered: int + + def __init__(self, ucdbFile: Path, mergeInstances: bool): + self._mergeInstances = mergeInstances + + with ucdbFile.open("r") as filename: + self._tree = etree.parse(filename) + + self._nsmap = { + k: v for (k, v) in self._tree.getroot().nsmap.items() if k is not None + } + + self._coverage = Coverage() + + self.statementsCount = 0 + self.statementsCovered = 0 + + def getCoberturaModel(self) -> Coverage: + self._parseStatementCoverage() + + return self._coverage + + def _groupByIndex(self, statements: List[StatementData]) -> List[StatementData]: + groupedStmts = [] + + sortedStmts = sorted(statements, key=attrgetter("index")) + for index, stmts in groupby(sortedStmts, key=attrgetter("index")): + hit = any((stmt.hits for stmt in stmts)) + + groupedStmts.append( + StatementData( + file=statements[0].file, + line=statements[0].line, + index=index, + instance="", + hits=hit, + ) + ) + + return groupedStmts + + def _parseStatementCoverage(self) -> None: + scopes = self._tree.xpath( + "/ux:ucdb/ux:scope[.//ux:bin[@type='STMTBIN']]", namespaces=self._nsmap + ) + + if not isinstance(scopes, list): + raise InternalErrorOccurred(f"Unexpected type: '{scopes.__class__.__name__}'.") + + nodes: List[etree._Element] = [] + + for scopeNode in scopes: + if not isinstance(scopeNode, etree._Element): + raise InternalErrorOccurred(f"Unexpected type: '{scopeNode.__class__.__name__}'.") + + typeName = scopeNode.get("type") + + if typeName is None: + raise InternalErrorOccurred("Unexpected 'None' value.") + + if typeName.startswith("DU_"): + continue + + statementBins = scopeNode.xpath(".//ux:bin[@type='STMTBIN']", namespaces=self._nsmap) + + if not isinstance(statementBins, list): + raise InternalErrorOccurred(f"Unexpected type: '{statementBins.__class__.__name__}'.") + + for statementBin in statementBins: + if not isinstance(statementBin, etree._Element): + raise InternalErrorOccurred(f"Unexpected type: '{statementBin.__class__.__name__}'.") + + nodes.append(statementBin) + + statements: DefaultDict[str, DefaultDict[int, List]] = defaultdict(lambda: defaultdict(list)) + + for node in nodes: + workdir, stmtData = self._parseStatementNode(node) + self._coverage.addSource(workdir) + + flags = node.get("flags") + + if flags is None: + raise InternalErrorOccurred("Unexpected 'None' value.") + + if int(flags, 16) & UCDB_EXCLUDED: + _ = statements[stmtData.file] + continue + + statements[stmtData.file][stmtData.line].append(stmtData) + + for file, lines in statements.items(): + package = Package(file) + coberturaClass = Class(file, file) + package.addClass(coberturaClass) + self._coverage.addPackage(package) + + for line, lineStmts in lines.items(): + if self._mergeInstances: + lineStmts = self._groupByIndex(lineStmts) + + self.statementsCount += len(lineStmts) + + covered = len(list(filter(attrgetter("hits"), lineStmts))) + hit = int(covered == len(lineStmts)) + + self.statementsCovered += covered + + coberturaClass.addStatement(line, hit) + + def _parseStatementNode(self, node) -> Tuple[str, StatementData]: + srcNode = node.find("./ux:src", namespaces=self._nsmap) + workdir = srcNode.get("workdir") + + instancePath = ".".join( + (scope.get("name") for scope in node.iterancestors("{*}scope")) + ) + + stmtIndex = int( + node.find("./ux:attr[@key='#SINDEX#']", namespaces=self._nsmap).text + ) + + count = int(node.find("./ux:count", namespaces=self._nsmap).text) + + stmtData = StatementData( + file=srcNode.get("file"), + line=int(srcNode.get("line")), + index=stmtIndex, + instance=instancePath, + hits=count, + ) + + return workdir, stmtData + |
+
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 + |
+# ==================================================================================================================== # +# _____ ____ _ _ _ _ ____ ___ ____ # +# _ __ _ _| ____| _ \ / \ / \ | | | |/ ___|_ _/ ___| # +# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | |\___ \ # +# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |___ | | ___) | # +# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \____|___|____/ # +# |_| |___/ # +# ==================================================================================================================== # +# Authors: # +# Patrick Lehmann # +# # +# License: # +# ==================================================================================================================== # +# Copyright 2021-2022 Electronic Design Automation Abstraction (EDA²) # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); # +# you may not use this file except in compliance with the License. # +# You may obtain a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +# # +# SPDX-License-Identifier: Apache-2.0 # +# ==================================================================================================================== # +# +"""The Unified Coverage Interoperability Standard (UCIS) layer of EDA² offers a data model for reading UCDB files.""" +__author__ = "Patrick Lehmann" +__email__ = "Paebbels@gmail.com" +__copyright__ = "2021-2022, Electronic Design Automation Abstraction (EDA²)" +__license__ = "Apache License, Version 2.0" +__version__ = "0.3.0" +__keywords__ = ["UCIS", "UCDB", "coverage", "Cobertura", "xml"] + |
+
| File | +Imprecision | +Lines | +
|---|---|---|
| Total | +14.31% imprecise | +720 LOC | +
| UCIS | +0.00% imprecise | +37 LOC | +
| UCIS.CLI | +20.87% imprecise | +230 LOC | +
| UCIS.Cobertura | +4.10% imprecise | +244 LOC | +
| UCIS.UCDB | +21.53% imprecise | +209 LOC | +