[BWC and API enforcement] Introduce checks for enforcing the API restrictions #11175

reta · 2023-11-13T16:48:22Z

Description

Introduce checks for enforcing the API restrictions, at this stage the failing checks are advisory only (they don't break the build), but that would need to be changed later on, example below:

Note: Processing Log4j annotations                                                                                                                                         
Note: Annotations processed                                                           
Note: Processing OpenSearch Api annotations                                           
Note: The element org.opensearch.common.inject.Module is part of the public APIs but is not maked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.plugins.Plugin) 
Note: Processing Log4j annotations                                                                                                                                                                                                                                                                                                                    
Note: No elements to process                                                                                                                                                                                                                                                                                                                          
Note: Processing OpenSearch Api annotations

Related Issues

Closes #9304

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
Public documentation issue/PR created

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.

github-actions · 2023-11-13T17:10:14Z

Compatibility status:

Checks if related components are compatible with change d0865a0

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/performance-analyzer.git]

github-actions · 2023-11-13T17:35:52Z

❌ Gradle check result for 2523a54: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T17:48:00Z

❌ Gradle check result for 0fc54eb: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T19:07:47Z

✅ Gradle check result for 8bc186f: SUCCESS

codecov · 2023-11-13T19:08:52Z

Codecov Report

Attention: 25 lines in your changes are missing coverage. Please review.

Comparison is base (f7f3500) 71.37% compared to head (d0865a0) 71.34%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
...n/annotation/processor/ApiAnnotationProcessor.java	88.18%	1 Missing and 14 partials ⚠️
...search/core/common/io/stream/BytesStreamInput.java	40.00%	7 Missing and 2 partials ⚠️
...ch/index/translog/BufferedChecksumStreamInput.java	66.66%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11175      +/-   ##
============================================
- Coverage     71.37%   71.34%   -0.03%     
- Complexity    59113    59129      +16     
============================================
  Files          4893     4894       +1     
  Lines        277831   277962     +131     
  Branches      40367    40404      +37     
============================================
+ Hits         198288   198313      +25     
- Misses        63042    63141      +99     
- Partials      16501    16508       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2023-11-13T19:21:00Z

❌ Gradle check result for df6a6c6: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T19:34:44Z

❌ Gradle check result for e591f65: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T19:55:56Z

❌ Gradle check result for e591f65: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T22:06:30Z

❌ Gradle check result for e591f65: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-14T13:52:01Z

❌ Gradle check result for 5478d7a: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T18:46:09Z

❌ Gradle check result for 6b6f2d1: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T19:32:48Z

❌ Gradle check result for e9502e9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

reta · 2023-11-15T19:41:47Z

❌ Gradle check result for e9502e9: FAILURE

#11221

github-actions · 2023-11-15T20:04:53Z

❌ Gradle check result for c7c8cbd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T20:36:51Z

❌ Gradle check result for 7031a6a: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T21:23:11Z

❌ Gradle check result for b7530f9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

reta · 2023-11-15T21:26:48Z

❌ Gradle check result for b7530f9: FAILURE

#11208
#8945

github-actions · 2023-12-05T16:00:06Z

✅ Gradle check result for a3e22f7: SUCCESS

github-actions · 2023-12-05T16:35:17Z

❕ Gradle check result for d0865a0: UNSTABLE

TEST FAILURES:

      1 org.opensearch.repositories.azure.AzureBlobStoreRepositoryTests.testWriteRead

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

andrross

Nice job on the tests! Looks quite comprehensive

opensearch-trigger-bot · 2023-12-07T00:12:31Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11175-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 33e9578b6f3b5c9756dabc00521915dd18b3ed93
# Push it to GitHub
git push --set-upstream origin backport/backport-11175-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-11175-to-2.x.

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit 33e9578)

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit 33e9578) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

…rictions (#11175) (#11514) (cherry picked from commit 33e9578) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

github-actions bot added API Issues with external APIs enhancement Enhancement or improvement to existing feature or request Plugins labels Nov 13, 2023

reta force-pushed the issue-9304 branch from 2523a54 to 0fc54eb Compare November 13, 2023 17:38

reta force-pushed the issue-9304 branch from 0fc54eb to 8bc186f Compare November 13, 2023 18:18

reta force-pushed the issue-9304 branch 2 times, most recently from df6a6c6 to e591f65 Compare November 13, 2023 19:17

reta force-pushed the issue-9304 branch from e591f65 to 5478d7a Compare November 14, 2023 13:43

reta force-pushed the issue-9304 branch from 5478d7a to 6b6f2d1 Compare November 15, 2023 18:38

reta force-pushed the issue-9304 branch from 6b6f2d1 to e9502e9 Compare November 15, 2023 19:10

reta force-pushed the issue-9304 branch from e9502e9 to c7c8cbd Compare November 15, 2023 19:42

reta force-pushed the issue-9304 branch 2 times, most recently from 7031a6a to b7530f9 Compare November 15, 2023 20:34

reta requested review from kotwanikunal, mch2, msfroh, nknize, owaiskazi19, peternied, Rishikesh1159, ryanbogan, sachinpkale, saratvemulapalli, setiah, shwetathareja, sohami, tlfeng and VachaShah as code owners December 5, 2023 15:50

andrross approved these changes Dec 7, 2023

View reviewed changes

andrross added the backport 2.x Backport to 2.x branch label Dec 7, 2023

andrross merged commit 33e9578 into opensearch-project:main Dec 7, 2023
116 checks passed

opensearch-trigger-bot bot added the backport-failed label Dec 7, 2023

reta mentioned this pull request Dec 7, 2023

[Backport] [2.x] [BWC and API enforcement] Introduce checks for enforcing the API restrictions (#11175) #11514

Merged

dblock pushed a commit that referenced this pull request Dec 8, 2023

[BWC and API enforcement] Introduce checks for enforcing the API rest…

8c5c700

…rictions (#11175) (#11514) (cherry picked from commit 33e9578) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

deshsidd pushed a commit to deshsidd/OpenSearch that referenced this pull request Dec 11, 2023

[BWC and API enforcement] Introduce checks for enforcing the API rest…

3f93c71

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

BrewTestBot mentioned this pull request Feb 21, 2024

opensearch 2.12.0 Homebrew/homebrew-core#163463

Merged

rayshrey pushed a commit to rayshrey/OpenSearch that referenced this pull request Mar 18, 2024

[BWC and API enforcement] Introduce checks for enforcing the API rest…

a990610

…rictions (opensearch-project#11175) Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BWC and API enforcement] Introduce checks for enforcing the API restrictions #11175

[BWC and API enforcement] Introduce checks for enforcing the API restrictions #11175

reta commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

codecov bot commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Dec 5, 2023

github-actions bot commented Dec 5, 2023

andrross left a comment

opensearch-trigger-bot bot commented Dec 7, 2023

[BWC and API enforcement] Introduce checks for enforcing the API restrictions #11175

[BWC and API enforcement] Introduce checks for enforcing the API restrictions #11175

Conversation

reta commented Nov 13, 2023 • edited Loading

Description

Related Issues

Check List

github-actions bot commented Nov 13, 2023 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

codecov bot commented Nov 13, 2023 • edited Loading

Codecov Report

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Dec 5, 2023

github-actions bot commented Dec 5, 2023

andrross left a comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Dec 7, 2023

reta commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 13, 2023 •

edited

Loading

codecov bot commented Nov 13, 2023 •

edited

Loading