From 065a7ea0496b3f948b3df69742a367ca33210398 Mon Sep 17 00:00:00 2001 From: Rajvaibhav Rahane Date: Tue, 25 Feb 2025 16:35:42 -0800 Subject: [PATCH] Bug: Repo maintenance (#14) * Add Initial Repo Maintenance Files. Signed-off-by: Rajvaibhav Rahane * add github templates, workflows, codeowners Signed-off-by: Rajvaibhav Rahane * Add RELEASING.md and .codecov.yml Signed-off-by: Rajvaibhav Rahane * Add Test CI Signed-off-by: Rajvaibhav Rahane * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane * bug: move run-tests.yml to base workflows folder Signed-off-by: Rajvaibhav Rahane * nit: resolve lint errors Signed-off-by: Rajvaibhav Rahane * nit: resolve mypy errors Signed-off-by: Rajvaibhav Rahane * nit: resolve rename errors in run-tests.py Signed-off-by: Rajvaibhav Rahane * add test placeholder Signed-off-by: Rajvaibhav Rahane * add test placeholder Signed-off-by: Rajvaibhav Rahane * Change test config to setup.cfg Signed-off-by: Rajvaibhav Rahane * nit: delete renamed folders, fix placeholder test Signed-off-by: Rajvaibhav Rahane * Add Test CI Signed-off-by: Rajvaibhav Rahane * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane * bug: move run-tests.yml to base workflows folder Signed-off-by: Rajvaibhav Rahane * nit: resolve lint errors Signed-off-by: Rajvaibhav Rahane * nit: resolve mypy errors Signed-off-by: Rajvaibhav Rahane * nit: resolve rename errors in run-tests.py Signed-off-by: Rajvaibhav Rahane * add test placeholder Signed-off-by: Rajvaibhav Rahane * add test placeholder Signed-off-by: Rajvaibhav Rahane * Repo maintenance (#10) * Add Initial Repo Maintenance Files. Signed-off-by: Rajvaibhav Rahane * add github templates, workflows, codeowners Signed-off-by: Rajvaibhav Rahane * Add RELEASING.md and .codecov.yml Signed-off-by: Rajvaibhav Rahane * Add Test CI Signed-off-by: Rajvaibhav Rahane * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane --------- Signed-off-by: Rajvaibhav Rahane * Change test config to setup.cfg Signed-off-by: Rajvaibhav Rahane * nit: delete renamed folders, fix placeholder test Signed-off-by: Rajvaibhav Rahane --------- Signed-off-by: Rajvaibhav Rahane --- .github/workflows/run-tests.yml | 56 +++++++++++++++++++ .../__init__.py | 2 +- .../core}/__init__.py | 2 +- .../core/index_builder/__init__.py | 0 .../core/main.py | 2 +- .../core}/requirements.txt | 0 .../testing_api}/__init__.py | 2 +- .../testing_api/app.py | 2 +- .flake8 => setup.cfg | 7 ++- .../__init__.py | 2 +- .../requirements.txt | 5 ++ .../test_placeholder.py | 10 ++++ 12 files changed, 83 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/run-tests.yml rename {test_remote-vector-index-builder => remote_vector_index_builder}/__init__.py (85%) rename {remote-vector-index-builder => remote_vector_index_builder/core}/__init__.py (85%) rename remote-vector-index-builder/core/requirements.txt => remote_vector_index_builder/core/index_builder/__init__.py (100%) rename {remote-vector-index-builder => remote_vector_index_builder}/core/main.py (85%) rename {test_remote-vector-index-builder => remote_vector_index_builder/core}/requirements.txt (100%) rename {remote-vector-index-builder/core => remote_vector_index_builder/testing_api}/__init__.py (85%) rename {remote-vector-index-builder => remote_vector_index_builder}/testing_api/app.py (85%) rename .flake8 => setup.cfg (63%) rename {remote-vector-index-builder/testing_api => test_remote_vector_index_builder}/__init__.py (85%) create mode 100644 test_remote_vector_index_builder/requirements.txt create mode 100644 test_remote_vector_index_builder/test_placeholder.py diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml new file mode 100644 index 0000000..9c0d990 --- /dev/null +++ b/.github/workflows/run-tests.yml @@ -0,0 +1,56 @@ +name: Run tests for Remote-Vector-Index-Builder + +on: + push: + paths: # Note this is done for folder specific checkouts, reduce CI memory load + - 'remote_vector_index_builder/**' + - 'test_remote_vector_index_builder/**' + pull_request: + paths: # Note this is done for folder specific checkouts, reduce CI memory load + - 'remote_vector_index_builder/**' + - 'test_remote_vector_index_builder/**' + +permissions: + contents: read + +jobs: + run-tests: + name: Run tests for Remote-Vector-Index-Builder + runs-on: ubuntu-latest + if: github.repository == 'opensearch-project/remote-vector-index-builder' + + steps: + # https://github.com/actions/checkout?tab=readme-ov-file#usage + - name: Checkout code + uses: actions/checkout@v4 + with: + # Note this is done for folder specific checkouts, reduce CI memory load + sparse-checkout: | + .github/CODEOWNERS + remote_vector_index_builder + test_remote_vector_index_builder + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install -r remote_vector_index_builder/core/requirements.txt + python -m pip install -r test_remote_vector_index_builder/requirements.txt + + - name: Run Linting - flake8 + run: | + python -m flake8 remote_vector_index_builder/ test_remote_vector_index_builder/ + + - name: Run Formatter - black + run: | + python -m black --check remote_vector_index_builder/ test_remote_vector_index_builder/ + + - name: Run Type Checker - mypy + run: | + python -m mypy remote_vector_index_builder/ test_remote_vector_index_builder/ + - name: Run tests + run: | + python -m pytest test_remote_vector_index_builder/ diff --git a/test_remote-vector-index-builder/__init__.py b/remote_vector_index_builder/__init__.py similarity index 85% rename from test_remote-vector-index-builder/__init__.py rename to remote_vector_index_builder/__init__.py index 109ae6c..fe22b86 100644 --- a/test_remote-vector-index-builder/__init__.py +++ b/remote_vector_index_builder/__init__.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/remote-vector-index-builder/__init__.py b/remote_vector_index_builder/core/__init__.py similarity index 85% rename from remote-vector-index-builder/__init__.py rename to remote_vector_index_builder/core/__init__.py index 109ae6c..fe22b86 100644 --- a/remote-vector-index-builder/__init__.py +++ b/remote_vector_index_builder/core/__init__.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/remote-vector-index-builder/core/requirements.txt b/remote_vector_index_builder/core/index_builder/__init__.py similarity index 100% rename from remote-vector-index-builder/core/requirements.txt rename to remote_vector_index_builder/core/index_builder/__init__.py diff --git a/remote-vector-index-builder/core/main.py b/remote_vector_index_builder/core/main.py similarity index 85% rename from remote-vector-index-builder/core/main.py rename to remote_vector_index_builder/core/main.py index 109ae6c..fe22b86 100644 --- a/remote-vector-index-builder/core/main.py +++ b/remote_vector_index_builder/core/main.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/test_remote-vector-index-builder/requirements.txt b/remote_vector_index_builder/core/requirements.txt similarity index 100% rename from test_remote-vector-index-builder/requirements.txt rename to remote_vector_index_builder/core/requirements.txt diff --git a/remote-vector-index-builder/core/__init__.py b/remote_vector_index_builder/testing_api/__init__.py similarity index 85% rename from remote-vector-index-builder/core/__init__.py rename to remote_vector_index_builder/testing_api/__init__.py index 109ae6c..fe22b86 100644 --- a/remote-vector-index-builder/core/__init__.py +++ b/remote_vector_index_builder/testing_api/__init__.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/remote-vector-index-builder/testing_api/app.py b/remote_vector_index_builder/testing_api/app.py similarity index 85% rename from remote-vector-index-builder/testing_api/app.py rename to remote_vector_index_builder/testing_api/app.py index 109ae6c..fe22b86 100644 --- a/remote-vector-index-builder/testing_api/app.py +++ b/remote_vector_index_builder/testing_api/app.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/.flake8 b/setup.cfg similarity index 63% rename from .flake8 rename to setup.cfg index 0bfbc17..b3066ad 100644 --- a/.flake8 +++ b/setup.cfg @@ -1,3 +1,4 @@ +[flake8] max-line-length = 120 extend-ignore = @@ -10,4 +11,8 @@ exclude = # Output formatting statistics = True count = True -show-source = True \ No newline at end of file +show-source = True + +[black] +max-line-length = 120 +target-version = 'py38' diff --git a/remote-vector-index-builder/testing_api/__init__.py b/test_remote_vector_index_builder/__init__.py similarity index 85% rename from remote-vector-index-builder/testing_api/__init__.py rename to test_remote_vector_index_builder/__init__.py index 109ae6c..fe22b86 100644 --- a/remote-vector-index-builder/testing_api/__init__.py +++ b/test_remote_vector_index_builder/__init__.py @@ -3,4 +3,4 @@ # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a -# compatible open source license. \ No newline at end of file +# compatible open source license. diff --git a/test_remote_vector_index_builder/requirements.txt b/test_remote_vector_index_builder/requirements.txt new file mode 100644 index 0000000..ee9a34e --- /dev/null +++ b/test_remote_vector_index_builder/requirements.txt @@ -0,0 +1,5 @@ +black>=25.1.0,<26.0.0 +flake8>=7.1.0,<8.0.0 +isort>=6.0.0,<7.0.0 +mypy>=1.15.0,<2.0.0 +pytest>=8.0.0,<9.0.0 \ No newline at end of file diff --git a/test_remote_vector_index_builder/test_placeholder.py b/test_remote_vector_index_builder/test_placeholder.py new file mode 100644 index 0000000..2a99f7f --- /dev/null +++ b/test_remote_vector_index_builder/test_placeholder.py @@ -0,0 +1,10 @@ +# Copyright OpenSearch Contributors +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. + + +def test_placeholder(): + assert 1 + 1 == 2