Bug: Repo maintenance (#14)

* Add Initial Repo Maintenance Files. Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add github templates, workflows, codeowners Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Add RELEASING.md and .codecov.yml Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Add Test CI Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * bug: move run-tests.yml to base workflows folder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve lint errors Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve mypy errors Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve rename errors in run-tests.py Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add test placeholder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add test placeholder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Change test config to setup.cfg Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: delete renamed folders, fix placeholder test Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Add Test CI Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * bug: move run-tests.yml to base workflows folder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve lint errors Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve mypy errors Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: resolve rename errors in run-tests.py Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add test placeholder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add test placeholder Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Repo maintenance (#10) * Add Initial Repo Maintenance Files. Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * add github templates, workflows, codeowners Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Add RELEASING.md and .codecov.yml Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Add Test CI Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * fix: add pytest to test requirements Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> --------- Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * Change test config to setup.cfg Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> * nit: delete renamed folders, fix placeholder test Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com> --------- Signed-off-by: Rajvaibhav Rahane <rrahane@amazon.com>
opensearch-project · Feb 26, 2025 · 065a7ea · 065a7ea
1 parent cd6d8d0
commit 065a7ea
Show file tree

Hide file tree

Showing 12 changed files with 83 additions and 7 deletions.
diff --git a/.github/workflows/run-tests.yml 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 → remote_vector_index_builder/__init__.py b/test_remote-vector-index-builder/__init__.py → 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.
+# compatible open source license.
diff --git a/remote-vector-index-builder/__init__.py → remote_vector_index_builder/core/__init__.py b/remote-vector-index-builder/__init__.py → 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.
+# compatible open source license.
diff --git a/...ector-index-builder/core/requirements.txt → ...ex_builder/core/index_builder/__init__.py b/...ector-index-builder/core/requirements.txt → ...ex_builder/core/index_builder/__init__.py
diff --git a/remote-vector-index-builder/core/main.py → remote_vector_index_builder/core/main.py b/remote-vector-index-builder/core/main.py → 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.
+# compatible open source license.
diff --git a/...ote-vector-index-builder/requirements.txt → ...ector_index_builder/core/requirements.txt b/...ote-vector-index-builder/requirements.txt → ...ector_index_builder/core/requirements.txt
diff --git a/remote-vector-index-builder/core/__init__.py → ...tor_index_builder/testing_api/__init__.py b/remote-vector-index-builder/core/__init__.py → ...tor_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.
+# compatible open source license.
diff --git a/...e-vector-index-builder/testing_api/app.py → ...e_vector_index_builder/testing_api/app.py b/...e-vector-index-builder/testing_api/app.py → ...e_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.
+# compatible open source license.
diff --git a/.flake8 → setup.cfg b/.flake8 → 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
+show-source = True
+
+[black]
+max-line-length = 120
+target-version = 'py38'
diff --git a/...tor-index-builder/testing_api/__init__.py → test_remote_vector_index_builder/__init__.py b/...tor-index-builder/testing_api/__init__.py → 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.
+# compatible open source license.
diff --git a/test_remote_vector_index_builder/requirements.txt 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
diff --git a/test_remote_vector_index_builder/test_placeholder.py 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