Tweaking travis-cii settings. Adding some code comments. Adding codecov.yml to ignore config classes. Updating README.

Author: Cameron-C-Chapman

.travis.yml

@@ -3,8 +3,7 @@ jdk:
  - oraclejdk8
 script:
  - ./gradlew clean
- - ./gradlew build
- - ./gradlew test
+ - ./gradlew assemble
  - ./gradlew jacocoTestReport
 after_success:
  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -18,6 +18,10 @@ This repo is an example of a simple spring rest service that demonstrates some g
 ```
 
 ### Testing the Application
+* Unit testing
+ ```
+ ./gradlew test
+ ```
 * Through swagger-ui
  * With the application running navigate to [http://localhost:9000/swagger-ui.html](http://localhost:9000/swagger-ui.html)
  * You will see several controllers exposed including the Customer Controller which exposes the functionality for viewing all customers, viewing a specific customer, and adding a customer.

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+ - "src/main/java/org/cameronchapman/github/webservice/config"

src/main/java/org/cameronchapman/github/webservice/config/SwaggerConfig.java

@@ -2,6 +2,7 @@
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.spi.DocumentationType;
@@ -10,6 +11,7 @@
 
 @Configuration
 @EnableSwagger2
+@Profile({"local", "dev", "test"})
 public class SwaggerConfig {
 
  @Bean

src/main/java/org/cameronchapman/github/webservice/controller/CustomerController.java

@@ -24,6 +24,12 @@ public class CustomerController {
  @Autowired
  CustomerManager customerManager;
 
+ /**
+ * HTTP GET
+ * Return a list of all customers.
+ *
+ * @return ResponseEntity<List<Customer>>
+ */
  @RequestMapping(value="/customers", method= RequestMethod.GET)
  public ResponseEntity<List<Customer>> getAll() {
  List<Customer> customers = null;
@@ -38,12 +44,20 @@ public ResponseEntity<List<Customer>> getAll() {
  responseMsg = FAILED;
  LOGGER.error("Exception calling getAll! msg={}", e.getMessage());
  } finally {
- LOGGER.info("{} | {}", responseMsg, httpStatus.toString());
+ LOGGER.info("{} | {}", responseMsg, httpStatus.toString()); //@NOTE: logging in a real application should be much more robust than this, this is just an example
  }
 
  return new ResponseEntity<List<Customer>>(customers, httpStatus);
  }
 
+ /**
+ * HTTP GET
+ * Return a specific customer.
+ *
+ * @param @PathVariable Long id
+ *
+ * @return ResponseEntity<Customer>
+ */
  @RequestMapping(value="/customers/{id}", method=RequestMethod.GET)
  public ResponseEntity<Customer> getById(@PathVariable Long id) {
  Customer customer = null;
@@ -68,6 +82,13 @@ public ResponseEntity<Customer> getById(@PathVariable Long id) {
  return new ResponseEntity<Customer>(customer, httpStatus);
  }
 
+ /**
+ * HTTP POST
+ * Create a customer.
+ *
+ * @param @RequestBody Customer customer
+ * @return ResponseEntity<Map<String, Number>>
+ */
  @RequestMapping(value="customers", method=RequestMethod.POST)
  public ResponseEntity<Map<String, Number>> insert(@RequestBody Customer customer) {
  Number newId = null;

src/main/java/org/cameronchapman/github/webservice/org/cameronchapman/github/webservice/manager/CustomerManager.java

@@ -37,13 +37,15 @@ public Customer getCustomerById(Long id) {
  try {
  customer = customerDao.getById(id);
  } catch(DataAccessException dae) {
+ // if no data is returned return null to caller
  LOGGER.debug("No data returned from getCustomerById. id={}", id);
  }
  return customer;
  }
 
  public Number insertCustomer(Customer customer) throws Exception {
  Number newId = customerDao.insert(customer);
+ // if no new id was generated from the insert attempt throw an exception
  if (null == newId) {
  throw new NoNewCustomerIdReturnedException("No new customer id returned.");
  }