Wide range of integration tests. #2139

lukasz-soszynski-eliatra · 2022-10-04T13:07:22Z

Signed-off-by: Lukasz Soszynski lukasz.soszynski@eliatra.com

Description

Adds:

Search requests test
Basic auth tests
A package containing matchers that can be used for future tests

Category (Enhancement)
Wide variety of integration tests which uses a new test framework

Issues Resolved

[List any issues this PR will resolve]

Testing

Production code can be treated as a test for tests

Check List

New functionality includes testing
New functionality has been documented
Commits are signed per the DCO using --signoff

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.

peternied

I really like the format of the Search Operation tests, but I don't think the matchers belong in this project, or at least if we merge them we will immediately want to migrate them into the high level rest client or a OpenSearch centric test framework - what do you think of this?

src/integrationTest/java/org/opensearch/security/Song.java

src/integrationTest/java/org/opensearch/security/SnapshotSteps.java

src/integrationTest/java/org/opensearch/test/framework/cluster/LocalOpenSearchCluster.java

src/integrationTest/java/org/opensearch/test/framework/cluster/TestRestClient.java

peternied · 2022-10-04T14:43:09Z

.../java/org/opensearch/test/framework/matcher/BulkResponseContainExceptionsAtIndexMatcher.java

+
+import static java.util.Objects.requireNonNull;
+
+class BulkResponseContainExceptionsAtIndexMatcher extends TypeSafeDiagnosingMatcher<BulkResponse> {


These matchers are really great, but I don't think they belong in the security plugin - I think they would be better suited as part of the high-level rest client, what do you think about moving them to that project?

Looking back at this comment, its major scope creep! Lets move forward with the great work you've got here and we can enhance the HLRC in another effort

...ionTest/java/org/opensearch/test/framework/matcher/ClusterContainSuccessSnapshotMatcher.java

Signed-off-by: Lukasz Soszynski <lukasz.soszynski@eliatra.com>

peternied · 2022-10-06T18:50:49Z

...java/org/opensearch/test/framework/matcher/ClusterContainsDocumentWithFieldValueMatcher.java

+
+class ClusterContainsDocumentWithFieldValueMatcher extends TypeSafeDiagnosingMatcher<Client> {
+
+	private static final Logger log = LogManager.getLogger(LocalCluster.class);


Nit: Can we change the logger to be a different class?

codecov-commenter · 2022-10-07T09:18:47Z

Codecov Report

Merging #2139 (eb3180b) into main (ca4917c) will increase coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #2139      +/-   ##
============================================
+ Coverage     61.01%   61.02%   +0.01%     
- Complexity     3229     3232       +3     
============================================
  Files           256      257       +1     
  Lines         18101    18110       +9     
  Branches       3229     3229              
============================================
+ Hits          11044    11052       +8     
- Misses         5475     5476       +1     
  Partials       1582     1582

Impacted Files	Coverage Δ
...pensearch/security/setting/DeprecatedSettings.java	`80.00% <0.00%> (ø)`
...c/auth/ldap/backend/LDAPAuthenticationBackend.java	`81.57% <0.00%> (+0.32%)`	⬆️
.../dlic/auth/ldap2/LDAPConnectionFactoryFactory.java	`57.46% <0.00%> (+0.64%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

DarshitChanpura

Ty @lukasz-soszynski-eliatra for this PR. SearchOperationTest looks really good and ty for adding the Matchers. I have one change to request to make SearchRequestFactory class final.

DarshitChanpura · 2022-10-06T18:22:43Z

src/integrationTest/java/org/opensearch/security/SearchOperationTest.java

+
+			SearchScrollRequest scrollRequest = getSearchScrollRequest(searchResponse);
+
+			assertThatThrownBy(() -> restHighLevelClient.scroll(scrollRequest, DEFAULT), statusException(FORBIDDEN));


For my understanding, why does this request fail even though DOUBLE_READER_USER has slightly broader set of permissions than LIMITED_READ_USER.

The result of request restHighLevelClient.scroll(scrollRequest, DEFAULT) is HTTP response with 403 status code because the DOUBLE_READER_USER is lacking cluster permission indices:data/read/scroll.

DarshitChanpura · 2022-10-06T19:33:38Z

src/integrationTest/java/org/opensearch/test/framework/TestSecurityConfig.java

@@ -380,7 +380,7 @@ public AuthcDomain jwtHttpAuthenticator(String headerName, String signingKey) {
 			return this;
 		}

-		public AuthcDomain challengingAuthenticator(String type) {
+		public AuthcDomain httpAuthenticatorWithChallenge(String type) {


DarshitChanpura · 2022-10-06T19:37:23Z

src/integrationTest/java/org/opensearch/test/framework/cluster/SearchRequestFactory.java

+
+import static java.util.concurrent.TimeUnit.MINUTES;
+
+public class SearchRequestFactory {


we should make this class final since it contains static methods only

DarshitChanpura · 2022-10-06T19:39:03Z

src/integrationTest/java/org/opensearch/test/framework/cluster/TestRestClient.java

+		} catch (URISyntaxException ex) {
+			throw new RuntimeException("Incorrect URI syntax", ex);
+		}
+	}


DarshitChanpura · 2022-10-07T17:02:59Z

@lukasz-soszynski-eliatra I'm ready to approve it. Can you please sign-off your commits, so we can get DCO check to be successful to have passing CI.

Signed-off-by: Lukasz Soszynski <lukasz.soszynski@eliatra.com>

lukasz-soszynski-eliatra · 2022-10-07T17:10:30Z

Thanks, commits corrected.

Adds: 1. Search requests test 2. Basic auth tests 3. A package containing matchers that can be used for future tests Signed-off-by: Lukasz Soszynski <lukasz.soszynski@eliatra.com> Signed-off-by: Lukasz Soszynski <110241464+lukasz-soszynski-eliatra@users.noreply.github.com> Signed-off-by: Stephen Crawford <steecraw@amazon.com>

lukasz-soszynski-eliatra requested a review from a team October 4, 2022 13:07

lukasz-soszynski-eliatra force-pushed the search-operation-test branch from 0b61666 to 614a87a Compare October 4, 2022 13:25

peternied requested changes Oct 4, 2022

View reviewed changes

Wide range of integration tests.

dd76d67

Signed-off-by: Lukasz Soszynski <lukasz.soszynski@eliatra.com>

lukasz-soszynski-eliatra force-pushed the search-operation-test branch from 8741946 to dd76d67 Compare October 6, 2022 10:01

peternied previously approved these changes Oct 6, 2022

View reviewed changes

lukasz-soszynski-eliatra dismissed peternied’s stale review via eb3180b October 7, 2022 08:47

DarshitChanpura requested changes Oct 7, 2022

View reviewed changes

Correction after code review (SearchOperationTest).

0a35c03

Signed-off-by: Lukasz Soszynski <lukasz.soszynski@eliatra.com>

lukasz-soszynski-eliatra force-pushed the search-operation-test branch from cbb2d48 to 0a35c03 Compare October 7, 2022 17:09

peternied approved these changes Oct 7, 2022

View reviewed changes

DarshitChanpura approved these changes Oct 10, 2022

View reviewed changes

DarshitChanpura merged commit f09af90 into opensearch-project:main Oct 10, 2022

DarshitChanpura mentioned this pull request Aug 22, 2023

Backport the test framework to 2.x branch #3230

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wide range of integration tests. #2139

Wide range of integration tests. #2139

lukasz-soszynski-eliatra commented Oct 4, 2022 •

edited by DarshitChanpura

Loading

peternied left a comment

peternied Oct 4, 2022

peternied Oct 6, 2022

peternied Oct 6, 2022

lukasz-soszynski-eliatra Oct 7, 2022

codecov-commenter commented Oct 7, 2022 •

edited

Loading

DarshitChanpura left a comment

DarshitChanpura Oct 6, 2022

lukasz-soszynski-eliatra Oct 7, 2022

DarshitChanpura Oct 6, 2022

DarshitChanpura Oct 6, 2022 •

edited

Loading

lukasz-soszynski-eliatra Oct 7, 2022

DarshitChanpura Oct 6, 2022

DarshitChanpura commented Oct 7, 2022 •

edited

Loading

lukasz-soszynski-eliatra commented Oct 7, 2022


		import static java.util.Objects.requireNonNull;

		class BulkResponseContainExceptionsAtIndexMatcher extends TypeSafeDiagnosingMatcher<BulkResponse> {


		class ClusterContainsDocumentWithFieldValueMatcher extends TypeSafeDiagnosingMatcher<Client> {

		private static final Logger log = LogManager.getLogger(LocalCluster.class);


		SearchScrollRequest scrollRequest = getSearchScrollRequest(searchResponse);

		assertThatThrownBy(() -> restHighLevelClient.scroll(scrollRequest, DEFAULT), statusException(FORBIDDEN));


		import static java.util.concurrent.TimeUnit.MINUTES;

		public class SearchRequestFactory {

Wide range of integration tests. #2139

Wide range of integration tests. #2139

Conversation

lukasz-soszynski-eliatra commented Oct 4, 2022 • edited by DarshitChanpura Loading

Description

Issues Resolved

Testing

Check List

peternied left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 7, 2022 • edited Loading

Codecov Report

DarshitChanpura left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DarshitChanpura Oct 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DarshitChanpura commented Oct 7, 2022 • edited Loading

lukasz-soszynski-eliatra commented Oct 7, 2022

lukasz-soszynski-eliatra commented Oct 4, 2022 •

edited by DarshitChanpura

Loading

codecov-commenter commented Oct 7, 2022 •

edited

Loading

DarshitChanpura Oct 6, 2022 •

edited

Loading

DarshitChanpura commented Oct 7, 2022 •

edited

Loading