diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..1fde7f8 --- /dev/null +++ b/.flake8 @@ -0,0 +1,4 @@ +[flake8] +exclude = tests/*, .venv/* +max-complexity = 10 +max-line-length = 100 diff --git a/.github/workflows/lint-and-smoke.yml b/.github/workflows/lint-and-smoke.yml new file mode 100644 index 0000000..4fe9934 --- /dev/null +++ b/.github/workflows/lint-and-smoke.yml @@ -0,0 +1,27 @@ +name: lint & smoke +on: [push, pull_request] +jobs: + lint-and-smoke: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: '3.11' + architecture: x64 + - uses: actions/cache@v2 + env: + cache-name: pipenv-virtualenvs-cache + with: + path: ~/.local/share/virtualenvs + key: ${{env.cache-name}}-${{runner.os}}-${{hashFiles('Pipfile.lock')}} + - name: setup + run: | + pip install pipenv + pipenv install --dev + - name: lint + run: | + pipenv run python -m flake8 . + - name: smoke + run: | + pipenv run python -m pytest -m smoke diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..26e5f56 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,21 @@ +name: release +on: + push: + tags: + - v* +jobs: + release: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: '3.11' + - name: setup + run: pip install wheel + - name: build + run: python setup.py --release-version ${GITHUB_REF#refs/tags/v} sdist bdist_wheel + - name: release + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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/Pipfile b/Pipfile index a8087e8..7ece735 100644 --- a/Pipfile +++ b/Pipfile @@ -5,16 +5,12 @@ pylint = "*" pytest = "<8.0.0" python-dotenv = "*" backoff = "*" -responses = "*" -pytest-profiling = "*" python-language-server = "*" pyls-mypy = "*" pyls-isort = "*" pytest-order = "*" [packages] -#3scale-api = {editable = true,path = "./../mkudlej-3scale-api-python"} -#3scale-api = {git = "https://github.com/3scale/3scale-api-python.git",editable = true,ref = "master"} 3scale-api = "*" openshift-client = "*" diff --git a/README.md b/README.md index 314ed2d..070a2e3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,58 @@ # 3scale-api-python-crd +3scale client uses CRs for object definition. CRs are processed by 3scale Operator. + +[Capabilities documentation](https://github.com/3scale/3scale-operator/blob/master/doc/operator-application-capabilities.md) + +## Installing + +Install and update using pip: + +```bash +pip install 3scale-api-crd +``` + +Or as a dependency using the pipenv + +```bash +pipenv install 3scale-api-crd +``` + +## Usage + +Client supports basic CRUD operations and it generates CRs in Openshift namespace defined by `oc` session. + +Basic usage of the client: + +```bash +oc login +oc project example +``` + +```python +import threescale_api_crd + +client = threescale_api_crd.ThreeScaleClientCRD(url="myaccount.3scale.net", token="secret_token", ssl_verify=True, ocp_provider_ref="secret_with_credentials") +``` +Using of objects are described in [3scale API client README](https://github.com/3scale-qe/3scale-api-python/blob/master/README.md#usage). + + +## Run the Smoke Tests + +To run the tests you need to have installed development dependencies: +```bash +pipenv install --dev +``` + +and then run the `pytest`: + +```bash +pipenv run pytest -m smoke +``` + ### Integration tests configuration -To run the integration tests you need to set these env variables: +To run the integration tests you need to set these extra env variables: ``` THREESCALE_PROVIDER_URL='https://example-admin.3scale.net' THREESCALE_PROVIDER_TOKEN='' @@ -11,14 +61,14 @@ THREESCALE_MASTER_URL='https://master.3scale.net' THREESCALE_MASTER_TOKEN='' ``` -and to have valid `oc` tool session. +and to have valid `oc` tool session to Openshift where 3scale Operator is deployed and watches for CRs. By default: - `oc` namespace should be the namespace where 3scale instance is deployed - the `system-seed` secret is used by 3scale Operator client - `THREESCALE_` variables are used for not implemented Threescale client features -If CRDs are created in different namespace to 3scale deployment, env variable +If CRs are created in different namespace to 3scale deployment, env variable `OCP_PROVIDER_ACCOUNT_REF` can be specified with secret name used by 3scale Operator client, see https://github.com/3scale/3scale-operator/blob/master/doc/backend-reference.md#provider-account-reference @@ -55,7 +105,6 @@ Command to run integration unit tests: `pipenv run pytest --log-cli-level=10 -vv - ProductDeploymentSpec - AuthenticationSpec - implement delete of policies + add unit tests -- create jenkins job for running unit tests - add proper error messages in case of for example missing required arguments, see test_should_fields_be_required - implement optimitazation on the oc level: - for every test run, label objects - oc label product.capabilities.3scale.net/testyrclkfzyhue test_run=new --overwrite diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..2529b9e --- /dev/null +++ b/pytest.ini @@ -0,0 +1,3 @@ +[pytest] +markers = + smoke: Build verification test diff --git a/setup.py b/setup.py index e14821f..9e861c6 100644 --- a/setup.py +++ b/setup.py @@ -1,33 +1,38 @@ -import io import re +import sys from setuptools import find_packages, setup with open("README.md", "r") as fh: long_description = fh.read() -with io.open('threescale_api_crd/__init__.py', 'rt', encoding='utf8') as f: - VERSION = re.search(r'__version__ = \'(.*?)\'', f.read()).group(1) +VERSION = "devel" +if sys.argv[1] == "--release-version": + sys.argv.pop(1) + VERSION = sys.argv.pop(1) + assert re.match(r"[0-9]+\.[0-9]+\.[0-9]+", VERSION), "Version definition required as first arg" -requirements = ['requests', '3scale-api'] +requirements = ['3scale-api', 'openshift-client'] extra_requirements = { 'dev': [ + 'flake8', + 'mypy', + 'pylint', 'pytest', - 'coverage', - 'mock', - 'python-dotenv' + 'python-dotenv', + 'backoff' ], 'docs': ['sphinx'] } setup(name='3scale-api-crd', version=VERSION, - description='3scale CRD python client', + description='3scale CRD Python Client', author='Martin Kudlej', author_email='kudlej.martin@gmail.com', maintainer='Martin Kudlej', - url='https://github.com/mkudlej/3scale-api-python-crd', + url='https://github.com/3scale-qe/3scale-api-python-crd', packages=find_packages(exclude=("tests",)), long_description=long_description, long_description_content_type='text/markdown', @@ -37,7 +42,7 @@ entry_points={}, classifiers=[ "Programming Language :: Python :: 3", - 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.11', "Operating System :: OS Independent", "License :: OSI Approved :: Apache Software License", 'Intended Audience :: Developers', diff --git a/tests/test_3scale_api_client.py b/tests/test_3scale_api_client.py new file mode 100644 index 0000000..1294d76 --- /dev/null +++ b/tests/test_3scale_api_client.py @@ -0,0 +1,45 @@ +import pytest + +import openshift_client as ocp +from openshift_client import OpenShiftPythonException +from threescale_api_crd import client + + +@pytest.fixture() +def url(): + return 'http://localhost' + + +@pytest.fixture() +def token(): + return 'test-token' + +@pytest.fixture(scope='session') +def ocp_provider_ref() -> str: + return 'secret' + + +def _create_client(url, token, ocp_provider_ref, **kwargs) -> client.ThreeScaleClientCRD: + return client.ThreeScaleClientCRD(url=url, token=token, ocp_provider_ref=ocp_provider_ref, **kwargs) + + +@pytest.fixture() +def api(url, token, ocp_provider_ref): + return _create_client(url, token, ocp_provider_ref) + +@pytest.fixture() +def namespace(): + try: + return ocp.get_project_name() + except OpenShiftPythonException: + return "NOT LOGGED IN" + + +@pytest.mark.smoke +def test_api_client_initialization(api, url, ocp_provider_ref, namespace): + assert api.url == url + assert api.parent == api + assert api.threescale_client == api + assert api.admin_api_url == f'{url}/admin/api' + assert api.ocp_provider_ref == ocp_provider_ref + assert api.ocp_namespace == namespace diff --git a/threescale_api_crd/client.py b/threescale_api_crd/client.py index fa93f9e..2f6578c 100644 --- a/threescale_api_crd/client.py +++ b/threescale_api_crd/client.py @@ -3,6 +3,7 @@ """ import openshift_client as ocp +from openshift_client import OpenShiftPythonException import threescale_api from threescale_api_crd import resources @@ -13,7 +14,7 @@ class ThreeScaleClientCRD(threescale_api.client.ThreeScaleClient): def __init__(self, url, token, ocp_provider_ref=None, *args, **kwargs): super().__init__(url, token, *args, **kwargs) self._ocp_provider_ref = ocp_provider_ref - self._ocp_namespace = ocp.get_project_name() + self._ocp_namespace = ThreeScaleClientCRD.get_namespace() self._services = resources.Services(parent=self, instance_klass=resources.Service) self._active_docs = resources.ActiveDocs( parent=self, @@ -29,6 +30,15 @@ def __init__(self, url, token, ocp_provider_ref=None, *args, **kwargs): self._promotes = resources.Promotes(parent=self, instance_klass=resources.Promote) self._applications = resources.Applications(parent=self, account=None, instance_klass=resources.Application) + def get_namespace(): + """ + Returns namespace. If there is no valid Openshift 'oc' session, returns "NOT LOGGED IN". + """ + try: + return ocp.get_project_name() + except OpenShiftPythonException: + return "NOT LOGGED IN" + @property def services(self) -> resources.Services: """Gets services client