Dynamic Hierarchy Test Kotlin

Implementation and automation of a Dynamic Hierarchy processor in Kotlin.

Download

git clone https://github.com/marcelovcpereira/mvcp-dynamic-hierarchy-test.git

Building, Testing And Running locally

Pre requisites:

• Git
• Java 8 - SDK
• Gradle

Building And Unit Testing

Run inside project folder root:

gradle build

A jar file will be generated at /build/libs folder

Running Locally

java -jar mvcp-dynamic-hierarchy-test-1.0.0-SNAPSHOT.jar

This will run the server locally, listening for HTTP requests coming on port 8080.

No-install Run: From Docker hub

Pre requisites:

• Docker

Starting service:

docker run --rm --name mvcp-dynamic-hierarchy-test -p 8080:8080 marcelovcpereira/mvcp-dynamic-hierarchy-test:1.0.0 

Stopping service:

docker stop mvcp-dynamic-hierarchy-test

Usage

Hierarchy Basic Rules:

• Input data should not contain more than 1 reference to a employee's supervisor. For example: {"marcelo":"andre", "marcelo":"ana"} It is considered invalid JSON (ConflictingParentException)

As order of tuples in the input is not important, multiple references could lead to unexpected behavior

• Input data should not contain cycles For example: {"marcelo":"andre", "andre":"marcelo"} It is considered invalid JSON (CyclicInputException)

• Input data should not contain more than 1 root Employee For example: {"marcelo":"andre", "ana":"peter"} It is considered invalid JSON (MultipleRootsException)

Authentication

In the current version, the Dynamic Hierarchy app implements HTTP basic auth with only one user:

user: admin

password: admin

So, in order to use its API, always send user auth information in the requests as in the examples below

Examples:

Valid Hierarchy

curl -XPOST --user admin:admin http://localhost:8080 -H 'Content-type: application/json' -d '{"claudia":"andre","joao":"andre"}'

result:

andre{
 claudia{}
 joao{}
}

Cyclic Hierarchy

curl -XPOST --user admin:admin http://localhost:8080 -H 'Content-type: application/json' -d '{"claudia":"andre","andre":"claudia"}'

result:

{
    "timestamp":"2019-07-08T18:33:03.140+0000",
    "status":500,
    "error":"Internal Server Error",
    "message":"[ERROR] Your input contains a cycle at (claudia)",
    "path":"/"
}

Internal Components

Entrypoint: Central controller responsible for intercepting all http requests done to the app.

DynamicHierarchy: The Dynamic Hierarchy is the heart of the application and is responsible for delegating the creation of a Hierarchy, exhibition of a Hierarchy and for retrieving an Employee's Supervisors inside a Hierarchy

Employee Factory: Component responsible for creating valid Employees objects based on input

Employee Manager: Component responsible for managing persistency on Employees

Input Validator: Component responsible for applying validation strategies on the input

Improvements:

• Improve HTTP status code on Exceptions (currently 500)
• Improve tests
• Improve authentication mechanism (currently Basic HTTP)
• Externalize some configuration (admin user/pass could be in properties, port binding could be in properties, etc)
• Allow multiple hierarchies to be created and persisted