codacy-badger/microservice

====================================

Lookup Service

This module intentions is to:

• read fixed length transaction files.
• product a daily summary report.

How to run the program

java -jar fileingestor.jar datafile.txt out.csv

Continous Integration and Code Coverage

• Continous Integration
• Code Coverage
• Codacy

CREATE USER 'golden'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON * . * TO 'golden'@'localhost'; FLUSH PRIVILEGES;

-Dspring.profiles.active=local-mysql

Relevant Articles:

• Introduction to Spring Batch
• FixedLengthTokenizer
• Jackson CSV extension
• Java Bean Validation Basics

What is this repository for?

• Service to process Future Clearing files
• 1.0.0

How do I get set up?

• Summary of set up
• Configuration
• Dependencies
• Database configuration
• How to run tests
• Deployment instructions

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
• Other community or team contact

Building The Project

---

###Eclipse:

1. Before importing into eclipse execute the mvn eclipse:eclipse command to prepare the project to be able to be simply imported into the IDE.
2. Within the IDE, select import existing eclipse project option and as the eclipse:eclipse command will have prepared .project and .classpath files, this will mean minimal setup required.
3. Add the integration-test src and resources to your classpath to ensure your can easily execute integration tests from the IDE.

###Compiling The project has been designed to be built via maven the pom has been configured to be able to execute unit and integration tests, generate code coverage reports, and code checkstyle testing.

Four Test Profiles have been configured to aid in building the project depending on what you wish to achieve:

1. unit-tests will only execute unit tests.
2. integration-tests will only execute integration tests.
3. all-tests both unit and integration tests are run.
4. no-tests no tests run.

The default profile is all-tests.

Some example executions are as followed.

• mvn clean test => Creates code coverage report for unit tests.
• mvn clean verify -P unit-tests => Creates code coverage report for unit tests and fails if does not meet coverage ratios.
• mvn clean verify -P integration-tests => Creates code coverage report for unit tests and fails if does not meet coverage ratios.
• mvn clean verify -P all-tests => Creates code coverage reports for unit and integration tests and fails if does not meet coverage ratios).
• mvn clean package -P no-tests => Does not execute tests and creates the distributable.
• mvn clean verify -P all-tests checkstyle:check => runs all tests, checkstyle and packages.

Before submitting your code to GIT run clean verify -P all-tests checkstyle:check and build successfully to ensure that all tests and code style checks are completed to ensure Continuous Integration build errors do not arise.

Test Profiles

no-tests - all tests are ignored all-tests - all tests are executed unit-tests - only unit tests are executed integration-tests - only integration tests are executed