Data & File Management Plan - Openbook
<aside> <img src="/icons/exclamation-mark_gray.svg" alt="/icons/exclamation-mark_gray.svg" width="40px" /> NOTE: The acronym ‘OTE’ is used to refer to Openbook Textbook Engine
</aside>
| No. | System | What was tested | How it was tested | Sample data | Expected resulted | Actual result | Type of error | Fix | Error | Pass? |
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Site | Log in wrong password | Incorrect password for account | THISISNOTMYPASSWORD | Fail sign-in | Failed sign-in | Y | |||
| 2 | Site | Log in correct password | Correct password for account | adminuser#210! | Successful sign-in and redirected to profile page | Successful sign-in and redirected to profile page | Y | |||
| 3 | Site | Generate new profile picture | Click ‘Regenerate’ button on profile edit page and then click ‘Save’. Verify that the profile picture is updated | N/A | New profile picture is generated and displayed | New profile picture is generated and displayed | Y | |||
| 4 | Site | Update user details | Replace username and year level on profile edit page and then click ‘Save’. Verify that the profile picture is updated | Username: william h |
Year level: 11 | Details are updated and displayed | Details are updated and displayed | | | | Y | | 5 | Site | Submit a textbook from repository for approval | On upload centre, fill in the repository URL with a valid textbook GitHub repository and click submit | GitHub Repository URL: https://github.com/william-herring/example-textbook | Redirected to submission confirmation page and message verifying that the textbook has been submitted is displayed | Redirected to submission confirmation page and message verifying that the textbook has been submitted is displayed | | | | Y | | 6 | Site | Approve textbook as admin user | Logged in as a user with the administrator role, click ‘Approve’ on the submission from before on uploads centre | N/A | Submission is removed from pending approvals list and is displayed in library | Submission is removed from pending approvals list and is displayed in library | | | | Y | | 7 | Site | Use chapters list with corresponding page numbers for a textbook | On the textbook viewer page, click on a chapter title underneath the ‘Chapters’ tab | N/A | The relevant textbook page containing the chapter heading is loaded | The wrong page is loaded (one page further than the expected result) | Logic Error | Update the way that chapters are mapped to page numbers in the textbook engine. Instead of just mapping a chapter to a display number, map to the absolute page index as well to resolve navigation errors. | No error message, incorrect result | N | | 8 | Site | Use chapters list with corresponding page numbers for a textbook | On the textbook viewer page, click on a chapter title underneath the ‘Chapters’ tab | N/A | The relevant textbook page containing the chapter heading is loaded | The relevant textbook page containing the chapter heading is loaded | | | | Y | | 9 | Site | Access the PDF export of a textbook | On the textbook viewer page, click on the download icon in the top right and then click the ‘PDF’ button | N/A | The textbook PDF is loaded in another tab | The textbook PDF is loaded in another tab | | | | Y | | 10 | Site | Answer an interactive question incorrectly | On the textbook viewer page, switch to the ‘Questions’ page and answer the first question with an incorrect answer. Submit the answer by pressing enter | Question: Who is the GOAT of Software Development (provided as part of the example textbook used in previous tests)
Answer: William Herring | The ‘Incorrect’ dialogue is displayed with the correct answer given underneath | The ‘Correct’ dialogue is displayed | Logic Error | Change the script responsible for hiding and showing answer feedback so that it does not reference the wrong element id when attempting to display the ‘Incorrect’ dialogue | No error message, incorrect result | N | | 11 | Site | Answer an interactive question incorrectly | On the textbook viewer page, switch to the ‘Questions’ page and answer the first question with an incorrect answer. Submit the answer by pressing enter | Question: Who is the GOAT of Software Development (provided as part of the example textbook used in previous tests)
Answer: William Herring | The ‘Incorrect’ dialogue is displayed with the correct answer given underneath | The ‘Incorrect’ dialogue is displayed with the correct answer given underneath | | | | Y | | 12 | Site | Answer an interactive question correctly | On the textbook viewer page, switch to the ‘Questions’ page and answer the first question with an incorrect answer. Submit the answer by pressing enter | Question: Who is the GOAT of Software Development (provided as part of the example textbook used in previous tests)
Answer: R Shelly | The ‘Correct’ dialogue is displayed | The ‘Correct’ dialogue is displayed | | | | Y | | 13 | Site | Log out | Using the side navigation (accessed with the menu icon button in the top-left), click ‘Log out’ at the bottom of the navigation bar | N/A | User session deleted and redirected to log in screen | User session deleted and redirected to log in screen | | | | Y | | 14 | Site | Create an account | Fill in the registration form with an email and password | Email: [email protected]
Password: th1s1sMYv3ryS3CUREpsWd!@# | User with credentials is added to database and redirected to profile page | User with credentials is added to database and redirected to profile page | | | | Y | | 15 | OTE | Create a textbook | Run ‘ote create my-textbook’ in the terminal | N/A | A new folder containing a basic textbook structure is created | An error is raised | Logic Error | Add an empty “tempfile” to the sample textbook ‘out’ directory so that it can be discovered during packaging and included as part of the package (the program needs this directory to output the HTML files) | FileNotFoundError | N | | 16 | OTE | Create a textbook | Run ‘ote create my-textbook’ in the terminal | N/A | A new folder containing a basic textbook structure is created | A new folder containing a basic textbook structure is created | | | | Y | | 17 | OTE | Export a textbook to HTML containing a YouTube video embed | Modify the first (after pre-content) chapter file to contain an embed and then run ‘ote build’ in the terminal | Markdown content (book/chapters/1.md):
This is a test. [[embed("https://www.youtube.com/embed/CrMAy18VRg4")]] | HTML files are generated and 1.html renders a valid HTML video embed | HTML files are generated and 1.html renders a valid HTML video embed | | | | Y | | 18 | OTE | Divide a single chapter file into multiple pages | Modify the first (after pre-content) chapter file to contain page breaks and then run ‘ote build’ in the terminal | Markdown content (book/chapters/1.md):
This is a test. [[embed("https://www.youtube.com/embed/CrMAy18VRg4")]]
[[pg]]
This is a new page…
blah blah blah [[pg]] Ok this is the last page now. | HTML files are generated and the content of 1.md is split correctly between 1.html, 2.html and 3.html | HTML files are generated and the content of 1.md is split correctly between 1.html, 2.html and 3.html | | | | Y | | 19 | OTE | Add an interactive question to the textbook | Modify the first (after pre-content) chapter file to contain an interactive question and then run ‘ote build’ in the terminal. Test the question by uploading to the site and performing test 10 and 11 | Markdown content (book/chapters/1.md):
This is a test.