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

#844 Adding spec for UBI #845

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jzonthemtn
Copy link

Description

Adds the UBI spec per opensearch-project/user-behavior-insights#77.

Issues Resolved

Closes #844.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

github-actions bot commented Mar 19, 2025

Changes Analysis

Commit SHA: 9eb972f
Comparing To SHA: 389a8de

API Changes

Summary

├─┬Paths
│ └──[➕] path (8967:3)
└─┬Components
  ├──[➕] responses (34482:7)
  └──[➕] schemas (63921:7)

Document Element Total Changes Breaking Changes
components 2 0
paths 1 0
  • Total Changes: 3
  • Additions: 3

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/13979359037/artifacts/2795779638

API Coverage

Before After Δ
Covered (%) 663 (64.94 %) 663 (64.94 %) 0 (0 %)
Uncovered (%) 358 (35.06 %) 358 (35.06 %) 0 (0 %)
Unknown 49 50 1

@nhtruong
Copy link
Collaborator

Thanks @jzonthemtn
This test is failing with 503 error.

@dblock
Copy link
Member

dblock commented Mar 20, 2025

Is this plugin part of 2.19? If so you don't need a custom plugins/user_behavior_insights folder, add the tests under default.

@jzonthemtn
Copy link
Author

Is this plugin part of 2.19? If so you don't need a custom plugins/user_behavior_insights folder, add the tests under default.

No, it's not. Just 3.0. Thanks, will update.

@dblock
Copy link
Member

dblock commented Mar 20, 2025

Is this plugin part of 2.19? If so you don't need a custom plugins/user_behavior_insights folder, add the tests under default.

No, it's not. Just 3.0. Thanks, will update.

If it's (going to be) installed by default tests should go into default still and have version: >= 3.0. The plugins tests are for those that require custom setup.

@jzonthemtn
Copy link
Author

Is this plugin part of 2.19? If so you don't need a custom plugins/user_behavior_insights folder, add the tests under default.

No, it's not. Just 3.0. Thanks, will update.

If it's (going to be) installed by default tests should go into default still and have version: >= 3.0. The plugins tests are for those that require custom setup.

@dblock Sorry, I'm not sure I follow. Are you saying I still don't have it quite right?

@dblock
Copy link
Member

dblock commented Mar 20, 2025

@dblock Sorry, I'm not sure I follow. Are you saying I still don't have it quite right?

  1. The test is in the right place now, but tests/default/user_behavior_insights/initialize.yaml should be tests/default/ubi/initialize.yaml to match the route.
  2. The tests run in CI in a big matrix of versions, so you need to make sure the test only runs on 3.0+ since your feature doesn't exist till then by adding version: 3.0. And you'll need to make sure the build of 3.0 used has your feature (and potentially bump the revision in the CI).

There's probably more. I'd start by making sure the tests pass locally for you.

@jzonthemtn jzonthemtn marked this pull request as draft March 20, 2025 20:46
@jzonthemtn
Copy link
Author

@dblock Sorry, I'm not sure I follow. Are you saying I still don't have it quite right?

  1. The test is in the right place now, but tests/default/user_behavior_insights/initialize.yaml should be tests/default/ubi/initialize.yaml to match the route.
  2. The tests run in CI in a big matrix of versions, so you need to make sure the test only runs on 3.0+ since your feature doesn't exist till then by adding version: 3.0. And you'll need to make sure the build of 3.0 used has your feature (and potentially bump the revision in the CI).

There's probably more. I'd start by making sure the tests pass locally for you.

Thanks, I think that got me on the right path.

$ npm run test:spec -- --opensearch-url http://localhost:9200 --tests ./tests/default/ubi/

> [email protected] test:spec
> ts-node tools/src/tester/test.ts --opensearch-url http://localhost:9200 --tests ./tests/default/ubi/

[WARNING] No credentials provided, did you forget to set OPENSEARCH_PASSWORD or AWS_ACCESS_KEY_ID?
OpenSearch 3.0.0

PASSED  initialize.yaml (tests/default/ubi/initialize.yaml)

Tested 1/600 paths.

@jzonthemtn jzonthemtn marked this pull request as ready for review March 20, 2025 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Add specifications for the User Behavior Insights (UBI) plugin
3 participants