diff --git a/lint/LICENSE b/lint/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/lint/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "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. + + 2. Grant of Copyright License. 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. + + 3. Grant of Patent License. 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. + + 4. Redistribution. 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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. + + 5. Submission of Contributions. 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. + + 6. Trademarks. 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. + + 7. Disclaimer of Warranty. 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. + + 8. Limitation of Liability. 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. + + 9. Accepting Warranty or Additional Liability. 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. + + END OF TERMS AND CONDITIONS + + 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. diff --git a/lint/README.md b/lint/README.md index e3596b0..3e695cf 100644 --- a/lint/README.md +++ b/lint/README.md @@ -14,8 +14,7 @@ The witness linter can be used to make sure that a given witness conforms to the The following modules are necessary to use the witness linter: -- lxml -- zlib +- lxml >= 4.6.3 ### Usage diff --git a/lint/doc/Changelog.md b/lint/doc/Changelog.md new file mode 100644 index 0000000..ea75bd4 --- /dev/null +++ b/lint/doc/Changelog.md @@ -0,0 +1,17 @@ + + +# Witnesslint Changelog + +## Version 1.4 + +Initial release version. Essentially the version used in SV-COMP 2022 with a small number of changes: + - Added option `excludeRecentChecks` to disable newly introduced checks, e.g. for linting older witnesses. + - An overview of the checked witness is printed out after linting. + - Linter output now contains the used linter version. + - Some bugfixes. \ No newline at end of file diff --git a/lint/doc/Developing.md b/lint/doc/Developing.md new file mode 100644 index 0000000..9ed932f --- /dev/null +++ b/lint/doc/Developing.md @@ -0,0 +1,36 @@ + + +# Witnesslint Development Instructions + +## Installation for Development + +0. You will need a python version >=3.5. + +1. Witnesslint uses `poetry` for dependency management and packaging. +Please refer to https://python-poetry.org/docs/master/#installation for installation instructions. + +2. Install project dependencies with `poetry install`. + +## Releasing a new version + +1. Bump version number in `witnesslint/__init__.py` and `pyproject.toml` to next release version. +Write an entry for the new version in `doc/Changelog.md`. Commit these changes and nothing else. + +2. Build the release archives with `poetry build`. Test the archives and make sure all necessary files are included. + +3. Upload the generated archives to PyPI with `poetry publish`. This requires a PyPI account. +You can use either your username/password combination or an API token for authentication. +Please refer to `https://python-poetry.org/docs/repositories/#configuring-credentials` for details. + +4. Create and push a git tag for the new release. + +5. Create a release on GitHub from the tag. + +6. Bump version number in `witnesslint/__init__.py` and `pyproject.toml` to next development version. +Commit only these changes. \ No newline at end of file diff --git a/lint/pyproject.toml b/lint/pyproject.toml new file mode 100644 index 0000000..5dc81f1 --- /dev/null +++ b/lint/pyproject.toml @@ -0,0 +1,32 @@ +# This file is part of sv-witnesses repository: https://github.com/sosy-lab/sv-witnesses +# +# SPDX-FileCopyrightText: 2021 Dirk Beyer +# +# SPDX-License-Identifier: Apache-2.0 + +[tool.poetry] +name = "witnesslint" +version = "1.4" +authors = ["Dirk Beyer"] +description = "A linter for the sv-witness format" +readme = "README.md" +repository = "https://github.com/sosy-lab/sv-witnesses/tree/main/lint" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Intended Audience :: Science/Research", + "Environment :: Console" + ] +license = "Apache-2.0" +include = ["LICENSE", "README.md", "doc/Changelog.md"] + +[tool.poetry.dependencies] +python = "^3.5" +lxml = "^4.6.3" + +[tool.poetry.scripts] +witnesslint = "witnesslint.linter:main" + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api" diff --git a/lint/witnesslint/__init__.py b/lint/witnesslint/__init__.py new file mode 100644 index 0000000..a6ffbd6 --- /dev/null +++ b/lint/witnesslint/__init__.py @@ -0,0 +1,7 @@ +# This file is part of sv-witnesses repository: https://github.com/sosy-lab/sv-witnesses +# +# SPDX-FileCopyrightText: 2021 Dirk Beyer +# +# SPDX-License-Identifier: Apache-2.0 + +__version__ = "1.4" diff --git a/lint/witnesslint/linter.py b/lint/witnesslint/linter.py index dd13763..77c746f 100644 --- a/lint/witnesslint/linter.py +++ b/lint/witnesslint/linter.py @@ -11,8 +11,6 @@ [1]: github.com/sosy-lab/sv-witnesses/blob/main/README-GraphML.md """ -__version__ = "1.3-dev" - import argparse import collections import hashlib @@ -21,8 +19,7 @@ from lxml import etree # noqa: S410 does not matter -from . import logger as logging -from . import witness +from . import witness, __version__, logger as logging CREATIONTIME_PATTERN = r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$" @@ -991,9 +988,11 @@ def _exit(exit_code=None): sys.exit(exit_code) -def main(argv): +def main(argv=None): + if argv is None: + argv = sys.argv[1:] try: - linter = create_linter(argv[1:]) + linter = create_linter(argv) print("Running witnesslint version {}\n".format(__version__)) linter.lint() _exit() diff --git a/lint/witnesslinter.py b/lint/witnesslinter.py index c5d590b..0ec363c 100755 --- a/lint/witnesslinter.py +++ b/lint/witnesslinter.py @@ -13,4 +13,4 @@ from witnesslint import linter # noqa: E402 raises, but prevents bytecode generation if __name__ == "__main__": - sys.exit(linter.main(sys.argv)) + linter.main()