Adding additional configuration polish to the dev container

Author: sc2automation

dev/Dockerfile

@@ -24,7 +24,26 @@ RUN \
     vim \
     wget
 
+ARG SYSTEM_USER_NAME=gituser
+ARG GIT_USER_NAME="Git User"
+ARG [email protected]
+
+# Create the new git user
+RUN useradd -ms /bin/bash $SYSTEM_USER_NAME
+
+# Change the game folder ownership
+RUN chown -R $SYSTEM_USER_NAME:$SYSTEM_USER_NAME /SC2
+
+# Setup the git commit environment
+USER $SYSTEM_USER_NAME
+RUN git config --global user.name "$GIT_USER_NAME"
+RUN git config --global user.email "$GIT_EMAIL"
+
+# Generate a new SSH key pair without user input
+RUN cat /dev/zero | ssh-keygen -q -N "" > /dev/null
+
 # Add the code
-WORKDIR /s2client-api
+WORKDIR /home/$SYSTEM_USER_NAME
 
+# Override the s2client-game entrypoint
 ENTRYPOINT [ "/bin/bash" ]

dev/README.md

@@ -0,0 +1,90 @@
+# Setting up your development environment
+
+The developer container is a combination of s2client-game and s2client-api. 
+
+The API code has been omitted because it's assumed you will be cloning the repo
+and working with GIT to manipuate the API code.
+
+This container will copy your git configuration and system username to the 
+development container. If you want to override this process see below.
+
+To get setup for developing API code on linux:
+
+~~~
+    ./all.sh
+~~~
+
+You will see your github.com public key as the last step of the build process:
+
+~~~
+...
+Successfully built 11c71c8b3a9b
+==== Your github.com SSH public key for the container is:
+ssh-rsa XXXXXXXXXXXX2EAAAADAQABAAABAQDf1N64V0NHQEcat3oiE+gTU/q7VPpXvJztRtaQ0X0/rHqGohFI+RVTCAGTsUyzNeVxJDuiPMhV/j9X1rqVV73pcLyM7flgYnriroo19Y3S9np4dPgyR+IeSztBhfCaLSmrVhvscIUlFCcXM8o1mgy8/mUSn5UJJxBdGdRfRt8TrWT7WVnbkLKNv6xUoBWssSNJds6itD/qBjEkZfD4BCP3dXEJL6U6y+HYnIGqv3lByxHhLK+dJ5pU2lGtyypj1/0IsWQVW4F6EaEBtyEy8cOmh17j9FusfhJkply2Xf2q81jm6nHRNsfd1thOAFe2quc0cTfZzX4ZqC9RE9gxwXI/ jrepp@8089fe031125
+~~~
+
+You should copy the ssh-rsa .. user@container_id into your github.com settings under the section for SSH keys.
+
+
+To run the developer container:
+~~~
+    ./run.sh
+~~~
+
+If you want to configure the container by hand see the docker commands in **./make-container.sh** for the --build-arg overrides needed to setup your git account without a working shell.
+
+
+# Using the development environment
+
+Once your ssh key is imported to github.com you're ready to start working with the API:
+
+Clone the repository:
+~~~
+    git clone [email protected]:Blizzard/s2client-api.git
+~~~
+
+Generate the project build files:
+~~~
+    cd ~/s2client-api
+    mkdir -p build
+    cd build && cmake -G "Unix Makefiles" ..
+~~~
+
+# To save your work between sessions
+
+Now that you've gotten your container up and running you will want to snapshot your changes:
+~~~
+    ./commit-container.sh
+~~~
+
+If you want to move files out of your container consider cloning into a volume mount (e.g.: /code):
+~~~
+    docker run -v code:/code -it s2client-username
+~~~
+
+Alternative you can copy the files out using 'docker cp':
+~~~
+    .. run your container
+    export DEV_CONTAINER=`docker ps -l -q`
+    docker cp $DEV_CONTAINER:/home/username/myfile.txt .
+~~~
+
+# Resuming or attaching
+
+To resume your work after **./commit-container.sh**:
+
+~~~
+./run-user.sh
+~~~
+
+
+To attach an additional TTY to a running container:
+~~~
+./attach-user.sh
+~~~
+
+# Additional Notes
+
+The game executable will be located in:
+
+    **/SC2/${GAME_VERSION}/StarCraftII/Versions/Base${BUILD_VERSION}/SC2_x64

dev/attach-user.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# This attaches a shell the last user dev container ID
+docker exec -it `docker ps -l -q` /bin/bash

dev/commit-container.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+#
+# This commits the last run container (dev) as with the system user
+# as a tag.
+#
+
+SYSTEM_USER_NAME=`whoami`
+LAST_CONTAINER_ID=`docker ps -q -l`
+CONTAINER_NAME=s2client-${SYSTEM_USER_NAME}
+
+echo "Committing last  container ${LAST_CONTAINER_ID} as ${CONTAINER_NAME}"
+docker commit ${LAST_CONTAINER_ID} ${CONTAINER_NAME}

dev/make-container.sh

@@ -5,5 +5,21 @@
 IMAGE_NAME=s2client-dev
 SCRIPT_PATH=${0%/*}
 
+# Get the current git user to intantiate in the container
+SYSTEM_USER_NAME=`whoami`
+GIT_USER_NAME=`git config --get user.name`
+GIT_EMAIL=`git config --get user.email`
+
 echo ${IMAGE_NAME} docker image building using ${SCRIPT_PATH}/Dockerfile
-docker build ${SCRIPT_PATH} -t ${IMAGE_NAME}
+echo Configuring for GIT user: $SYSTEM_USER_NAME, name: ${GIT_USER_NAME}, email: ${GIT_EMAIL}
+
+docker build ${SCRIPT_PATH} \
+    --build-arg SYSTEM_USER_NAME=${SYSTEM_USER_NAME} \
+    --build-arg GIT_USER_NAME="${GIT_USER_NAME}" \
+    --build-arg GIT_EMAIL="${GIT_EMAIL}" \
+    -t ${IMAGE_NAME}
+
+echo ==== Your github.com SSH public key for the container is:
+
+# Output the key for usage on github.com
+docker run -t ${IMAGE_NAME}:latest -c "/bin/cat /home/${SYSTEM_USER_NAME}/.ssh/id_rsa.pub"

dev/run.sh renamed to dev/run-dev.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 docker run \
     -v build-mount:/build-mount \
     -it s2client-dev

dev/run-user.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# This runs the user dev container
+docker run \
+    -v build-mount:/build-mount \
+    -it s2client-`whoami`