The last dance
This is the last work term report I’ll ever have to outline (unless I fail ;))
Organizing your paper before writing is 90% of the work… I had to WKRPT 200 during my 2A co-op term, and WKRPT 100 (a technical brief) during my 1B co-op term.
Title Ideas:
- Optimizing Test Automation with a Test-Data BFF using MVC and Pub/Sub Patterns
- Optimizing Test Automation using MVC and Pub/Sub patterns for a Test-Data BFF
PROJECT OUTLINE
- Title Page
- Letter of submittal
- Table of Contents
- List of Figures
- List of Tables
- Summary (Finish on 04/21/2024)
- Condense the report to one page
- Introduction
- Project overview (why is the API necessary)
- Objective
- The objective of this project is to develop a test-data BFF in Java using Spring, designed to automate the generation, and disposal of test data for testing application code. The test-data BFF aims to enhance the efficiency of testing by offering customizable test data, seamless integration, and data manipulation features, all whilst ensuring high scalability.
- Scope (What is M1)
- Background
- Mostly for pre-defining terms used in the report
- We call the service a test-data BFF because a BFF typically is represented as a proxy API but it is just an API
- What is a REST API?
- Define what checkout means
- Actual definition
- Key components and define them
- Broker Listing
- Broker
- Account
- Production
- Event
- Event Performer
- Venue
- WKRPT 300 - Technical Process
- Software design patterns
- MVC system design
- Implementation
- Controller implementation
- Service implementation
- Data model layer implementation
- Cleanup Implementation
- Testing
- Deployment
- Conclusions - Conclusions about the results of the project, deliverables - Did you reach the project objective
- Next Steps and Recommendations (Finish by 04/20/2024)
- Defining M2 which is the next most business critical thing to test
- Integrate test-data BFF into regression DBs
- Pull out cleanup service into a microservice
- Replace returned domain entities with responses to decouple db transactions with HTTP transactions
- References
Revision!
- Go back and fix code examples (done)
- Go back and fix “quotes” vs Italics notation (done)
- Go back and fix incomplete references to td-bff related information (references to “persistent”, “contextId”, and cleanup storage) (done)
Writing a Good Report
- 20 body pages, 1.5 line spaced, 11 or 12 pt font
- “Design something and describe the process, for sub-par results suggest corrective action”
- “Decision making component”
- “State a clear objective”
- “Demonstrate technical proficiency”
- “Justify all decisions”