kode-konveyor / tidy-up Goto Github PK

Behaviour: LoggerService/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("LoggerService")

The production code is at com.kodekonveyor.logging.LoggerService.java
The testcase base should be at com.kodekonveyor.logging.LoggerServiceTestBase.java
The testcase should probably be at com.kodekonveyor.logging.LoggerServiceLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

LoggerService

DTOs and Entities:

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: MarkAsPaidController/statuses

Annotations for the test cases:

@TestedBehaviour("statuses")
@TestedService("MarkAsPaidController")

The production code is at com.kodekonveyor.completion.MarkAsPaidController.java
The testcase base should be at com.kodekonveyor.completion.MarkAsPaidControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkAsPaidControllerStatusesTest.java

a posted work request is in the POSTED status
when an offer is accepted, it changes status to be AGREED
when the provider marks an AGREED work as completed its status becomes COMPLETED
when the customer marks a COMPLETED work as completed, it becomes VERIFIED
when the customer marks a VERIFIED work as paid, it becomes PAID
when the customer marks a PAID work as pid, it becomes CLOSED

No other state transition is allowed

When the work request is not in POSTED status, only its customer and provider can access it.

The service:

mark work as paid

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: FindWorkRequestController/statuses

Annotations for the test cases:

@TestedBehaviour("statuses")
@TestedService("FindWorkRequestController")

The production code is at com.kodekonveyor.work_request.find.FindWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.find.FindWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.find.FindWorkRequestControllerStatusesTest.java

a posted work request is in the POSTED status
when an offer is accepted, it changes status to be AGREED
when the provider marks an AGREED work as completed its status becomes COMPLETED
when the customer marks a COMPLETED work as completed, it becomes VERIFIED
when the customer marks a VERIFIED work as paid, it becomes PAID
when the customer marks a PAID work as pid, it becomes CLOSED

No other state transition is allowed

When the work request is not in POSTED status, only its customer and provider can access it.

The service:

FindWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("CustomerGetWorkRequestsController")

The production code is at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsController.java
You should probably start at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerTests.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

CustomerGetWorkRequestsController

DTOs and Entities:

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: OpenWorkRequestController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("OpenWorkRequestController")

The production code is at com.kodekonveyor.work_request.open.OpenWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.open.OpenWorkRequestControllerTests.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

OpenWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: RevokeWorkRequestController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("RevokeWorkRequestController")

The production code is at com.kodekonveyor.work_request.revoke.RevokeWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

RevokeWorkRequestController

DTOs and Entities:

WorkRequestEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: CreateWorkRequestController/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("CreateWorkRequestController")

The production code is at com.kodekonveyor.work_request.create.CreateWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.create.CreateWorkRequestControllerTests.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

CreateWorkRequestController

DTOs and Entities:

CreateWorkRequestDTO

WorkRequestEntity

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: MarkCompletionController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("MarkCompletionController")

The production code is at com.kodekonveyor.completion.MarkCompletionController.java
The testcase base should be at com.kodekonveyor.completion.MarkCompletionControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkCompletionControllerCompileOutputTest.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

mark work as completed

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: FindWorkRequestController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("FindWorkRequestController")

The production code is at com.kodekonveyor.work_request.find.FindWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.find.FindWorkRequestControllerTests.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

FindWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: OpenWorkRequestController/Open work request

@TestedBehaviour("Open work request")
@TestedService("OpenWorkRequestController")

You should modify com.kodekonveyor.work_request.open.OpenWorkRequestController.

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: AcceptOfferController/statuses

Annotations for the test cases:

@TestedBehaviour("statuses")
@TestedService("AcceptOfferController")

The production code is at com.kodekonveyor.work_request.offer.AcceptOfferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.AcceptOfferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.AcceptOfferControllerStatusesTest.java

a posted work request is in the POSTED status
when an offer is accepted, it changes status to be AGREED
when the provider marks an AGREED work as completed its status becomes COMPLETED
when the customer marks a COMPLETED work as completed, it becomes VERIFIED
when the customer marks a VERIFIED work as paid, it becomes PAID
when the customer marks a PAID work as pid, it becomes CLOSED

No other state transition is allowed

When the work request is not in POSTED status, only its customer and provider can access it.

The service:

AcceptOfferController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: MarkAsPaidController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("MarkAsPaidController")

The production code is at com.kodekonveyor.completion.MarkAsPaidController.java
The testcase base should be at com.kodekonveyor.completion.MarkAsPaidControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkAsPaidControllerCompileOutputTest.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

mark work as paid

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: RevokeWorkRequestController/Revoke work request

@TestedBehaviour("Revoke work request")
@TestedService("RevokeWorkRequestController")

You should modify com.kodekonveyor.work_request.revoke.RevokeWorkRequestController.

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("CustomerGetWorkRequestsController")

The production code is at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsController.java
The testcase base should be at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

CustomerGetWorkRequestsController

DTOs and Entities:

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: AcceptOfferController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("AcceptOfferController")

The production code is at com.kodekonveyor.work_request.offer.AcceptOfferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.AcceptOfferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.AcceptOfferControllerCompileOutputTest.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

AcceptOfferController

DTOs and Entities:

WorkRequestDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: GiveofferController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("GiveofferController")

The production code is at com.kodekonveyor.work_request.offer.GiveofferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.GiveofferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.GiveofferControllerCompileOutputTest.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

GiveOfferController

DTOs and Entities:

WorkRequestEntity

OfferDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: FindWorkRequestController/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("FindWorkRequestController")

The production code is at com.kodekonveyor.work_request.find.FindWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.find.FindWorkRequestControllerTests.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

FindWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: AcceptOfferController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("AcceptOfferController")

The production code is at com.kodekonveyor.work_request.offer.AcceptOfferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.AcceptOfferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.AcceptOfferControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

AcceptOfferController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: AuthenticatedUserService/Retrieves signed in user

@TestedBehaviour("Retrieves signed in user")
@TestedService("AuthenticatedUserService")

You should modify com.kodekonveyor.authentication.AuthenticatedUserService.

        Using

SecurityContextHolder.getContext().getAuthentication();

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: GiveofferController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("GiveofferController")

The production code is at com.kodekonveyor.work_request.offer.GiveofferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.GiveofferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.GiveofferControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

GiveOfferController

DTOs and Entities:

WorkRequestEntity

OfferDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: AcceptOfferController/accepted offer

Annotations for the test cases:

@TestedBehaviour("accepted offer")
@TestedService("AcceptOfferController")

The production code is at com.kodekonveyor.work_request.offer.AcceptOfferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.AcceptOfferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.AcceptOfferControllerAcceptedOfferTest.java

When an offer is accepted, the provider of the offer entity is set as the provider of the work request entity

The service:

AcceptOfferController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: RevokeWorkRequestController/Save the new/modified entities

Annotations for the test cases:

@TestedBehaviour("Save the new/modified entities")
@TestedService("RevokeWorkRequestController")

The production code is at com.kodekonveyor.work_request.revoke.RevokeWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerTests.java

new/modified entities should be saved using the save() method of the corresponding repository.
The service:

RevokeWorkRequestController

DTOs and Entities:

WorkRequestEntity

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/compile output

Annotations for the test cases:

@TestedBehaviour("compile output")
@TestedService("CustomerGetWorkRequestsController")

The production code is at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsController.java
You should probably start at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerTests.java

response DTOs are newly created and the fields are filled by copying information from entities and other available data
The service:

CustomerGetWorkRequestsController

DTOs and Entities:

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: AuthenticatedUserService/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("AuthenticatedUserService")

The production code is at com.kodekonveyor.authentication.AuthenticatedUserService.java
You should probably start at com.kodekonveyor.authentication.AuthenticatedUserServiceTests.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

AuthenticatedUserService

DTOs and Entities:

UserEntity

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: AcceptOfferController/access control

Annotations for the test cases:

@TestedBehaviour("access control")
@TestedService("AcceptOfferController")

The production code is at com.kodekonveyor.work_request.offer.AcceptOfferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.AcceptOfferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.AcceptOfferControllerAccessControlTest.java

• a user can only revoke its own work request
• a user can only accept an offer for its own work request
  The service:

AcceptOfferController

DTOs and Entities:

WorkRequestDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: OpenWorkRequestController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("OpenWorkRequestController")

The production code is at com.kodekonveyor.work_request.open.OpenWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.open.OpenWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.open.OpenWorkRequestControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

OpenWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/Get work requests by customerID

@TestedBehaviour("Get work requests by customerID")
@TestedService("CustomerGetWorkRequestsController")

You should modify com.kodekonveyor.work_request.open.CustomerGetWorkRequestsController.

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: OpenWorkRequestController/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("OpenWorkRequestController")

The production code is at com.kodekonveyor.work_request.open.OpenWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.open.OpenWorkRequestControllerTests.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

OpenWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: GiveofferController/input validation

Annotations for the test cases:

@TestedBehaviour("input validation")
@TestedService("GiveofferController")

The production code is at com.kodekonveyor.work_request.offer.GiveofferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.GiveofferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.GiveofferControllerInputValidationTest.java

All input is validated before any other processing.
The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

The service:

GiveOfferController

DTOs and Entities:

WorkRequestEntity

OfferDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: CreateWorkRequestController/input validation

Annotations for the test cases:

@TestedBehaviour("input validation")
@TestedService("CreateWorkRequestController")

The production code is at com.kodekonveyor.work_request.create.CreateWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.create.CreateWorkRequestControllerTests.java

All input is validated before any other processing.
The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

The service:

CreateWorkRequestController

DTOs and Entities:

CreateWorkRequestDTO

WorkRequestEntity

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: CreateWorkRequestController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("CreateWorkRequestController")

The production code is at com.kodekonveyor.work_request.create.CreateWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.create.CreateWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.create.CreateWorkRequestControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

CreateWorkRequestController

DTOs and Entities:

CreateWorkRequestDTO

WorkRequestEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

I believe there should be such issue, I find this while working on #69

Behaviour: CreateWorkRequestController/Create work request

Te tests should have the annotations

@TestedBehaviour("Create work request")
@TestedService("CreateWorkRequestController")

You should modify com.kodekonveyor.work_request.create.CreateWorkRequestController.

Relevant views:

CreateWorkRequestController

Processes

Behaviours

application structure

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: FindWorkRequestController/input validation

@TestedBehaviour("input validation")
@TestedService("FindWorkRequestController")

You should modify .FindWorkRequestController.

        All input is validated before any other processing.

The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: OpenWorkRequestController/input validation

Annotations for the test cases:

@TestedBehaviour("input validation")
@TestedService("OpenWorkRequestController")

The production code is at com.kodekonveyor.work_request.open.OpenWorkRequestController.java
The test base is at com.kodekonveyor.work_request.open.OpenWorkRequestControllerTestBase.java
You should probably work on com.kodekonveyor.work_request.open.OpenWorkRequestControllerInputValidationTest.java

All input is validated before any other processing.
The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

The service:

OpenWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/access control

Annotations for the test cases:

@TestedBehaviour("access control")
@TestedService("CustomerGetWorkRequestsController")

The production code is at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsController.java
The testcase base should be at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.open.CustomerGetWorkRequestsControllerAccessControlTest.java

• a user can only revoke its own work request
• a user can only accept an offer for its own work request
• a user can only list its own work request with CustomerGetWorkRequestsController

The service:

CustomerGetWorkRequestsController

DTOs and Entities:

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: MarkCompletionController/statuses

Annotations for the test cases:

@TestedBehaviour("statuses")
@TestedService("MarkCompletionController")

The production code is at com.kodekonveyor.completion.MarkCompletionController.java
The testcase base should be at com.kodekonveyor.completion.MarkCompletionControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkCompletionControllerStatusesTest.java

a posted work request is in the POSTED status
when an offer is accepted, it changes status to be AGREED
when the provider marks an AGREED work as completed its status becomes COMPLETED
when the customer marks a COMPLETED work as completed, it becomes VERIFIED
when the customer marks a VERIFIED work as paid, it becomes PAID
when the customer marks a PAID work as pid, it becomes CLOSED

No other state transition is allowed

When the work request is not in POSTED status, only its customer and provider can access it.

The service:

mark work as completed

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: RevokeWorkRequestController/input validation

@TestedBehaviour("input validation")
@TestedService("RevokeWorkRequestController")

You should modify .RevokeWorkRequestController.

        All input is validated before any other processing.

The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: MarkCompletionController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("MarkCompletionController")

The production code is at com.kodekonveyor.completion.MarkCompletionController.java
The testcase base should be at com.kodekonveyor.completion.MarkCompletionControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkCompletionControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

mark work as completed

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: FindWorkRequestController/Find work requests by type and city

@TestedBehaviour("Find work requests by type and city")
@TestedService("FindWorkRequestController")

You should modify com.kodekonveyor.work_request.find.FindWorkRequestController.

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: FindWorkRequestController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("FindWorkRequestController")

The production code is at com.kodekonveyor.work_request.find.FindWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.find.FindWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.find.FindWorkRequestControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

FindWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: RevokeWorkRequestController/access control

Annotations for the test cases:

@TestedBehaviour("access control")
@TestedService("RevokeWorkRequestController")

The production code is at com.kodekonveyor.work_request.revoke.RevokeWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerAccessControlTest.java

• a user can only revoke its own work request
• a user can only accept an offer for its own work request
  The service:

RevokeWorkRequestController

DTOs and Entities:

WorkRequestEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: AuthenticatedUserService/Creates user if does not exist

@TestedBehaviour("Creates user if does not exist")
@TestedService("AuthenticatedUserService")

You should modify .AuthenticatedUserService.

        By the rules defined in UserEntity fields, using Authentication.getName()

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: CustomerGetWorkRequestsController/input validation

@TestedBehaviour("input validation")
@TestedService("CustomerGetWorkRequestsController")

You should modify .CustomerGetWorkRequestsController.

        All input is validated before any other processing.

The validation rules of entity fields are described at the corresponding entity field documentation.
Error is signaled by throwing ValidationException, with the message detailing the business meaning and value of the bad value, along with description of the accepted inputs

Relevant views:

More about the service:

More about the behaviour:

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: GiveofferController/Save the new/modified entities

Annotations for the test cases:

@TestedBehaviour("Save the new/modified entities")
@TestedService("GiveofferController")

The production code is at com.kodekonveyor.work_request.offer.GiveofferController.java
The testcase base should be at com.kodekonveyor.work_request.offer.GiveofferControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.offer.GiveofferControllerSaveTheNew/modifiedEntitiesTest.java

new/modified entities should be saved using the save() method of the corresponding repository.
The service:

GiveOfferController

DTOs and Entities:

WorkRequestEntity

OfferDTO

OfferEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: RevokeWorkRequestController/Data access

Annotations for the test cases:

@TestedBehaviour("Data access")
@TestedService("RevokeWorkRequestController")

The production code is at com.kodekonveyor.work_request.revoke.RevokeWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.revoke.RevokeWorkRequestControllerDataAccessTest.java

Entities are

• created using the constructor of the entity. Created entities should be saved by the save() method of the corresponding repository
• retrieved using the query methods of the corresponding repository
• updated using setters of the entity. updated entities should be saved (see above)
• deleted using the delete() method of the corresponding repository

The service:

RevokeWorkRequestController

DTOs and Entities:

WorkRequestEntity

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: MarkAsPaidController/Logging

Annotations for the test cases:

@TestedBehaviour("Logging")
@TestedService("MarkAsPaidController")

The production code is at com.kodekonveyor.completion.MarkAsPaidController.java
The testcase base should be at com.kodekonveyor.completion.MarkAsPaidControllerTestBase.java
The testcase should probably be at com.kodekonveyor.completion.MarkAsPaidControllerLoggingTest.java

All activities should be logged with level INFO before anything else is done with the user initiating the activity (if known), and the name of the controller.

The result of all successful activities should be logged with level FINE the name of the controller, id(s) of the result(s) (if there is an id), or the value, using the string SUCCESS

The result of all failures should be logged with level WARNING, with the name of the controller, the string "FAILURE", and the reason of the failure.

The logging is implemented by LoggerService. All other controllers and services should call that.

If the user is not knowns, the "user" parameter must be null.

See https://www.vogella.com/tutorials/Logging/article.html for how to log.

The service:

mark work as paid

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.

Behaviour: CreateWorkRequestController/Save the new/modified entities

Annotations for the test cases:

@TestedBehaviour("Save the new/modified entities")
@TestedService("CreateWorkRequestController")

The production code is at com.kodekonveyor.work_request.create.CreateWorkRequestController.java
You should probably start at com.kodekonveyor.work_request.create.CreateWorkRequestControllerTests.java

new/modified entities should be saved using the save() method of the corresponding repository.
The service:

CreateWorkRequestController

DTOs and Entities:

CreateWorkRequestDTO

WorkRequestEntity

If you have questions, see the FAQ, ask on the Telegram channel or ask your mentor.

Behaviour: OpenWorkRequestController/statuses

Annotations for the test cases:

@TestedBehaviour("statuses")
@TestedService("OpenWorkRequestController")

The production code is at com.kodekonveyor.work_request.open.OpenWorkRequestController.java
The testcase base should be at com.kodekonveyor.work_request.open.OpenWorkRequestControllerTestBase.java
The testcase should probably be at com.kodekonveyor.work_request.open.OpenWorkRequestControllerStatusesTest.java

a posted work request is in the POSTED status
when an offer is accepted, it changes status to be AGREED
when the provider marks an AGREED work as completed its status becomes COMPLETED
when the customer marks a COMPLETED work as completed, it becomes VERIFIED
when the customer marks a VERIFIED work as paid, it becomes PAID
when the customer marks a PAID work as pid, it becomes CLOSED

No other state transition is allowed

When the work request is not in POSTED status, only its customer and provider can access it.

The service:

OpenWorkRequestController

DTOs and Entities:

WorkRequestEntity

WorkRequestDTO

If you have questions, see the FAQ, or ask on the development slack channel or ask your mentor.