VH 1303 - Updated the script to generate a .env file based on user input #615
Conversation
configuration/initialization.sh
Outdated
| @@ -1,4 +1,82 @@ | |||
| #!/bin/bash | |||
|
|
|||
| # Default values for the variables | |||
| PORT_DRAYAGE_ENABLED_DEFAULT="TRUE" | |||
There was a problem hiding this comment.
Change this to false by default
There was a problem hiding this comment.
Changed it to False
configuration/initialization.sh
Outdated
| @@ -9,15 +87,15 @@ sudo apt update -y && sudo apt upgrade -y | |||
| sudo apt-get install chromium-browser -y | |||
|
|
|||
| # Make passwords for mysql | |||
| mkdir -p secrets && cd secrets | |||
| mkdir -p secrets && cd secrets || return | |||
There was a problem hiding this comment.
Why is this necessary. Is this something from shell check. Can you add justification for adding return statement here, maybe even link rule.
There was a problem hiding this comment.
Yes, shell has thrown a warning here "^-- SC2164 (warning): Use 'cd ... || exit' or 'cd ... || return' in case cd fails."
Added a comment next to return saying "# return in case cd fails"
configuration/initialization.sh
Outdated
|
|
||
| # Creates password files where user inputs password | ||
| FILE1=mysql_root_password.txt | ||
| FILE2=mysql_password.txt | ||
| if test -f "$FILE1"; then | ||
| echo "$FILE1 exists." | ||
| else | ||
| read -p "enter password for the mysql_root_password: " sql_root_pass | ||
| read -r -p "enter password for the mysql_root_password: " sql_root_pass |
There was a problem hiding this comment.
Why is this necessary.
There was a problem hiding this comment.
Added this again as shell check thrown an error:
^-- SC2162 (info): read without -r will mangle backslashes.
For this reason it is "read -r -p"
There was a problem hiding this comment.
Can you comment the rule
There was a problem hiding this comment.
Added the Rule as a comment
| echo "$sql_pass" > sql_pass.txt | ||
| # Remove endline characters from password files | ||
| tr -d '\n' <sql_pass.txt> mysql_password.txt && rm sql_pass.txt | ||
| fi | ||
| # TODO VH-1303 Allow for version and configuration selection in initialization script |
configuration/initialization.sh
Outdated
|
|
||
| # Create V2X Hub user | ||
| cd $mysqlDir | ||
| cd "$mysqlDir" || return |
There was a problem hiding this comment.
Why is this necessary?
There was a problem hiding this comment.
Added a comment next to return saying "# return in case cd fails"
configuration/initialization.sh
Outdated
| SENSOR_JSON_FILE_PATH=${SENSOR_JSON_FILE_PATH:-$SENSOR_JSON_FILE_PATH_DEFAULT} | ||
| fi | ||
|
|
||
| # Write to .env file |
There was a problem hiding this comment.
If .env file already exists we may want to warn user that we are overwriting of even ask for permission to overwrite
There was a problem hiding this comment.
Updated the script to ask for permission to overwrite the existing .env file
configuration/initialization.sh
Outdated
| @@ -9,15 +93,15 @@ sudo apt update -y && sudo apt upgrade -y | |||
| sudo apt-get install chromium-browser -y | |||
|
|
|||
| # Make passwords for mysql | |||
| mkdir -p secrets && cd secrets | |||
| mkdir -p secrets && cd secrets || return # return in case cd fails | |||
There was a problem hiding this comment.
Can you link the rule
There was a problem hiding this comment.
Added the Rule as a comment
|
| # Check if Port Drayage functionality is enabled | ||
| if [[ $PORT_DRAYAGE_ENABLED == "TRUE" ]]; then | ||
| sudo docker compose up -d | ||
| elif [[ $PORT_DRAYAGE_ENABLED == "FALSE" ]]; then |
There was a problem hiding this comment.
Most of the time, users or at least I will not want port drayage enabled. Won't this only bring up the php container?
paulbourelly999
deleted the
vh-1303_update_initialization_script_to_create_env_file_based_on_user_input
branch
PR Details
Description
In this PR, initialization script is updated to generate a .env file based on user input.
Related Issue
VH-1303
Motivation and Context
How Has This Been Tested?
This update has been tested by running the script locally to check that user input is taken and .env file created.
Types of changes
Checklist:
V2XHUB Contributing Guide