diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml new file mode 100644 index 0000000..3f1df76 --- /dev/null +++ b/.github/workflows/coverage.yml @@ -0,0 +1,36 @@ +name: Coverage +on: + pull_request: + push: + branches: + - 'master' +jobs: + check_coverage: + runs-on: ubuntu-latest + name: Check coverage + permissions: + pull-requests: write + contents: write + steps: + - uses: actions/checkout@v3 + - name: Set up Python + id: setup-python + uses: actions/setup-python@v4 + with: + python-version: 3.9 + - name: Install deps + run: | + python -m pip install --upgrade pip + python -m pip install .[tests] + - name: Launch tests & generate report + run: pytest + - name: Coverage comment + id: coverage_comment + uses: py-cov-action/python-coverage-comment-action@v3 + with: + GITHUB_TOKEN: ${{ github.token }} + - name: Store Pull Request comment to be posted + uses: actions/upload-artifact@v3 + with: + name: python-coverage-comment-action + path: python-coverage-comment-action.txt diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..31cb133 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,33 @@ +# This workflow will install Python dependencies, and run tests and lint with a variety of Python versions +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Lint +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] +jobs: + lint: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11"] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install .[tests] + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 src tests --count --exit-zero --max-complexity=10 --statistics diff --git a/LICENSE b/LICENSE index 036db76..b1de87f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,29 @@ - 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 2016 cdumay - - 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. +BSD 3-Clause License + +Copyright (c) 2019, Cédric Dumay +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.rst b/README.rst index 35d2cc0..63ccc6b 100644 --- a/README.rst +++ b/README.rst @@ -7,14 +7,17 @@ :target: https://travis-ci.org/cdumay/cdumay-rest-client :alt: Latest version - .. image:: https://readthedocs.org/projects/cdumay-rest-client/badge/?version=latest :target: http://cdumay-rest-client.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status -.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg +.. image:: https://img.shields.io/badge/license-BSD3-blue.svg :target: https://github.com/cdumay/cdumay-rest-client/blob/master/LICENSE +.. image:: https://raw.githubusercontent.com/cdumay/cdumay-rest-client/python-coverage-comment-action-data/badge.svg + :target: https://htmlpreview.github.io/?https://github.com/cdumay/cdumay-rest-client/blob/python-coverage-comment-action-data/htmlcov/index.html + :alt: Coverage badge + cdumay-rest-client ================== @@ -88,4 +91,4 @@ Result: License ------- -Licensed under `Apache License 2.0 <./LICENSE>`_ or https://opensource.org/licenses/Apache-2.0. \ No newline at end of file +Licensed under `BSD 3-Clause License <./LICENSE>`_ or https://opensource.org/licenses/BSD-3-Clause. \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..63a265b --- /dev/null +++ b/setup.cfg @@ -0,0 +1,12 @@ +[tool:pytest] +addopts = + --cov=src --cov-report term-missing --cov-branch --cov-report xml --cov-report term + --cov=codebase.code -vv --strict-markers -rfE + +pythonpath = src + +testpaths = + tests + +[coverage:run] +relative_files = true \ No newline at end of file diff --git a/setup.py b/setup.py index fc9d2e4..8683905 100755 --- a/setup.py +++ b/setup.py @@ -18,14 +18,18 @@ author='Cedric DUMAY', author_email='cedric.dumay@gmail.com', url='https://github.com/cdumay/cdumay-rest-client', - license='Apache License', + license='BSD 3-Clause', include_package_data=True, zip_safe=True, install_requires=open('requirements.txt', 'r').readlines(), packages=find_packages('src'), package_dir={'': 'src'}, - test_suite="cdumay_rest_client.tests", extras_require={ - 'opentracing': ['cdumay-opentracing>=0.1.8'] + 'opentracing': ['cdumay-opentracing>=0.1.8'], + "tests": [ + "flake8", + "pytest", + "pytest-cov", + ] } ) diff --git a/src/cdumay_rest_client/tests/test_base.py b/src/cdumay_rest_client/tests/test_base.py deleted file mode 100644 index daeb5f3..0000000 --- a/src/cdumay_rest_client/tests/test_base.py +++ /dev/null @@ -1,24 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -.. codeauthor:: Cédric Dumay - - -""" -import unittest -from cdumay_rest_client.client import RESTClient -from cdumay_http_client.errors import NotFound - - -class BaseTestCase(unittest.TestCase): - def test_post_1(self): - client = RESTClient(server="http://jsonplaceholder.typicode.com") - data = client.do_request(method="GET", path="/posts/1") - self.assertEqual(data['userId'], 1) - self.assertEqual(data['id'], 1) - - def test_post_a(self): - client = RESTClient(server="http://jsonplaceholder.typicode.com") - with self.assertRaises(NotFound): - client.do_request(method="GET", path="/posts/a") diff --git a/src/cdumay_rest_client/tests/__init__.py b/tests/__init__.py similarity index 100% rename from src/cdumay_rest_client/tests/__init__.py rename to tests/__init__.py diff --git a/tests/cdumay_rest_client/__init__.py b/tests/cdumay_rest_client/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/cdumay_rest_client/test_base.py b/tests/cdumay_rest_client/test_base.py new file mode 100644 index 0000000..2006d30 --- /dev/null +++ b/tests/cdumay_rest_client/test_base.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +.. codeauthor:: Cédric Dumay + + +""" +import unittest +from unittest.mock import patch + +from requests import Response + +from cdumay_rest_client.client import RESTClient + + +class BaseTestCase(unittest.TestCase): + def test_init(self): + """Client inititialization""" + client = RESTClient(server="http://localhost", timeout=15) + self.assertEqual(client.server, "http://localhost") + self.assertEqual(client.timeout, 15) + self.assertEqual(client.headers, {'Accept': 'application/json', 'Content-Type': 'application/json'}) + self.assertIsNone(client.auth) + self.assertEqual(client.ssl_verify, True) + self.assertEqual(client.retry_number, 10) + self.assertEqual(client.retry_delay, 30) + self.assertEqual(repr(client), 'Connection: http://localhost') + + def test_get(self): + client = RESTClient(server="http://localhost", timeout=15) + resp = Response() + resp.status_code = 200 + resp.encoding = 'UTF-8' + resp._content = b'{"user_id": 1, "name": "john"}' + with patch('requests.request', return_value=resp): + data = client.do_request(method="GET", path="/posts/1") + self.assertEqual(data['user_id'], 1) + self.assertEqual(data['name'], "john") + self.assertNotIn('age', data)