Merge pull request #39 from derickson2402/dev

Merge changes for v0.7.0 from dev
derickson2402 · Oct 2, 2022 · ad34e2c · ad34e2c
2 parents c522db4 + 1415add
commit ad34e2c
Show file tree

Hide file tree

Showing 5 changed files with 123 additions and 111 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -42,15 +42,3 @@ jobs:
           docker run --rm ${{ env.TEST_TAG }} valgrind --version
           docker run --rm ${{ env.TEST_TAG }} cppcheck --version
           docker run --rm ${{ env.TEST_TAG }} go version
-
-      - name: Test wrapper script
-        run: |
-          echo "$(date +%y-%m-%d)" > /tmp/caen-last-update-check
-          ./caen version
-          ./caen help
-          ./caen gcc --version
-          ./caen g++ --version
-          ./caen valgrind --version
-          ./caen cppcheck --version
-          ./caen go version
-
diff --git a/Dockerfile b/Dockerfile
@@ -143,7 +143,7 @@ RUN wget https://github.com/danmar/cppcheck/archive/2.4.tar.gz \
 
 ################################################################################
 #
-# Builder container for compiling cppcheck
+# Builder container for compiling golang
 
 FROM caen-dev AS builder-golang
 
@@ -156,23 +156,10 @@ RUN wget https://dl.google.com/go/go1.16.12.linux-amd64.tar.gz \
 
 ################################################################################
 #
-# Default container with all current tools and supported languages
+# Default container with all tools and supported languages
 
 FROM caen-base
 
-# Install dev packages and tools
-RUN dnf --setopt=group_package_types=mandatory \
-        groupinstall --nodocs -y "Development Tools" \
-    && dnf install --nodocs -y perf valgrind \
-    && dnf clean all \
-    && rm -rf /var/cache/yum \
-    && rm -rf /var/lib/rpm/Packages
-
-# Sym link expected location of CAEN compiler just in case
-RUN mkdir -p /usr/um/gcc-6.2.0/bin/ \
-    && ln -s /usr/bin/gcc /usr/um/gcc-6.2.0/bin/gcc \
-    && ln -s /usr/bin/g++ /usr/um/gcc-6.2.0/bin/g++
-
 # Set up cppcheck
 COPY --from=builder-cppcheck /usr/bin/cppcheck /usr/bin/cppcheck
 COPY --from=builder-cppcheck /usr/share/Cppcheck /usr/share/Cppcheck
@@ -181,12 +168,31 @@ COPY --from=builder-cppcheck /usr/share/Cppcheck /usr/share/Cppcheck
 COPY --from=builder-golang /usr/um/go /usr/um/go
 RUN ln -s /usr/um/go/bin/go /usr/bin/go
 
-# Copy and link our compiled gcc to the system default
+# Set our compiled gcc to custom software location
 COPY --from=gcc-builder /usr/um/gcc-6.2.0/ /usr/um/gcc-6.2.0/
-RUN ln -s /usr/um/gcc-6.2.0/bin/gcc /usr/local/bin/gcc \
-    && ln -s /usr/um/gcc-6.2.0/bin/g++ /usr/local/bin/g++ \
-    && ln -s /usr/um/gcc-6.2.0/bin/gfortran /usr/local/bin/gfortran
+
+# Install dev packages and tools, clean dnf cache to save space
+RUN dnf --setopt=group_package_types=mandatory \
+        groupinstall --nodocs -y "Development Tools" \
+    && dnf install --nodocs -y \
+        perf \
+        valgrind \
+        git \
+        vim \
+        which \
+        gnupg2 \
+    && dnf clean all \
+    && rm -rf /var/cache/yum \
+    && rm -rf /var/cache/dnf
+
+# Give bash a pretty prompt
+ENV PS1="\[\e[0;1;38;5;82m\]CAEN ~\[\e[0m\] "
+
+# Configure bash to force CRLF conversions, fix Perf bug (#28)
+RUN git config --global core.autocrlf true \
+    && mkdir -p /usr/share/doc/perf-tip/ \
+    && echo "CAEN in Docker" > /usr/share/doc/perf-tip/tips.txt
 
 # Run the container in the user's project folder
 WORKDIR /code
-CMD ["/bin/bash"]
+CMD ["/bin/bash", "-c"]
diff --git a/README.md b/README.md
@@ -2,79 +2,87 @@
 
 [![Publish Latest](https://github.com/derickson2402/Dockerized-CAEN/actions/workflows/publish.yml/badge.svg)](https://github.com/derickson2402/Dockerized-CAEN/actions/workflows/publish.yml) [![Build test image](https://github.com/derickson2402/Dockerized-CAEN/actions/workflows/testing.yml/badge.svg)](https://github.com/derickson2402/Dockerized-CAEN/actions/workflows/publish-dev.yml)
 
-Tired of using ssh and Duo mobile when testing your code with CAEN? Programming on macOS or Windows and missing out on Linux tools? With this script, you can easily run anything on Linux. All you have to do is run it like this:
+Tired of using ssh and Duo mobile when testing your code with CAEN?
+Love using VS Code on your own laptop?
+Use this project and you'll never have an issue again!
 
-```bash
-caen [program] [args]
-```
+# Installation
 
-This will run your command in an environment identical to CAEN Linux. For example, if you are working on a C++ project for EECS 281, you could use:
+Before using, you will need Docker Desktop installed (
+[macOS](https://docs.docker.com/desktop/mac/install/),
+[Windows](https://docs.docker.com/desktop/windows/install/),
+[Linux](https://docs.docker.com/engine/install/)
+).
+Now copy the file ```devcontainer.json``` into your repository as ```.devcontainer/devcontainer.json```.
+You can do this automatically by moving into your repository and running the following:
 
 ```bash
-caen make my_program.cpp
-caen my_program < input.txt
-caen valgrind my_program
-caen perf record my_program
-caen go build my_other_program.go
-caen ./my_other_program < input.txt | caen my_program
+/bin/bash -c 'mkdir .devcontainer && wget https://raw.githubusercontent.com/derickson2402/Dockerized-CAEN/main/devcontainer.json -O .devcontainer/devcontainer.json'
 ```
 
-## Installation
+Great!
+Now when you open your project in VS Code, it will ask if you want to open the project in the container.
+This will reopen the window and say ```Dev Container: CAEN``` in the bottom left corner.
+Everything you do is now running in a CAEN environment!
+If you don't see the prompt, you can also open the command palette and run ```Remote-Containers: Reopen in Container```.
+Happy coding!
 
-To use this script, you need to have Docker installed on your [macOS](https://docs.docker.com/desktop/mac/install/), [Windows](https://docs.docker.com/desktop/windows/install/), or [Linux](https://docs.docker.com/engine/install/) computer. Windows users, you will need to make sure to upgrade your existing WSL1 installation to WSL2 BEFORE installing Docker (see [#25](https://github.com/derickson2402/Dockerized-CAEN/issues/25)). Linux users, you will need to add yourself to the ```docker``` group (see [here](https://www.configserverfirewall.com/ubuntu-linux/add-user-to-docker-group-ubuntu/)).
+## How Does This Work?
 
-With Docker installed, simply run the following command in a shell:
+Great question!
+It uses a [Docker Container](https://www.docker.com/resources/what-container/), which is like a virtual environment running Linux.
+This environment is set up with CentOS (the free version of RHEL on CAEN) and all of the tools that you normally use on CAEN.
+That means that there is no difference running a program in the container versus on actual CAEN servers.
+It also means that the Autograder compiler works the same as in the container!
 
-```bash
-sudo /bin/bash -c 'wget \
-https://raw.githubusercontent.com/derickson2402/Dockerized-CAEN/main/caen \
--O /usr/local/bin/caen && chmod +x /usr/local/bin/caen'
-```
+## Need A Program That's Not Installed?
 
-## How Does This Work?
+There's a simple solution to that!
+The ```devcontainer.json``` file contains instructions for installing more tools.
+You can also log an issue [here](https://github.com/derickson2402/Dockerized-CAEN/issues/new) with the name of said program and any special tools that might go along with it.
+I will add it as a default as soon as I can!
 
-This script runs your command inside of a Docker Container, which is like a virtual environment running Linux. This environment is set up with CentOS (very similar to RHEL on CAEN) and all of the tools that you normally use on CAEN. That means that there should be no difference running a program in the container versus on actual CAEN servers, and that the Autograder compiler should work the same as in the container!
+# ```caen``` script for macOS users
 
-## Help! I Need A Program That's Not Installed!
+Programming on macOS and just want to use CAEN tools on the command line?
+You can use the ```caen``` script to use the devcontainer from a terminal (however you cannot use custom tools this way).
+You can run commands like this and it will execute in CAEN:
 
-Oops! Sorry about that! Please log an issue [here](https://github.com/derickson2402/Dockerized-CAEN/issues/new) with the name of said program and any special tools that might go along with it. I will add it as soon as I can!
+```bash
+caen [program] [args]
+```
+
+To use this script, you need to have Docker installed (see above).
+With Docker installed, simply run the following command to download the script:
 
-## Useful Tips
+```bash
+sudo /bin/bash -c 'wget \
+https://raw.githubusercontent.com/derickson2402/Dockerized-CAEN/main/caen \
+-O /usr/local/bin/caen && chmod +x /usr/local/bin/caen'
+```
 
-You can run ```caen bash``` to start a new bash shell in the container! This can be handy if you have a lot of commands to run, or if you are having issues with redirecting stdin, stdout, or stderr, or you are trying to use piping.
+## Script Tips
 
-Executables generated with this container are compiled for CAEN servers and won't work on your host system. You should run your ```make clean``` script before switching back and forth, and then run ```make``` from the environment you want to use.
+You can run ```caen bash``` to start a new bash shell in the container!
+This can be handy if you have a lot of commands to run, or if you are having issues with redirecting stdin, stdout, or stderr, or you are trying to use piping.
 
-There are a few environment variables that you can use to change the behavior of the container. To permanently set an option, add it to a file in your home directory ```~/.caen.conf```. To set an option just for the current workspace, you can set them in the file ```$(pwd)/.caen.conf```. You can also use ```export VARIABLE=value``` to make the settings stick around just until you close your shell, or you can use ```VARIABLE=value caen ...``` to just use it once. The currently supported variables are given below:
+There are a few environment variables that you can use to change the behavior of the container.
+To permanently set an option, add it to a file in your home directory ```~/.caen.conf```.
+To set an option just for the current workspace, you can set them in the file ```$(pwd)/.caen.conf```.
+You can also use ```export VARIABLE=value``` to make the settings stick around just until you close your shell, or you can use ```VARIABLE=value caen ...``` to just use it once.
+The currently supported variables are given below:
 
 Variable Name | Default Value | Description
 --------------|---------------|------------
 CAEN_VERSION  | latest        | Container tag to use, either of the form ```v0.5```, or a branch name like ```dev``` or ```feature-example```
 CAEN_ARGS     | --            | Optional arguments to pass to the ```docker run``` command. Be careful with these, they will likely collide with existing options
 CAEN_USER     | your-uid:your-gid | Defaults to your current ```UID:GID```. You can specify just ```UID``` or both, just need to use the number
+CAEN_REPO_NAME | ghcr.io/derickson2402/dockerized-caen | Can be changed for locally testing new containers
 
-For example, your workspace configuration might look like this because you need to run as a different user:
+# Contributing
 
-```env
-CAEN_USER=65535
-```
-
-Or maybe you want to use a different container version until you close your shell:
+I started working on this project while taking EECS-281, in order to make debugging my programs easier.
+I am sharing this project online in hopes that others will find it useful, but note that I don't have much free time to develop this project.
 
-```bash
-export CAEN_VERSION=dev
-caen ls
-caen my-program
-```
-
-## Contributing
-
-I started working on this project while taking EECS-281, in order to make debugging my programs easier. I am sharing this project online in hopes that others will find it useful, but note that I don't have much free time to develop this project.
-
-With that said, if you have an idea that would make this project even better, feel free to log an issue or submit a Pull Request. I greatly appreciate any help on developing this project!
-
-If you are developing locally, it might be helpful to know that you can specify the name of the container to use just like you can specify the tag:
-
-```bash
-CAEN_REPO_NAME=my-container-name caen my-program
-```
+With that said, if you have an idea that would make this project even better, feel free to log an issue or submit a Pull Request.
+I greatly appreciate any help on developing this project!
diff --git a/caen b/caen
@@ -1,5 +1,5 @@
 #!/bin/bash
-CAEN_SCRIPT_VER=v0.6.3
+CAEN_SCRIPT_VER=v0.7.0
 
 # Shell settings to improve safety
 set -fu -o pipefail
@@ -48,9 +48,7 @@ For more help, check me out on GitHub:
 EOF
 )
 MESSAGE_OS_ERROR=$(cat << EOF
-Hold up! We couldn't figure out what computer you're running! You
-can probably still run the container manually though, check me out
-on GitHub for help:
+Hold up! This script is only supported for macOS. See GitHub for more help:
 
     ${CAEN_URL}
  
@@ -61,17 +59,9 @@ EOF
 [[ -f /tmp/caen-last-update-check ]] || touch /tmp/caen-last-update-check
 CAEN_SCRIPT_LAST_UPDATE=$(cat /tmp/caen-last-update-check)
 
-# Get OS information and store it to HOST_OS as 'linux', 'windows', or 'mac'
-# This is different from OSTYPE since for example WSL and Ubuntu are both
-# of the form 'linux-gnu*'
+# Get OS information and verify we are on macOS
 function identifyOS() {
-    if [[ "$OSTYPE" == "linux-gnu"* ]]; then
-        if [[ "${WSL_DISTRO_NAME:=unknown}" == "unknown" ]]; then
-            HOST_OS=linux
-        else
-            HOST_OS=windows
-        fi
-    elif [[ "$OSTYPE" == "darwin"* ]]; then
+    if [[ "$OSTYPE" == "darwin"* ]]; then
         HOST_OS=mac
     else
         echo -e "$MESSAGE_OS_ERROR" && exit 1
@@ -118,24 +108,12 @@ function checkDocker() {
     if ( ! command -v docker &> /dev/null ); then
         echo -e "Hold up! Docker is not installed on your computer!"
         echo -e "You can download and install it here:"
-        if [[ "$HOST_OS" == "windows" ]]; then
-            echo -e "\n    https://docs.docker.com/desktop/#download-and-install\n"
-        elif [[ ${HOST_OS} == "mac" ]]; then
-            echo -e "\n    https://docs.docker.com/desktop/mac/install/\n"
-        else
-            echo -e "\n    https://docs.docker.com/engine/install/\n"
-        fi
+        echo -e "\n    https://docs.docker.com/desktop/mac/install/\n"
         return
     fi
     if ( ! docker ps &> /dev/null ); then
         echo -e "Waking up Moby the Whale..."
-        if [[ "$HOST_OS" == "mac" ]]; then
-            open /Applications/Docker.app
-        elif [[ "$HOST_OS" == "windows" ]]; then
-            bash -c '/mnt/c/Program\ Files/Docker/Docker/Docker\ Desktop.exe &'
-        elif [[ "$HOST_OS" == "linux" ]]; then
-            sudo systemctl start docker
-        fi
+        open /Applications/Docker.app
         # Docker takes up to about 1m to boot, need to wait for it
         sleep 10
         declare -i counter=0
@@ -152,7 +130,6 @@ function checkDocker() {
             fi
         done
         echo "Hi Moby!"
-        return
     fi
 
     # All checks have passed, Docker is ready to go

diff --git a/devcontainer.json b/devcontainer.json
@@ -0,0 +1,33 @@
+{
+	// Specify the CAEN container to develop in. You can replace "latest" with another tag if you need a different version (you probably don't though)
+	"name": "CAEN",
+	"image": "ghcr.io/derickson2402/dockerized-caen:latest",
+
+	// Add your extensions below. You can find the extension name by searching
+	// the extension store, and copy/pasting the "identifier" on the right side.
+	// Some useful extensions are already included
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-vscode.cpptools-extension-pack",
+				"violetbp.lc2k",
+				"mhutchie.git-graph",
+				"nhoizey.gremlins"
+			]
+		}
+	},
+
+	// Here you can add scripts to run when the container is built. This is good
+	// for installing extra tools you need or making some specific change for
+	// your workflow. Remember you can also request the tools be included by
+	// default by logging an issue at:
+	//     https://github.com/derickson2402/Dockerized-CAEN/issues
+	// In this case, we are installing the tree command (even though it is
+	// there by default, so this is not a useful example...):
+	// "initializeCommand": "dnf update -y && dnf install -y tree",
+
+	// Give us a pretty bash prompt (since VSCode is overriding shell)
+	"remoteEnv": {
+		"PS1": "\\[\\e[0;1;38;5;82m\\]CAEN ~\\[\\e[0m\\] " // Note the '\\'
+	}
+}