Skip to content
Permalink
Browse files
Merge pull request #11 from Izakey/develop
Fixed undocumented parts of the payload and license API docs code
  • Loading branch information
Izakey committed Dec 29, 2018
2 parents ee672a7 + 9047cdb commit 102bcfe2e6d927ce25ad6883c5c5521e2bffc7a3
Showing 9 changed files with 1,168 additions and 1,000 deletions.

Large diffs are not rendered by default.

@@ -1,3 +1,21 @@
/*
* 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.cn.portfolio;

import com.google.gson.Gson;
@@ -30,98 +48,98 @@

public class CaseDocumentsApiDocumentation extends AbstractPortfolioTest {

@Rule
public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-casedocuments");
@Rule
public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-casedocuments");

@Autowired
private WebApplicationContext context;
@Autowired
private WebApplicationContext context;

private MockMvc mockMvc;
private MockMvc mockMvc;

@Before
public void setUp() {
@Before
public void setUp() {

this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration(this.restDocumentation))
.alwaysDo(document("{method-name}", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint())))
.build();
}
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration(this.restDocumentation))
.alwaysDo(document("{method-name}", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint())))
.build();
}

@Test
public void documentGetCaseDocuments() throws Exception {
@Test
public void documentGetCaseDocuments() throws Exception {

final Product product = createAndEnableProduct();
final Product product = createAndEnableProduct();

final Case customerCase = createCase(product.getIdentifier());
final Case customerCase = createCase(product.getIdentifier());


final CaseCustomerDocuments caseDocuments = caseDocumentsManager.getCaseDocuments(
product.getIdentifier(), customerCase.getIdentifier());
final CaseCustomerDocuments caseDocuments = caseDocumentsManager.getCaseDocuments(
product.getIdentifier(), customerCase.getIdentifier());

final CaseCustomerDocuments.Document studentLoanDocument
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "student_loan_documents");
final CaseCustomerDocuments.Document houseTitle
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_title");
final CaseCustomerDocuments.Document workContract
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "work_contract");
final CaseCustomerDocuments.Document studentLoanDocument
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "student_loan_documents");
final CaseCustomerDocuments.Document houseTitle
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_title");
final CaseCustomerDocuments.Document workContract
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "work_contract");

caseDocuments.setDocuments(Arrays.asList(studentLoanDocument, houseTitle, workContract));
caseDocuments.setDocuments(Arrays.asList(studentLoanDocument, houseTitle, workContract));

this.mockMvc.perform(get("/individuallending/products/" + product.getIdentifier() + "/cases/" + customerCase.getIdentifier() + "/documents")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.accept(MediaType.ALL_VALUE))
.andExpect(status().isOk())
.andDo(document("document-get-case-documents", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
responseFields(
fieldWithPath("documents").type("List<Document>").description("The case document +\n" +
" +\n" +
"_Document_ { +\n" +
" *enum* _Type_ { +\n" +
" customerId, +\n" +
" documentId, +\n" +
" } +"))));
this.mockMvc.perform(get("/individuallending/products/" + product.getIdentifier() + "/cases/" + customerCase.getIdentifier() + "/documents")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.accept(MediaType.ALL_VALUE))
.andExpect(status().isOk())
.andDo(document("document-get-case-documents", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
responseFields(
fieldWithPath("documents").type("List<Document>").description("The case document +\n" +
" +\n" +
"_Document_ { +\n" +
" *enum* _Type_ { +\n" +
" customerId, +\n" +
" documentId, +\n" +
" } +"))));

}
}


@Test
public void documentChangeCaseDocuments() throws Exception {
@Test
public void documentChangeCaseDocuments() throws Exception {

final Product product = createAndEnableProduct();
final Product product = createAndEnableProduct();

final Case customerCase = createCase(product.getIdentifier());
final Case customerCase = createCase(product.getIdentifier());

final CaseCustomerDocuments caseDocuments = caseDocumentsManager.getCaseDocuments(
product.getIdentifier(), customerCase.getIdentifier());
final CaseCustomerDocuments caseDocuments = caseDocumentsManager.getCaseDocuments(
product.getIdentifier(), customerCase.getIdentifier());

final CaseCustomerDocuments.Document houseLoanDocument
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_loan_documents");
final CaseCustomerDocuments.Document houseTitle
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_title");
final CaseCustomerDocuments.Document workContract
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "work_contract");
final CaseCustomerDocuments.Document houseLoanDocument
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_loan_documents");
final CaseCustomerDocuments.Document houseTitle
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "house_title");
final CaseCustomerDocuments.Document workContract
= new CaseCustomerDocuments.Document(Fixture.CUSTOMER_IDENTIFIER, "work_contract");

caseDocuments.setDocuments(Arrays.asList(houseLoanDocument, houseTitle, workContract));
caseDocuments.setDocuments(Arrays.asList(houseLoanDocument, houseTitle, workContract));

caseDocumentsManager.changeCaseDocuments(product.getIdentifier(), customerCase.getIdentifier(), caseDocuments);
caseDocumentsManager.changeCaseDocuments(product.getIdentifier(), customerCase.getIdentifier(), caseDocuments);

Gson gson = new Gson();
this.mockMvc.perform(put("/individuallending/products/" + product.getIdentifier() + "/cases/" + customerCase.getIdentifier() + "/documents")
.accept(MediaType.APPLICATION_JSON_VALUE)
.contentType(MediaType.APPLICATION_JSON_VALUE)
.header(TENANT_HEADER, tenantDataStoreContext.getTenantName())
.content(gson.toJson(caseDocuments)))
.andExpect(status().isAccepted())
.andDo(document(
"document-change-case-documents", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
requestFields(
fieldWithPath("documents").type("List<Document>").description("The case document +\n" +
" +\n" +
"_Document_ { +\n" +
" *enum* _Type_ { +\n" +
" customerId, +\n" +
" documentId, +\n" +
" } +"))));
}
Gson gson = new Gson();
this.mockMvc.perform(put("/individuallending/products/" + product.getIdentifier() + "/cases/" + customerCase.getIdentifier() + "/documents")
.accept(MediaType.APPLICATION_JSON_VALUE)
.contentType(MediaType.APPLICATION_JSON_VALUE)
.header(TENANT_HEADER, tenantDataStoreContext.getTenantName())
.content(gson.toJson(caseDocuments)))
.andExpect(status().isAccepted())
.andDo(document(
"document-change-case-documents", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
requestFields(
fieldWithPath("documents").type("List<Document>").description("The case document +\n" +
" +\n" +
"_Document_ { +\n" +
" *enum* _Type_ { +\n" +
" customerId, +\n" +
" documentId, +\n" +
" } +"))));
}

}
@@ -1,3 +1,21 @@
/*
* 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.cn.portfolio;

import com.google.gson.Gson;
@@ -15,8 +33,10 @@
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import java.util.HashSet;
import java.util.Set;

import static org.apache.fineract.cn.lang.config.TenantHeaderFilter.TENANT_HEADER;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
@@ -31,78 +51,79 @@

public class CasesApiDocumentation extends AbstractPortfolioTest {

@Rule
public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-cases");

@Autowired
private WebApplicationContext context;

private MockMvc mockMvc;

@Before
public void setUp() {

this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration(this.restDocumentation))
.alwaysDo(document("{method-name}", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint())))
.build();
}

@Test
public void documentCreateCase () throws Exception {

final Product product = createAndEnableProduct();

final Case caseInstance = createCase(product.getIdentifier());
caseInstance.setIdentifier("case-v1");

Gson gson = new Gson();
this.mockMvc.perform(post("/products/"+product.getIdentifier()+"/cases/")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.content(gson.toJson(caseInstance)))
.andExpect(status().isAccepted())
.andDo(document("document-create-case", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
requestFields(
fieldWithPath("identifier").description("Cases's identifier"),
fieldWithPath("productIdentifier").description("Products's identifier"),
fieldWithPath("interest").description("Cases's interest"),
fieldWithPath("parameters").description("cases's parameters"),
fieldWithPath("accountAssignments").description("Cases's account assignment"),
fieldWithPath("currentState").description("Cases's current state"))));

}

@Test
public void documentChangeCase () throws Exception {

final Product product = createAndEnableProduct();


final CaseParameters newCaseParameters = Fixture.createAdjustedCaseParameters(x -> {});
final String originalParameters = new Gson().toJson(newCaseParameters);
final Case caseInstance = createAdjustedCase(product.getIdentifier(), x -> x.setParameters(originalParameters));

final Set<AccountAssignment> accountAssignments = new HashSet<>();
accountAssignments.add(new AccountAssignment(AccountDesignators.CUSTOMER_LOAN_GROUP, "002-011"));
accountAssignments.add(new AccountAssignment(AccountDesignators.ENTRY, "002-012"));
caseInstance.setAccountAssignments(accountAssignments);

Gson gson = new Gson();
this.mockMvc.perform(put("/products/" + product.getIdentifier() + "/cases/" + caseInstance.getIdentifier())
.accept(MediaType.APPLICATION_JSON_VALUE)
.contentType(MediaType.APPLICATION_JSON_VALUE)
.header(TENANT_HEADER, tenantDataStoreContext.getTenantName())
.content(gson.toJson(caseInstance)))
.andExpect(status().isAccepted())
.andDo(document(
"document-change-case", preprocessRequest(prettyPrint()),
requestFields(
fieldWithPath("identifier").description("Cases's identifier"),
fieldWithPath("productIdentifier").description("Products's identifier"),
fieldWithPath("interest").description("Cases's interest"),
fieldWithPath("parameters").description("cases's parameters"),
fieldWithPath("accountAssignments").description("Cases's account assignment"),
fieldWithPath("currentState").description("Cases's current state"))));

}
@Rule
public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-cases");

@Autowired
private WebApplicationContext context;

private MockMvc mockMvc;

@Before
public void setUp() {

this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration(this.restDocumentation))
.alwaysDo(document("{method-name}", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint())))
.build();
}

@Test
public void documentCreateCase() throws Exception {

final Product product = createAndEnableProduct();

final Case caseInstance = createCase(product.getIdentifier());
caseInstance.setIdentifier("case-v1");

Gson gson = new Gson();
this.mockMvc.perform(post("/products/" + product.getIdentifier() + "/cases/")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.content(gson.toJson(caseInstance)))
.andExpect(status().isAccepted())
.andDo(document("document-create-case", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
requestFields(
fieldWithPath("identifier").description("Cases's identifier"),
fieldWithPath("productIdentifier").description("Products's identifier"),
fieldWithPath("interest").description("Cases's interest"),
fieldWithPath("parameters").description("cases's parameters"),
fieldWithPath("accountAssignments").description("Cases's account assignment"),
fieldWithPath("currentState").description("Cases's current state"))));

}

@Test
public void documentChangeCase() throws Exception {

final Product product = createAndEnableProduct();


final CaseParameters newCaseParameters = Fixture.createAdjustedCaseParameters(x -> {
});
final String originalParameters = new Gson().toJson(newCaseParameters);
final Case caseInstance = createAdjustedCase(product.getIdentifier(), x -> x.setParameters(originalParameters));

final Set<AccountAssignment> accountAssignments = new HashSet<>();
accountAssignments.add(new AccountAssignment(AccountDesignators.CUSTOMER_LOAN_GROUP, "002-011"));
accountAssignments.add(new AccountAssignment(AccountDesignators.ENTRY, "002-012"));
caseInstance.setAccountAssignments(accountAssignments);

Gson gson = new Gson();
this.mockMvc.perform(put("/products/" + product.getIdentifier() + "/cases/" + caseInstance.getIdentifier())
.accept(MediaType.APPLICATION_JSON_VALUE)
.contentType(MediaType.APPLICATION_JSON_VALUE)
.header(TENANT_HEADER, tenantDataStoreContext.getTenantName())
.content(gson.toJson(caseInstance)))
.andExpect(status().isAccepted())
.andDo(document(
"document-change-case", preprocessRequest(prettyPrint()),
requestFields(
fieldWithPath("identifier").description("Cases's identifier"),
fieldWithPath("productIdentifier").description("Products's identifier"),
fieldWithPath("interest").description("Cases's interest"),
fieldWithPath("parameters").description("cases's parameters"),
fieldWithPath("accountAssignments").description("Cases's account assignment"),
fieldWithPath("currentState").description("Cases's current state"))));

}
}

0 comments on commit 102bcfe

Please sign in to comment.