Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration test cleanup workflow #138

Merged
merged 3 commits into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/cleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Cleanup test resources'

on:
workflow_dispatch: {}
schedule:
- cron: '0 0 * * *'

jobs:
cleanup:
name: Delete all indexes and collections in sdk-node-testing project
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Cleanup
run: npm run test:integration:cleanup
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"repl": "npm run build && node utils/replInit.ts",
"test:integration:node": "jest src/integration/ -c jest.config.integration-node.js",
"test:integration:edge": "jest src/integration/ -c jest.config.integration-edge.js",
"test:integration:cleanup": "npm run build && node utils/cleanupResources.ts",
"test:unit": "jest src/"
},
"engines": {
Expand Down
26 changes: 26 additions & 0 deletions utils/cleanupResources.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
var dotenv = require('dotenv');
dotenv.config();

for (const envVar of ['PINECONE_ENVIRONMENT', 'PINECONE_API_KEY']) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: This may be a minor issue, but if you run this locally outside CI where we're using secrets, I'd imagine this will just wipe things for whatever environment values you have configured, would that be an issue? Not sure if there's a good way around that as we don't want to embed the integration testing stuff in the repo itself.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it would run for whatever environment you are currently pointing at in your .env. Not ideal I suppose if you have a lot of test index data you're worried about accidentally deleting, but how likely are you to accidentally run npm run integration:test:cleanup from local? By wrapping this into a github actions workflow, we shouldn't ever really be running this locally.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose I could remove the dotenv invocation since that is only used locally. But I actually do want the ability to run this locally sometimes when developing new tests that throw off a lot of unintended indexes.

I think a more advanced version of this workflow would have us adopt a standardized naming scheme for indexes and collections (e.g. one that starts with a build number), and then trigger a cleanup job immediately after every CI run that deletes resources tied to that build number only. But that's more work / somewhat error prone. This quick and dirty approach gives most of the benefits.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I ultimately think this is fine, it would be very unlikely somewhat would run the integration cleanup step by accident or without knowing what it does.

if (!process.env[envVar]) {
console.warn(`WARNING Missing environment variable ${envVar} in .env file`);
} else {
console.log(`INFO Found environment variable ${envVar} in .env file`);
}
}

var pinecone = require('../dist');

(async () => {
const p = new pinecone.Pinecone();

const collections = await p.listCollections();
for (const collection of collections) {
await p.deleteCollection(collection.name);
}

const indexes = await p.listIndexes();
for (const index of indexes) {
await p.deleteIndex(index.name);
}
})();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Would it be useful to log anything out here if there were resources to clean up? Was thinking it might be nice to have some sort of indication of that either when running in the CLI or triggered via workflows.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, I'll add some log output.