Assignment #1 - Unix, Shell, Git & GitHub

.github/issue_template.yaml

@@ -0,0 +1,46 @@
+name: Bug Report
+description: Report a bug
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - danielrazavi
+  - rohanalexander
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the sections below to help everyone identify and fix the bug
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe your issue
+      placeholder: When I click here this happens
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. Go to page X
+        2. Click here
+        3. Click there
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What was the expected result?
+      placeholder: I expected this to happen
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Put here any screenshots or videos (optional)
+  - type: textarea
+    id: assignee
+    attributes:
+      label: Put here the code owner you'd like to review this issue.
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting this issue! We will get back to you as soon as possible.

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+<!-- PULL REQUEST TITLE: UofT-DSI | <Module Name> - Assignment <assignment number>-->
+
+## What changes are you trying to make? (e.g. Adding or removing code, refactoring existing code, adding reports)
+
+## What did you learn from the changes you have made?
+
+## Was there another approach you were thinking about making? If so, what approach(es) were you thinking of?
+
+## Were there any challenges? If so, what issue(s) did you face? How did you overcome it?
+
+## How were these changes tested?
+
+## A reference to a related issue in your repository (if applicable)
+
+## Checklist
+- [ ] I can confirm that my changes are working as intended

.github/workflows/autograder.yml

@@ -0,0 +1,40 @@
+name: Assignment autograder
+on: 
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  autograder:
+    name: Assignment autograder
+    if: startsWith(github.head_ref, 'assignment') && github.repository_owner != 'UofT-DSI'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Setup working directory for script
+        run: |
+          UUID=$(uuidgen)
+          echo "UUID=$UUID" >> $GITHUB_ENV
+          mkdir /tmp/$UUID
+          cp $GITHUB_WORKSPACE/02_activities/assignments/assignment.sh /tmp/$UUID
+      - name: Run assignment script
+        run: |
+          bash -c "bash assignment.sh 2>&1 | tee /tmp/${{ env.UUID }}_output.txt"
+        working-directory: /tmp/${{ env.UUID }}
+      - name: Grade responses
+        id: grade
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO_OWNER: ${{ github.repository_owner }}
+          REPO_NAME: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          REPO_BRANCH: ${{ github.event.pull_request.head.ref }}
+          WORKING_DIR: /tmp/${{ env.UUID }}
+        run: |
+          wget -O /tmp/autograder.py https://github.com/UofT-DSI/shell/raw/refs/heads/main/03_instructional_team/autograder/autograder.py
+          uv run --python 3.12 --with pandas,tabulate,requests /tmp/autograder.py

.github/workflows/automatic_pr_comment.yaml

@@ -0,0 +1,77 @@
+name: UofT-DSI Main Repository PR Workflow
+
+on:
+  pull_request_target:
+    types: [opened, reopened]
+
+jobs:
+  handle-pr:
+    if: github.repository_owner == 'UofT-DSI'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Handle PR based on branch and author
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            const branchName = pr.head.ref;
+            const issue_number = pr.number;
+            const repo = context.repo;
+            const sender = context.payload.sender.login;
+
+            let isMember = false;
+            let isContributor = false;
+
+            // Check if user is a member of the org
+            try {
+              const membership = await github.rest.orgs.getMembershipForUser({
+                org: repo.owner,
+                username: sender
+              });
+              isMember = membership && membership.status === "active";
+            } catch (error) {
+              // If not a member, GitHub API throws a 404
+              isMember = false;
+            }
+
+            // Check if user is a contributor to the repo
+            try {
+              const contributors = await github.paginate(
+                github.rest.repos.listContributors,
+                {
+                  owner: repo.owner,
+                  repo: repo.repo,
+                  anon: false
+                }
+              );
+              isContributor = contributors.some(contributor => contributor.login === sender);
+            } catch (error) {
+              isContributor = false;
+            }
+
+            if ((!isMember && !isContributor) || branchName.startsWith('assignment')) {
+              const commentBody = `This pull request was made to the wrong repository. If you are a participant, please close it and open it in your own fork instead. Refer to the [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md) for detailed instructions.`;
+
+              await github.rest.issues.createComment({
+                owner: repo.owner,
+                repo: repo.repo,
+                issue_number: issue_number,
+                body: commentBody
+              });
+
+              await github.rest.pulls.update({
+                owner: repo.owner,
+                repo: repo.repo,
+                pull_number: issue_number,
+                state: "closed"
+              });
+            } else {
+              const commentBody = `Thanks for your contribution! 🎉\n\nPlease remember to tag or request a review from the DSI team. Give us up to 72 hours to review your pull request. We appreciate your patience and efforts.`;
+
+              await github.rest.issues.createComment({
+                owner: repo.owner,
+                repo: repo.repo,
+                issue_number: issue_number,
+                body: commentBody
+              });
+            }

.github/workflows/deploy_github_pages.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  push:
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    if: |
+      (github.repository == 'UofT-DSI/shell' && github.ref == 'refs/heads/main') ||
+      (github.repository != 'UofT-DSI/shell' && github.ref == 'refs/heads/githubpages')
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './03_instructional_team/githubpages'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,20 @@
 .DS_Store
+.vscode/
+03_instructional_team/lessons/pdf/*
+03_instructional_team/lessons/html/*
+
+# local node modules
+node_modules/
+package-lock.json
+package.json
+
+### Running the assignment script unzips a large number of files into the tree
+# Ignore all files in shell/02_activities/assignments/
+02_activities/assignments/*
+
+# Un-ignore the specific files
+!02_activities/assignments/assignment.sh
+!02_activities/assignments/github_actions.png
+!02_activities/assignments/assignment_instructions.md
+
+.venv

01_materials/bash_quick_reference.md

@@ -0,0 +1,84 @@
+# Bash Commands Reference
+
+## 📋 Commands Overview
+
+```bash
+$ echo Rachael
+Rachael
+
+$ date
+Tue, Nov 19, 2024 6:28:10PM
+
+$ asdkfjhgoipwhr
+Command not found
+
+$ man ls
+# Opens the manual for `ls`
+# To exit, press 'q'
+
+$ help
+# Lists available shell commands
+```
+
+---
+
+## 📁 File & Directory Navigation
+
+| Command                | Description                                                |
+|------------------------|------------------------------------------------------------|
+| `pwd`                 | Show current working directory                             |
+| `ls`                  | List folders & files in the working directory              |
+| `cd`                  | Move to home directory                                     |
+| `cd Desktop`          | Move into Desktop directory                                |
+| `cd <path>`           | Move into a specific path                                  |
+| `cd ..`               | Move one level up (parent directory)                       |
+
+---
+
+## 🛠 File & Directory Management
+
+| Command                             | Description                                         |
+|-------------------------------------|-----------------------------------------------------|
+| `mkdir <dir_name>`                 | Make new directories                                |
+| `touch <file_name>`               | Create a file                                       |
+| `rm <directory_name>`             | Remove a directory                                  |
+| `rm <file_name>`                  | Remove a file                                       |
+| `cp <source> <destination>`       | Copy file from source to destination                |
+| `cp <dir_source>/* <dir_dest>`    | Copy all files from source dir to destination dir   |
+| `mv <file1> <file2>`              | Rename/move file1 to file2                          |
+| `cat <file_name>`                 | Display content of the file                         |
+| `echo "text" > file.txt`          | Replace content in file with text                   |
+| `echo "text" >> file.txt`         | Append text to file                                 |
+
+---
+
+## ✏️ Editing Files
+
+| Command            | Description                        |
+|--------------------|------------------------------------|
+| `nano <file_name>` | Open file in nano text editor      |
+| `code <file_name>` | Open file in VS Code               |
+
+---
+
+## 🧰 Useful Options
+
+| Option | Description                                               |
+|--------|-----------------------------------------------------------|
+| `-i`   | Prompt before overwriting an existing file                |
+| `-r`   | Recursively copy directories and their contents           |
+| `-v`   | Show informative messages during operations               |
+| `-f`   | Force action (overrides `-i` if both are used together)   |
+
+---
+
+## 🔧 Hash-bang (Shebang)
+
+Place this at the top of every Bash script to indicate which shell to use:
+
+```bash
+#!/bin/bash
+```
+
+---
+

02_activities/assignments/assignment.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -x
+
+############################################
+# DSI CONSULTING INC. Project setup script #
+############################################
+# This script creates standard analysis and output directories
+# for a new project. It also creates a README file with the
+# project name and a brief description of the project.
+# Then it unzips the raw data provided by the client.
+
+if [ -d newproject ]; then
+  echo "Directory 'newproject' already exists. Please remove it before running this script."
+  exit 1
+fi
+mkdir newproject
+cd newproject
+
+mkdir analysis output
+touch README.md
+touch analysis/main.py
+
+# download client data
+curl -Lo rawdata.zip https://github.com/UofT-DSI/shell/raw/refs/heads/main/02_activities/assignments/rawdata.zip
+unzip -q rawdata.zip
+
+###########################################
+# Complete assignment here
+
+# 1. Create a directory named data
+mkdir data
+
+# 2. Move the ./rawdata directory to ./data/raw
+mv rawdata data/raw
+
+# 3. List the contents of the ./data/raw directory
+ls -l ./data/raw
+
+# 4. In ./data/processed, create the following directories: server_logs, user_logs, and event_logs
+mkdir -p ./data/processed/{server_logs,user_logs,event_logs}
+
+# 5. Copy all server log files (files with "server" in the name AND a .log extension) from ./data/raw to ./data/processed/server_logs
+cp ./data/raw/*server*.log ./data/processed/server_logs/
+
+# 6. Repeat the above step for user logs and event logs
+
+# 7. For user privacy, remove all files containing IP addresses (files with "ipaddr" in the filename) from ./data/raw and ./data/processed/user_logs
+
+# 8. Create a file named ./data/inventory.txt that lists all the files in the subfolders of ./data/processed
+
+
+###########################################
+
+echo "Project setup is complete!"