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

Add Secure Bwc documentation to TESTING.md #9414

Merged
merged 9 commits into from
Aug 28, 2023

Conversation

stephen-crawford
Copy link
Contributor

@stephen-crawford stephen-crawford commented Aug 17, 2023

Description

Add Secure BWC documentation to TESTING.md as a followup to #8900.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)

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.

Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
@stephen-crawford stephen-crawford changed the title Add Secure Bwc documentation to TESTING.md [SKIP-CHANGELOG] Add Secure Bwc documentation to TESTING.md Aug 17, 2023
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.index.translog.RemoteFSTranslogTests.testSimpleOperationsUpload

@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Merging #9414 (4f197b6) into main (8cfde6c) will increase coverage by 0.07%.
The diff coverage is n/a.

❗ Current head 4f197b6 differs from pull request most recent head 6fd0a72. Consider uploading reports for the commit 6fd0a72 to get more accurate results

@@             Coverage Diff              @@
##               main    #9414      +/-   ##
============================================
+ Coverage     71.08%   71.16%   +0.07%     
- Complexity    57428    57534     +106     
============================================
  Files          4781     4781              
  Lines        271184   271184              
  Branches      39591    39591              
============================================
+ Hits         192780   192994     +214     
+ Misses        62122    61934     -188     
+ Partials      16282    16256      -26     

see 468 files with indirect coverage changes

@stephen-crawford
Copy link
Contributor Author

@dblock here is the documentation you requested. Failures are unrelated. Let me know if you need anything else.

Copy link
Member

@dbwiddis dbwiddis left a comment

Choose a reason for hiding this comment

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

LGTM. I'm curious if we could improve this to be copy-pasteable by setting an environemnt variable for <TARGET_VERSION> and using it.

@stephen-crawford
Copy link
Contributor Author

Hi @dbwiddis, that is a good idea. I am not sure how we would want to go about referencing the target version to convert from however. We could always assume that the current version is the "new" version, but I don't know what we would want to do for the version we are converting from.

@kotwanikunal kotwanikunal changed the title [SKIP-CHANGELOG] Add Secure Bwc documentation to TESTING.md Add Secure Bwc documentation to TESTING.md Aug 21, 2023
@kotwanikunal
Copy link
Member

Compatibility again. Restarting :)

@opensearch-trigger-bot
Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change 6a5b464

Incompatible components

Incompatible components: [https:/opensearch-project/index-management.git, https:/opensearch-project/asynchronous-search.git, https:/opensearch-project/notifications.git, https:/opensearch-project/security-analytics.git]

Skipped components

Compatible components

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

@stephen-crawford
Copy link
Contributor Author

Can we merge this?

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

I have some nits. TOC is a must have, SORRY

TESTING.md Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

Signed-off-by: Stephen Crawford <[email protected]>
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change 4f197b6

Incompatible components

Incompatible components: [https:/opensearch-project/asynchronous-search.git, https:/opensearch-project/cross-cluster-replication.git]

Skipped components

Compatible components

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

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@stephen-crawford
Copy link
Contributor Author

Flaky tests:

[org.opensearch.repositories.azure.AzureBlobContainerRetriesTests.testWriteLargeBlob](https://build.ci.opensearch.org/job/gradle-check/23550/testReport/junit/org.opensearch.repositories.azure/AzureBlobContainerRetriesTests/testWriteLargeBlob/)
    [org.opensearch.action.admin.indices.create.CreateIndexIT.testCreateAndDeleteIndexConcurrently](https://build.ci.opensearch.org/job/gradle-check/23550/testReport/junit/org.opensearch.action.admin.indices.create/CreateIndexIT/testCreateAndDeleteIndexConcurrently/)
    [org.opensearch.action.admin.indices.create.CreateIndexIT.classMethod](https://build.ci.opensearch.org/job/gradle-check/23550/testReport/junit/org.opensearch.action.admin.indices.create/CreateIndexIT/classMethod/)
    [org.opensearch.remotestore.RemoteIndexRecoveryIT.testRerouteRecovery](https://build.ci.opensearch.org/job/gradle-check/23550/testReport/junit/org.opensearch.remotestore/RemoteIndexRecoveryIT/testRerouteRecovery/)
    ```

@dblock dblock merged commit a08d588 into opensearch-project:main Aug 28, 2023
8 of 10 checks passed
kaushalmahi12 pushed a commit to kaushalmahi12/OpenSearch that referenced this pull request Sep 12, 2023
* Update BWC testing documentation

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Add placeholder

Signed-off-by: Stephen Crawford <[email protected]>

* Fix typos

Signed-off-by: Stephen Crawford <[email protected]>

* Fix table of contents order

Signed-off-by: Stephen Crawford <[email protected]>

* Add colon

Signed-off-by: Stephen Crawford <[email protected]>

* trigger retry

Signed-off-by: Stephen Crawford <[email protected]>

---------

Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Kaushal Kumar <[email protected]>
brusic pushed a commit to brusic/OpenSearch that referenced this pull request Sep 25, 2023
* Update BWC testing documentation

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Add placeholder

Signed-off-by: Stephen Crawford <[email protected]>

* Fix typos

Signed-off-by: Stephen Crawford <[email protected]>

* Fix table of contents order

Signed-off-by: Stephen Crawford <[email protected]>

* Add colon

Signed-off-by: Stephen Crawford <[email protected]>

* trigger retry

Signed-off-by: Stephen Crawford <[email protected]>

---------

Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Ivan Brusic <[email protected]>
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
* Update BWC testing documentation

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Fix code block

Signed-off-by: Stephen Crawford <[email protected]>

* Add placeholder

Signed-off-by: Stephen Crawford <[email protected]>

* Fix typos

Signed-off-by: Stephen Crawford <[email protected]>

* Fix table of contents order

Signed-off-by: Stephen Crawford <[email protected]>

* Add colon

Signed-off-by: Stephen Crawford <[email protected]>

* trigger retry

Signed-off-by: Stephen Crawford <[email protected]>

---------

Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Shivansh Arora <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants