Description

You must keep your repo inside of your directory located in $HOME/private on the mac1xa3.ca server

• WARNING not doing so or changing the default permissions on the private directory will be considered academic dishonesty
• If you accidentently delete the directory, contact me or one of your TA’s (preferably me / dalvescb on discord)

1.2           Create a new folder in your repo

On the master branch, create a new folder CS1XA3/Project01 (where CS1XA3 is the already existant root of repo)

1.3           Add the folowing files

• Add CS1XA3/Project01/project_analyze.sh
• Add CS1XA3/Project01/README.md

1.4           Commit and Push

• Add and commit with the following message EXACTLY “Initial Project01 Commit”
• Push to GitHub

1.5           Create a Branch

• Create a branch called project01
• Push the branch to github (i.e git push origin project01)
• Work from the project01 branch and only merge with master when your ready to submit Part 1 or Part 2

Merge to the master branch a WORKING SCRIPT that:

• implements at least 20 points worth of 5 point features including the Script Input feature
• documents the features you implement and script usage in the md
• documents the two custom features you plan to implement (although you don’t need to implement them yet)
• has a commit/merge message “Submitting Project 01 Part 1” EXACTLY WARNING make sure to push to GitHub to complete your submission

3           Part 2 Submission

Merge to the master branch a WORKING SCRIPT that:

• implements at least 20 points more worth of features including at least one 10 point feature
• implements 2 custom features that should be around the same level of difficulty as the 10 point features
• has completed documentation of all features in the md
• has a commit/merge message “Submitting Project 01 Part 2” EXACTLY

WARNING make sure to push to GitHub to complete your submission

4           README

You MUST document your code in a file CS1XA3/Project01/README.md

• The document should be styled with MarkDown (see https://guides.github.com/features/ mastering-markdown/)
• The document should describe usage of the script (i.e how to execute, with what arguments, under what conditions)
• The document should contain a section (header) for each feature (including custom features)
• You must reference any code used that was found online with a link to the url (failing to do so will be considered academic dishonesty)

An example of the general outline of the document would be as follows (this is not an exact template you need to follow, you are encouraged to use your best judgment for constructing a useful README):

# CS 1XA3 Project01 – <MyMacId>

## Usage

Execute this script from project root with:

chmod +x CS1XA3/Project01/project_analyze.sh

./CS1XA3/Project01/project_analyze arg1 arg2 …

With possible arguments arg1: ….

arg2: ….

….

## Feature 01

Description: this feature does ….

Execution: execute this feature by …

Reference: some code was taken from [[https://someurl.com]]

## Feature 02 …

## Custom Feature SomeFeature …

5.1           Criteria: README Documentation

• 30% for using good style (i.e using proper markdown, proper sectioning of functionality etc)
• 30% for specifying execution/usage information correctly
• 40% for proper detail: what each feature does, as well as pitfalls for the feature not functioning correctly, while still be concise and not containing superfluous information

5.2           Criteria: Custom Features

• Each of the two custom features is worth 20% of the overall project mark
• Per each feature:
  • 50% for the creativity / difficulty level of the feature you came up with
  • 50% for implementing the feature correctly

5.3           Criteria: Other Features

• You will implement 40 points of features directly corresponding to 40% of your overall project mark
• Features will be marked on level of correctness. Partial marks will be taken off for failing to include edge case, including but not limited to:
  • failing to account for directories/files including special characters (i.e whitespace)
  • failing to account for directories/files not existing / already existing
  • failing to account for command IO failure

5.4           Plagiarism / Academic Dishonesty

Tools will be used to compare your code with your peers (including previous years of this course)

• Stealing a custom feature idea will be considered plagiarism
• Using code without referencing the source in your README will be considered plagiarism.
• Any account of plagiarism will result in an automatic grade of 0

6           Features

6.1           Script Input (Mandatory) (5 Points)

• Make the script interactive (i.e select which feature(s) are executed) either by providing script arguments or by user prompted input
• Describe this feature in the Usage section of the md document rather than in it’s own header

6.2           FIXME Log

• Find every file in your repo that has the word #FIXME in the last line
• Put the list of these file names in CS1XA3/Project01/fixme.log with each file separated by a newline
• Create the file CS1XA3/Project01/fixme.log if it doesn’t exist, overwrite it if it does

6.3           Checkout Latest Merge

• Find the most recent commit with the word merge (case insensitive) in the commit message
• Automatically checkout that commit (so that you’re in a detached head state)

6.4           File Size List

• List all files in the repo (just files not directories) and their sizes in a human readable format (i.e KB, MB, GB, etc)
• List the files sorted from largest to smallest

6.5           File Type Count

• Using the read command (with a prompt), prompt the user for an extension (i.e txt, pdf, py, etc)
• Output the number of files in your repo with that extension

6.6           Find Tag

• Using the read command (with a prompt, prompt the user for a Tag (any single word)
• Create a log file CS1XA3/Project01/Tag.log (where Tag is the name of the Tag provided) if it doesn’t already exist, overwrite it if it does
• For each python file (i.e ending in .py) in the repo, find all lines that begin with a comment (i.e #) and include Tag and put them in CS1XA3/Project01/Tag.log

6.7           Switch to Executable

• Find all shell scripts (i.e ending in .sh) in the repo
• Create a file CS1XA3/Project01/permissions.log if it doesn’t already exist
• Using the read command, prompt the user to Change or Restore (use a prompt that tells the user what to do)
• If the user selects Change:
  • For each shell script, change the permissions so that only people who have write permissions also have executable permissions (i.e if only user has write permissions, then only user has executable permissions)
  • Store a log of the file and it’s original permissions in CS1XA3/Project01/permissions.log (overwrite it if it already exists)
• If the user selects Restore
  • Restore each file to its original permissions (as specified in CS1XA3/Project01/permissions.log)

6.8           Backup and Delete / Restore

• Using the read command, prompt the user to Backup or Restore (use a prompt that tells the user what to do)
• If the user selects Backup:
  • Create an empty directory CS1XA3/Project01/backup if it doesn’t exit
  • Empty the directory CS1XA3/Project01/backup if it does exist
  • Find all files that end in the .tmp extension

∗ copy them to the CS1XA3/Project01/backup directory

∗ delete them from their original location

∗ create a file CS1XA3/Project01/backup/restore.log that contains a list of paths of the files original locations

• If the user selects Restore:
  • use the file CS1XA3/Project01/backup/restore.log to restore the files to their original location
  • if the file does not exist, through an error message