Evelyn 08 fd2

INSTALL.md

@@ -36,7 +36,7 @@ Full installation details for these tools are provided by the projects themselve
           - You'll be using a *WSL Terminal* for many of the steps below.
         - Then follow the instructions for installing [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/). Be sure to follow the directions for the "WSL 2 backend" (not the "Hyper-V backend").
       - For MacOS:
-        - Follow the instructions for installing [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/). Be sure to choose chose "Mac with Intel Chip" or "Mac with Apple Silicon" as appropriate for your Mac.  If you are unsure, choose "About this Mac" from the Apple menu and check which "Chip" is in your Mac (Intel or Apple).
+        - Follow the instructions for installing [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/). Be sure to choose "Mac with Intel Chip" or "Mac with Apple Silicon" as appropriate for your Mac.  If you are unsure, choose "About this Mac" from the Apple menu and check which "Chip" is in your Mac (Intel or Apple).
       - For Linux:
         - Follow the instructions for installing [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/).
     - Test your installation of Docker Desktop.

docker/api/Dockerfile

@@ -3,9 +3,11 @@ FROM node:alpine3.17
 
 WORKDIR /app
 
-# Get the package.json and install dependencies
-COPY package.json .
-RUN npm install
+# Get the package.json, package-lock.json and install the dependencies
+# NOTE: Use npm ci here so that we use package-lock.json and
+#       so that we are alerted if there are any changes.
+COPY package.json package-lock.json ./
+RUN npm ci
 
 # Start the express api hander.
 CMD ["npm", "start"]

docker/api/after.bash

@@ -1,2 +1,3 @@
 # Delete the package.json file that was copied into the build context.
-rm package.json
+rm package.json
+rm package-lock.json

docker/api/before.bash

@@ -1,2 +1,3 @@
 # Copy the package.json file to the build context.
-cp ../../farmdata2/farmdata2_api/package.json .
+cp ../../farmdata2/farmdata2_api/package.json ./
+cp ../../farmdata2/farmdata2_api/package-lock.json ./

docker/api/repo.txt

@@ -1 +1 @@
-api:fd2.1
+api:fd2.2

docker/build-images.bash

@@ -1,15 +1,26 @@
 #!/bin/bash
 
-# Build and push to DockerHub multi architecture images
-# for all of the containers used by FarmData2.
+# Build and optionally push to DockerHub multi architecture images
+# or single architecture local images for FarmData2.
 
-LOGGED_IN=$(cat ~/.docker/config.json 2> /dev/null | grep "index.docker.io" | wc -l | cut -f 8 -d ' ')
-if [ "$LOGGED_IN" == "0" ];
-then
-  echo "Please log into Docker Hub before building images."
-  echo "  Use: docker login"
-  echo "This allows multi architecture images to be pushed."
-  exit -1
+LOCAL_BUILD=0
+
+# Check for --local flag
+if [ "$1" == "--local" ]; then
+    LOCAL_BUILD=1
+    shift # Remove the --local argument
+fi
+
+# Check for Docker Hub login only if not a local build
+if [ "$LOCAL_BUILD" -eq 0 ]; then
+    LOGGED_IN=$(cat ~/.docker/config.json 2> /dev/null | grep "index.docker.io" | wc -l | cut -f 8 -d ' ')
+    if [ "$LOGGED_IN" == "0" ];
+    then
+      echo "Please log into Docker Hub before building images."
+      echo "  Use: docker login"
+      echo "This allows multi architecture images to be pushed."
+      exit -1
+    fi
 fi
 
 if [ $# -lt 1 ];
@@ -21,19 +32,21 @@ then
   exit -1
 fi
 
-# Create the builder if it doesn't exist.
-FD2_BUILDER=$(docker buildx ls | grep "fd2builder" | wc -l | cut -f 8 -d ' ')
-if [ "$FD2_BUILDER" == "0" ];
-then
-  echo "Making new builder for FarmData2 images."
-  docker buildx create --name fd2builder
-fi
+# Create the builder if it doesn't exist and if not a local build
+if [ "$LOCAL_BUILD" -eq 0 ]; then
+    FD2_BUILDER=$(docker buildx ls | grep "fd2builder" | wc -l | cut -f 8 -d ' ')
+    if [ "$FD2_BUILDER" == "0" ];
+    then
+      echo "Making new builder for FarmData2 images."
+      docker buildx create --name fd2builder
+    fi
 
-# Switch to use the fd2builder.
-echo "Using the fd2bilder."
-docker buildx use fd2builder
+    # Switch to use the fd2builder.
+    echo "Using the fd2builder."
+    docker buildx use fd2builder
+fi
 
-# Build and push each of the images to Docker Hub.
+# Build (and push) each of the images
 for IMAGE in "$@"
 do
   if [ ! -f $IMAGE/Dockerfile ] | [ ! -f $IMAGE/repo.txt ];
@@ -54,7 +67,14 @@ do
     TAG=$(cat repo.txt)
     REPO="farmdata2/$TAG"
     echo "  Performing docker build using tag $REPO ..."
-    docker buildx build --platform linux/amd64,linux/arm64 -t $REPO --push .
+
+    if [ "$LOCAL_BUILD" -eq 1 ]; then
+        # Local build for the architecture of the local machine
+        docker build -t $REPO .
+    else
+        # Multi architecture build and push
+        docker buildx build --platform linux/amd64,linux/arm64 -t $REPO --push .
+    fi
 
     if [ -f after.bash ];
     then

docker/dev/Dockerfile

@@ -49,6 +49,7 @@ RUN apt install -y --no-install-recommends \
  && npm install -g \
         @vue/cli@5.0.8 \
         jsdoc@3.6.7 \
+        jsdoc-escape-at \
         jsdoc-vuejs@3.0.9 \
         vue-template-compiler@2.6.14
 
@@ -142,7 +143,9 @@ RUN npm install -d \
         @cypress/webpack-dev-server@2.5.0 \
         @cypress/vue2@1.1.2 \
         path@0.12.7 \
-        axios@0.24.0
+        axios@0.24.0 \
+        bootstrap@3.3.7
+
 WORKDIR /home/$USERNAME
 
 # Configure the VNC server so that it allows fd2dev to connect without

docker/dev/bash_aliases

@@ -8,7 +8,7 @@ setDB ()
 }
 
 # Clear the drupal cache in the fd2_farmdata2 container.
-alias clearDupalCache="docker exec -it fd2_farmdata2 drush cc all"
+alias clearDrupalCache="docker exec -it fd2_farmdata2 drush cc all"
 
 # Alias codium for running VSCodium with no-sandbox.
 codium ()

docker/dev/repo.txt

@@ -1 +1 @@
-dev:fd2.3
+dev:fd2.4

docker/dev/startup.bash

@@ -1,36 +1,36 @@
 #!/bin/bash
 
-# Cleanup from past vnc session that may hav been running in the container.
+# Cleanup from past VNC session that may have been running in the container.
 # This clean-up is not done when the container is stopped (not deleted).
-rm /tmp/.X11-unix/X1
-rm /tmp/.X1-lock
+# Using `rm -f` to ignore nonexistent files and suppress error messages.
+rm -f /tmp/.X11-unix/X1
+rm -f /tmp/.X1-lock
 
-# Ensure that the fd2dev user is in a group that has RW permission to
-# the docker.sock file.  This will allow fd2dev to use the docker on docker
-# to interact with containers within the development environment.
-# Note: This must be here instead of in Dockerfile so the GID for the
-# docker.sock in the container can match the one on the host.
-# Note: The docker.gid file is mounted into the container by docker-compose.
-HOST_DOCKER_GID=$(cat ~/.fd2/gids/docker.gid)
-HOST_DOCKER_GID_IN_CONTAINER=$(echo /etc/group | grep ":$HOST_DOCKER_GID:")
-if [ -z "$HOST_DOCKER_GID_IN_CONTAINER" ];
-then
-  echo "fd2dev" | sudo -S groupadd --gid $HOST_DOCKER_GID fd2docker
+# The sudo password is assumed to be 'fd2dev' for all operations.
+# Using a single invocation of sudo and a here-document to execute multiple commands.
+# This reduces the number of times the password needs to be echoed and sudo is called.
+# This also reduces the script complexity and potential points of failure.
+sudo -S sh <<SCRIPT
+# Ensure that the fd2dev user is in a group that has RW permission to the docker.sock file.
+HOST_DOCKER_GID=\$(cat ~/.fd2/gids/docker.gid)
+if ! grep -q ":$HOST_DOCKER_GID:" /etc/group; then
+  groupadd --gid $HOST_DOCKER_GID fd2docker
 fi
-echo "fd2dev" | sudo -S usermod -a -G $HOST_DOCKER_GID fd2dev
-echo "fd2dev" | sudo -S chgrp +$HOST_DOCKER_GID /var/run/docker.sock
-echo "fd2dev" | sudo -S chmod 775 /var/run/docker.sock
+usermod -a -G $HOST_DOCKER_GID fd2dev
+chgrp $HOST_DOCKER_GID /var/run/docker.sock
+chmod 775 /var/run/docker.sock
 
 # Ensure that the fd2grp has RW access to mounted FarmData2 directory.
-# This probably is not necessary as in linux the group will reflect
-# the host group.  But it does make things consistent across macOS and linux.
-echo "fd2dev" | sudo -S chgrp -R fd2grp /home/fd2dev/FarmData2
-echo "fd2dev" | sudo -S chmod -R g+rw /home/fd2dev/FarmData2
+# This may not be necessary on Linux as the group will reflect the host group.
+# But it does make things consistent across macOS and Linux.
+chgrp -R fd2grp /home/fd2dev/FarmData2
+chmod -R g+rw /home/fd2dev/FarmData2
 
 # Ensure that the dbus service is running.
-echo "fd2dev" | sudo /etc/init.d/dbus restart
+/etc/init.d/dbus restart
+SCRIPT
 
-# Launch the VNC server
+# Launch the VNC server with the desired settings.
 vncserver \
   -localhost no \
   -geometry 1024x768 -depth 16 \

docker/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '2.2'
 services:
   express:
-    image: farmdata2/api:fd2.1
+    image: farmdata2/api:fd2.2
     container_name: fd2_api
     ports:
       - 8080:80
@@ -60,12 +60,13 @@ services:
       - /sessions
     links:
       - 'db'
-
+    profiles:
+      - phpmyadmin
   # Note: Separate profiles for unix vs windows systems
   #       Necessary to mount /var/run/docker.sock due to 
   #       absolute path syntax on windows.
   fd2dev-unix:
-    image: farmdata2/dev:fd2.3
+    image: farmdata2/dev:fd2.4
     container_name: fd2_dev
     init: true
     networks:
@@ -77,7 +78,7 @@ services:
       - ../farmdata2/cypress:/home/fd2dev/fd2test/cypress
       - ../farmdata2/cypress/cypress.config.js:/home/fd2dev/fd2test/cypress.config.js
       - /var/run/docker.sock:/var/run/docker.sock
-      - farmdev_home_fd2.2:/home/fd2dev  # preserve home dir on volume.
+      - farmdev_home_fd2.4:/home/fd2dev  # preserve home dir on volume.
       - farmos_db:/home/fd2dev/FarmData2/docker/db  # use volume for performance.
       - ~/.fd2gids:/home/fd2dev/.fd2/gids  # mount GID information.
     ports:
@@ -88,7 +89,7 @@ services:
       - linux
 
   fd2dev-win:
-    image: farmdata2/dev:fd2.3
+    image: farmdata2/dev:fd2.4
     container_name: fd2_dev
     init: true
     networks:
@@ -100,7 +101,7 @@ services:
       - ../farmdata2/cypress:/home/fd2dev/fd2test/cypress
       - ../farmdata2/cypress/cypress.config.js:/home/fd2dev/fd2test/cypress.config.js
       - //var/run/docker.sock:/var/run/docker.sock
-      - farmdev_home_fd2.2:/home/fd2dev  # preserve home dir on volume.
+      - farmdev_home_fd2.4:/home/fd2dev  # preserve home dir on volume.
       - farmos_db:/home/fd2dev/FarmData2/docker/db  # use volume for performance.
       - ~/.fd2gids:/home/fd2dev/.fd2/gids  # mount GID information.
     ports:
@@ -110,7 +111,7 @@ services:
       - windows
 
 volumes:
-  farmdev_home_fd2.2:
+  farmdev_home_fd2.4:
   farmos_db:
 
 networks:
@@ -120,4 +121,4 @@ networks:
   # This network is available only to containers defined here.
   fd2_private:  
     name: farmdata2_api
-    internal: true
+    internal: true

docker/fd2-down.bash

@@ -10,6 +10,16 @@ then
   exit -1
 fi
 
+# Env var was not being set on MacOS
+# So Revert this to the old approach.
+
+# if [ -z "$COMPOSE_PROFILES" ]; then
+#     echo "Error: COMPOSE_PROFILES doesn't have profiles stored. Please run fd2-up.bash to bring FarmData2 containers up first."
+#     exit 1
+# fi
+# I'm pretty sure since the COMPOSE_PROFILES utilize the environment variables, you can just run docker-compose down and that's it.
+#docker-compose down
+
 echo "Stopping Containers..."
 docker stop fd2_phpmyadmin
 docker stop fd2_farmdata2
@@ -24,4 +34,5 @@ docker rm fd2_farmdata2
 docker rm fd2_dev
 docker rm fd2_api
 
-echo "Done."
+#Unsets COMPOSE_PROFILES to prevent irregular edge cases. 
+unset COMPOSE_PROFILES

docker/fd2-up.bash

@@ -261,7 +261,42 @@ mkdir ~/.fd2gids
 echo "$FD2GRP_GID" > ~/.fd2gids/fd2grp.gid
 echo "$DOCKER_GRP_GID" > ~/.fd2gids/docker.gid 
 
-# Now finally... actually start the containers...
+profiles="${PROFILE} phpmyadmin" #Default Profile List
+
+# Parse Profile CLI Arguments
+for arg in "$@"; do
+    case $arg in
+        --no-dev)
+            # Exclude dev profiles
+            profiles="${profiles//macos/}"
+            profiles="${profiles//linux/}"
+            profiles="${profiles//windows/}"
+            ;;
+        --no-phpmyadmin)
+            # Exclude phpmyadmin profile
+            profiles="${profiles//phpmyadmin/}"
+            ;;
+        --no-phpmyadmin-dev)
+            # Exclude both phpmyadmin and dev profiles
+            profiles="${profiles//macos/}"
+            profiles="${profiles//linux/}"
+            profiles="${profiles//windows/}"
+            profiles="${profiles//phpmyadmin/}"
+            ;;
+    esac
+    shift
+done
+
+# Remove duplicates from profiles
+read -ra profile_array <<< "$profiles" 
+unique_profiles=($(printf "%s\n" "${profile_array[@]}" | sort -u))
+profiles=$(echo "${unique_profiles[@]}" | tr ' ' '\n' | xargs)
+
+# Create a comma-separated list of profiles for the COMPOSE_PROFILES environment variable
+COMPOSE_PROFILES=$(echo $profiles | tr ' ' ',')
+
+# Export the COMPOSE_PROFILES environment variable
+export COMPOSE_PROFILES
 
 # Delete any of the existing containers (except dev so that its writeable
 # layer - and thus any installed software or configuration - is preserved.)
@@ -270,9 +305,9 @@ docker rm fd2_mariadb &> /dev/null
 docker rm fd2_phpmyadmin &> /dev/null
 docker rm fd2_farmdata2 &> /dev/null
 
-echo "Starting containers..."
+echo "Starting containers with profiles: $profiles"
 # Note: Any command line args are passed to the docker-compose up command
-docker compose --profile $PROFILE up -d "$@"
+docker-compose up -d "$@"
 
 echo "Clearing drupal cache..."
 sleep 3  # give site time to come up before clearing the cache.

farmdata2/cypress/cypress.config.js

@@ -18,6 +18,13 @@ module.exports = {
   e2e: {
     setupNodeEvents(on, config) {
       // implement node event listeners here
+      on('task', {
+        log(message) {
+          console.log(message)
+
+          return null
+        },
+      })
     },
     baseUrl: 'http://fd2_farmdata2',
     specPattern: '**/*.spec.js',

farmdata2/cypress/support/component.js

@@ -16,6 +16,12 @@
 // Import commands.js using ES2015 syntax:
 import './commands'
 
+// Import specific FD2 style sheet
+import '/home/fd2dev/fd2test/farmdata2/farmdata2_modules/resources/fd2.css'
+
+// Import Bootstrap style sheet
+import 'bootstrap/dist/css/bootstrap.css'
+
 // Alternatively you can use CommonJS syntax:
 // require('./commands')