billyJoePiano / TenaPull

TenaPull is a configurable Java application which fetches and processes the data from one or more Nessus APIs, and converts it into JSON ouputs that are usable by Splunk
7 stars 1 forks source link

Peer Review #1 - Jackson Daniels #3

Closed jackrdaniels97 closed 2 years ago

jackrdaniels97 commented 2 years ago

Design/Code Review 1

Project: Nessus Tool App

Developer: Bill Anderson

Reviewer: Jackson Daniels

Item Considerations Comments/Suggestions
Reviewer comments and suggestions go here. Each item should have at least one "kudos" and two suggestions for improvement
Problem Statement 1. Accurately describes project purpose
2. Is professional and free of typos, slang, etc.
3. Fully explains the problem and the solution
4. Is understandable by the average person
Good problem description about how this is needed to due python scripts that are now broken. This would also make the data more accessable than to just the server team. Potenitally add some definition to what Splunk and Nessus are cause I do not know much about it
Design Documentation 1. Navigation/flow through the application is logical and easy to use.
2. The order in which values are displayed are logical and easy to understand/use
3. The order in which the form fields entered are logical and easy to understand/use
4. All data discussed/documented (problem statement, flow, db design, etc.) is represented on the screens
Design of the basic dash board looks nice and can definitly be useful
Data model/Database 1. Everything on the screens and problem statement/flow is represented in the model
2. There is at least one 1-to-many relationship.
3. The model represents good database design
Description of the database seems like it will be nice and easy to pull data from and make it more accessible.
Code 1. Proper Maven project structure is used
2. a .gitignore file for IntelliJ Java projects has been implemented
3. There is not any redundant or copy/paste code in the JSPs or classes
4. Classes are appropriately-sized (no monster classes)
Property files are used appropriately: no hard-coded values
5. Logging statements are used rather than System.out.println and printStackTrace.
6. There are appropriate unit tests/code coverage.
Code so far looks good and the project as a whole looks really nice.