tpiekarski / dockerized-restinio Goto Github PK

For an improved output of current options the operator << could be overloaded to display address and port in the following way: <address>:<port>.

For a better and more convenient handling of endpoints struct could be considered.

User Story
As a developer I want to have some CI, so I can be sure that unit tests works, both build stages build something intended and that the final container is answering requests.

Description
none

Acceptance Criteria

• All available unit tests should be run.
• Both build stages should be used to build images,
• Final docker container should be started from the runtime stage
• Request should be answered with an HTTP 200 after sending a request to http://localhost:8080.

User Story
As a developer I want to have a registry of routes, so I can register new routes and their controllers with ease.

Description
none

Acceptance Criteria

• Provide a registry for routes and controllers
• Implement the registry pattern for being able to map routes to derived classes of the ControllerInterface
• (Find a solution how to deal with different HTTP methods)

Consider to strip down the image for RESTinio, because the Dispatcher, Controller and Router should probably go into an own project using that image.

Especially when this image should be offered at DockerHub for other people.

User Story
As a user I want to have a readiness probe, so I can check if the container started and can answer HTTP requests from outside.

Description
Take that current hello world route and transform it to a useful route, starring this readiness probe (:

Acceptance Criteria
curl -X GET http://localhost:8080/ready
- Should return an HTTP 200

User Story
As a user I want to pass the host name and port by CLI, so I can configure those values from outside.

Description
When any of those arguments are provided there should be some sane default to fallback to (like the current hard-coded values).

Acceptance Criteria

User Story
As a developer I might want to have the Express Router offered by RESTinio, so I could gain a more convenient routing.

Description
Consider and introduce express routing instead of the basic restinio::run approach.
For details see Express Routing

Acceptance Criteria

• Consideration about benefits
• Leverage express routing

Bottom line
When requesting anything the connection gets reset by peer.

Steps to reproduce
curl -X GET http://localhost:8080

Current output

curl: (56) Recv failure: Connection reset by peer

Expected output

Hello world!

User Story
As a developer I want to have a this docker image at docker hub, so I can base other projects upon that docker image.

Description
none

Acceptance Criteria

• The image is published at docker hub

User Story
As a developer I want to code against unit tests, so I can be sure that things work and that I won't code something different than expected.

Description
none

Acceptance Criteria
Something red :)

RESTinio should be updated to the most recent version, possible issues solved and the development of this Docker Image should be restarted once again.