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
FINERACT-1754: Fix Search API #3311
Merged
adamsaghy
merged 1 commit into
apache:develop
from
josehernandezfintecheandomx:fix/search_api
Jul 20, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
...gration-tests/src/test/java/org/apache/fineract/integrationtests/SearchResourcesTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
/** | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.apache.fineract.integrationtests; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
import static org.junit.Assert.assertNotNull; | ||
|
||
import io.restassured.builder.RequestSpecBuilder; | ||
import io.restassured.builder.ResponseSpecBuilder; | ||
import io.restassured.http.ContentType; | ||
import io.restassured.specification.RequestSpecification; | ||
import io.restassured.specification.ResponseSpecification; | ||
import java.util.ArrayList; | ||
import java.util.Arrays; | ||
import java.util.List; | ||
import org.apache.fineract.client.models.GetClientsClientIdResponse; | ||
import org.apache.fineract.client.models.GetSearchResponse; | ||
import org.apache.fineract.client.models.PostClientsResponse; | ||
import org.apache.fineract.integrationtests.common.ClientHelper; | ||
import org.apache.fineract.integrationtests.common.SearchHelper; | ||
import org.apache.fineract.integrationtests.common.Utils; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
public class SearchResourcesTest { | ||
|
||
private ResponseSpecification responseSpec; | ||
private RequestSpecification requestSpec; | ||
|
||
@BeforeEach | ||
public void setup() { | ||
Utils.initializeRESTAssured(); | ||
this.requestSpec = new RequestSpecBuilder().setContentType(ContentType.JSON).build(); | ||
this.requestSpec.header("Authorization", "Basic " + Utils.loginIntoServerAndGetBase64EncodedAuthenticationKey()); | ||
this.responseSpec = new ResponseSpecBuilder().expectStatusCode(200).build(); | ||
} | ||
|
||
@Test | ||
public void searchAnyValueOverAllResources() { | ||
final List<String> resources = Arrays.asList("clients", "clientIdentifiers", "groups", "savings", "shares", "loans"); | ||
|
||
final String query = Utils.randomStringGenerator("C", 12); | ||
final ArrayList<GetSearchResponse> searchResponse = SearchHelper.getSearch(requestSpec, responseSpec, query, Boolean.TRUE, | ||
resources.toString()); | ||
assertNotNull(searchResponse); | ||
assertEquals(0, searchResponse.size()); | ||
} | ||
|
||
@Test | ||
public void searchAnyValueOverClientResources() { | ||
final List<String> resources = Arrays.asList("clients"); | ||
|
||
final String query = Utils.randomStringGenerator("C", 12); | ||
final ArrayList<GetSearchResponse> searchResponse = SearchHelper.getSearch(requestSpec, responseSpec, query, Boolean.TRUE, | ||
getResources(resources)); | ||
assertNotNull(searchResponse); | ||
assertEquals(0, searchResponse.size()); | ||
} | ||
|
||
@Test | ||
public void searchOverClientResources() { | ||
final List<String> resources = Arrays.asList("clients"); | ||
|
||
// Client and Loan account creation | ||
String jsonPayload = ClientHelper.getBasicClientAsJSON(ClientHelper.DEFAULT_OFFICE_ID, ClientHelper.LEGALFORM_ID_PERSON, null); | ||
final PostClientsResponse clientResponse = ClientHelper.addClientAsPerson(requestSpec, responseSpec, jsonPayload); | ||
final Long clientId = clientResponse.getClientId(); | ||
final GetClientsClientIdResponse getClientResponse = ClientHelper.getClient(requestSpec, responseSpec, clientId.intValue()); | ||
final String query = getClientResponse.getAccountNo(); | ||
|
||
final ArrayList<GetSearchResponse> searchResponse = SearchHelper.getSearch(requestSpec, responseSpec, query, Boolean.FALSE, | ||
getResources(resources)); | ||
assertNotNull(searchResponse); | ||
assertEquals(1, searchResponse.size()); | ||
assertEquals("Client name comparation", getClientResponse.getDisplayName(), searchResponse.get(0).getEntityName()); | ||
} | ||
|
||
@Test | ||
public void searchAnyValueOverLoanResources() { | ||
final List<String> resources = Arrays.asList("loans"); | ||
|
||
final String query = Utils.randomStringGenerator("L", 12); | ||
final ArrayList<GetSearchResponse> searchResponse = SearchHelper.getSearch(requestSpec, responseSpec, query, Boolean.TRUE, | ||
getResources(resources)); | ||
assertNotNull(searchResponse); | ||
assertEquals(0, searchResponse.size()); | ||
} | ||
|
||
private String getResources(final List<String> resources) { | ||
return String.join(",", resources); | ||
} | ||
|
||
} |
52 changes: 52 additions & 0 deletions
52
...gration-tests/src/test/java/org/apache/fineract/integrationtests/common/SearchHelper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/** | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.apache.fineract.integrationtests.common; | ||
|
||
import com.google.gson.Gson; | ||
import com.linecorp.armeria.internal.shaded.guava.reflect.TypeToken; | ||
import io.restassured.specification.RequestSpecification; | ||
import io.restassured.specification.ResponseSpecification; | ||
import java.lang.reflect.Type; | ||
import java.util.ArrayList; | ||
import lombok.extern.slf4j.Slf4j; | ||
import org.apache.fineract.client.models.GetSearchResponse; | ||
import org.apache.fineract.client.util.JSON; | ||
|
||
@Slf4j | ||
public final class SearchHelper { | ||
|
||
private static final Gson GSON = new JSON().getGson(); | ||
|
||
private SearchHelper() { | ||
|
||
} | ||
|
||
private static final String SEARCH_URL = "/fineract-provider/api/v1/search?" + Utils.TENANT_IDENTIFIER; | ||
|
||
public static ArrayList<GetSearchResponse> getSearch(final RequestSpecification requestSpec, final ResponseSpecification responseSpec, | ||
final String query, final Boolean exactMatch, final String resources) { | ||
final String urlSearch = SEARCH_URL + "&exactMatch=" + exactMatch.toString() + "&query=" + query + "&resource=" + resources; | ||
log.info("URL to search: {}", urlSearch); | ||
final String response = Utils.performServerGet(requestSpec, responseSpec, urlSearch); | ||
log.info("Result: {}", response); | ||
Type searchResourcesListType = new TypeToken<ArrayList<GetSearchResponse>>() {}.getType(); | ||
return GSON.fromJson(response, searchResourcesListType); | ||
} | ||
|
||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Every other places the
subEntityType
is null, i dont think thats the place to fix this. Please rather have a condition in the mapper if you dont wanna seeDepositType.INVALID
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason to have this is because the RDBMS can not have in the same column strings (due the nulls) and integer for the Savings for the column deposit types
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing changed...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we leave the original SQL we get an error when we use more than one resource why? because the column subEntityType (as you have viewed) in almost all the SQL uses null (the null is considered as string type by the RDBMS) and in the Savings SQL filter It has a value for the Savings attribute deposit_type_enum (int type) and that difference to the RDBMS generates tan error, so It is not possible to manage after run the SQL in the mapper
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how does solve this problem by changing this to not be null only one place? what happens if you search in SAVINGS accounts and LOAN accounts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There will be not a problem, because in the SQL both values are now Strings values in the Loan will be null and in the Savings will be the Deposit Type (if exists) as
String
too. We get this because we are using theconcat
function. Even in the POJOSearchData
this attribute isString
typeprivate final String subEntityType;