Fall 2018
The system consists of three main components: a command line order entry module, a central processing module and a data storage module.
- The order entry module handles all communication with the user
- The data storage module handles all communication with the underlying file system.
- The central processing system coordinates the activities across the system taking requests from the order entry module and interacting with the data storage layer to fulfill the request.
A key component of understanding and extending the Online Ordering System is its architecture. Management expects each team to fully document the architecture and how they plan to extend it. Components to consider in developing the architecture documentation are the key drivers, the Architectually Significant Requirements the team is addressing, the architecture itself, and how the chosen architecture addresses the drivers.
The Online Ordering System was developed using the Java language. The developers used IntelliJ IDEA, atom, and vsCode as their principle development tools. Development work was done in both Ubuntu and Windows 10. However, the customer has explicitly asked that the final product run on Windows 10.
The management team fired the last set of architects and developers because they could not agree on architectural direction or coding styles and conventions. This inability has led to a slightly brittle system that is at risk of falling behind its primary competitor, that South American company, Amazon.
The management team strongly believes that consistency in coding will yield a better result and a better final grade.
-
Java 8 : Refactoring work done over the life of the ordering system has resulted in dependencies on newer versions of Java. Currently, streams and lambda expressions are used.
The customer is open to upgrading to newer Java versions if the architecture team identifies functionality that would enhance functionality of the system or readability of the resulting code.
-
Lombok Library: Lombok annotations are used in places to auto-generate getters and setters.
-
JUnit Library: Included but never used.
The development team choose Maven as their build tool. Maven 3.1.0 and 3.3.9 have both been successfully used.
With Maven installed, running mvn clean install from the root install directory should successfully build the program. It is expected that every build will also execute the test lifecycle ensuring that unit tests all still pass.
The development team pushed developing unit tests to the end of their development cycle. As is often the case, this was a poor decision. Time was never allocated and no tests were written.
The stakeholders have high hopes that the new Crack Teams taking over the project have a better sense of the importance of unit testing and deliver code with good unit tests and high coverage.
The previous team left no written instructions on how to run the system, other than it appears the main app runs via menutest. Management sincerely hopes the new teams understand the importance of good documentation and provide this critical piece of information.
It should be noted that a large part of the compensation for working on this project is dependent on the management team being able to evaluate it. A key part of evaluation will be installing, building and running the system you produce. Additionally, explaining architecture choices going forward is essential.