{"id":15470736,"url":"https://github.com/comtihon/catcher","last_synced_at":"2025-10-08T20:05:10.250Z","repository":{"id":38375773,"uuid":"123724495","full_name":"comtihon/catcher","owner":"comtihon","description":"microservices and data pipelines end-to-end test tool","archived":false,"fork":false,"pushed_at":"2023-10-12T04:36:07.000Z","size":1160,"stargazers_count":96,"open_issues_count":19,"forks_count":13,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-08T13:34:49.624Z","etag":null,"topics":["catcher","e2e","e2e-testing","e2e-tests","migration-tool","test-automation","test-framework","testing-tools"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/comtihon.png","metadata":{"files":{"readme":"Readme.rst","changelog":"Changelog.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-03T19:30:21.000Z","updated_at":"2025-07-14T02:24:01.000Z","dependencies_parsed_at":"2024-10-02T02:06:33.909Z","dependency_job_id":"4ae38cee-8158-4428-b967-551815675b84","html_url":"https://github.com/comtihon/catcher","commit_stats":{"total_commits":369,"total_committers":9,"mean_commits":41.0,"dds":0.5067750677506775,"last_synced_commit":"0676c6151707519ebe69bdbab5b20d4226bbee35"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/comtihon/catcher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comtihon%2Fcatcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comtihon%2Fcatcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comtihon%2Fcatcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comtihon%2Fcatcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comtihon","download_url":"https://codeload.github.com/comtihon/catcher/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comtihon%2Fcatcher/sbom","scorecard":{"id":301950,"data":{"date":"2025-08-11","repo":{"name":"github.com/comtihon/catcher","commit":"0676c6151707519ebe69bdbab5b20d4226bbee35"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/2 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: test/resources/MyClass.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docker-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/tag_master.yml:1","Warn: no topLevel permission defined: .github/workflows/test-package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/docker-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tag_master.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/tag_master.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tag_master.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/tag_master.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tag_master.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/tag_master.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tag_master.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/tag_master.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-package.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/test-package.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-package.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/test-package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-package.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/comtihon/catcher/test-package.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.9-alpine to python:3.9-alpine@sha256:372f3cfc1738ed91b64c7d36a7a02d5c3468ec1f60c906872c3fd346dda8cbbb","Warn: pipCommand not pinned by hash: .github/workflows/tag_master.yml:41","Warn: pipCommand not pinned by hash: .github/workflows/test-package.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/test-package.yml:31","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-496j-2rq6-j6cc","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-gmj6-6f8f-6699","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: PYSEC-2023-212 / GHSA-g4mx-q9vg-27p4","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2023-192 / GHSA-v845-jxx5-vc9f"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T20:52:21.874Z","repository_id":38375773,"created_at":"2025-08-17T20:52:21.874Z","updated_at":"2025-08-17T20:52:21.874Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000704,"owners_count":26082819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["catcher","e2e","e2e-testing","e2e-tests","migration-tool","test-automation","test-framework","testing-tools"],"created_at":"2024-10-02T02:06:31.745Z","updated_at":"2025-10-08T20:05:10.222Z","avatar_url":"https://github.com/comtihon.png","language":"Python","readme":".. image:: https://github.com/comtihon/catcher/actions/workflows/test-package.yml/badge.svg?branch=master\n    :target: https://github.com/comtihon/catcher/actions/workflows/test-package.yml\n.. image:: https://img.shields.io/pypi/v/catcher.svg\n    :target: https://pypi.python.org/pypi/catcher\n.. image:: https://img.shields.io/pypi/pyversions/catcher.svg\n    :target: https://pypi.python.org/pypi/catcher\n.. image:: https://img.shields.io/pypi/wheel/catcher.svg\n    :target: https://pypi.python.org/pypi/catcher\n.. image:: https://patrolavia.github.io/telegram-badge/chat.png\n    :target: https://t.me/catcher_e2e\n\nMicroservices automated test tool\n=================================\nSupport your team with a good Catcher!\n\n.. image:: https://raw.githubusercontent.com/comtihon/catcher/master/docs/_static/logo_big.png\n   :scale: 50 %\n\nWhat is catcher?\n----------------\nCatcher is a flexible end to end test tool, that can be used for automated microservices or data pipelines testing.\nIt helps you to check either one service or whole system interaction from the front-end to the back-end.\nWith the help of Catcher you can easily mock external services your system relies on. Catcher is not about only http, it\ncan check different services, such as Kafka, Postgres, CouchBase, Mongodb, Elastic, S3, emails and others.\n\nQuickstart and documentation\n----------------------------\n1. Check, how to write a `test \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/tests.html\u003e`_.\n2. Get to know how to `install \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/run.html\u003e`_ and run Catcher.\n3. List all `steps \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/steps.html\u003e`_ and select those you need.\n4. Learn more about `variables \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/variables.html\u003e`_ and `resources \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/resources.html\u003e`_\n5. Read how to trace and debug your test using `reports \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/reports.html\u003e`_\n\nFor more information check `readthedocs`_.\n\nVery quick start\n----------------\nYou can run Catcher in `docker`_ with all libraries, drivers and steps already installed and configured. It allows\nyou to try Catcher without installing anything.\n\nJust run the minimal command::\n\n    docker run -v $(pwd)/inventory:/opt/catcher/inventory\n               -v $(pwd)/tests:/opt/catcher/tests\n                catcher -i inventory/my_inventory.yml tests\n\nIt will ask Catcher to run everything within your local **tests** folder using **inventory/my_inventory.yml**. For more\ninformation please check run `instructions \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/run.html\u003e`_\n\n.. _docker: https://hub.docker.com/repository/docker/comtihon/catcher\n\nHow does it look like?\n----------------------\n\nImagine you have a **user_service** which saves users in **postgre** and posts them to **kafka** topic, where they are\nconsumed by another service, which sends them emails.\nYou mention your environment in the inventory files.\n\nlocal.yml::\n\n    kafka_server: '127.0.0.1:9092'\n    postgres: 'test:test@localhost:5433/test'\n    user_service: 'http://127.0.0.1:9090'\n    email_config:\n        host: '127.0.0.1:12345'\n        user: 'local_user'\n        pass: 'local_pass'\n\ndevelop.yml::\n\n    kafka_server: 'kafka.dev.mycompany.com:9092'\n    postgres: 'dev:dev@postgres.dev.mycompany.com:5433/test'\n    user_service: 'http://user_service.dev.mycompany.com:9090'\n    email_config:\n        host: 'imap.google.com'\n        user: 'my_user@google.com'\n        pass: 'my_pass'\n\nYou write a test::\n\n    variables: # here you specify test-local variables\n        users:\n            - email: '{{ test_user@my_company.com }}'\n              name: '{{ random(\"name\") }}' # templates fully supported\n            - email: '{{ random(\"email\") }}'\n              name: '{{ random(\"name\") }}'\n    steps: # here you write steps which Catcher executed one by one until it fails\n        - http:\n            post:\n                url: '{{ user_service }}/sign_up' # user_service value is taken from active inventory which you specify at runtime\n                body: '{{ users[0] }}' # send first user from variables as a POST body\n                headers: {Content-Type: 'application/json'}\n                response_code: 2xx # will accept 200-299 codes\n            name: 'Register {{ users[0].email }} as a new user' # name your step properly (Optional)\n            register: {user_id: '{{ OUTPUT.id }}'}  # register new variable user_id as id param from json response\n        - postgres: # check if user was saved in the database\n            request:\n                conf: '{{ postgres }}'\n                sql: 'select * from users where user_id = {{ user_id }}'  # user_id from previous step will be used in this template\n            register: {email_in_db: '{{ OUTPUT.email }}'}  # load full user data and register only email as a new variable\n        - check: # compare email from the database with real user email\n            equals: {the: '{{ users[0].email }}', is: '{{ email_id_db }}'}}  # checks the equality between two strings. Templates supported.\n        - kafka:\n            consume:  # check if user_service pushed newly created user to kafka\n                server: '{{ kafka_server }}' # kafka_server value is taken from active inventory\n                topic: 'new_users'\n                where: # filter all messages except messages for our user\n                    equals: {the: '{{ MESSAGE.user_id }}', is: '{{ user_id }}'}\n        - email: # check if email was sent for this user\n              receive:\n                  config: '{{ email_conf }}'\n                  filter: {unread: true, subject: 'Welcome {{ users[0].name }}'} # select all unread and filter by subject\n                  ack: true  # mark as read\n                  limit: 1\n              register: {messages: '{{ OUTPUT }}'}  # register all messages found (0 or 1)\n        - check: '{{ messages |length \u003e 0 }}' # short form of compare - we should have more than 0 messages co pass this step\n    finally:\n        - postgres: # delete user from database to cleanup after test finishes (no matter successfully or not)\n            request:\n                conf: '{{ postgres }}'\n                sql: 'delete from users where user_id = {{ user_id }}'\n\nFor local environment run it as::\n\n    catcher -i inventories/local.yml tests/my_test.yml\n\nFor dev::\n\n    catcher -i inventories/develop.yml tests/my_test.yml\n\nSee `microservices`_ for more complex example.\n\nCustomization\n-------------\nCatcher can be easily customized to serve your needs.\n\n1. You can write your own functions and filters and use them in your step's `templates \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/filters_and_functions.html\u003e`_.\n2. You can create your own `modules \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/modules.html\u003e`_ (in Python, Java, Kotlin, JS, jar-files or any executable)\n3. You can write your steps in catcher itself and `include \u003chttps://catcher-test-tool.readthedocs.io/en/latest/source/includes.html#run-on-action\u003e`_ them from other tests.\n\nWhy catcher?\n------------\n\n* don't repeat test code. Write one test and call its steps from another;\n* compute and override variables to check your data and compose new flexible requests;\n* write test for development, change inventory and test stage/uat/prod with no changes;\n* test your data pipelines with `Airflow \u003chttps://catcher-modules.readthedocs.io/en/latest/source/airflow.html\u003e`_ step;\n* test your front-end \u003c-\u003e back-end integration with `Selenium \u003chttps://catcher-modules.readthedocs.io/en/latest/source/selenium.html\u003e`_ step;\n* test all your `microservices`_ with ease;\n* `modular`_ architecture\n* bulk-prepare and bulk-check data for you tests with `prepare-expect`_ step\n* automate your testing!\n\nChangelog is `here \u003chttps://github.com/comtihon/catcher/blob/master/Changelog.rst\u003e`_.\n\nContributors:\n-------------\n* Many thanks to `Ekaterina Belova \u003chttps://github.com/kbelova\u003e`_ for core \u0026 modules contribution.\n\n.. _readthedocs: https://catcher-test-tool.readthedocs.io/en/latest/\n.. _microservices: https://catcher-test-tool.readthedocs.io/en/latest/source/microservices.html\n.. _modular: https://catcher-test-tool.readthedocs.io/en/latest/source/modules.html\n.. _prepare-expect: https://catcher-modules.readthedocs.io/en/latest/source/prepare_expect.html\n.. _selenium: https://catcher-modules.readthedocs.io/en/latest/source/selenium.html","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomtihon%2Fcatcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomtihon%2Fcatcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomtihon%2Fcatcher/lists"}