From aed091161ad26579c8002f8fbf4ef70a82fe83a0 Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 15:11:34 +0100 Subject: [PATCH 1/7] add coverage to ci & badge to readme --- .github/workflows/ci_api.yml | 18 +++++++++++++++++- README.md | 3 +++ api/poetry.lock | 28 ++++++++++++++++------------ api/pyproject.toml | 1 + 4 files changed, 37 insertions(+), 13 deletions(-) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index 1a1e9425e..bd604448c 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -1,9 +1,14 @@ +name: Tests + on: push: branches: [main] pull_request: branches: [main] +permissions: + contents: write + jobs: test: runs-on: ${{ matrix.os }} @@ -46,8 +51,19 @@ jobs: - name: Run tests mocked working-directory: ./api - run: poetry run pytest -vv --durations=0 + run: poetry run pytest -vv --durations=0 --cov-report term-missing --cov=./ - name: Run tests working-directory: ./api run: MONKEYPATCH=0 poetry run pytest -vv --durations=0 + + - name: Generate coverage badge + run: coverage-badge -fo coverage_badge.svg + + - name: Commit changes + uses: EndBug/add-and-commit@v9 + with: + author_name: github-actions + author_email: actions@github.com + message: 'Update coverage badge' + add: 'coverage_badge.svg' diff --git a/README.md b/README.md index 08eeafa3b..a14cd52cd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # NameHash NameGuard +![Tests](https://github.com/namehash/nameguard/actions/workflows/ci_api.yml/badge.svg?branch=main) +![Coverage](https://raw.githubusercontent.com/namehash/nameguard/main/coverage_badge.svg) + The NameHash team is proud to present NameGuard, a tool for identifying and preventing malicious use of ENS names. - Offers multiple levels of protection diff --git a/api/poetry.lock b/api/poetry.lock index 645d6fc2f..93d06c87b 100644 --- a/api/poetry.lock +++ b/api/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand. [[package]] name = "aiohttp" @@ -514,6 +514,20 @@ tomli = {version = "*", optional = true, markers = "python_full_version <= \"3.1 [package.extras] toml = ["tomli"] +[[package]] +name = "coverage-badge" +version = "1.1.0" +description = "Generate coverage badges for Coverage.py." +optional = false +python-versions = "*" +files = [ + {file = "coverage-badge-1.1.0.tar.gz", hash = "sha256:c824a106503e981c02821e7d32f008fb3984b2338aa8c3800ec9357e33345b78"}, + {file = "coverage_badge-1.1.0-py2.py3-none-any.whl", hash = "sha256:e365d56e5202e923d1b237f82defd628a02d1d645a147f867ac85c58c81d7997"}, +] + +[package.dependencies] +coverage = "*" + [[package]] name = "cytoolz" version = "0.12.2" @@ -1786,7 +1800,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1794,15 +1807,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1819,7 +1825,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1827,7 +1832,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2555,4 +2559,4 @@ lambda = ["mangum"] [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.12" -content-hash = "964bac6fda1926212da8a6f2c959f5fdd3b67857c617478feaac7f1f884fed80" +content-hash = "914008d5f4926d483ca67227316d1b689595d5147611c9eb0545bd1fb7706e10" diff --git a/api/pyproject.toml b/api/pyproject.toml index 15a827d9f..8545892f5 100644 --- a/api/pyproject.toml +++ b/api/pyproject.toml @@ -33,6 +33,7 @@ uvicorn = {extras = ["standard"], version = "^0.23.2"} pytest-asyncio = "^0.21.1" pytest-cov = "^4.1.0" pytest-retry = "^1.5.0" +coverage-badge = "^1.1.0" [build-system] From ebe868b524ed2acaed2aec98d6a3a09a7f8564ab Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 15:16:25 +0100 Subject: [PATCH 2/7] fix poetry prefix --- .github/workflows/ci_api.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index bd604448c..585943ce2 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -58,7 +58,7 @@ jobs: run: MONKEYPATCH=0 poetry run pytest -vv --durations=0 - name: Generate coverage badge - run: coverage-badge -fo coverage_badge.svg + run: poetry run coverage-badge -fo coverage_badge.svg - name: Commit changes uses: EndBug/add-and-commit@v9 From c26a1a9356de38673ea81e318ab412e9377af4f4 Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 15:19:42 +0100 Subject: [PATCH 3/7] fix working dir --- .github/workflows/ci_api.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index 585943ce2..597b9ea3d 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -58,7 +58,8 @@ jobs: run: MONKEYPATCH=0 poetry run pytest -vv --durations=0 - name: Generate coverage badge - run: poetry run coverage-badge -fo coverage_badge.svg + working-directory: ./api + run: poetry run coverage-badge -fo ../coverage_badge.svg - name: Commit changes uses: EndBug/add-and-commit@v9 From 2d7eb37337a50f0cc7588f5159a090706f835a36 Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 30 Nov 2023 14:21:33 +0000 Subject: [PATCH 4/7] Update coverage badge --- coverage_badge.svg | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 coverage_badge.svg diff --git a/coverage_badge.svg b/coverage_badge.svg new file mode 100644 index 000000000..607d3de4d --- /dev/null +++ b/coverage_badge.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 91% + 91% + + From 11db773d42a4fa08df98e1b619f8ddb9e3dbf343 Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 15:41:30 +0100 Subject: [PATCH 5/7] restrict badge commit to one run --- .github/workflows/ci_api.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index 597b9ea3d..5fcededd3 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -58,10 +58,12 @@ jobs: run: MONKEYPATCH=0 poetry run pytest -vv --durations=0 - name: Generate coverage badge + if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' working-directory: ./api run: poetry run coverage-badge -fo ../coverage_badge.svg - name: Commit changes + if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' uses: EndBug/add-and-commit@v9 with: author_name: github-actions From ed14e21dc792f9297dde72c1d91495669ad3c75f Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 17:28:32 +0100 Subject: [PATCH 6/7] create a separate job for badge --- .github/workflows/ci_api.yml | 41 +++++++++++++++++++++++++++++++----- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index 5fcededd3..e2c1d9b15 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -6,8 +6,6 @@ on: pull_request: branches: [main] -permissions: - contents: write jobs: test: @@ -51,19 +49,52 @@ jobs: - name: Run tests mocked working-directory: ./api - run: poetry run pytest -vv --durations=0 --cov-report term-missing --cov=./ + run: poetry run pytest -vv --durations=0 - name: Run tests working-directory: ./api run: MONKEYPATCH=0 poetry run pytest -vv --durations=0 + add_badge: + runs-on: ubuntu-latest + needs: test + permissions: + contents: write + + if: github.ref == 'refs/heads/main' # run this job only on a push to main + + env: + PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }} + PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }} + PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }} + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Install poetry + run: pipx install poetry + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: 3.11 + cache: "poetry" + + - name: Install dependencies + working-directory: ./api + run: poetry install + + - name: Run tests mocked + working-directory: ./api + run: poetry run pytest -vv --durations=0 --cov-report term-missing --cov=./ + - name: Generate coverage badge - if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' working-directory: ./api run: poetry run coverage-badge -fo ../coverage_badge.svg - name: Commit changes - if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' uses: EndBug/add-and-commit@v9 with: author_name: github-actions From a992656fe39f23a316cf2a5e4f7c6c24ab3df7cc Mon Sep 17 00:00:00 2001 From: Byczong Date: Thu, 30 Nov 2023 17:32:52 +0100 Subject: [PATCH 7/7] move env to top --- .github/workflows/ci_api.yml | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci_api.yml b/.github/workflows/ci_api.yml index e2c1d9b15..ef0760aa4 100644 --- a/.github/workflows/ci_api.yml +++ b/.github/workflows/ci_api.yml @@ -6,6 +6,11 @@ on: pull_request: branches: [main] +env: + PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }} + PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }} + PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }} + jobs: test: @@ -16,11 +21,6 @@ jobs: os: [ubuntu-latest] python-version: [3.9, 3.11] - env: - PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }} - PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }} - PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }} - steps: - uses: actions/checkout@v3 with: @@ -63,11 +63,6 @@ jobs: if: github.ref == 'refs/heads/main' # run this job only on a push to main - env: - PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }} - PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }} - PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }} - steps: - uses: actions/checkout@v3 with: