SOFT3202 Exam Submission README

How to run application
Feature claim - DISTINCTION
RED-GREEN-REFACTOR commits
TDD for exam extension features

Developer's Note

This was a project done for the SOFT3202 Software Design and Consturction unit in my final year of studies, it contains submitted and assessed components for the unit. The tutor has approved students to post our work as part of a portfolio and display it publicly.

As part of the unit's focus on design patterns and principles, the MVP architecture and Facade pattern was applied to achieve maintanability, extensibility and modularity of the application components.

If any future students who are doing SOFT2201/SOFT3203 is reading this - please double check with your unit coordinator on whether it is okay to reference this work, I am NOT promoting this work as a solution to the assessment in the unit.

Assigned API

Input: Marvel API Output: Pastebin API

Assigned exam extension

Maintain a list of up to 3 characters - this list should be empty when the application starts. As the user searches for characters, add them to the list in order of when they were searched. When the list is full and the user searches for a character, ask them for an index from 0 to 2, and swap out the matching index with the new character. Display this list in your GUI.

When the user requests a report, include the information on the last matched character, but also include the names of any other characters in the list in brackets at the end, eg if index 1 was matched then the brackets would be (name0) (name2), omitting any that are empty.

How to run application

Configuration file for API keys

Marker's own API keys for both input and output APIs should be placed in the configuration JSON file KeyConfig.json under src/main/resources/marvel in order for the live versions to run.

Replace API keys as JSON strings in the following fields as annotated

{
"marvelKey": "<Marvel API public key>",
"marvelPrivateKey": "<Marvel API private key>",
"pastebinKey" : "<Pastebin API public key>"
}

NOTE: For Marvel API, both public and private keys need to be provided.

Gradle command

Option to use live or dummy versions of both the input and output APIs can be selected with 2 arguments in sequence, where the first specifies for the input API and the second for the output API.

For example,

gradle run --args="offline online"

will run the application using offline (dummy) input API and live (requests hitting the web) output API.

gradle run --args="online offline"

will run the application using live (requests hitting the web) input API and offline (dummy) output API.

Feature claim

PASS requirements feature set

Given specified Marvel character name, display information about it (information on character, including image) on GUI in a way that would be useful to a user
Produce report related to character information entity built from input Marvel API for output Pastebin API

The version where this is fully completed and tested in tagged with version v1.2.2.

CREDIT requirements feature set

Cache feature: The input model will automatically cache the JSON response body from a successful character data search request.
MarvelCache.sqlite is a database with a Character table that has 2 columns "Name" and "Response" which is a key-value pair for caching search strings and their response strings.
If the user hit search with a text in the text field that corresponds to a cached record, application will ask the user for option to load from cache or hit search again to request data from API.
Both the online and offline input API models can save and load from cache, valid response saved in a previous session can be loaded in a offline version, and dummy response cached in a offline search will overwrite valid data from a previous live session.

The version where this is fully completed and tested in tagged with version v1.3.

DISTINCTION requirements feature set

Basic concurrency using Task and Platform.runLater, GUI thread is separated out from database and API calls.
This is done in the MainPresenter file where onSearch() and onLoadFromCache() uses Tasks to call model mutable methods

The version where this is fully completed and tested in tagged with version v1.3.

RED-GREEN-REFACTOR Commits

Note to marker:

1. Pass set 1-7 lists commits in early development stages, while there was effort to keep track of TDD through commit messages, commit history was unfortunately messy and require looking into files to compare changes (For example, ModelImplTest file might show up as modified but the change was done to a test method that is different to the ones added in the RED stage), to make marking easier I have added commit comments on the sets and individual commits to explain

1.2. Some RED-GREEN processes were submerged within a commit (as a mistake of not correctly tracking RED-GREEN-RED-GREEN-REFACTORs where modification to existing tests were done before refactoring), after consulting Josh, it was adviced to still list them.

3. Pass set 6-10 and credit set 1-3 are much cleaner commits.

Commits during development of pass requirement features

Pass set 1 , Pass set 2 - RED-GREEN-REFACTOR , Pass set 3, Pass set 4, Pass set 5, Pass set 6 - Clean RED-GREEN,

Commits during refactoring of pass requirement version

Pass set 7 - Clean RED-GREEN, Pass set 8 - Clean RED-GREEN, Pass set 9 - Clean RED-GREEN-REFACTOR, Pass set 10 - Clean RED-GREEN

Commits during development for credit requirement features

Credit set 1, Credit set 2, Credit set 3

Commits during Replacement Examination for extension features

Exam set 1, Exam set 2

Pass set 1

Relevant tests : testValidCharacterName() [Mocked InputModel] , testInvalidCharacterName() [Mocked InputModel]

Methods: getCharacterInfo() method in ModelFacade and getInfoByName() method in InputModel

RED Commit URL: 34085ddc84013575a8313846ef4f753bdca4a33b

GREEN Commit URL: 62ae76d3050793e2555b3bb024b43f5bfe3f4f7f

Shows ModelImplTest as modified file but changes were not made to relevant tests.

REFACTOR Commit URL: f50a188a001db8954dbbf479fb1fc5b0a4fed0f7

Submerged RED-GREEN process concerning change to CharacterInfo

Pass set 2

RED-GREEN-REFACTOR

Relevant tests : testInputModelGetInfoByNameInvalid() [Mocked MarvelApiHandler], testInputModelGetInfoByNameValid() [Mocked MarvelApiHandler], testInptModelGetInfoNullList() [Mocked MarvelApiHandler]

Methods: getCharacterInfo() in ModelFacade, getInfoByName() in InputModel and getCharacterInfoByName() in MarvelApiHandler

RED Commit URL: 5eb7094b1fc518177fb8599680991137255ff78e

GREEN Commit URL: f6a9831731296ced3fe5456f86593b57e2ec0ef3

REFACTOR Commit URL: 51a4911b7c30bc9abda1a68a2a6916472e788b07

Modification to how MarvelApiHandler's access to public and private keys were done, from setApiKeys to setting keys by Constructor arguments.

MarvelApiHandler constructor is refactored, uses injected strings to set keys rather than hard coded strings.

This leads to modification in method call inside ModelImpl to setApiHandler for input model, ModelImpl's line 29.

Tests for InputModel still passes after this refactoring (interaction between OnlineMarvelModel and MarvelApiHandler still behaves as before).

Pass set 3

Relevant tests: testGetImageViaModelFacade() [Mock InputModel] testInputModelGetThumbnailImage() [Mock InputModel]

RED Commit URL: 1b6354243320e8cfd76c6a9a8c367c3875f0761e

GREEN Commit URL: 09ce9e19892a408ac674930df5a05861136ba28d

-- GREEN for testGetImageViaModelFacade()

-- RED-GREEN for testInputModelGetThumbnailImage() submerged

REFACTOR Commit URL: 446a133e9799091a8b42ea55c935c134396c54fa

Pass set 4

(relatively clean RED-GREEN), please ignore commit messages and see commit comments for details.

Relevant tests: testSendReportFacade() [Mocked OutputModel], testGetReportUrlFacade() [Mocked OutputModel]

Methods: sendReport() in ModelFacade and sendReport() in OutputModel

Methods: getReportUrl() in ModelFacade and getReportUrl() in OutputModel

RED Commit URL: 203c4799ebbcd2b9491625806ae2baee2429de37

GREEN Commit URL: 100599aa893b87d88373eb85e1f582cd54a83b2c

See commit comments.

REFACTOR (Relevant tests unchanged and passed - however test suite fails because commit) Commit URL: face90c6efe6c72344c380a214ad5130910626d6

Pass set 5

Relevant tests: testOutputModelSendReport(), testOutputModelGetReportUrl()

Methods: sendReport() in ModelFacade and sendReport() in OutputModel

Methods: getReportUrl() in ModelFacade, getReportUrl() in OutputModel and sendReport() in PastebinApiHandler

RED Commit URL: face90c6efe6c72344c380a214ad5130910626d6

GREEN Commit URL: 77e5c8178db8e22bd51fc5640d1e0f3e5bf338c3

See commit comments - submerged RED-GREEN.

Pass set 6

Relevant test: testInputModelGetThumbnailFullPath() [Mocked InputModel]

Methods: ModelFacade getImagePathByInfo() and getThumbnailFullPath() in InputModel

RED Commit URL: 0524160fd5d7cdc3eac075d7d88981b9e9e1c25c

GREEN Commit URL: bb1de09a047c9085c1ba9c4d490e11b0be09978f

Pass set 7

Relavant tests:

testRefactoredObserverUpdateGetCharacterInfoComplete()

testRefactoredObserverUpdateSendReportComplete()

Methods:

ModelFacade's addObserver(), getCharacterInfo() and ModelObserver's updateCharacterInfo()

ModelFacade's addObserver(), sendReport() and ModelObserver's updateReportUrl()

RED Commit URL: 46b740c05e072f4559b2bc60d3dc08bfbce35eb9

(Test file shows one line modification to a previous test set) GREEN Commit URL: bc6c545fed706da786ccfde5b8c647d502a97e6e

Pass set 8

Tests: (Mocked MarvelApiHandler and ResponseHandler to verify OnlineMarvelModel method calls)

testGetCharacterInfoErrorResponse()

testNullApiHandlerSet()

testNullResponseHandlerSet()

testInputModelGetInfoNullList()

testInputModelGetInfoByNameValid()

Feature done:

Added setResponseHandler() to InputModel, have InputModel coordinate passing response body string to ResponseHandler on getCharacterInfo(), return null on null handlers set.

RED Commit URL: 18a018a17ac8654ebd837cbcfb69605fa806ddd3

GREEN Commit URL: 1b28bcac427811dddc9209860b92bd6c15e44f40

Pass set 9

CLEAN RED-GREEN-REFACTOR

Tests: testOfflineMarvelModelGetCharacter()

Feature:

Using dummy data loaded from JSON file to create more convincing dummy data instead of in method construction.

Method : OfflineMarvelModel getInfoByName()

RED Commit URL: 66b6b19362b41ff69dfe7f2de8cce623d6ac3c3f

GREEN Commit URL: ccfdd36a5bcb4c0ebe3e32ffd2cf8ce2b8fc23a6

Refactoring:

Uses new method setResponseHandler in OutputModel, allow both online and offline model to use ResponseHandler as a JSON - CharacterInfo parser.

OfflineMarvelModel's getInfoByName() now delegates to the handler class to create CharacterInfo object.

REFACTOR Commit URL: d43e63ca82f456f2842b2c91c0fb89381af0cb6f

Pass set 10

Tests: (Mocked MarvelApiHandler and ResponseHandler to verify OnlineMarvelModel method calls)

testReportServiceGenerateReportNullHandler(), testReportServiceGenerateReportNullService(), testReportServiceGenerateReportValid()

testOutputModelSendReport() - modified existing test 10c90071dfdfb04669d25958fafadbc92cddb921

Feature done: Restructured how the report string is created - added new ReportService class and setReportService() in OutputModel interface.

Tests done using OnlinePastebinModel with mocked ReportService and mocked PastebinApiHandler to test generateReport() and sendReport() was called.

Added setResponseHandler() to InputModel, have InputModel coordinate passing response body string to ResponseHandler on getCharacterInfo(), return null on null handlers set.

RED Commits URL: ff8fa0cb6ec6f73fa4bc051bb7026733dc31e989 10c90071dfdfb04669d25958fafadbc92cddb921

GREEN Commit URL: 258d3d06826cdb97c2ac5b2f4ef109852b5fd624

Credit set 1

Tests: testIsInfoInCacheExceptions(), testIsInfoInCacheNotFound(), testIsInfoInCacheFound(), testIsInfoInCacheExceptions()

RED Commits URL: 8feccabae0ccf06b732ec6d9a624988a2e5a89a3

GREEN Commit URL: 39e906accc903c17d705e88cb580d5aa54d5d781

Credit set 2

CLEAN RED-GREEN-REFACTOR

Tests: testLoadInfoFromCacheNoCache(), testLoadInfoFromCacheValid(), testLoadInfoFromCacheException() [Mocked InputModel]

Method: loadInfoFromCache() in ModelImpl interaction with isInfoInCache() and loadInfoByNameFromCache() in InputModel

RED Commits URL: 1fabc210c92c81b3a63da7489fab4f388b5115dc

GREEN Commit URL: 378fae3011a2a51a276121efe7b3133f7ac08607

Refactor: Changing implementation of loadInfoFromCache() (return value changed) and using notifyObserversGetInfoComplete() to notify ModelObserver (presenter)

REFACTOR Commit URL: 86acae014038ecfbbbed9648f7bcc47777ccf163

Credit set 3

Added new method setCacheHandler() in InputModel interface for refactoring how CacheHandler object is created (from inside class to injection with method).

Tests: testInputModelGetInfoByNameValid(), testNullApiHandlerSet(), testNullCacheHandlerSet(), testNullResponseHandlerSet()[Mocked handler classes]

Methods: getCharacterInfoByName() in ModelImpl and setCacheHandler() in InputModel

RED Commits URL: 4e61a525d35160dff01a444649bb7b2fc3017e78

GREEN Commit URL: e341c8fbe0d413963d85c903dea2ba643143dbe1

Exam set 1

For index integer selection and searched list tracking feature,

Tests: testNotifySearchedListUpdate(), testSearchedListUpdateOne(), testSearchedListUpdateMoreThanOne(), testSearchedListReplace(), testSetIndexSelectedExceptions() in ModelImplTest

Methods: setIndexSelected(int index); notifyObserversSearchedListUpdated(); List getSearchedList(); in ModelImpl

RED Commits URL: 1921be24c698284db8aefdeeae2094ff55bde3a6

GREEN Commit URL: d40d0ba8bc71398eda660691e8cec003db3485bf

Exam set 2

For adding unmatched names at end of report feature,

Tests: Changed testSendReportFacade, added testSendReportWithNamesList() in ModelImplTest

Changed testOutputModelSendReport(), added testReportServiceGenerateReportArgsOneInList(), TwoInList(), ThreeInList(), ReplacedInList(), NullListExceptions() in OnlinePasteBinModelTest

Methods: Changed sendReport() in OutputModel and generateReport() in ReportService signatures to take in list of unmatched characters names

RED Commits URL: 2109741168e136bee4ff3d54f9a0007b1818da39

GREEN Commit URL: 46987b6ff221a8af67f6683e494f2c85614f1afb

Javadoc location

Javadoc documentation for the project is located under docs folder

Citations for code in previous unit

References

JavaDoc description for character package classes references description of Response Class attributes under Marvel API Interactive Documentation

Dummy version thumbnail image made by Freepik from www.flaticon.com

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!