move functions to common.sh
move shared functions to common.sh. Move common.sh to script/common/utils/common.sh closes: DE-571 flag = none Test Plan: -running docker_dev_setup succeeds -running docker_dev_update succeeds -running rebase_canvas_and_plugins succeeds Change-Id: I4d74369f9c88854d1bb4ac0b3b990f5045f24506 Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/261153 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> QA-Review: James Butters <jbutters@instructure.com> Product-Review: James Butters <jbutters@instructure.com> Reviewed-by: Andrea Cirulli <andrea.cirulli@instructure.com>
This commit is contained in:
James Butters
parent
41849fec6c
commit
6e11d6868c
|
|
@ -36,7 +36,7 @@ def buildParameters = [
|
|||
|
||||
def dockerDevFiles = [
|
||||
'^docker-compose/',
|
||||
'^script/common.sh',
|
||||
'^script/common/',
|
||||
'^script/canvas_update',
|
||||
'^docker-compose.yml',
|
||||
'^Dockerfile$',
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
source script/common/canvas/build_helpers.sh
|
||||
|
||||
LOG="$(pwd)/log/canvas_update.log"
|
||||
|
|
|
|||
135
script/common.sh
135
script/common.sh
|
|
@ -1,135 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
# This file contains commonly used BASH functions for scripting in canvas-lms,
|
||||
# particularly script/canvas_update and script/rebase_canvas_and_plugins . As such,
|
||||
# *be careful* when you modify these functions as doing so will impact multiple
|
||||
# scripts that likely aren't used or tested in continuous integration builds.
|
||||
|
||||
if [[ -n "${COMMON_LIB_LOADED-}" ]]; then
|
||||
return
|
||||
fi
|
||||
COMMON_LIB_LOADED=i_am_here
|
||||
BOLD="$(tput bold)"
|
||||
NORMAL="$(tput sgr0)"
|
||||
|
||||
function create_log_file {
|
||||
if [ ! -f "$LOG" ]; then
|
||||
echo "" > "$LOG"
|
||||
fi
|
||||
}
|
||||
|
||||
function echo_console_and_log {
|
||||
echo "$1" |tee -a "$LOG"
|
||||
}
|
||||
|
||||
function print_results {
|
||||
exit_code=$?
|
||||
set +e
|
||||
|
||||
if [ "${exit_code}" == "0" ]; then
|
||||
echo ""
|
||||
echo_console_and_log " \o/ Success!"
|
||||
_canvas_lms_telemetry_report_status $exit_code
|
||||
else
|
||||
echo ""
|
||||
echo_console_and_log " /o\ Something went wrong. Check ${LOG} for details."
|
||||
_canvas_lms_telemetry_report_status $exit_code
|
||||
fi
|
||||
|
||||
exit ${exit_code}
|
||||
}
|
||||
|
||||
function is_git_dir {
|
||||
[ "$(basename "$(git rev-parse --show-toplevel)")" == "$(basename "$(pwd)")" ]
|
||||
}
|
||||
|
||||
# Parameter: the name of the script calling this function
|
||||
function intro_message {
|
||||
script_name="$1"
|
||||
echo "Bringing Canvas up to date ..."
|
||||
echo " Log file is $LOG"
|
||||
|
||||
echo >>"$LOG"
|
||||
echo "-----------------------------" >>"$LOG"
|
||||
echo "$1 ($(date)):" >>"$LOG"
|
||||
echo "-----------------------------" >>"$LOG"
|
||||
}
|
||||
|
||||
# If DOCKER var set true, run with docker-compose
|
||||
function run_command {
|
||||
if [ "${DOCKER:-}" == 'y' ]; then
|
||||
docker-compose run --rm web "$@"
|
||||
else
|
||||
"$@"
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_track {
|
||||
command="$@"
|
||||
if _canvas_lms_telemetry_enabled; then
|
||||
_inst_telemetry $command
|
||||
else
|
||||
$command
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_track_with_log {
|
||||
command="$@"
|
||||
if _canvas_lms_telemetry_enabled; then
|
||||
_inst_telemetry_with_log $command
|
||||
else
|
||||
$command >> "$LOG" 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_telemetry_enabled() {
|
||||
if [[ "${TELEMETRY_OPT_IN-n}" == 'y' ]] && installed _inst_telemetry ; then
|
||||
return 0
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
function _canvas_lms_opt_in_telemetry() {
|
||||
SCRIPT_NAME=$1
|
||||
LOG_FILE=$2
|
||||
if installed _canvas_lms_activate_telemetry; then
|
||||
_canvas_lms_activate_telemetry
|
||||
if installed _inst_setup_telemetry && _inst_setup_telemetry "canvas-lms:$SCRIPT_NAME"; then
|
||||
_inst_track_os
|
||||
if [[ ! -z "${LOG_FILE-}" ]]; then
|
||||
_inst_set_redirect_log_file "$LOG_FILE"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
function installed {
|
||||
type "$@" &> /dev/null
|
||||
}
|
||||
|
||||
function _canvas_lms_telemetry_report_status() {
|
||||
exit_status=$?
|
||||
if [[ ! -z ${1-} ]]; then
|
||||
exit_status=$1
|
||||
fi
|
||||
if installed _inst_report_status && _canvas_lms_telemetry_enabled; then
|
||||
_inst_report_status $exit_status
|
||||
fi
|
||||
}
|
||||
|
||||
function prompt {
|
||||
read -r -p "$1 " "$2"
|
||||
}
|
||||
|
||||
function message {
|
||||
echo ''
|
||||
echo "$BOLD> $*$NORMAL"
|
||||
}
|
||||
|
||||
function confirm_command {
|
||||
if [ -z "${JENKINS-}" ]; then
|
||||
prompt "OK to run '$*'? [y/n]" confirm
|
||||
[[ ${confirm:-n} == 'y' ]] || return 1
|
||||
fi
|
||||
eval "$*"
|
||||
}
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
|
||||
function ensure_in_canvas_root_directory {
|
||||
if ! is_canvas_root; then
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
# TODO use with check_dependencies refactor
|
||||
#dependencies='docker,docker-compose 1.20.0'
|
||||
#optional_dependencies='dory'
|
||||
|
|
|
|||
|
|
@ -0,0 +1,249 @@
|
|||
#!/bin/bash
|
||||
|
||||
# This file contains commonly used BASH functions for scripting in canvas-lms,
|
||||
# particularly script/canvas_update and script/rebase_canvas_and_plugins . As such,
|
||||
# *be careful* when you modify these functions as doing so will impact multiple
|
||||
# scripts that likely aren't used or tested in continuous integration builds.
|
||||
|
||||
if [[ -n "${COMMON_LIB_LOADED-}" ]]; then
|
||||
return
|
||||
fi
|
||||
COMMON_LIB_LOADED=i_am_here
|
||||
BOLD="$(tput bold)"
|
||||
NORMAL="$(tput sgr0)"
|
||||
|
||||
function create_log_file {
|
||||
if [ ! -f "$LOG" ]; then
|
||||
echo "" > "$LOG"
|
||||
fi
|
||||
}
|
||||
|
||||
function echo_console_and_log {
|
||||
echo "$1" |tee -a "$LOG"
|
||||
}
|
||||
|
||||
function print_results {
|
||||
exit_code=$?
|
||||
set +e
|
||||
|
||||
if [ "${exit_code}" == "0" ]; then
|
||||
echo ""
|
||||
echo_console_and_log " \o/ Success!"
|
||||
_canvas_lms_telemetry_report_status $exit_code
|
||||
else
|
||||
echo ""
|
||||
echo_console_and_log " /o\ Something went wrong. Check ${LOG} for details."
|
||||
_canvas_lms_telemetry_report_status $exit_code
|
||||
fi
|
||||
|
||||
exit ${exit_code}
|
||||
}
|
||||
|
||||
function is_git_dir {
|
||||
[ "$(basename "$(git rev-parse --show-toplevel)")" == "$(basename "$(pwd)")" ]
|
||||
}
|
||||
|
||||
# Parameter: the name of the script calling this function
|
||||
function intro_message {
|
||||
script_name="$1"
|
||||
echo "Bringing Canvas up to date ..."
|
||||
echo " Log file is $LOG"
|
||||
|
||||
echo >>"$LOG"
|
||||
echo "-----------------------------" >>"$LOG"
|
||||
echo "$1 ($(date)):" >>"$LOG"
|
||||
echo "-----------------------------" >>"$LOG"
|
||||
}
|
||||
|
||||
# If DOCKER var set true, run with docker-compose
|
||||
function run_command {
|
||||
if [ "${DOCKER:-}" == 'y' ]; then
|
||||
docker-compose run --rm web "$@"
|
||||
else
|
||||
"$@"
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_track {
|
||||
command="$@"
|
||||
if _canvas_lms_telemetry_enabled; then
|
||||
_inst_telemetry $command
|
||||
else
|
||||
$command
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_track_with_log {
|
||||
command="$@"
|
||||
if _canvas_lms_telemetry_enabled; then
|
||||
_inst_telemetry_with_log $command
|
||||
else
|
||||
$command >> "$LOG" 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
function _canvas_lms_telemetry_enabled() {
|
||||
if [[ "${TELEMETRY_OPT_IN-n}" == 'y' ]] && installed _inst_telemetry ; then
|
||||
return 0
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
function _canvas_lms_opt_in_telemetry() {
|
||||
SCRIPT_NAME=$1
|
||||
LOG_FILE=$2
|
||||
if installed _canvas_lms_activate_telemetry; then
|
||||
_canvas_lms_activate_telemetry
|
||||
if installed _inst_setup_telemetry && _inst_setup_telemetry "canvas-lms:$SCRIPT_NAME"; then
|
||||
_inst_track_os
|
||||
if [[ ! -z "${LOG_FILE-}" ]]; then
|
||||
_inst_set_redirect_log_file "$LOG_FILE"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
function installed {
|
||||
type "$@" &> /dev/null
|
||||
}
|
||||
|
||||
function _canvas_lms_telemetry_report_status() {
|
||||
exit_status=$?
|
||||
if [[ ! -z ${1-} ]]; then
|
||||
exit_status=$1
|
||||
fi
|
||||
if installed _inst_report_status && _canvas_lms_telemetry_enabled; then
|
||||
_inst_report_status $exit_status
|
||||
fi
|
||||
}
|
||||
|
||||
function prompt {
|
||||
read -r -p "$1 " "$2"
|
||||
}
|
||||
|
||||
function message {
|
||||
echo ''
|
||||
echo "$BOLD> $*$NORMAL"
|
||||
}
|
||||
|
||||
function confirm_command {
|
||||
if [ -z "${JENKINS-}" ]; then
|
||||
prompt "OK to run '$*'? [y/n]" confirm
|
||||
[[ ${confirm:-n} == 'y' ]] || return 1
|
||||
fi
|
||||
eval "$*"
|
||||
}
|
||||
|
||||
function check_dependencies {
|
||||
local packages=()
|
||||
#check for proper docker-compose version
|
||||
if ! check_docker_compose_version; then
|
||||
message "docker-compose $DOCKER_COMPOSE_MIN_VERSION or higher is required."
|
||||
printf "\tPlease see %s for installation instructions.\n" "https://docs.docker.com/compose/install/"
|
||||
packages+=("docker-compose")
|
||||
docker_missing=1
|
||||
fi
|
||||
#check for required packages installed
|
||||
for package in $dependencies; do
|
||||
if ! installed "$package"; then
|
||||
packages+=("$package")
|
||||
fi
|
||||
done
|
||||
#if missing packages, print missing packages with install assistance.
|
||||
if [[ ${#packages[@]} -gt 0 ]]; then
|
||||
#when more dependencies get added, modify this output to include them.
|
||||
if [[ $OS == 'Linux' ]];then
|
||||
if [[ "${packages[*]}" =~ "dory" ]];then
|
||||
message "Some additional dependencies need to be installed for your OS."
|
||||
printf "\tCanvas recommends using dory for a reverse proxy allowing you to
|
||||
\taccess canvas at http://canvas.docker. Detailed instructions
|
||||
\tare available at https://github.com/FreedomBen/dory.
|
||||
\tIf you want to install it, run 'gem install dory' then rerun this script.\n"
|
||||
[[ ${docker_missing:-0} == 1 ]] || prompt 'Would you like to skip dory? [y/n]' skip_dory
|
||||
[[ ${skip_dory:-n} != 'y' ]] || return 0
|
||||
fi
|
||||
elif [[ $OS == 'Darwin' ]];then
|
||||
message "Some additional dependencies need to be installed for your OS."
|
||||
printf -v joined '%s,' "${packages[@]}"
|
||||
echo "Please install ${joined%,}."
|
||||
printf "\tTry: %s %s\n" "$install" "${packages[*]}"
|
||||
else
|
||||
echo 'This script only supports MacOS and Linux :('
|
||||
exit 1
|
||||
fi
|
||||
printf "\nOnce all dependencies are installed, rerun this script.\n"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function check_docker_compose_version {
|
||||
if ! installed "docker-compose"; then
|
||||
return 1
|
||||
fi
|
||||
compose_version=$(eval docker-compose --version |grep -oE "[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+")
|
||||
if (( $(echo "$compose_version $DOCKER_COMPOSE_MIN_VERSION" | awk '{print ($1 < $2)}') )); then
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
function display_next_steps {
|
||||
message "You're good to go! Next steps:"
|
||||
|
||||
# shellcheck disable=SC2016
|
||||
[[ $OS == 'Darwin' ]] && echo '
|
||||
First, run:
|
||||
|
||||
eval "$(dinghy env)"
|
||||
|
||||
This will set up environment variables for docker to work with the dinghy VM.'
|
||||
|
||||
[[ $OS == 'Linux' ]] && echo '
|
||||
I have added your user to the docker group so you can run docker commands
|
||||
without sudo. Note that this has security implications:
|
||||
|
||||
https://docs.docker.com/engine/installation/linux/linux-postinstall/
|
||||
|
||||
You may need to logout and login again for this to take effect.'
|
||||
|
||||
echo "
|
||||
Running Canvas:
|
||||
|
||||
docker-compose up -d
|
||||
open http://canvas.docker
|
||||
|
||||
Running the tests:
|
||||
|
||||
docker-compose run --rm web bundle exec rspec
|
||||
|
||||
Running Selenium tests:
|
||||
|
||||
add docker-compose/selenium.override.yml in the .env file
|
||||
echo ':docker-compose/selenium.override.yml' >> .env
|
||||
|
||||
build the selenium container
|
||||
docker-compose build selenium-chrome
|
||||
|
||||
run selenium
|
||||
docker-compose run --rm web bundle exec rspec spec/selenium
|
||||
|
||||
Virtual network remote desktop sharing to selenium container
|
||||
for Firefox:
|
||||
$ open vnc://secret:secret@seleniumff.docker
|
||||
for chrome:
|
||||
$ open vnc://secret:secret@seleniumch.docker:5901
|
||||
|
||||
I'm stuck. Where can I go for help?
|
||||
|
||||
FAQ: https://github.com/instructure/canvas-lms/wiki/FAQ
|
||||
Dev & Friends: http://instructure.github.io/
|
||||
Canvas Guides: https://guides.instructure.com/
|
||||
Vimeo channel: https://vimeo.com/canvaslms
|
||||
API docs: https://canvas.instructure.com/doc/api/index.html
|
||||
Mailing list: http://groups.google.com/group/canvas-lms-users
|
||||
IRC: http://webchat.freenode.net/?channels=canvas-lms
|
||||
|
||||
Please do not open a GitHub issue until you have tried asking for help on
|
||||
the mailing list or IRC - GitHub issues are for verified bugs only.
|
||||
Thanks and good luck!
|
||||
"
|
||||
}
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
|
||||
# Defaults
|
||||
DINGHY_MEMORY='8192'
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
source script/common/canvas/build_helpers.sh
|
||||
|
||||
trap '_canvas_lms_telemetry_report_status' ERR EXIT
|
||||
|
|
@ -50,58 +49,6 @@ else
|
|||
exit 1
|
||||
fi
|
||||
|
||||
function check_dependencies {
|
||||
local packages=()
|
||||
#check for proper docker-compose version
|
||||
if ! check_docker_compose_version; then
|
||||
message "docker-compose $DOCKER_COMPOSE_MIN_VERSION or higher is required."
|
||||
printf "\tPlease see %s for installation instructions.\n" "https://docs.docker.com/compose/install/"
|
||||
packages+=("docker-compose")
|
||||
docker_missing=1
|
||||
fi
|
||||
#check for required packages installed
|
||||
for package in $dependencies; do
|
||||
if ! installed "$package"; then
|
||||
packages+=("$package")
|
||||
fi
|
||||
done
|
||||
#if missing packages, print missing packages with install assistance.
|
||||
if [[ ${#packages[@]} -gt 0 ]]; then
|
||||
#when more dependencies get added, modify this output to include them.
|
||||
if [[ $OS == 'Linux' ]];then
|
||||
if [[ "${packages[*]}" =~ "dory" ]];then
|
||||
message "Some additional dependencies need to be installed for your OS."
|
||||
printf "\tCanvas recommends using dory for a reverse proxy allowing you to
|
||||
\taccess canvas at http://canvas.docker. Detailed instructions
|
||||
\tare available at https://github.com/FreedomBen/dory.
|
||||
\tIf you want to install it, run 'gem install dory' then rerun this script.\n"
|
||||
[[ ${docker_missing:-0} == 1 ]] || prompt 'Would you like to skip dory? [y/n]' skip_dory
|
||||
[[ ${skip_dory:-n} != 'y' ]] || return 0
|
||||
fi
|
||||
elif [[ $OS == 'Darwin' ]];then
|
||||
message "Some additional dependencies need to be installed for your OS."
|
||||
printf -v joined '%s,' "${packages[@]}"
|
||||
echo "Please install ${joined%,}."
|
||||
printf "\tTry: %s %s\n" "$install" "${packages[*]}"
|
||||
else
|
||||
echo 'This script only supports MacOS and Linux :('
|
||||
exit 1
|
||||
fi
|
||||
printf "\nOnce all dependencies are installed, rerun this script.\n"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function check_docker_compose_version {
|
||||
if ! installed "docker-compose"; then
|
||||
return 1
|
||||
fi
|
||||
compose_version=$(eval docker-compose --version |grep -oE "[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+")
|
||||
if (( $(echo "$compose_version $DOCKER_COMPOSE_MIN_VERSION" | awk '{print ($1 < $2)}') )); then
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
function setup_docker_environment {
|
||||
check_dependencies
|
||||
if [[ $OS == 'Darwin' ]]; then
|
||||
|
|
@ -111,69 +58,6 @@ function setup_docker_environment {
|
|||
fi
|
||||
}
|
||||
|
||||
function display_next_steps {
|
||||
message "You're good to go! Next steps:"
|
||||
|
||||
# shellcheck disable=SC2016
|
||||
[[ $OS == 'Darwin' ]] && echo '
|
||||
First, run:
|
||||
|
||||
eval "$(dinghy env)"
|
||||
|
||||
This will set up environment variables for docker to work with the dinghy VM.'
|
||||
|
||||
[[ $OS == 'Linux' ]] && echo '
|
||||
I have added your user to the docker group so you can run docker commands
|
||||
without sudo. Note that this has security implications:
|
||||
|
||||
https://docs.docker.com/engine/installation/linux/linux-postinstall/
|
||||
|
||||
You may need to logout and login again for this to take effect.'
|
||||
|
||||
echo "
|
||||
Running Canvas:
|
||||
|
||||
docker-compose up -d
|
||||
open http://canvas.docker
|
||||
|
||||
Running the tests:
|
||||
|
||||
docker-compose run --rm web bundle exec rspec
|
||||
|
||||
Running Selenium tests:
|
||||
|
||||
add docker-compose/selenium.override.yml in the .env file
|
||||
echo ':docker-compose/selenium.override.yml' >> .env
|
||||
|
||||
build the selenium container
|
||||
docker-compose build selenium-chrome
|
||||
|
||||
run selenium
|
||||
docker-compose run --rm web bundle exec rspec spec/selenium
|
||||
|
||||
Virtual network remote desktop sharing to selenium container
|
||||
for Firefox:
|
||||
$ open vnc://secret:secret@seleniumff.docker
|
||||
for chrome:
|
||||
$ open vnc://secret:secret@seleniumch.docker:5901
|
||||
|
||||
I'm stuck. Where can I go for help?
|
||||
|
||||
FAQ: https://github.com/instructure/canvas-lms/wiki/FAQ
|
||||
Dev & Friends: http://instructure.github.io/
|
||||
Canvas Guides: https://guides.instructure.com/
|
||||
Vimeo channel: https://vimeo.com/canvaslms
|
||||
API docs: https://canvas.instructure.com/doc/api/index.html
|
||||
Mailing list: http://groups.google.com/group/canvas-lms-users
|
||||
IRC: http://webchat.freenode.net/?channels=canvas-lms
|
||||
|
||||
Please do not open a GitHub issue until you have tried asking for help on
|
||||
the mailing list or IRC - GitHub issues are for verified bugs only.
|
||||
Thanks and good luck!
|
||||
"
|
||||
}
|
||||
|
||||
|
||||
setup_docker_environment
|
||||
message 'Now we can set up Canvas!'
|
||||
copy_docker_config
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
source script/common/canvas/build_helpers.sh
|
||||
|
||||
LOG="$(pwd)/log/docker_dev_update.log"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/bin/bash
|
||||
set -o pipefail
|
||||
|
||||
source script/common.sh
|
||||
source script/common/utils/common.sh
|
||||
source script/common/canvas/build_helpers.sh
|
||||
|
||||
LOG="$(pwd)/log/rebase_canvas_and_plugins.log"
|
||||
|
|
@ -162,4 +162,4 @@ create_log_file
|
|||
intro_message "Rebase Canvas and Plugins"
|
||||
check_for_changes
|
||||
[[ -n "$SKIP_CANVAS" ]] || rebase_canvas
|
||||
[[ -n "$SKIP_PLUGINS" ]] || rebase_plugins
|
||||
[[ -n "$SKIP_PLUGINS" ]] || rebase_plugins
|
||||
|
|
|
|||
Loading…
Reference in New Issue