From 754d1ca219188f269b6debcc8f47418928e033eb Mon Sep 17 00:00:00 2001 From: Vicente Eduardo Ferrer Garcia Date: Tue, 11 Jun 2024 19:52:32 +0200 Subject: [PATCH] Refactor project structure following python standards. --- .github/workflows/test.yml | 38 +++- LICENSE | 201 ++++++++++++++++++ README.md | 12 +- requirements.txt | 1 + .../test-auth-function-mesh.yaml | 0 .../test-auth-middleware.yaml | 0 .../test-random-password-generator.yaml | 0 .../test-string-manipulation.yaml | 0 {test-suits => suites}/test-time-app-web.yaml | 0 metacall-test.py => testing.py | 8 +- testing/__init__.py | 0 {utilities => testing}/logger.py | 0 {utilities => testing}/repo_manager.py | 2 +- .../runner/cli_interface.py | 4 +- .../runner/composite_runner_interface.py | 2 +- .../runner/faas_interface.py | 2 +- .../runner/interface_factory.py | 6 +- .../runner/runner_interface.py | 0 {utilities => testing}/test_runner.py | 4 +- .../test_suites_extractor.py | 2 +- todo.md | 6 +- 21 files changed, 254 insertions(+), 34 deletions(-) create mode 100644 LICENSE create mode 100644 requirements.txt rename {test-suits => suites}/test-auth-function-mesh.yaml (100%) rename {test-suits => suites}/test-auth-middleware.yaml (100%) rename {test-suits => suites}/test-random-password-generator.yaml (100%) rename {test-suits => suites}/test-string-manipulation.yaml (100%) rename {test-suits => suites}/test-time-app-web.yaml (100%) rename metacall-test.py => testing.py (81%) create mode 100644 testing/__init__.py rename {utilities => testing}/logger.py (100%) rename {utilities => testing}/repo_manager.py (96%) rename {utilities => testing}/runner/cli_interface.py (93%) rename {utilities => testing}/runner/composite_runner_interface.py (88%) rename {utilities => testing}/runner/faas_interface.py (79%) rename {utilities => testing}/runner/interface_factory.py (73%) rename {utilities => testing}/runner/runner_interface.py (100%) rename {utilities => testing}/test_runner.py (94%) rename {utilities => testing}/test_suites_extractor.py (96%) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 76b85a7..011fcd0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -7,11 +7,15 @@ on: tags: - 'v*.*.*' branches: - - main + - master jobs: build: - runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest] # TODO: macos-latest + runs-on: ${{ matrix.os }} steps: - name: Checkout code uses: actions/checkout@v4 @@ -21,16 +25,28 @@ jobs: with: python-version: '3.10' - - name: Install MetaCall + - name: Install MetaCall (Linux) + if: matrix.os == 'ubuntu-latest' run: curl -sL https://raw.githubusercontent.com/metacall/install/master/install.sh | sh - # TODO - # - name: Install dependencies - # run: | - # python -m pip install --upgrade pip - # pip install -r requirements.txt + - name: Install MetaCall (Windows) + if: matrix.os == 'windows-latest' + run: powershell -NoProfile -ExecutionPolicy unrestricted -Command "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; &([scriptblock]::Create((Invoke-WebRequest -UseBasicParsing 'https://raw.githubusercontent.com/metacall/install/master/install.ps1')))" - # TODO: Iterate through the whole folder and test all suites - - name: Run tests - run: python ./metacall-test.py -f test-suits/test-time-app-web.yaml -V + # TODO: + # - name: Install MetaCall (MacOS) + # if: matrix.os == 'macos-latest' + # run: curl -sL https://raw.githubusercontent.com/metacall/install/master/install.sh | sh + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Run tests + shell: bash + run: | + for test in ./suites/*.yaml; do + echo "Running $test" + python3 ./testing.py -f $test -V + done diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..aeb1094 --- /dev/null +++ b/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 2016-2024 Vicente Eduardo Ferrer Garcia + + 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. \ No newline at end of file diff --git a/README.md b/README.md index e4acc81..a7b3d6c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Matacall Test Center This is a test center for Matacall. It contains a set of test cases for Matacall projects and examples. The test cases are written in a specific yaml format, which is described in the following sections. -The main script used for testing is `metacall-test.py` and it is mainly used in the CI/CD pipeline of this repository. It can also used to test the projects locally. +The main script used for testing is `testing.py` and it is mainly used in the CI/CD pipeline of this repository. It can also used to test the projects locally. ## Test Suits Format The test suits are written in a yaml format. The following is an example of a test suit for the [random-password-generator-example](https://github.com/metacall/random-password-generator-example) @@ -19,10 +19,10 @@ code-files: ``` ## Arguments -The following arguments are available for the `metacall-test.py` script: +The following arguments are available for the `testing.py` script: ```bash -> ./metacall-test.py -h -usage: metacall-test.py [-h] [-V] [-f FILE] +> ./testing.py -h +usage: testing.py [-h] [-V] [-f FILE] options: -h, --help show this help message and exit @@ -31,5 +31,5 @@ options: ``` Example: ```bash -./metacall-test.py -f test-suits/test-time-app-web.yaml -V -``` \ No newline at end of file +./testing.py -f tests/test-time-app-web.yaml -V +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..be2b74d --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +PyYAML==6.0.1 diff --git a/test-suits/test-auth-function-mesh.yaml b/suites/test-auth-function-mesh.yaml similarity index 100% rename from test-suits/test-auth-function-mesh.yaml rename to suites/test-auth-function-mesh.yaml diff --git a/test-suits/test-auth-middleware.yaml b/suites/test-auth-middleware.yaml similarity index 100% rename from test-suits/test-auth-middleware.yaml rename to suites/test-auth-middleware.yaml diff --git a/test-suits/test-random-password-generator.yaml b/suites/test-random-password-generator.yaml similarity index 100% rename from test-suits/test-random-password-generator.yaml rename to suites/test-random-password-generator.yaml diff --git a/test-suits/test-string-manipulation.yaml b/suites/test-string-manipulation.yaml similarity index 100% rename from test-suits/test-string-manipulation.yaml rename to suites/test-string-manipulation.yaml diff --git a/test-suits/test-time-app-web.yaml b/suites/test-time-app-web.yaml similarity index 100% rename from test-suits/test-time-app-web.yaml rename to suites/test-time-app-web.yaml diff --git a/metacall-test.py b/testing.py similarity index 81% rename from metacall-test.py rename to testing.py index c5822dd..6f0e558 100644 --- a/metacall-test.py +++ b/testing.py @@ -1,8 +1,8 @@ import argparse -from utilities.repo_manager import RepoManager -from utilities.test_suites_extractor import TestSuitesExtractor -from utilities.test_runner import TestRunner -from utilities.logger import Logger +from testing.repo_manager import RepoManager +from testing.test_suites_extractor import TestSuitesExtractor +from testing.test_runner import TestRunner +from testing.logger import Logger def main(): parser = argparse.ArgumentParser() diff --git a/testing/__init__.py b/testing/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/utilities/logger.py b/testing/logger.py similarity index 100% rename from utilities/logger.py rename to testing/logger.py diff --git a/utilities/repo_manager.py b/testing/repo_manager.py similarity index 96% rename from utilities/repo_manager.py rename to testing/repo_manager.py index 9b83e7c..38dccee 100644 --- a/utilities/repo_manager.py +++ b/testing/repo_manager.py @@ -1,6 +1,6 @@ import os import subprocess -from utilities.logger import Logger +from testing.logger import Logger class RepoManager: def __init__(self, repo_url): diff --git a/utilities/runner/cli_interface.py b/testing/runner/cli_interface.py similarity index 93% rename from utilities/runner/cli_interface.py rename to testing/runner/cli_interface.py index 67c9bcb..719da8a 100644 --- a/utilities/runner/cli_interface.py +++ b/testing/runner/cli_interface.py @@ -1,6 +1,6 @@ import subprocess -from utilities.runner.runner_interface import RunnerInterface -from utilities.logger import Logger +from testing.runner.runner_interface import RunnerInterface +from testing.logger import Logger class CLIInterface(RunnerInterface): def __init__(self): diff --git a/utilities/runner/composite_runner_interface.py b/testing/runner/composite_runner_interface.py similarity index 88% rename from utilities/runner/composite_runner_interface.py rename to testing/runner/composite_runner_interface.py index fab7468..a2e79ae 100644 --- a/utilities/runner/composite_runner_interface.py +++ b/testing/runner/composite_runner_interface.py @@ -1,4 +1,4 @@ -from utilities.runner.runner_interface import RunnerInterface +from testing.runner.runner_interface import RunnerInterface class CompositeRunnerInterface(RunnerInterface): def __init__(self): diff --git a/utilities/runner/faas_interface.py b/testing/runner/faas_interface.py similarity index 79% rename from utilities/runner/faas_interface.py rename to testing/runner/faas_interface.py index 8273179..688feba 100644 --- a/utilities/runner/faas_interface.py +++ b/testing/runner/faas_interface.py @@ -1,4 +1,4 @@ -from utilities.runner.runner_interface import RunnerInterface +from testing.runner.runner_interface import RunnerInterface class FaaSInterface(RunnerInterface): def run_test_command(self, filename, file_path, test_case_command): diff --git a/utilities/runner/interface_factory.py b/testing/runner/interface_factory.py similarity index 73% rename from utilities/runner/interface_factory.py rename to testing/runner/interface_factory.py index 5c409c1..884edd7 100644 --- a/utilities/runner/interface_factory.py +++ b/testing/runner/interface_factory.py @@ -1,6 +1,6 @@ -from utilities.runner.cli_interface import CLIInterface -from utilities.runner.faas_interface import FaaSInterface -from utilities.runner.composite_runner_interface import CompositeRunnerInterface +from testing.runner.cli_interface import CLIInterface +from testing.runner.faas_interface import FaaSInterface +from testing.runner.composite_runner_interface import CompositeRunnerInterface class InterfaceFactory: @staticmethod diff --git a/utilities/runner/runner_interface.py b/testing/runner/runner_interface.py similarity index 100% rename from utilities/runner/runner_interface.py rename to testing/runner/runner_interface.py diff --git a/utilities/test_runner.py b/testing/test_runner.py similarity index 94% rename from utilities/test_runner.py rename to testing/test_runner.py index ca93bf6..239bf12 100644 --- a/utilities/test_runner.py +++ b/testing/test_runner.py @@ -1,6 +1,6 @@ import re -from utilities.runner.interface_factory import InterfaceFactory -from utilities.logger import Logger +from testing.runner.interface_factory import InterfaceFactory +from testing.logger import Logger class TestRunner: def __init__(self, interface_type): diff --git a/utilities/test_suites_extractor.py b/testing/test_suites_extractor.py similarity index 96% rename from utilities/test_suites_extractor.py rename to testing/test_suites_extractor.py index 1600a96..bd4d1a7 100644 --- a/utilities/test_suites_extractor.py +++ b/testing/test_suites_extractor.py @@ -1,5 +1,5 @@ import yaml -from utilities.logger import Logger +from testing.logger import Logger class TestSuitesExtractor: def __init__(self, file_name): diff --git a/todo.md b/todo.md index 1272896..b7e3653 100644 --- a/todo.md +++ b/todo.md @@ -1,10 +1,12 @@ # ToDos +- [ ] Create a stable version that runs existing tests. - [ ] Support FaaS. - [ ] Update/fix test cases. -- [ ] Run the pipeline on Linux. -- [ ] Run the pipeline on Windows. +- [x] Run the pipeline on Linux. +- [x] Run the pipeline on Windows. - [ ] Run the pipeline on MacOS. - [ ] Link the pipeline with the distributables and install script. - [ ] Update the Readme. - [ ] Add more test cases. +- [ ] Is it possible to use a existing test runner or reporter for showing a cleaner output?