-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from BenjamenMeyer/enhancement_debug_tooling
Enhancement: Add debug tooling
- Loading branch information
Showing
3 changed files
with
259 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ARG CI_OS_IMAGE | ||
| ARG GIT_USER=vegastrike | ||
| ARG GIT_BRANCH=master | ||
|
|
||
| FROM vegastrike/vega-strike-build-env:${CI_OS_IMAGE} | ||
| ARG GIT_USER=vegastrike | ||
| ARG GIT_BRANCH=master | ||
|
|
||
| ENV GIT_USER=${GIT_USER} | ||
| ENV GIT_BRANCH=${GIT_BRANCH} | ||
|
|
||
| RUN mkdir -p /home/${GIT_USER} | ||
| WORKDIR /home/${GIT_USER} | ||
| RUN git clone https://github.com/${GIT_USER}/Vega-Strike-Engine-Source.git | ||
|
|
||
| WORKDIR /home/${GIT_USER}/Vega-Strike-Engine-Source | ||
| RUN git checkout ${GIT_BRANCH} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Image Tests | ||
|
|
||
| The functionality provided here allows one to test any of the Vega Strike Build Images | ||
| and perform an actual build of the source as we would do in CI. | ||
|
|
||
| The Dockerfile is parameterized to use the build image and then allow the caller | ||
| to set which fork and branch via `GIT_USER` and `GIT_BRANCH` respectively of the | ||
| VS code to build. | ||
|
|
||
| The user can then use `vs-image.sh` in order to build the image. This provided | ||
| as a convenience for how to use Build Args with Docker Images and to help | ||
| the caller know what to set. | ||
|
|
||
| Example: | ||
|
|
||
| $ ./vs-image.sh --image-base "rockylinux_rockylinux_8.10" build | ||
| ... | ||
| $ ./vs-image.sh run | ||
| [root@85fa1b0c4b92 Vega-Strike-Engine-Source]# | ||
|
|
||
| The caller is dumped in as the root user so they can manipulate the image | ||
| runtime with package installation, removal, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Options | ||
| DOCKER=docker | ||
| GITHUB_USERNAME="vegastrike" | ||
| GITHUB_WORKFLOW="../.github/workflows/gh-actions-pr.yml" | ||
| GIT_BRANCH="master" | ||
| IMAGE_BASE="" | ||
| IMAGE_TAG="vs_tester:latest" | ||
| YQ=yq | ||
|
|
||
| # Error message accumulator | ||
| MY_ERRORS="" | ||
|
|
||
| # Print out the error messages for the user | ||
| function printErrors() { | ||
| printf "${MY_ERRORS}" | ||
| } | ||
|
|
||
| # Add an error message to the error message accumulator | ||
| function recordErrorString() { | ||
| local NEW_ERROR="${1}" | ||
| if [ -n "${NEW_ERROR}" ]; then | ||
| MY_ERRORS="${NEW_ERROR}\n${MY_ERRORS}" | ||
| fi | ||
| } | ||
|
|
||
| # Determine if the error string needs to be output before | ||
| # terminating the program using the return code from the previous command | ||
| # return the code so it can then be used to exit the application | ||
| function processOpErrors() { | ||
| local -i result=${1} | ||
| if [ ${result} -ne 0 ]; then | ||
| printErrors | ||
| fi | ||
| return ${result} | ||
| } | ||
|
|
||
| # Check if `yq` is installed and if so is it the one expected? | ||
| # There are different implementations and they do not act the same way. | ||
| # So this is setup to use one that will easily parse and output the results | ||
| function isYqInstalled() { | ||
| local YQ_VERSION_DATA=$(${YQ} --version) | ||
| local -i result=0 | ||
| if [ $? -ne 0 ]; then | ||
| recordErrorString "YQ by https://github.com/mikefarah/yq is not installed" | ||
| let -i result=1 | ||
| else | ||
| local YQ_REPO=$(echo "${YQ_VERSION_DATA}" | cut -f 2 -d '(' | cut -f 1 -d ')') | ||
| if [ "${YQ_REPO}" != "https://github.com/mikefarah/yq/" ]; then | ||
| recordErrorString "YQ Version: ${YQ_VERSION_DATA}" | ||
| recordErrorString "Unexpected YQ version installed. Please use the version by https://github.com/mikefarah/yq" | ||
| let -i result=2 | ||
| fi | ||
| fi | ||
|
|
||
| return ${result} | ||
| } | ||
|
|
||
| # Command: CMD_SHOW_IMAGES | ||
| function printImageNames() { | ||
| isYqInstalled | ||
| if [ $? -ne 0 ]; then | ||
| return 1 | ||
| fi | ||
|
|
||
| echo "The following images are available:" | ||
| IFS=" | ||
| " | ||
| for IMAGE_NAME in $(${YQ} eval '.jobs.build.strategy.matrix.FROM*' ${GITHUB_WORKFLOW} | grep -v ^# | cut -f 2 -d \' | sort) | ||
| do | ||
| printf "\t${IMAGE_NAME}\n" | ||
| done | ||
| return 0 | ||
| } | ||
| # Command: CMD_BUILD_IMAGE | ||
| function buildImage() { | ||
| local IMAGE_BASE="${1}" | ||
| local IMAGE_TAG="${2}" | ||
| local GIT_USER="${3}" | ||
| local GIT_BRANCH="${4}" | ||
| ${DOCKER} build \ | ||
| --build-arg CI_OS_IMAGE="${IMAGE_BASE}" \ | ||
| --build-arg GIT_USER="${GIT_USER}" \ | ||
| --build-arg GIT_BRANCH="${GIT_BRANCH}" \ | ||
| --tag ${IMAGE_TAG} \ | ||
| . | ||
| } | ||
| # Command: CMD_RUN_IMAGE | ||
| function runImage() { | ||
| local IMAGE_TAG="${1}" | ||
| ${DOCKER} run -it "${IMAGE_TAG}" /bin/bash | ||
| } | ||
| # output option values for debugging | ||
| function printInfo() { | ||
| echo | ||
| echo " Git Branch: \"${GIT_BRANCH}\"" | ||
| echo "GitHub Username: \"${GITHUB_USERNAME}\"" | ||
| echo "GitHub Workflow: \"${GITHUB_WORKFLOW}\"" | ||
| echo " Image Base: \"${IMAGE_BASE}\"" | ||
| echo " Image Tag: \"${IMAGE_TAG}\"" | ||
| echo | ||
| } | ||
| # Variablized commands and argument names | ||
| CMD_HELP="help" | ||
| CMD_SHOW_IMAGES="show-images" | ||
| CMD_BUILD_IMAGE="build" | ||
| CMD_RUN_IMAGE="run" | ||
| ARG_IMAGE_BASE="--image-base" | ||
| ARG_IMAGE_TAG="--image-tag" | ||
| ARG_GITHUB_USERNAME="--github-user" | ||
| ARG_GITHUB_WORKFLOW="--github-workflow" | ||
| ARG_GIT_BRANCH="--git-branch" | ||
| ARG_YQ="--yq" | ||
| ARG_DOCKER="--docker" | ||
| # Command: CMD_HELP | ||
| function printHelp() { | ||
| local SCRIPT_NAME="${1}" | ||
| echo "${SCRIPT_NAME} <options> <command>" | ||
| echo | ||
| echo " <options> may be one or more of the following:" | ||
| echo " ${ARG_DOCKER} 'docker' binary to use" | ||
| echo " ${ARG_GITHUB_USERNAME} Specify the github user or organization to use - Default: \"${GITHUB_USERNAME}\"" | ||
| echo " ${ARG_GITHUB_WORKFLOW} Specify the github workflow to use for images - Default: \"${GITHUB_WORKFLOW}\"" | ||
| echo " ${ARG_GIT_BRANCH} Specify which Git Branch to use - Default: \"${GIT_BRANCH}\"" | ||
| echo " ${ARG_IMAGE_BASE} Specify which Vega Strike Image to use" | ||
| echo " ${ARG_IMAGE_TAG} Specify tag name to use - Default: \"${IMAGE_TAG}\"" | ||
| echo " ${ARG_YQ} 'yq' binary to use" | ||
| echo | ||
| echo " <command> may be one of the following:" | ||
| echo " ${CMD_HELP} Show this dialog" | ||
| echo " ${CMD_SHOW_IMAGES} List Images used by the Vega Strike CI system" | ||
| echo " ${CMD_BUILD_IMAGE} Build the image" | ||
| echo " ${CMD_RUN_IMAGE} Run the image" | ||
| echo | ||
| } | ||
| # Script argument processing | ||
| ARG_NAME="" | ||
| for ARG in $@ | ||
| do | ||
| # if ARG_NAME is not set then treat it as a command or argument name | ||
| # arguments will set ARG_NAME to fall to the `else` condition to save | ||
| # the value, then reset ARG_NAME once it has all is parts. | ||
| if [ -z "${ARG_NAME}" ]; then | ||
| case "${ARG}" in | ||
| "${CMD_HELP}") | ||
| printHelp "${0}" | ||
| printInfo | ||
| exit 0 | ||
| ;; | ||
| "${CMD_SHOW_IMAGES}") | ||
| printImageNames "${YQ}" | ||
| processOpErrors $? | ||
| exit $? | ||
| ;; | ||
| "${CMD_BUILD_IMAGE}") | ||
| printInfo | ||
| buildImage "${IMAGE_BASE}" "${IMAGE_TAG}" "${GITHUB_USERNAME}" "${GIT_BRANCH}" | ||
| processOpErrors $? | ||
| exit $? | ||
| ;; | ||
| "${CMD_RUN_IMAGE}") | ||
| printInfo | ||
| runImage "${IMAGE_TAG}" | ||
| processOpErrors $? | ||
| exit $? | ||
| ;; | ||
| "${ARG_IMAGE_BASE}"|"${ARG_IMAGE_TAG}"|"${ARG_GITHUB_USERNAME}"|"${ARG_GIT_BRANCH}"|"${ARG_YQ}"|"${ARG_GITHUB_WORKFLOW}"|"${ARG_DOCKER}") | ||
| # All arguments can be easily checked as one group | ||
| ARG_NAME="${ARG}" | ||
| ;; | ||
| *) | ||
| echo "Unknown command or option: ${ARG}" | ||
| ;; | ||
| esac | ||
| else | ||
| case "${ARG_NAME}" in | ||
| "${ARG_IMAGE_BASE}") | ||
| IMAGE_BASE="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_IMAGE_TAG}") | ||
| IMAGE_TAG="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_GITHUB_USERNAME}") | ||
| GITHUB_USERNAME="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_GITHUB_WORKFLOW}") | ||
| GITHUB_WORKFLOW="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_GIT_BRANCH}") | ||
| GIT_BRANCH="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_YQ}") | ||
| YQ="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| "${ARG_DOCKER}") | ||
| DOCKER="${ARG}" | ||
| ARG_NAME="" | ||
| ;; | ||
| *) | ||
| echo "Unknown option name: ${ARG_NAME}" | ||
| ARG_NAME="" | ||
| ;; | ||
| esac | ||
| fi | ||
| done | ||