Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add confirmation dialog for blank input in config script #2836

Merged
merged 2 commits into from
Jun 29, 2024
Merged

Add confirmation dialog for blank input in config script #2836

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23f7892
Add confirmation dialog for blank input in config script
Ulincsys Jun 28, 2024
cd8bad5
Add return from blank_confirm on bad usage
Ulincsys Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 131 additions & 108 deletions scripts/install/config.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,173 +6,202 @@ Your choice: "

target=$1

function get_github_username(){
function blank_confirm() {
if [ -z "${1}" ]; then
echo "Bad usage of blank_confirm at:"
caller
return
fi

confirm_placeholder=${!1}

while [ -z "${confirm_placeholder}" ]; do
echo "You entered a blank line, are you sure?"
read -p "enter 'yes' to continue, or enter the intended value: " confirm_placeholder
case "$confirm_placeholder" in
[yY][eE][sS] | [yY][eE] | [yY])
return
;;
*)
continue
;;
esac
done
printf -v "$1" "%s" $confirm_placeholder
}

function get_github_username() {
echo
echo "Please provide your username for Github."
echo "** This is required for Augur to clone Github repos ***"
read -p "GitHub username: " github_username
blank_confirm github_username
echo
}


function get_github_api_key(){
function get_github_api_key() {
echo
echo "Please provide a valid GitHub API key."
echo "For more information on how to create the key, visit:"
echo "https://oss-augur.readthedocs.io/en/dev/getting-started/installation.html#backend"
echo "** This is required for Augur to gather data ***"
read -p "GitHub API Key: " github_api_key
blank_confirm github_api_key
echo
}

function get_gitlab_username(){
function get_gitlab_username() {
echo
echo "Please provide your username for GitLab."
echo "** This is required for Augur to clone GitLab repos ***"
read -p "GitLab username: " gitlab_username
blank_confirm gitlab_username
echo
}

function get_gitlab_api_key(){
function get_gitlab_api_key() {
echo
echo "Please provide a valid GitLab API key."
echo "For more information on how to create the key, visit:"
echo "https://oss-augur.readthedocs.io/en/dev/getting-started/installation.html#backend"
echo "** This is required for Augur to gather data ***"
read -p "GitLab API Key: " gitlab_api_key
blank_confirm gitlab_api_key
echo
}

function get_facade_repo_path() {

echo "The Facade data collection worker will clone repositories to this machine to run its analysis."
echo "Please select a new or existing directory for the Facade worker to use:"
echo

while true; do
read -e -p "Facade worker directory: " facade_repo_directory
facade_repo_directory=$(realpath $facade_repo_directory)
echo

if ! [ -w $facade_repo_directory/.git-credentials ]; then
echo "User $(whoami) does not have permission to write to that location"
echo "Please select another location"
continue
fi

if [[ -d "$facade_repo_directory" ]]; then
read -r -p "That directory already exists. Use it? [Y/n]: " facade_response
case "$facade_response" in
[nN][oO]|[nN])
continue
;;
*)
break
;;
esac
else
read -r -p "That directory does not exist. Create it? [Y/n]: " facade_response
case "$facade_response" in
[nN][oO]|[nN])
continue
;;
*)
mkdir "$facade_repo_directory"
echo "Directory created."
break
;;
esac
fi
done

[[ "${facade_repo_directory}" != */ ]] && facade_repo_directory="${facade_repo_directory}/"
echo "The Facade data collection worker will clone repositories to this machine to run its analysis."
echo "Please select a new or existing directory for the Facade worker to use:"
echo

while true; do
read -e -p "Facade worker directory: " facade_repo_directory
blank_confirm facade_repo_directory

facade_repo_directory=$(realpath $facade_repo_directory)
echo

if ! [ -w $facade_repo_directory/.git-credentials ]; then
echo "User $(whoami) does not have permission to write to that location"
echo "Please select another location"
continue
fi

if [[ -d "$facade_repo_directory" ]]; then
read -r -p "That directory already exists. Use it? [Y/n]: " facade_response
case "$facade_response" in
[nN][oO] | [nN])
continue
;;
*)
break
;;
esac
else
read -r -p "That directory does not exist. Create it? [Y/n]: " facade_response
case "$facade_response" in
[nN][oO] | [nN])
continue
;;
*)
mkdir "$facade_repo_directory"
echo "Directory created."
break
;;
esac
fi
done

[[ "${facade_repo_directory}" != */ ]] && facade_repo_directory="${facade_repo_directory}/"
}

function get_rabbitmq_broker_url(){
function get_rabbitmq_broker_url() {
echo
echo "Please provide your rabbitmq broker url."
echo "** This is required for Augur to run all collection tasks. ***"
read -p "broker_url: " rabbitmq_conn_string
blank_confirm rabbitmq_conn_string
echo
}

function create_config() {

function create_config(){

if [[ -z "${AUGUR_GITHUB_API_KEY}" ]]
then
if [[ -z "${AUGUR_GITHUB_API_KEY}" ]]; then
get_github_api_key
else
echo
echo "Found AUGUR_GITHUB_API_KEY environment variable with value $AUGUR_GITHUB_API_KEY"
echo "Using it in the config"
echo "Please unset AUGUR_GITHUB_API_KEY if you would like to be prompted for a github api key"
github_api_key=$AUGUR_GITHUB_API_KEY
echo
echo
echo "Found AUGUR_GITHUB_API_KEY environment variable with value $AUGUR_GITHUB_API_KEY"
echo "Using it in the config"
echo "Please unset AUGUR_GITHUB_API_KEY if you would like to be prompted for a github api key"
github_api_key=$AUGUR_GITHUB_API_KEY
echo
fi

if [[ -z "${AUGUR_GITHUB_USERNAME}" ]]
then
if [[ -z "${AUGUR_GITHUB_USERNAME}" ]]; then
get_github_username
else
echo
echo "Found AUGUR_GITHUB_USERNAME environment variable with value $AUGUR_GITHUB_USERNAME"
echo "Using it in the config"
echo "Please unset AUGUR_GITHUB_USERNAME if you would like to be prompted for a github username"
github_username=$AUGUR_GITHUB_USERNAME
echo
echo
echo "Found AUGUR_GITHUB_USERNAME environment variable with value $AUGUR_GITHUB_USERNAME"
echo "Using it in the config"
echo "Please unset AUGUR_GITHUB_USERNAME if you would like to be prompted for a github username"
github_username=$AUGUR_GITHUB_USERNAME
echo
fi

if [[ -z "${AUGUR_GITLAB_API_KEY}" ]]
then
if [[ -z "${AUGUR_GITLAB_API_KEY}" ]]; then
get_gitlab_api_key
else
echo
echo "Found AUGUR_GITLAB_API_KEY environment variable with value $AUGUR_GITLAB_API_KEY"
echo "Using it in the config"
echo "Please unset AUGUR_GITLAB_API_KEY if you would like to be prompted for a gitlab api key"
gitlab_api_key=$AUGUR_GITLAB_API_KEY
echo
echo
echo "Found AUGUR_GITLAB_API_KEY environment variable with value $AUGUR_GITLAB_API_KEY"
echo "Using it in the config"
echo "Please unset AUGUR_GITLAB_API_KEY if you would like to be prompted for a gitlab api key"
gitlab_api_key=$AUGUR_GITLAB_API_KEY
echo
fi


if [[ -z "${AUGUR_GITLAB_USERNAME}" ]]
then
if [[ -z "${AUGUR_GITLAB_USERNAME}" ]]; then
get_gitlab_username
else
echo
echo "Found AUGUR_GITLAB_USERNAME environment variable with value $AUGUR_GITLAB_USERNAME"
echo "Using it in the config"
echo "Please unset AUGUR_GITLAB_USERNAME if you would like to be prompted for a gitlab username"
gitlab_username=$AUGUR_GITLAB_USERNAME
echo
echo
echo "Found AUGUR_GITLAB_USERNAME environment variable with value $AUGUR_GITLAB_USERNAME"
echo "Using it in the config"
echo "Please unset AUGUR_GITLAB_USERNAME if you would like to be prompted for a gitlab username"
gitlab_username=$AUGUR_GITLAB_USERNAME
echo
fi

if [[ -z "${AUGUR_FACADE_REPO_DIRECTORY}" ]]
then
if [[ -z "${AUGUR_FACADE_REPO_DIRECTORY}" ]]; then
get_facade_repo_path
else
echo
echo "Found AUGUR_FACADE_REPO_DIRECTORY environment variable with value $AUGUR_FACADE_REPO_DIRECTORY"
echo "Using it in the config"
echo "IMPORTANT NOTE: This assumes that this directory already exists"
echo "Please unset AUGUR_FACADE_REPO_DIRECTORY if you would like to be prompted for the facade repo directory"
facade_repo_directory=$AUGUR_FACADE_REPO_DIRECTORY
echo
echo
echo "Found AUGUR_FACADE_REPO_DIRECTORY environment variable with value $AUGUR_FACADE_REPO_DIRECTORY"
echo "Using it in the config"
echo "IMPORTANT NOTE: This assumes that this directory already exists"
echo "Please unset AUGUR_FACADE_REPO_DIRECTORY if you would like to be prompted for the facade repo directory"
facade_repo_directory=$AUGUR_FACADE_REPO_DIRECTORY
echo
fi

if [[ -z "${RABBITMQ_CONN_STRING}" ]]
then
if [[ -z "${RABBITMQ_CONN_STRING}" ]]; then
get_rabbitmq_broker_url
else
echo
echo "Found RABBITMQ_CONN_STRING environment variable with value $RABBITMQ_CONN_STRING"
echo "Using it in the config"
echo "Please unset RABBITMQ_CONN_STRING if you would like to be prompted for the rabbit MQ connection string"
rabbitmq_conn_string=$RABBITMQ_CONN_STRING
echo
echo
echo "Found RABBITMQ_CONN_STRING environment variable with value $RABBITMQ_CONN_STRING"
echo "Using it in the config"
echo "Please unset RABBITMQ_CONN_STRING if you would like to be prompted for the rabbit MQ connection string"
rabbitmq_conn_string=$RABBITMQ_CONN_STRING
echo
fi


# echo $rabbitmq_conn_string
# echo $facade_repo_directory
# echo $gitlab_username
# echo $gitlab_api_key
# echo $github_username
# echo $github_api_key

#special case for docker entrypoint
if [ $target = "docker" ]; then
cmd=( augur config init --github-api-key $github_api_key --gitlab-api-key $gitlab_api_key --facade-repo-directory $facade_repo_directory --redis-conn-string $redis_conn_string --rabbitmq-conn-string $rabbitmq_conn_string )
Expand All @@ -181,16 +210,14 @@ function create_config(){
cmd=( augur config init --github-api-key $github_api_key --gitlab-api-key $gitlab_api_key --facade-repo-directory $facade_repo_directory --rabbitmq-conn-string $rabbitmq_conn_string )
fi



#Create and cache credentials for github and gitlab
touch $facade_repo_directory/.git-credentials

echo "https://$github_username:$github_api_key@github.com" > $facade_repo_directory/.git-credentials
echo "https://$gitlab_username:$gitlab_api_key@gitlab.com" >> $facade_repo_directory/.git-credentials

git config --global credential.helper "store --file $facade_repo_directory/.git-credentials"
"${cmd[@]}"
"${cmd[@]}"
}
echo
echo "Collecting data for config..."
Expand All @@ -200,7 +227,3 @@ echo "Config created"
echo

# config_prompt




Loading