You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by GitBox <gi...@apache.org> on 2018/09/05 15:21:10 UTC
[GitHub] awasum closed pull request #7: Document office API to manage
offices & employees
awasum closed pull request #7: Document office API to manage offices & employees
URL: https://github.com/apache/fineract-cn-office/pull/7
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/.gitignore b/.gitignore
index f9d7cba..26f77cc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,9 @@
.idea
build/
target/
+api/out
+component-test/out
+service/out
# Ignore Gradle GUI config
gradle-app.setting
diff --git a/component-test/build.gradle b/component-test/build.gradle
index 4872ec2..67adfb0 100644
--- a/component-test/build.gradle
+++ b/component-test/build.gradle
@@ -26,6 +26,7 @@ buildscript {
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
+ classpath("org.asciidoctor:asciidoctor-gradle-plugin:1.5.3")
}
}
@@ -35,6 +36,7 @@ plugins {
}
apply from: '../shared.gradle'
+apply plugin: 'org.asciidoctor.convert'
dependencies {
compile(
@@ -43,10 +45,20 @@ dependencies {
[group: 'org.apache.fineract.cn.anubis', name: 'test', version: versions.frameworkanubis],
[group: 'org.apache.fineract.cn', name: 'api', version: versions.frameworkapi],
[group: 'org.apache.fineract.cn', name: 'test', version: versions.frameworktest],
- [group: 'org.springframework.boot', name: 'spring-boot-starter-test']
+ [group: 'org.springframework.boot', name: 'spring-boot-starter-test'],
+ [group: 'org.springframework.restdocs', name: 'spring-restdocs-mockmvc'],
+ [group: 'junit', name: 'junit', version: '4.12']
)
}
+asciidoctor {
+ sourceDir 'build/doc/asciidoc/'
+ outputDir 'build/doc/html5'
+ options backend: "html", doctype: "book"
+ attributes "source-highlighter": "highlightjs", \
+ 'snippets': file('build/doc/generated-snippets/')
+}
+
publishing {
publications {
mavenJava(MavenPublication) {
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/AbstractOfficeTest.java b/component-test/src/main/java/org/apache/fineract/cn/office/AbstractOfficeTest.java
new file mode 100644
index 0000000..6895cdd
--- /dev/null
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/AbstractOfficeTest.java
@@ -0,0 +1,119 @@
+/*
+ * 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.office;
+
+import org.apache.fineract.cn.anubis.test.v1.TenantApplicationSecurityEnvironmentTestRule;
+import org.apache.fineract.cn.api.context.AutoUserContext;
+import org.apache.fineract.cn.office.api.v1.EventConstants;
+import org.apache.fineract.cn.office.api.v1.client.OrganizationManager;
+import org.apache.fineract.cn.office.rest.config.OfficeRestConfiguration;
+import org.apache.fineract.cn.test.env.TestEnvironment;
+import org.apache.fineract.cn.test.fixture.TenantDataStoreContextTestRule;
+import org.apache.fineract.cn.test.fixture.cassandra.CassandraInitializer;
+import org.apache.fineract.cn.test.fixture.mariadb.MariaDBInitializer;
+import org.apache.fineract.cn.test.listener.EnableEventRecording;
+import org.apache.fineract.cn.test.listener.EventRecorder;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.rules.RuleChain;
+import org.junit.rules.TestRule;
+import org.junit.runner.RunWith;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cloud.netflix.feign.EnableFeignClients;
+import org.springframework.cloud.netflix.ribbon.RibbonClient;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.junit4.SpringRunner;
+
+@SuppressWarnings("SpringAutowiredFieldsWarningInspection")
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT,
+ classes = {AbstractOfficeTest.TestConfiguration.class})
+public class AbstractOfficeTest extends SuiteTestEnvironment {
+ private static final String APP_NAME = "office-v1";
+ private static final String TEST_USER = "thutmosis";
+
+ private final static TestEnvironment testEnvironment = new TestEnvironment(APP_NAME);
+ private final static CassandraInitializer cassandraInitializer = new CassandraInitializer();
+ private final static MariaDBInitializer mariaDBInitializer = new MariaDBInitializer();
+ private final static TenantDataStoreContextTestRule tenantDataStoreContext = TenantDataStoreContextTestRule.forRandomTenantName(cassandraInitializer, mariaDBInitializer);
+
+ @ClassRule
+ public static TestRule orderClassRules = RuleChain
+ .outerRule(testEnvironment)
+ .around(cassandraInitializer)
+ .around(mariaDBInitializer)
+ .around(tenantDataStoreContext);
+
+ @Rule
+ public final TenantApplicationSecurityEnvironmentTestRule tenantApplicationSecurityEnvironment
+ = new TenantApplicationSecurityEnvironmentTestRule(testEnvironment, this::waitForInitialize);
+
+ @Autowired
+ OrganizationManager organizationManager;
+
+ @Autowired
+ EventRecorder eventRecorder;
+
+ private AutoUserContext userContext;
+
+ @Before
+ public void prepareTest ( ) {
+ userContext = tenantApplicationSecurityEnvironment.createAutoUserContext(TEST_USER);
+ }
+
+ @After
+ public void cleanupTest ( ) {
+ userContext.close();
+ }
+
+ public boolean waitForInitialize ( ) {
+ try {
+ return this.eventRecorder.wait(EventConstants.INITIALIZE, EventConstants.INITIALIZE);
+ } catch (final InterruptedException e) {
+ throw new IllegalStateException(e);
+ }
+ }
+
+ @Configuration
+ @ComponentScan(
+ basePackages = "org.apache.fineract.cn.office.listener"
+ )
+ @EnableFeignClients(basePackages = {"org.apache.fineract.cn.office.api.v1.client"})
+ @RibbonClient(name = APP_NAME)
+ @EnableEventRecording(maxWait = 5000L)
+ @Import({OfficeRestConfiguration.class})
+ public static class TestConfiguration {
+ public TestConfiguration ( ) {
+ super();
+ }
+
+ @Bean
+ public Logger logger ( ) {
+ return LoggerFactory.getLogger("office-test-logger");
+ }
+ }
+}
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/EmployeeApiDocumentation.java b/component-test/src/main/java/org/apache/fineract/cn/office/EmployeeApiDocumentation.java
new file mode 100644
index 0000000..a0b4107
--- /dev/null
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/EmployeeApiDocumentation.java
@@ -0,0 +1,466 @@
+/*
+ * 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.office;
+
+import com.google.gson.Gson;
+import org.apache.fineract.cn.office.api.v1.EventConstants;
+import org.apache.fineract.cn.office.api.v1.domain.*;
+import org.apache.fineract.cn.office.util.EmployeeFactory;
+import org.apache.fineract.cn.office.util.OfficeFactory;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Sort;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.delete;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.post;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.put;
+
+public class EmployeeApiDocumentation extends TestEmployee {
+
+ @Rule
+ public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-employee");
+
+ @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 documentCreateEmployee ( ) throws Exception {
+
+ final Employee employee = EmployeeFactory.createRandomEmployee();
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("Accra");
+
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail firstContact = new ContactDetail();
+ firstContact.setType(ContactDetail.Type.MOBILE.name());
+ firstContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ firstContact.setValue("677889900");
+ firstContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(firstContact);
+
+ employee.setIdentifier("employ0010");
+ employee.setGivenName("Chale");
+ employee.setMiddleName("Asamoah");
+ employee.setSurname("Yamoah");
+ employee.setAssignedOffice("Accra");
+ employee.setContactDetails(contacts);
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(post("/employees")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(employee)))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-create-employee", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
+ requestFields(
+ fieldWithPath("identifier").description("Employee's identifier"),
+ fieldWithPath("givenName").description(" Employee given name"),
+ fieldWithPath("middleName").description("Employee's middle name"),
+ fieldWithPath("surname").description("Employee's surname"),
+ fieldWithPath("assignedOffice").description("Employee's assigned office"),
+ fieldWithPath("contactDetails").type("List<ContactDetail>").description("Employee's contact details"))));
+ }
+
+ @Test
+ public void documentFindEmployee ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("myOffice");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail firstContact = new ContactDetail();
+ firstContact.setType(ContactDetail.Type.MOBILE.name());
+ firstContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ firstContact.setValue("699009900");
+ firstContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contactsOne = new ArrayList <>();
+ contactsOne.add(firstContact);
+
+ final Employee employee = EmployeeFactory.createRandomEmployee();
+ employee.setIdentifier("emNo1");
+ employee.setGivenName("Ojong");
+ employee.setMiddleName("Cho");
+ employee.setSurname("Tah");
+ employee.setAssignedOffice(office.getIdentifier());
+ employee.setContactDetails(contactsOne);
+ this.organizationManager.createEmployee(employee);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employee.getIdentifier());
+
+ this.mockMvc.perform(get("/employees/" + employee.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-find-employee", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("identifier").description("first employee's identifier"),
+ fieldWithPath("givenName").description(" first employee given name"),
+ fieldWithPath("middleName").description("first employee's middle name"),
+ fieldWithPath("surname").description("first employee's surname"),
+ fieldWithPath("assignedOffice").description("first employee's assigned office"),
+ fieldWithPath("contactDetails").type("List<ContactDetail>").description("first employee's contact details"))));
+ }
+
+ @Test
+ public void documentFindAllEmployees ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("office001");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail firstContact = new ContactDetail();
+ firstContact.setType(ContactDetail.Type.MOBILE.name());
+ firstContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ firstContact.setValue("677889900");
+ firstContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contactsOne = new ArrayList <>();
+ contactsOne.add(firstContact);
+
+ final Employee firstEmployee = EmployeeFactory.createRandomEmployee();
+ firstEmployee.setIdentifier("employ001");
+ firstEmployee.setGivenName("Oru");
+ firstEmployee.setMiddleName("Asam");
+ firstEmployee.setSurname("Yoah");
+ firstEmployee.setAssignedOffice(office.getIdentifier());
+ firstEmployee.setContactDetails(contactsOne);
+ this.organizationManager.createEmployee(firstEmployee);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, firstEmployee.getIdentifier());
+
+
+ ContactDetail secondContact = new ContactDetail();
+ secondContact.setType(ContactDetail.Type.MOBILE.name());
+ secondContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ secondContact.setValue("675859565");
+ secondContact.setPreferenceLevel(new Integer(2));
+
+ List <ContactDetail> contactsTwo = new ArrayList <>();
+ contactsTwo.add(secondContact);
+
+ final Employee secondEmployee = EmployeeFactory.createRandomEmployee();
+ secondEmployee.setIdentifier("employ002");
+ secondEmployee.setGivenName("Oyadipo");
+ secondEmployee.setMiddleName("Okah");
+ secondEmployee.setSurname("Omo");
+ secondEmployee.setAssignedOffice(office.getIdentifier());
+ secondEmployee.setContactDetails(contactsTwo);
+ this.organizationManager.createEmployee(secondEmployee);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, secondEmployee.getIdentifier());
+
+ this.mockMvc.perform(get("/employees")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-find-all-employees", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("employees").description("Page of employees"),
+ fieldWithPath("employees[].identifier").description("first employee's identifier"),
+ fieldWithPath("employees[].givenName").description(" first employee given name"),
+ fieldWithPath("employees[].middleName").description("first employee's middle name"),
+ fieldWithPath("employees[].surname").description("first employee's surname"),
+ fieldWithPath("employees[].assignedOffice").description("first employee's assigned office"),
+ fieldWithPath("employees[].contactDetails").type("List<ContactDetail>").description("first employee's contact details"),
+ fieldWithPath("employees[1].identifier").description("second employee's identifier"),
+ fieldWithPath("employees[1].givenName").description(" second employee given name"),
+ fieldWithPath("employees[1].middleName").description("second employee's middle name"),
+ fieldWithPath("employees[1].surname").description("second employee's surname"),
+ fieldWithPath("employees[1].assignedOffice").description("second employee's assigned office"),
+ fieldWithPath("employees[1].contactDetails").type("List<ContactDetail>").description("second employee's contact details"),
+ fieldWithPath("totalPages").type("Integer").description("Page of Employees"),
+ fieldWithPath("totalElements").type("Integer").description("Page of Employees"))));
+ }
+
+ @Test
+ public void documentUpdateEmployee ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("myOfficeOne");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail orangeContact = new ContactDetail();
+ orangeContact.setType(ContactDetail.Type.MOBILE.name());
+ orangeContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ orangeContact.setValue("699009900");
+ orangeContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(orangeContact);
+
+ final Employee employed = EmployeeFactory.createRandomEmployee();
+ employed.setIdentifier("emNo10");
+ employed.setGivenName("Ojong");
+ employed.setMiddleName("Cho");
+ employed.setSurname("Tah");
+ employed.setAssignedOffice(office.getIdentifier());
+ employed.setContactDetails(contacts);
+ this.organizationManager.createEmployee(employed);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employed.getIdentifier());
+
+ ContactDetail updatedContact = new ContactDetail();
+ updatedContact.setType(ContactDetail.Type.PHONE.name());
+ updatedContact.setGroup(ContactDetail.Group.BUSINESS.name());
+ updatedContact.setValue("677557755");
+ updatedContact.setPreferenceLevel(new Integer(1));
+
+ Assert.assertTrue(contacts.size() == 1);
+ contacts.remove(orangeContact);
+ Assert.assertTrue(contacts.size() == 0);
+ contacts.add(updatedContact);
+ Assert.assertTrue(contacts.size() == 1);
+ employed.setContactDetails(contacts);
+ Assert.assertTrue(employed.getContactDetails().size() == contacts.size());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(put("/employees/" + employed.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(employed))
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-update-employee", preprocessResponse(prettyPrint()),
+ requestFields(
+ fieldWithPath("identifier").description("first employee's identifier"),
+ fieldWithPath("givenName").description(" first employee given name"),
+ fieldWithPath("middleName").description("first employee's middle name"),
+ fieldWithPath("surname").description("first employee's surname"),
+ fieldWithPath("assignedOffice").description("first employee's assigned office"),
+ fieldWithPath("contactDetails").type("List<ContactDetail>").description("first employee's contact details"))));
+ }
+
+ @Test
+ public void documentDeleteEmployee ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("myOfficeTwo");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail orangeContact = new ContactDetail();
+ orangeContact.setType(ContactDetail.Type.MOBILE.name());
+ orangeContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ orangeContact.setValue("699669966");
+ orangeContact.setPreferenceLevel(new Integer(1));
+
+ ContactDetail mtnContact = new ContactDetail();
+ mtnContact.setType(ContactDetail.Type.PHONE.name());
+ mtnContact.setGroup(ContactDetail.Group.BUSINESS.name());
+ mtnContact.setValue("677667766");
+ mtnContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(orangeContact);
+ contacts.add(mtnContact);
+
+ final Employee employeeToDelete = EmployeeFactory.createRandomEmployee();
+ employeeToDelete.setIdentifier("employeeNo2");
+ employeeToDelete.setGivenName("Manu");
+ employeeToDelete.setMiddleName("Ngoh");
+ employeeToDelete.setSurname("Haba");
+ employeeToDelete.setAssignedOffice(office.getIdentifier());
+ employeeToDelete.setContactDetails(contacts);
+ this.organizationManager.createEmployee(employeeToDelete);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employeeToDelete.getIdentifier());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(delete("/employees/" + employeeToDelete.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-delete-employee", preprocessResponse(prettyPrint())));
+ }
+
+ @Test
+ public void documentSetContactDetail ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("ourOffice");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail orangeContact = new ContactDetail();
+ orangeContact.setType(ContactDetail.Type.MOBILE.name());
+ orangeContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ orangeContact.setValue("699889988");
+ orangeContact.setPreferenceLevel(new Integer(1));
+
+ ContactDetail mtnContact = new ContactDetail();
+ mtnContact.setType(ContactDetail.Type.PHONE.name());
+ mtnContact.setGroup(ContactDetail.Group.BUSINESS.name());
+ mtnContact.setValue("677557700");
+ mtnContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(orangeContact);
+
+ final Employee employee = EmployeeFactory.createRandomEmployee();
+ employee.setIdentifier("employeeNo20");
+ employee.setGivenName("Manu");
+ employee.setMiddleName("Ngoh");
+ employee.setSurname("Haba");
+ employee.setAssignedOffice(office.getIdentifier());
+ employee.setContactDetails(contacts);
+ this.organizationManager.createEmployee(employee);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employee.getIdentifier());
+
+ contacts.add(mtnContact);
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(put("/employees/" + employee.getIdentifier() + "/contacts")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(contacts))
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-set-contact-detail", preprocessResponse(prettyPrint())));
+ }
+
+ @Test
+ public void documentFetchContactDetails ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("officeZero");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ final Employee employee = EmployeeFactory.createRandomEmployee();
+
+ ContactDetail emailContact = new ContactDetail();
+ emailContact.setType(ContactDetail.Type.EMAIL.toString());
+ emailContact.setGroup(ContactDetail.Group.PRIVATE.toString());
+ emailContact.setValue("me@example.com");
+ emailContact.setPreferenceLevel(new Integer(2));
+
+ ContactDetail phoneContact = new ContactDetail();
+ phoneContact.setType(ContactDetail.Type.MOBILE.name());
+ phoneContact.setGroup(ContactDetail.Group.BUSINESS.name());
+ phoneContact.setValue("6667667667");
+ phoneContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(emailContact);
+ contacts.add(phoneContact);
+
+ employee.setIdentifier("empNoThree");
+ employee.setGivenName("Mendi");
+ employee.setMiddleName("Ngong");
+ employee.setSurname("Ngang");
+ employee.setAssignedOffice(office.getIdentifier());
+ employee.setContactDetails(contacts);
+ this.organizationManager.createEmployee(employee);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employee.getIdentifier());
+
+ this.mockMvc.perform(get("/employees/" + employee.getIdentifier() + "/contacts")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-fetch-contact-details", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("[].type").description("Type of first contact"),
+ fieldWithPath("[].group").description("Group of first contact"),
+ fieldWithPath("[].value").description("Value of first contact"),
+ fieldWithPath("[].preferenceLevel").type("Integer").description("Preference level of first contact"),
+ fieldWithPath("[1].type").description("Type of second contact"),
+ fieldWithPath("[1].group").description("Group of second contact"),
+ fieldWithPath("[1].value").description("Value of second contact"),
+ fieldWithPath("[1].preferenceLevel").type("Integer").description("Preference level of second contact")
+ )));
+ }
+
+ @Test
+ public void documentDeleteContactDetails ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("Office24");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ ContactDetail orangeContact = new ContactDetail();
+ orangeContact.setType(ContactDetail.Type.MOBILE.name());
+ orangeContact.setGroup(ContactDetail.Group.PRIVATE.name());
+ orangeContact.setValue("699699966");
+ orangeContact.setPreferenceLevel(new Integer(1));
+
+ ContactDetail mtnContact = new ContactDetail();
+ mtnContact.setType(ContactDetail.Type.PHONE.name());
+ mtnContact.setGroup(ContactDetail.Group.BUSINESS.name());
+ mtnContact.setValue("677688766");
+ mtnContact.setPreferenceLevel(new Integer(1));
+
+ List <ContactDetail> contacts = new ArrayList <>();
+ contacts.add(orangeContact);
+
+ final Employee employeeToDelete = EmployeeFactory.createRandomEmployee();
+ employeeToDelete.setIdentifier("employeeNo4");
+ employeeToDelete.setGivenName("Maimuna");
+ employeeToDelete.setMiddleName("Obale");
+ employeeToDelete.setSurname("Sehu");
+ employeeToDelete.setAssignedOffice(office.getIdentifier());
+ employeeToDelete.setContactDetails(contacts);
+ this.organizationManager.createEmployee(employeeToDelete);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employeeToDelete.getIdentifier());
+
+ contacts.add(mtnContact);
+ this.organizationManager.setContactDetails(employeeToDelete.getIdentifier(), contacts);
+ this.eventRecorder.wait(EventConstants.SELECTOR_PUT_CONTACT_DETAIL, employeeToDelete.getIdentifier());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(delete("/employees/" + employeeToDelete.getIdentifier() + "/contacts")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-delete-contact-details", preprocessResponse(prettyPrint())));
+ }
+}
\ No newline at end of file
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/OfficeApiDocumentation.java b/component-test/src/main/java/org/apache/fineract/cn/office/OfficeApiDocumentation.java
new file mode 100644
index 0000000..f476fec
--- /dev/null
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/OfficeApiDocumentation.java
@@ -0,0 +1,402 @@
+/*
+ * 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.office;
+
+import com.google.gson.Gson;
+import org.apache.fineract.cn.office.api.v1.EventConstants;
+import org.apache.fineract.cn.office.api.v1.domain.*;
+import org.apache.fineract.cn.office.util.AddressFactory;
+import org.apache.fineract.cn.office.util.OfficeFactory;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.delete;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.post;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.put;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+public class OfficeApiDocumentation extends TestOffice {
+
+ @Rule
+ public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("build/doc/generated-snippets/test-office");
+
+ @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 documentCreateOffice ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("Kigali");
+ office.setName("Kigali And Sons MFI");
+ office.setDescription("Sons Of Kigali MFI");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(post("/employees")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(office)))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-create-office", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
+ requestFields(
+ fieldWithPath("identifier").description("Employee's identifier"),
+ fieldWithPath("name").description(" Employee given name"),
+ fieldWithPath("description").description("Employee's middle name"))));
+ }
+
+ @Test
+ public void documentFindOffice ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("MyOffice");
+ office.setName("My Office");
+ office.setDescription("My Own Office");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ this.mockMvc.perform(get("/offices/" + office.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-find-office", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("identifier").description("office's identifier"),
+ fieldWithPath("name").description("office name"),
+ fieldWithPath("description").description("office description"),
+ fieldWithPath("parentIdentifier").type("String").description("Parent's branch"),
+ fieldWithPath("address").type("Address").description("Office's address + \n " +
+ " *class* _Address_ { + \n" +
+ " private String street + \n" +
+ " private String city + \n" +
+ " private String region + \n" +
+ " private String postalCode + \n" +
+ " private String countryCode + \n" +
+ " private String country + \n" +
+ "}"),
+ fieldWithPath("externalReferences").description("External references"))));
+ }
+
+ @Test
+ public void documentUpdateOffice ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("originalOffice100");
+ office.setName("Original Office");
+ office.setDescription("My Original Office");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ office.setName("Updated Office");
+ office.setDescription("My Updated Office");
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(put("/offices/" + office.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(office))
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-update-office", preprocessRequest(prettyPrint()),
+ requestFields(
+ fieldWithPath("identifier").description("office's identifier"),
+ fieldWithPath("name").description("office name"),
+ fieldWithPath("description").description("office description"))));
+ }
+
+ @Test
+ public void documentAddBranch ( ) throws Exception {
+
+ final Office parentOffice = OfficeFactory.createRandomOffice();
+ parentOffice.setIdentifier("parentOffice");
+ parentOffice.setName("Parent Office");
+ parentOffice.setDescription("My Parent Office");
+ this.organizationManager.createOffice(parentOffice);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, parentOffice.getIdentifier());
+
+ final Office branch = OfficeFactory.createRandomOffice();
+ branch.setIdentifier("Branch");
+ branch.setName("Branch To Add");
+ branch.setDescription("Branch To Be Added");
+ branch.setParentIdentifier(parentOffice.getIdentifier());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(post("/offices/" + parentOffice.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(branch))
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-add-branch", preprocessRequest(prettyPrint()),
+ requestFields(
+ fieldWithPath("identifier").description("office's identifier"),
+ fieldWithPath("name").description("office name"),
+ fieldWithPath("description").description("office description"),
+ fieldWithPath("parentIdentifier").description("Parent Office"))));
+ }
+
+ @Test
+ public void documentGetBranches ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("office001");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ final Address firstAddress = AddressFactory.createRandomAddress();
+ firstAddress.setStreet("Rue De Vie");
+ firstAddress.setCity("Bandjoun");
+ firstAddress.setRegion("West Region");
+ firstAddress.setPostalCode("8050");
+ firstAddress.setCountry("Cameroon");
+
+ final Office firstBranch = OfficeFactory.createRandomOffice();
+ firstBranch.setIdentifier("firstBranch");
+ firstBranch.setName("First Branch");
+ firstBranch.setDescription("First Branch Of MFI");
+ firstBranch.setAddress(firstAddress);
+ this.organizationManager.addBranch(office.getIdentifier(), firstBranch);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, firstBranch.getIdentifier());
+
+ final Address secondAddress = AddressFactory.createRandomAddress();
+ secondAddress.setStreet("Rue Du Bon");
+ secondAddress.setCity("Baham");
+ secondAddress.setRegion("West Region");
+ secondAddress.setPostalCode("8050");
+ secondAddress.setCountry("Cameroon");
+
+ final Office secondBranch = OfficeFactory.createRandomOffice();
+ secondBranch.setIdentifier("secondBranch");
+ secondBranch.setName("Second Branch");
+ secondBranch.setDescription("Second Branch Of MFI");
+ secondBranch.setAddress(secondAddress);
+ this.organizationManager.addBranch(office.getIdentifier(), secondBranch);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, secondBranch.getIdentifier());
+
+ final OfficePage officePage = this.organizationManager.getBranches(office.getIdentifier(), 0, 20, null, null);
+ Assert.assertEquals(Long.valueOf(2L), officePage.getTotalElements());
+
+ this.mockMvc.perform(get("/offices/" + office.getIdentifier() + "/branches")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-get-branches", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("offices[].identifier").description("first employee's identifier"),
+ fieldWithPath("offices[].parentIdentifier").description("Parent office"),
+ fieldWithPath("offices[].name").description("first office's name"),
+ fieldWithPath("offices[].description").description("first branch's description"),
+ fieldWithPath("offices[].address").type("Address").description("first branch's address + \n " +
+ " *class* _Address_ { + \n" +
+ " private String street + \n" +
+ " private String city + \n" +
+ " private String region + \n" +
+ " private String postalCode + \n" +
+ " private String countryCode + \n" +
+ " private String country + \n" +
+ "}"),
+ fieldWithPath("offices[].externalReferences").description("first branch's external reference"),
+ fieldWithPath("offices[1].identifier").description("second employee's identifier"),
+ fieldWithPath("offices[1].parentIdentifier").description("Parent office"),
+ fieldWithPath("offices[1].name").description("second office's name"),
+ fieldWithPath("offices[1].description").description("second branch's description"),
+ fieldWithPath("offices[1].address").type("Address").description("second branch's address + \n " +
+ " *class* _Address_ { + \n" +
+ " private String street + \n" +
+ " private String city + \n" +
+ " private String region + \n" +
+ " private String postalCode + \n" +
+ " private String countryCode + \n" +
+ " private String country + \n" +
+ "}"),
+ fieldWithPath("offices[1].externalReferences").description("second branch's external reference"),
+ fieldWithPath("totalPages").type("Integer").description("Page of offices"),
+ fieldWithPath("totalElements").type("Integer").description("Page of offices"))));
+ }
+
+ @Test
+ public void documentDeleteOffice ( ) throws Exception {
+
+ final Address address = AddressFactory.createRandomAddress();
+ address.setStreet("Commercial Avenue");
+ address.setCity("Bamenda");
+ address.setRegion("North West Region");
+ address.setPostalCode("8050");
+ address.setCountry("Cameroon");
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("office007");
+ office.setName("Seventh Office ");
+ office.setDescription("The Seventh Office Of MFI");
+ office.setAddress(address);
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ this.mockMvc.perform(delete("/offices/" + office.getIdentifier())
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-delete-office", preprocessResponse(prettyPrint())));
+ }
+
+ @Test
+ public void documentSetOfficeAddress ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("originalOffice");
+ office.setName("Original Office");
+ office.setDescription("My Original Office");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ final Address newAddress = AddressFactory.createRandomAddress();
+ newAddress.setStreet("New Street");
+ newAddress.setCity("New City");
+ newAddress.setRegion("New region");
+ newAddress.setPostalCode("8050");
+ newAddress.setCountry("Cameroon");
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(put("/offices/" + office.getIdentifier() + "/address")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(newAddress))
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-set-office-address", preprocessRequest(prettyPrint()),
+ requestFields(
+ fieldWithPath("street").description("Street"),
+ fieldWithPath("city").description("City"),
+ fieldWithPath("region").description("Region"),
+ fieldWithPath("postalCode").description("Postal Code"),
+ fieldWithPath("countryCode").description("Country Code"),
+ fieldWithPath("country").description("Country"))));
+ }
+
+ @Test
+ public void documentGetOfficeAddress ( ) throws Exception {
+
+ final Address address = AddressFactory.createRandomAddress();
+ address.setStreet("The Street");
+ address.setCity("The City");
+ address.setRegion("The Region");
+ address.setPostalCode("8085");
+ address.setCountry("Gambia");
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("theOffice");
+ office.setName("The Office");
+ office.setDescription("The Office");
+ office.setAddress(address);
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ this.mockMvc.perform(get("/offices/" + office.getIdentifier() + "/address")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isOk())
+ .andDo(document("document-get-office-address", preprocessResponse(prettyPrint()),
+ responseFields(
+ fieldWithPath("street").description("Street"),
+ fieldWithPath("city").description("City"),
+ fieldWithPath("region").description("Region"),
+ fieldWithPath("postalCode").description("Postal Code"),
+ fieldWithPath("countryCode").description("Country Code"),
+ fieldWithPath("country").description("Country"))));
+ }
+
+ @Test
+ public void documentDeleteOfficeAddress ( ) throws Exception {
+
+ final Address address = AddressFactory.createRandomAddress();
+ address.setStreet("Delete Street");
+ address.setCity("Delete City");
+ address.setRegion("Delete Region");
+ address.setPostalCode("8040");
+ address.setCountry("Niger");
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("officeToDelete");
+ office.setName("Office To Delete");
+ office.setDescription("The Office To Delete");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ this.organizationManager.setAddressForOffice(office.getIdentifier(), address);
+ this.eventRecorder.wait(EventConstants.OPERATION_PUT_ADDRESS, office.getIdentifier());
+
+ this.mockMvc.perform(delete("/offices/" + office.getIdentifier() + "/address")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .accept(MediaType.ALL_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-delete-office-address", preprocessResponse(prettyPrint())));
+ }
+
+ // TODO : Fix documentAddExternalReference() method
+ /*
+ @Test
+ public void documentAddExternalReference ( ) throws Exception {
+
+ final Office office = OfficeFactory.createRandomOffice();
+ office.setIdentifier("ourNewOffice");
+ this.organizationManager.createOffice(office);
+ this.eventRecorder.wait(EventConstants.OPERATION_POST_OFFICE, office.getIdentifier());
+
+ final ExternalReference reference = new ExternalReference();
+ reference.setType("Type OneRef");
+ reference.setState(ExternalReference.State.ACTIVE.toString());
+
+ Gson gson = new Gson();
+ this.mockMvc.perform(put("/offices/" + office.getIdentifier() + "/references")
+ .contentType(MediaType.APPLICATION_JSON_VALUE)
+ .content(gson.toJson(reference))
+ .accept(MediaType.APPLICATION_JSON_VALUE))
+ .andExpect(status().isAccepted())
+ .andDo(document("document-add-external-reference", preprocessRequest(prettyPrint()),
+ requestFields(
+ fieldWithPath("type").description("Type of reference"),
+ fieldWithPath("state").description("State of reference ")
+ )));
+ }*/
+}
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/SuiteTestEnvironment.java b/component-test/src/main/java/org/apache/fineract/cn/office/SuiteTestEnvironment.java
new file mode 100644
index 0000000..eecff91
--- /dev/null
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/SuiteTestEnvironment.java
@@ -0,0 +1,41 @@
+/*
+ * 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.office;
+
+import org.apache.fineract.cn.test.env.TestEnvironment;
+import org.apache.fineract.cn.test.fixture.cassandra.CassandraInitializer;
+import org.apache.fineract.cn.test.fixture.mariadb.MariaDBInitializer;
+import org.junit.ClassRule;
+import org.junit.rules.RuleChain;
+import org.junit.rules.RunExternalResourceOnce;
+import org.junit.rules.TestRule;
+
+public class SuiteTestEnvironment {
+
+ static final String APP_NAME = "office-v1";
+ static final TestEnvironment testEnvironment = new TestEnvironment(APP_NAME);
+ static final CassandraInitializer cassandraInitializer = new CassandraInitializer();
+ static final MariaDBInitializer mariaDBInitializer = new MariaDBInitializer();
+
+ @ClassRule
+ public static TestRule orderClassRules = RuleChain
+ .outerRule(new RunExternalResourceOnce(testEnvironment))
+ .around(new RunExternalResourceOnce(cassandraInitializer))
+ .around(new RunExternalResourceOnce(mariaDBInitializer));
+}
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/TestEmployee.java b/component-test/src/main/java/org/apache/fineract/cn/office/TestEmployee.java
index 0d1c540..39b815e 100644
--- a/component-test/src/main/java/org/apache/fineract/cn/office/TestEmployee.java
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/TestEmployee.java
@@ -22,7 +22,6 @@
import org.apache.fineract.cn.office.api.v1.client.AlreadyExistsException;
import org.apache.fineract.cn.office.api.v1.client.BadRequestException;
import org.apache.fineract.cn.office.api.v1.client.NotFoundException;
-import org.apache.fineract.cn.office.api.v1.client.OrganizationManager;
import org.apache.fineract.cn.office.api.v1.domain.ContactDetail;
import org.apache.fineract.cn.office.api.v1.domain.Employee;
import org.apache.fineract.cn.office.api.v1.domain.EmployeePage;
@@ -31,91 +30,18 @@
import java.util.Collections;
import java.util.List;
import org.apache.commons.lang3.RandomStringUtils;
-import org.apache.fineract.cn.anubis.test.v1.TenantApplicationSecurityEnvironmentTestRule;
-import org.apache.fineract.cn.api.context.AutoUserContext;
-import org.apache.fineract.cn.office.rest.config.OfficeRestConfiguration;
import org.apache.fineract.cn.office.util.EmployeeFactory;
import org.apache.fineract.cn.office.util.OfficeFactory;
-import org.apache.fineract.cn.test.env.TestEnvironment;
-import org.apache.fineract.cn.test.fixture.TenantDataStoreContextTestRule;
-import org.apache.fineract.cn.test.fixture.cassandra.CassandraInitializer;
-import org.apache.fineract.cn.test.fixture.mariadb.MariaDBInitializer;
-import org.apache.fineract.cn.test.listener.EnableEventRecording;
-import org.apache.fineract.cn.test.listener.EventRecorder;
-import org.junit.After;
import org.junit.Assert;
-import org.junit.Before;
-import org.junit.ClassRule;
-import org.junit.Rule;
import org.junit.Test;
-import org.junit.rules.RuleChain;
-import org.junit.rules.TestRule;
-import org.junit.runner.RunWith;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.cloud.netflix.feign.EnableFeignClients;
-import org.springframework.cloud.netflix.ribbon.RibbonClient;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Import;
-import org.springframework.test.context.junit4.SpringRunner;
-
-@RunWith(SpringRunner.class)
-@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
-public class TestEmployee {
- private static final String APP_NAME = "office-v1";
- private static final String TEST_USER = "thutmosis";
-
- private final static TestEnvironment testEnvironment = new TestEnvironment(APP_NAME);
- private final static CassandraInitializer cassandraInitializer = new CassandraInitializer();
- private final static MariaDBInitializer mariaDBInitializer = new MariaDBInitializer();
- private final static TenantDataStoreContextTestRule tenantDataStoreContext = TenantDataStoreContextTestRule.forRandomTenantName(cassandraInitializer, mariaDBInitializer);
-
- @ClassRule
- public static TestRule orderClassRules = RuleChain
- .outerRule(testEnvironment)
- .around(cassandraInitializer)
- .around(mariaDBInitializer)
- .around(tenantDataStoreContext);
-
- @Rule
- public final TenantApplicationSecurityEnvironmentTestRule tenantApplicationSecurityEnvironment
- = new TenantApplicationSecurityEnvironmentTestRule(testEnvironment, this::waitForInitialize);
-
- @Autowired
- private OrganizationManager organizationManager;
-
- @Autowired
- private EventRecorder eventRecorder;
-
- private AutoUserContext userContext;
-
- @Before
- public void prepareTest() {
- userContext = tenantApplicationSecurityEnvironment.createAutoUserContext(TestEmployee.TEST_USER);
- }
-
- @After
- public void cleanupTest() {
- userContext.close();
- }
- public boolean waitForInitialize() {
- try {
- return this.eventRecorder.wait(EventConstants.INITIALIZE, EventConstants.INITIALIZE);
- } catch (final InterruptedException e) {
- throw new IllegalStateException(e);
- }
- }
+public class TestEmployee extends AbstractOfficeTest {
@Test
public void shouldCreateEmployee() throws Exception {
final Employee employee = EmployeeFactory.createRandomEmployee();
{
- this.organizationManager.createEmployee(employee);
+ super.organizationManager.createEmployee(employee);
final boolean found = this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, employee.getIdentifier());
Assert.assertTrue(found);
}
@@ -186,7 +112,7 @@ public void shouldFindAllEmployees() throws Exception {
this.eventRecorder.wait(EventConstants.OPERATION_POST_EMPLOYEE, secondEmployee.getIdentifier());
final EmployeePage employeePage = this.organizationManager.fetchEmployees(null, null, 0, 20, null, null);
- Assert.assertEquals(Long.valueOf(2L), employeePage.getTotalElements());
+ Assert.assertTrue(employeePage.getTotalElements() >= 2);
this.organizationManager.deleteEmployee(firstEmployee.getIdentifier());
this.eventRecorder.wait(EventConstants.OPERATION_DELETE_EMPLOYEE, firstEmployee.getIdentifier());
@@ -386,23 +312,4 @@ public void shouldDeleteContactDetailOfEmployee() throws Exception {
this.organizationManager.deleteEmployee(employee.getIdentifier());
this.eventRecorder.wait(EventConstants.OPERATION_DELETE_EMPLOYEE, employee.getIdentifier());
}
-
- @Configuration
- @ComponentScan(
- basePackages = "org.apache.fineract.cn.office.listener"
- )
- @EnableFeignClients(basePackages = {"org.apache.fineract.cn.office.api.v1.client"})
- @RibbonClient(name = APP_NAME)
- @EnableEventRecording(maxWait = 5000L)
- @Import({OfficeRestConfiguration.class})
- public static class TestConfiguration {
- public TestConfiguration() {
- super();
- }
-
- @Bean
- public Logger logger() {
- return LoggerFactory.getLogger("office-test-logger");
- }
- }
}
diff --git a/component-test/src/main/java/org/apache/fineract/cn/office/TestOffice.java b/component-test/src/main/java/org/apache/fineract/cn/office/TestOffice.java
index 6653c14..edc4ca3 100644
--- a/component-test/src/main/java/org/apache/fineract/cn/office/TestOffice.java
+++ b/component-test/src/main/java/org/apache/fineract/cn/office/TestOffice.java
@@ -23,93 +23,19 @@
import org.apache.fineract.cn.office.api.v1.client.BadRequestException;
import org.apache.fineract.cn.office.api.v1.client.ChildrenExistException;
import org.apache.fineract.cn.office.api.v1.client.NotFoundException;
-import org.apache.fineract.cn.office.api.v1.client.OrganizationManager;
import org.apache.fineract.cn.office.api.v1.domain.Address;
import org.apache.fineract.cn.office.api.v1.domain.Employee;
import org.apache.fineract.cn.office.api.v1.domain.ExternalReference;
import org.apache.fineract.cn.office.api.v1.domain.Office;
import org.apache.fineract.cn.office.api.v1.domain.OfficePage;
import org.apache.commons.lang3.RandomStringUtils;
-import org.apache.fineract.cn.anubis.test.v1.TenantApplicationSecurityEnvironmentTestRule;
-import org.apache.fineract.cn.api.context.AutoUserContext;
-import org.apache.fineract.cn.office.rest.config.OfficeRestConfiguration;
import org.apache.fineract.cn.office.util.AddressFactory;
import org.apache.fineract.cn.office.util.EmployeeFactory;
import org.apache.fineract.cn.office.util.OfficeFactory;
-import org.apache.fineract.cn.test.env.TestEnvironment;
-import org.apache.fineract.cn.test.fixture.TenantDataStoreContextTestRule;
-import org.apache.fineract.cn.test.fixture.cassandra.CassandraInitializer;
-import org.apache.fineract.cn.test.fixture.mariadb.MariaDBInitializer;
-import org.apache.fineract.cn.test.listener.EnableEventRecording;
-import org.apache.fineract.cn.test.listener.EventRecorder;
-import org.junit.After;
import org.junit.Assert;
-import org.junit.Before;
-import org.junit.ClassRule;
-import org.junit.Rule;
import org.junit.Test;
-import org.junit.rules.RuleChain;
-import org.junit.rules.TestRule;
-import org.junit.runner.RunWith;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.cloud.netflix.feign.EnableFeignClients;
-import org.springframework.cloud.netflix.ribbon.RibbonClient;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Import;
-import org.springframework.test.context.junit4.SpringRunner;
-
-@RunWith(SpringRunner.class)
-@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
-public class TestOffice {
- private static final String APP_NAME = "office-v1";
- private static final String TEST_USER = "thutmosis";
-
- private final static TestEnvironment testEnvironment = new TestEnvironment(APP_NAME);
- private final static CassandraInitializer cassandraInitializer = new CassandraInitializer();
- private final static MariaDBInitializer mariaDBInitializer = new MariaDBInitializer();
- private final static TenantDataStoreContextTestRule tenantDataStoreContext = TenantDataStoreContextTestRule.forRandomTenantName(cassandraInitializer, mariaDBInitializer);
-
- @ClassRule
- public static TestRule orderClassRules = RuleChain
- .outerRule(testEnvironment)
- .around(cassandraInitializer)
- .around(mariaDBInitializer)
- .around(tenantDataStoreContext);
-
- @Rule
- public final TenantApplicationSecurityEnvironmentTestRule tenantApplicationSecurityEnvironment
- = new TenantApplicationSecurityEnvironmentTestRule(testEnvironment, this::waitForInitialize);
-
- @Autowired
- private OrganizationManager organizationManager;
-
- @Autowired
- private EventRecorder eventRecorder;
-
- private AutoUserContext userContext;
-
- @Before
- public void prepareTest() {
- userContext = tenantApplicationSecurityEnvironment.createAutoUserContext(TestOffice.TEST_USER);
- }
-
- @After
- public void cleanupTest() {
- userContext.close();
- }
- public boolean waitForInitialize() {
- try {
- return this.eventRecorder.wait(EventConstants.INITIALIZE, EventConstants.INITIALIZE);
- } catch (final InterruptedException e) {
- throw new IllegalStateException(e);
- }
- }
+public class TestOffice extends AbstractOfficeTest {
@Test
public void shouldCreateOffice() throws Exception {
@@ -407,23 +333,4 @@ public void shouldIndicateOfficeHasExternalReferences() throws Exception {
final Office office = this.organizationManager.findOfficeByIdentifier(randomOffice.getIdentifier());
Assert.assertTrue(office.getExternalReferences());
}
-
- @Configuration
- @ComponentScan(
- basePackages = "org.apache.fineract.cn.office.listener"
- )
- @EnableFeignClients(basePackages = {"org.apache.fineract.cn.office.api.v1.client"})
- @RibbonClient(name = APP_NAME)
- @EnableEventRecording(maxWait = 5000L)
- @Import({OfficeRestConfiguration.class})
- public static class TestConfiguration {
- public TestConfiguration() {
- super();
- }
-
- @Bean
- public Logger logger() {
- return LoggerFactory.getLogger("office-test-logger");
- }
- }
}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services