aws-cloudformation / aws-cloudformation-samples

Apache License 2.0
134 stars 55 forks source link

Updated Javadoc comments. #70

Closed mrinaudo-aws closed 1 year ago

mrinaudo-aws commented 1 year ago

Issue #, if available:

Description of changes: Updated Javadoc comments.

Unit tests excerpts

% cfn generate && mvn clean package javadoc:javadoc && cfn submit --dry-run
[...]
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.awssamples.ec2instancetypes.hook.PreUpdateHookHandlerTest
[INFO] Tests run: 44, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 4.325 s - in com.awssamples.ec2instancetypes.hook.PreUpdateHookHandlerTest                                                                                                    
[INFO] Running com.awssamples.ec2instancetypes.hook.PreCreateHookHandlerTest
[INFO] Tests run: 44, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.089 s - in com.awssamples.ec2instancetypes.hook.PreCreateHookHandlerTest                                                                                                    
[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 88, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[...]
[INFO] --- maven-javadoc-plugin:3.4.1:javadoc (default-cli) @ awssamples-ec2instancetypes-hook-handler ---
[...]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  38.372 s
[INFO] Finished at: 2023-01-06T14:32:13-05:00
[INFO] ------------------------------------------------------------------------

Contract tests excerpts

% cfn test
[...]
collected 24 items / 17 deselected / 7 selected                                                                            

[...]/hook/handler_pre_create.py::contract_pre_create_success PASSED [ 14%]
[...]/hook/handler_pre_create.py::contract_pre_create_failed PASSED [ 28%]
[...]/hook/handler_pre_create.py::contract_pre_create_failed_unsupported_target SKIPPED [ 42%]
[...]/hook/handler_pre_update.py::contract_pre_update_success PASSED [ 57%]
[...]/hook/handler_pre_update.py::contract_pre_update_failed PASSED [ 71%]
[...]/hook/handler_pre_update.py::contract_pre_update_failed_unsupported_target SKIPPED [ 85%]
[...]/resource/handler_misc.py::contract_check_asserts_work PASSED [100%]

================================= 5 passed, 2 skipped, 17 deselected in 1705.83s (0:28:25) [...]
collected 24 items / 17 deselected / 7 selected                                                                            

[...]/hook/handler_pre_create.py::contract_pre_create_success PASSED [ 14%]
[...]/hook/handler_pre_create.py::contract_pre_create_failed PASSED [ 28%]
[...]/hook/handler_pre_create.py::contract_pre_create_failed_unsupported_target SKIPPED [ 42%]
[...]/hook/handler_pre_update.py::contract_pre_update_success PASSED [ 57%]
[...]/hook/handler_pre_update.py::contract_pre_update_failed PASSED [ 71%]
[...]/hook/handler_pre_update.py::contract_pre_update_failed_unsupported_target SKIPPED [ 85%]
[...]/resource/handler_misc.py::contract_check_asserts_work PASSED [100%]

================================= 5 passed, 2 skipped, 17 deselected in 1583.82s (0:26:23) [...]

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.