epistemophiliac/frappe_docker
1
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2026-06-26 09:05:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

#1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

Browse source
This commit is contained in:
Varun 2023-10-26 10:45:08 +11:00
parent ad4c2fac22
commit 8a94a45120
4 changed files with 110 additions and 113 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
devcontainer-example/docker-compose.yml
View file

@ -39,31 +39,33 @@ services:
ports: ports:
- 8000-8005:8000-8005 - 8000-8005:8000-8005
- 9000-9005:9000-9005 - 9000-9005:9000-9005
ui-tester: # enable the below service if you need Cypress UI Tests to be executed
# pass custom command to start Cypress otherwise it will use the entrypoint # Before enabling ensure install_x11_deps.sh has been executed and display variable is exported.
# specified in the Cypress Docker image. # Run install_x11_deps.sh again if DISPLAY is not set
# also pass "--project <folder>" so that when Cypress opens # ui-tester:
# it can find file "cypress.json" and show integration specs # # pass custom command to start Cypress otherwise it will use the entrypoint
# https://on.cypress.io/command-line#cypress-open # # specified in the Cypress Docker image.
entrypoint: 'sleep infinity' # # also pass "--project <folder>" so that when Cypress opens
image: "docker.io/cypress/included:latest" # # it can find file "cypress.json" and show integration specs
#command: sleep infinity # # https://on.cypress.io/command-line#cypress-open
environment: # entrypoint: 'sleep infinity'
- SHELL=/bin/bash # image: "docker.io/cypress/included:latest"
# get the IP address of the host machine and allow X11 to accept # environment:
# incoming connections from that IP address # - SHELL=/bin/bash
# IP=$(ipconfig getifaddr en0) or mac or \ # # get the IP address of the host machine and allow X11 to accept
# IP=$($(hostname -I | awk '{print $1}') ) for Ubuntu # # incoming connections from that IP address
# /usr/X11/bin/xhost + $IP # # IP=$(ipconfig getifaddr en0) or mac or \
# then pass the environment variable DISPLAY to show Cypress GUI on the host system # # IP=$($(hostname -I | awk '{print $1}') ) for Ubuntu
# DISPLAY=$IP:0 # # /usr/X11/bin/xhost + $IP
- DISPLAY # # then pass the environment variable DISPLAY to show Cypress GUI on the host system
volumes: # # DISPLAY=$IP:0
# for Cypress to communicate with the X11 server pass this socket file # - DISPLAY
# in addition to any other mapped volumes # volumes:
- /tmp/.X11-unix:/tmp/.X11-unix # # for Cypress to communicate with the X11 server pass this socket file
- ..:/workspace:z,cached # # in addition to any other mapped volumes
network_mode: "host" # - /tmp/.X11-unix:/tmp/.X11-unix
# - ..:/workspace:z,cached
# network_mode: "host"
volumes: volumes:
mariadb-data: mariadb-data:
#postgresql-data: #postgresql-data:

13
development/installer.py
View file

@ -106,12 +106,13 @@ def get_args_parser():
default="admin", default="admin",
) )
parser.add_argument( parser.add_argument(
"-d",
"--db-type", "--db-type",
action="store", action="store",
type=str, type=str,
help="Database type to use (e.g., mariadb or postgres)", help="Database type to use (e.g., mariadb or postgres)",
default="mariadb", # Set your default database type here default="mariadb", # Set your default database type here
) )
return parser return parser
@ -119,7 +120,6 @@ def init_bench_if_not_exist(args):
if os.path.exists(args.bench_name): if os.path.exists(args.bench_name):
cprint("Bench already exists. Only site will be created", level=3) cprint("Bench already exists. Only site will be created", level=3)
return return
try: try:
env = os.environ.copy() env = os.environ.copy()
if args.py_version: if args.py_version:
@ -135,7 +135,6 @@ def init_bench_if_not_exist(args):
init_command += f"--frappe-path={args.frappe_repo} " init_command += f"--frappe-path={args.frappe_repo} "
init_command += f"--frappe-branch={args.frappe_branch} " init_command += f"--frappe-branch={args.frappe_branch} "
init_command += f"--apps_path={args.apps_json} " init_command += f"--apps_path={args.apps_json} "
#init_command += f"--db_type={args.db_type} " #--db-type postgres
init_command += args.bench_name init_command += args.bench_name
print(init_command) print(init_command)
command = [ command = [
@ -200,13 +199,13 @@ def init_bench_if_not_exist(args):
def create_site_in_bench(args): def create_site_in_bench(args):
mariadb_socket_option="" mariadb_socket_option = ""
if "mariadb" == args.db_type: if "mariadb" == args.db_type:
cprint("Set db_host", level=3) cprint("Set db_host", level=3)
subprocess.call( subprocess.call(
["bench", "set-config", "-g", "db_host", "mariadb"], ["bench", "set-config", "-g", "db_host", "mariadb"],
cwd=os.getcwd() + "/" + args.bench_name, cwd=os.getcwd() + "/" + args.bench_name,
) )
new_site_cmd = [ new_site_cmd = [
"bench", "bench",
"new-site", "new-site",
@ -221,7 +220,7 @@ def create_site_in_bench(args):
subprocess.call( subprocess.call(
["bench", "set-config", "-g", "db_host", "postgresql"], ["bench", "set-config", "-g", "db_host", "postgresql"],
cwd=os.getcwd() + "/" + args.bench_name, cwd=os.getcwd() + "/" + args.bench_name,
) )
new_site_cmd = [ new_site_cmd = [
"bench", "bench",
"new-site", "new-site",
@ -235,9 +234,7 @@ def create_site_in_bench(args):
apps.remove("frappe") apps.remove("frappe")
for app in apps: for app in apps:
new_site_cmd.append(f"--install-app={app}") new_site_cmd.append(f"--install-app={app}")
new_site_cmd.append(args.site_name) new_site_cmd.append(args.site_name)
cprint(f"Creating Site {args.site_name} ...", level=2) cprint(f"Creating Site {args.site_name} ...", level=2)
subprocess.call( subprocess.call(
new_site_cmd, new_site_cmd,

8
docs/development.md
View file

@ -393,15 +393,15 @@ To run cypress based UI tests in a docker environment, follow the below steps:
```shell ```shell
sudo ./install_x11_deps.sh sudo ./install_x11_deps.sh
``` ```
This script will install required deps, enable X11Forwarding and restart SSH daemon and export `DISPLAY` variable. This script will install required deps, enable X11Forwarding and restart SSH daemon and export `DISPLAY` variable.
2. Run X11 service `startx` or `xquartz` 2. Run X11 service `startx` or `xquartz`
3. Start docker compose services. 3. Start docker compose services.
4. SSH into ui-tester service using `docker exec.. ` command 4. SSH into ui-tester service using `docker exec..` command
5. Export CYPRESS_baseUrl and other required env variables 5. Export CYPRESS_baseUrl and other required env variables
6. Start Cypress UI console by issuing `cypress run command` 6. Start Cypress UI console by issuing `cypress run command`
> More references : [Cypress Official Documentation](https://www.cypress.io/blog/2019/05/02/run-cypress-with-a-single-docker-command) > More references : [Cypress Official Documentation](https://www.cypress.io/blog/2019/05/02/run-cypress-with-a-single-docker-command)
> Ensure DISPLAY enviroment is always exported. > Ensure DISPLAY environment is always exported.

150
install_x11_deps.sh
View file

@ -6,101 +6,99 @@ set -e
# Check if the script is running with root privileges # Check if the script is running with root privileges
if [ "$EUID" -ne 0 ]; then if [ "$EUID" -ne 0 ]; then
echo "Error: This script requires root privileges. Please run it as a superuser" echo "Error: This script requires root privileges. Please run it as a superuser"
exit 1 exit 1
fi fi
# Function to restart SSH service (Linux) # Function to restart SSH service (Linux)
restart_ssh_linux() { restart_ssh_linux() {
if command -v service >/dev/null 2>&1; then if command -v service >/dev/null 2>&1; then
sudo service ssh restart sudo service ssh restart
else else
sudo systemctl restart ssh sudo systemctl restart ssh
fi fi
} }
# Function to restart SSH service (macOS) # Function to restart SSH service (macOS)
restart_ssh_macos() { restart_ssh_macos() {
launchctl stop com.openssh.sshd launchctl stop com.openssh.sshd
launchctl start com.openssh.sshd launchctl start com.openssh.sshd
} }
update_x11_forwarding() { update_x11_forwarding() {
if grep -q "X11Forwarding yes" /etc/ssh/sshd_config; then if grep -q "X11Forwarding yes" /etc/ssh/sshd_config; then
echo "X11Forwarding is already set to 'yes' in ssh_config." echo "X11Forwarding is already set to 'yes' in ssh_config."
else else
if [[ "$OSTYPE" == "linux-gnu" ]]; then if [[ "$OSTYPE" == "linux-gnu" ]]; then
# Linux: Use sed for Linux # Linux: Use sed for Linux
sudo sed -i 's/#\?X11Forwarding.*/X11Forwarding yes/' /etc/ssh/sshd_config sudo sed -i 's/#\?X11Forwarding.*/X11Forwarding yes/' /etc/ssh/sshd_config
elif [[ "$OSTYPE" == "darwin"* ]]; then elif [[ "$OSTYPE" == "darwin"* ]]; then
# macOS: Use sed for macOS # macOS: Use sed for macOS
sudo sed -i -E 's/#X11Forwarding.*/X11Forwarding yes/' /etc/ssh/sshd_config sudo sed -i -E 's/#X11Forwarding.*/X11Forwarding yes/' /etc/ssh/sshd_config
restart_ssh_macos restart_ssh_macos
fi
if [[ "$OSTYPE" == "linux-gnu" ]]; then
restart_ssh_linux
fi
fi fi
if [[ "$OSTYPE" == "linux-gnu" ]]; then
restart_ssh_linux
fi
fi
} }
# Determine the operating system # Determine the operating system
if [[ "$OSTYPE" == "linux-gnu" ]]; then if [[ "$OSTYPE" == "linux-gnu" ]]; then
# Linux # Linux
if command -v startx >/dev/null 2>&1; then if command -v startx >/dev/null 2>&1; then
echo "X11 is already installed." echo "X11 is already installed."
else
# Check which package manager is available
if command -v apt-get >/dev/null 2>&1; then
install_command="sudo apt-get update && sudo apt-get install xorg openbox"
elif command -v dnf >/dev/null 2>&1; then
install_command="sudo dnf install xorg-x11-server-Xorg openbox"
else else
# Check which package manager is available echo "Error: Unable to determine the package manager. Manual installation required."
if command -v apt-get >/dev/null 2>&1; then exit 1
package_manager="apt"
elif command -v dnf >/dev/null 2>&1; then
package_manager="dnf"
else
echo "Error: Unable to determine the package manager. Manual installation required."
exit 1
fi
# Install X11 and Openbox based on the package manager
if [ "$package_manager" = "apt" ]; then
sudo apt-get update
sudo apt-get install xorg openbox
elif [ "$package_manager" = "dnf" ]; then
sudo dnf install xorg-x11-server-Xorg openbox
fi
# Check if X11 and Openbox were installed successfully
if [ $? -eq 0 ]; then
echo "X11 and Openbox have been successfully installed."
else
echo "Error: Failed to install X11 and Openbox."
exit 1
fi
fi fi
fi
# Call the function to update X11Forwarding # Check if the installation command is defined
update_x11_forwarding if [ -n "$install_command" ]; then
# Execute the installation command
# Get the IP address of the host dynamically if $install_command; then
host_ip=$(hostname -I | awk '{print $1}') echo "X11 and Openbox have been successfully installed."
xhost + $host_ip && xhost + local:
# Set the DISPLAY variable to the host IP
export DISPLAY="$host_ip:0.0"
echo "DISPLAY variable set to $DISPLAY"
elif [[ "$OSTYPE" == "darwin"* ]]; then
# macOS
if command -v xquartz >/dev/null 2>&1; then
echo "XQuartz is already installed."
else else
echo "Error: XQuartz is required for X11 forwarding on macOS. Please install XQuartz manually." echo "Error: Failed to install X11 and Openbox."
exit 1 exit 1
fi fi
else
# Call the function to update X11Forwarding echo "Error: Unsupported package manager."
update_x11_forwarding
# Export the DISPLAY variable for macOS
export DISPLAY=:0
echo "DISPLAY variable set to $DISPLAY"
else
echo "Error: Unsupported operating system."
exit 1 exit 1
fi
# Call the function to update X11Forwarding
update_x11_forwarding
# Get the IP address of the host dynamically
host_ip=$(hostname -I | awk '{print $1}')
xhost + "$host_ip" && xhost + local:
# Set the DISPLAY variable to the host IP
export DISPLAY="$host_ip:0.0"
echo "DISPLAY variable set to $DISPLAY"
elif [[ "$OSTYPE" == "darwin"* ]]; then
# macOS
if command -v xquartz >/dev/null 2>&1; then
echo "XQuartz is already installed."
else
echo "Error: XQuartz is required for X11 forwarding on macOS. Please install XQuartz manually."
exit 1
fi
# Call the function to update X11Forwarding
update_x11_forwarding
# Export the DISPLAY variable for macOS
export DISPLAY=:0
echo "DISPLAY variable set to $DISPLAY"
else
echo "Error: Unsupported operating system."
exit 1
fi fi