Add configs to run new tests in CI

Author: jhamon

.github/actions/create-index/action.yml

@@ -30,6 +30,15 @@ outputs:
   index_name:
     description: 'The name of the index, including randomized suffix'
     value: ${{ steps.create-index.outputs.index_name }}
+  index_host:
+    description: 'The host of the index'
+    value: ${{ steps.create-index.outputs.index_host }}
+  index_dimension:
+    description: 'The dimension of the index'
+    value: ${{ steps.create-index.outputs.index_dimension }}
+  index_metric:
+    description: 'The metric of the index'
+    value: ${{ steps.create-index.outputs.index_metric }}
 
 runs:
   using: 'composite'

.github/actions/test-data-plane-asyncio/action.yaml

@@ -0,0 +1,55 @@
+name: 'Test Data Plane'
+description: 'Runs tests on the Pinecone data plane'
+
+inputs:
+  metric:
+    description: 'The metric of the index'
+    required: true
+  dimension:
+    description: 'The dimension of the index'
+    required: true
+  host:
+    description: 'The host of the index'
+    required: true
+  use_grpc:
+    description: 'Whether to use gRPC or REST'
+    required: true
+  freshness_timeout_seconds:
+    description: 'The number of seconds to wait for the index to become fresh'
+    required: false
+    default: '60'
+  PINECONE_API_KEY:
+    description: 'The Pinecone API key'
+    required: true
+
+outputs:
+  index_name:
+    description: 'The name of the index, including randomized suffix'
+    value: ${{ steps.create-index.outputs.index_name }}
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python_version }}
+
+    - name: Setup Poetry
+      uses: ./.github/actions/setup-poetry
+      with:
+        include_grpc: ${{ inputs.use_grpc }}
+        include_dev: 'true'
+
+    - name: Run data plane tests
+      id: data-plane-tests
+      shell: bash
+      run: poetry run pytest tests/integration/data_asyncio
+      env:
+        PINECONE_API_KEY: ${{ inputs.PINECONE_API_KEY }}
+        USE_GRPC: ${{ inputs.use_grpc }}
+        METRIC: ${{ inputs.metric }}
+        INDEX_HOST: ${{ inputs.host }}
+        DIMENSION: ${{ inputs.dimension }}
+        SPEC: ${{ inputs.spec }}
+        FRESHNESS_TIMEOUT_SECONDS: ${{ inputs.freshness_timeout_seconds }}

.github/workflows/testing-integration.yaml

@@ -25,6 +25,64 @@ jobs:
           PINECONE_DEBUG_CURL: 'true'
           PINECONE_API_KEY: '${{ secrets.PINECONE_API_KEY }}'
 
+  data-plane-setup:
+    name: Create index
+    runs-on: ubuntu-latest
+    outputs:
+      index_name: ${{ steps.setup-index.outputs.index_name }}
+      index_host: ${{ steps.setup-index.outputs.index_host }}
+      index_dimension: ${{ steps.setup-index.outputs.index_dimension }}
+      index_metric: ${{ steps.setup-index.outputs.index_metric }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create index
+        id: setup-index
+        uses: ./.github/actions/create-index
+        timeout-minutes: 5
+        with:
+          dimension: 100
+          metric: 'cosine'
+          PINECONE_API_KEY: ${{ secrets.PINECONE_API_KEY }}
+
+
+  test-data-plane-asyncio:
+    name: Data plane asyncio integration tests
+    runs-on: ubuntu-latest
+    needs:
+      - data-plane-setup
+    outputs:
+      index_name: ${{ needs.data-plane-setup.outputs.index_name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: [3.8, 3.12]
+        use_grpc: [true]
+        spec:
+          - '{ "asyncio": { "environment": "us-east1-gcp" }}'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/test-data-plane-asyncio
+        with:
+          python_version: '${{ matrix.python_version }}'
+          use_grpc: '${{ matrix.use_grpc }}'
+          metric: '${{ needs.data-plane-setup.outputs.index_metric }}'
+          dimension: '${{ needs.data-plane-setup.outputs.index_dimension }}'
+          host: '${{ needs.data-plane-setup.outputs.index_host }}'
+          PINECONE_API_KEY: '${{ secrets.PINECONE_API_KEY }}'
+          freshness_timeout_seconds: 600
+
+  data-plane-asyncio-cleanup:
+    name: Deps cleanup
+    runs-on: ubuntu-latest
+    needs:
+      - test-data-plane-asyncio
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/delete-index
+        with:
+          index_name: '${{ needs.test-data-plane-asyncio.outputs.index_name }}'
+          PINECONE_API_KEY: '${{ secrets.PINECONE_API_KEY }}'
+
   data-plane-serverless:
     name: Data plane serverless integration tests
     runs-on: ubuntu-latest
@@ -33,7 +91,7 @@ jobs:
       matrix:
         python_version: [3.8, 3.12]
         use_grpc: [true, false]
-        metric: 
+        metric:
           - cosine
           # - euclidean
           # - dotproduct

scripts/create.py

@@ -59,14 +59,22 @@ def generate_index_name(test_name: str) -> str:
 
 def main():
     pc = Pinecone(api_key=read_env_var("PINECONE_API_KEY"))
+
     index_name = generate_index_name(read_env_var("NAME_PREFIX") + random_string(20))
+    dimension = int(read_env_var("DIMENSION"))
+    metric = read_env_var("METRIC")
+
     pc.create_index(
         name=index_name,
-        metric=read_env_var("METRIC"),
-        dimension=int(read_env_var("DIMENSION")),
+        metric=metric,
+        dimension=dimension,
         spec={"serverless": {"cloud": read_env_var("CLOUD"), "region": read_env_var("REGION")}},
     )
+    desc = pc.describe_index(index_name)
     write_gh_output("index_name", index_name)
+    write_gh_output("index_host", desc.host)
+    write_gh_output("index_metric", metric)
+    write_gh_output("index_dimension", dimension)
 
 
 if __name__ == "__main__":