Bonus quiz specifications: CSCI 265 Fall 2024

The bonus quiz takes the form of a bash scripting exercise, obtained and submitted following our standard 'git submit' cycle.

To obtain credit, the bonus quiz must be completed and submitted (following the processed specified) by 5pm on Saturday December 7th. As it is a bonus, the deadline for the quiz is a hard deadline: no extensions, no exceptions.

Getting and submitting the quiz:

The quiz is obtained and submitted following our typical git submit cycle, using the reponame bonusquiz Obtaining the quiz:

ssh csci fork csci265/bonusquiz csci265/$USER/bonusquiz
git clone csci:csci265/$USER/bonusquiz

Submitting the quiz:

Be sure you have done git adds for the bonus.sh script and also for the contents of the testing subdirectory.
git push

Bash script specifications:

The primary objective for the quiz is to implement the Bash script described below, ensuring it is in the 'bonus.sh' file in the top level of your repo, that the file is executable, and that it has included the /bin/bash specifier at the top of the script.

The script itself is intended to output (to standard output) a markdown table built from the contents of a collection of .md files in a directory provided to the script as a command line argument. More specifically:

The script expects a directory name as its sole command line argument.
It checks that the name given is for a readable, executable directory (providing a suitable error message and exiting if not).

It generates the following text output to begin:

| TestID | TestName | TestFile |
| ------ | -------- | -------- |

It then processes every readable markdown (.md) file within the specified directory, assuming these files represent descriptions of a set of test cases and seeking to extract a test case ID and test case name from the file.
The ID is expected to be a single word on a line of the form
## ID: someword
The name is expected to be a single word on a line of the form
## Name: anotherword
The script finds the first such ID line and the first such name line, and generates the following text output:
```
| someword | anotherword | thedirectoryname/thefilename |
```
(though of course with the actual id, name, directory name, and file name for that particular case).
For example, suppose the script was run on the directory "mycases" (i.e. bonus.sh mycases) which contained four files:
- errbdform.md: contains a line with id E003 and a line with name BadFormat
- messedup: not of the form considered by the script
- valnorm.md: contains a line with id TN01 and a line with name ValidBasic
- valnull.md: contains a line with id TN00 and a line with name ValidEmpty
Then the output of the script would be the following text:
```
| TestID | TestName | TestFile |
| ------ | -------- | -------- |
| E003   | BadFormat | mycases/errbdform.md |
| TN01   | ValidBasic | mycases/valnorm.md |
| TN00   | ValidEmpty | mycases/valnull.md |
```

Testing requirements:

To show that you have made a reasonable effort testing the correctness of your script, the "testing" subdirectory of the repo must contain 6-8 subdirectories, each used as a suitable test case for your script.

The README in the testing subdirectory is to be modified to include a short description of the nature/purpose of each of the test cases.

Note: typically some of the test cases would involve creating test directories and/or files that are not readable. In this particular case that isn't practical, as git won't be able to submit an unreadable file or directory.