DataAuthority

Data Authority API - Request content of endpoint A and B are stored, diff-ed and the result is available throught a third endpoint

Context

There are 3 endpoints Asp.net Web Api phisycally independent so that them can be scale out.

• Endpoint A - Store request contents into Microsoft Sql LocalDb
• Endpoint B - Store request contents into Microsoft Sql LocalDb
• Endpoint C - Read the differ result from Microsoft Sql LocalDb

Business rules

The results shall provide the following info in JSON format

• If Endpoint A's content equal Endpoint B's content return that
• If contents from A and B not of equal size just return that
• If contents of same size provide insight in where the diffs are, actual diffs are not needed.
  • So mainly offsets + length in the data

Non-functional requirements

• Scalabiity
• Solution written in C#
• Internal logic shall be under unit test
• Functionality shall be under integration test
• Documentation in code
• Clear and to the point readme on usage
• 2 endpoints that accepts JSON base64 encoded binary data

Architecure Overview

Design Patterns and principles

• CQRS - Command Query Responsibility Segregation
• Repository
• Domain Model
• DDD principles (Domain Event, rules kept inside Entities)
• Inversion of Control
• Dependency Injection
• Mediator

Requirements to run

• Visual Studio community 2017
• .Net Core
• Complemeting packages are downloaded in first build
• Postman

How to run

• Open solution DataAuthority.sln from Visual Studio
• Build Solution to restore packages
• Go to solution properties -> Startup Project menu -> Select Multiple startup projects -> set Start for:
  • DataAuthority.Base64Left.API
  • DataAuthority.Base64Right.API
  • DataAuthority.Base64Result.API
• Hit play button to boot the 3 APIs
• 3 consoles hosts will get running
• Each console shows its endpoint url
• Open postman
• inform DataAuthority.Base64Left.API's url + /v1/diff/ + {ID} + /Left, set action Post and inform the body content and click Send
• inform DataAuthority.Base64Right.API's url + /v1/diff/ + {ID} + /Right, set action Post and inform the body content and click Send
• To get the diff result, inform DataAuthority.Base64Right.API's url + /v1/diff/{ID}, set action Get and click Send

Screenshots

Post: Response:

Unit tests

• No Database required

Integration tests

• Database and seed get set up in the boot
• In case of these tests get red, please execute one by one. Some concurrency problem I think