Martian Robots

How the project has been developed

After reading the documentation provided the first thing done has been defining what kind of application is wanting to get. At this point, it has been chosen to develop an ASP.NET CORE 3.1 Web API. Due to the time of developing something are get straightforward.

Considerations taking before starting the development process:

Visual Studio 2019 has been selected as principal IDE.
Entity Framework is the ORM selected to boost the database integration
Non Relational DB has been refused because of data types. As we want to keep in mind that this app could be increased, main data models (robot, sensors, grid position, info from the grid, astronauts on mars...) could have a relationship between each others.
The web app has 3 principal classes, Grid, Modules and Robots. Grid is the "planet" divided by a number of modules. For example, 1 grid of 2x2 has 6 module 1 (1-N relation). A robot explores one grid and has a relation to the module (1-1) but not all modules have a robot.
The main purpose has been to make a 2 ways of using the app. 1 to explore CRUD calls using "Info" endpoints and another which use "Robot" endpoint to modify the model.
At the end of developing, info endpoints are set to develop them. The unique endpoint full useful is "martianrobots/deploy" which handle the input requirements.

Project

Structure

├───src
│   ├───Controllers         # Endoints
│   ├───Database            # Database and model
│   │   ├───Contexts
│   │   │   └───Configurations
│   │   ├───Entities
│   │   └───Repositories
│   │       └───Base
│   ├───Diagrams
│   ├───Helpers             # Logic
│   │   ├───Commands
│   │   ├───Engines
│   │   └───Receiver
│   ├───Migrations
│   ├───Models
│   │   └───Grids
│   ├───Properties
│   ├───Servicies           # Logic
│   └───Shared
│       └───Interfaces
│           ├───Commands
│           └───Servicies
└───test
    ├───Engines

Endpoints

API works with the following structure:

Info (not implemented): - Get (id) - Get (x,y) - GetAll() - GetByPlanet(id) - GetDanger (danger) This endpoints just consume data generated by deploy endpoints.
Deploy - DeployRobot(robot): deploy a robot with the input requeriment format

Endpoints can be found inside controller.

Model

Using the clean architecture layer the model was defined using domain driven design and code first with EF Core.

The model is inside the Database/Entities folder, and Repositories and Context are folders with the classes to make EF work correctly.

The model is generated taking care of multiples Planets (Plante Enum), more instructions to be added (Intruction Enum) and future extensions.

#### Logic

The the web app core follows the command pattern inside the Helpers folder.

When the endpoint controller is posted, the controller use RobotService to perform a model update. Then, there are 3 steps, grid creation, robot first deploy and movements. These 3 steps are represented by 3 commands inside commands folder, Engines use this created commands reading the path given in the input and pass it to the specific receiver for each single action.

Test

Test project is inside the test folder. There the unit test made were created with XUnit framework and Fluent assertions.

More unit test cases need to be added for example to perform correct insertion in the database with an in memory database to test.

The unit test created test the principal cases of the input requirements.

More things to add

The main challenge has been to create an extensible app, using dependency injection, repository, singleton, TDD, single-responsibility, segregation, etc... Patterns.

At this point, I would like to extend the app-ending the Getters endpoints, adding the possibility of a robot "restart" from the finish endpoint, docker integration, microservicies...

One point to work would have been to segregate the base repository to give more flexibility to CRUD operation, extending the current base class in new ones and making a base class abstract.

Running the web app

To run the app, firstly clone this repo with visual studio.

Clone this repo with visual studio.
Create a database, by default this app use a database called test.
- Connection string is in appsetting.Development.json
- It's essential to have SSMS and SQL installed.
Check package are installed.
Run migrations and model creation using the command: "Update-Database" in the package manager console or "dotnet ef database update" in normal terminal.
Run the app with MartianRobot Debug Profile.
Test using Postman passing the input requirements. Postman use to give problems with HTTPS connection so I recommend to use http port (see the image below).

Ture2/MartianRobots