Skip to content

Commit

Permalink
Merge branch 'main' into ocm-stub-fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@michielbdejong
michielbdejong committed Dec 20, 2024
2 parents 4f24b8c + 2434c27 commit 9da9907
Show file tree
Hide file tree
Showing 2 changed files with 337 additions and 0 deletions.
66 changes: 66 additions & 0 deletions .github/workflows/share-with-os-v1-nc-v27.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: OCM Test Share With OcmStub v1.0.0 to NC v27.1.11

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the specified branch and files.
push:
branches:
- main
paths:
- "cypress/ocm-test-suite/**"
- "dev/ocm-test-suite.sh"
- "dev/ocm-test-suite/**"
pull_request:
branches:
- main
paths:
- "cypress/ocm-test-suite/**"
- "dev/ocm-test-suite.sh"
- "dev/ocm-test-suite/**"
# Allows you to run this workflow manually from the Actions tab.
workflow_dispatch:

jobs:
share-with:
strategy:
fail-fast: false
max-parallel: 1
matrix:
sender: [
{
platform: ocmstub,
version: "v1.0.0"
},
]
receiver: [
{
platform: nextcloud,
version: v27.1.11
},
]

# The OS to run tests on, (I believe for OCM testing OS is really not that important).
runs-on: ubuntu-24.04

# Steps represent a sequence of tasks that will be executed as part of the job.
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it.
- name: Checkout.
uses: actions/checkout@v4

- name: Pull images.
shell: bash
run: |
./docker/pull/ocm-test-suite/${{ matrix.sender.platform }}.sh ${{ matrix.sender.version }}
./docker/pull/ocm-test-suite/${{ matrix.receiver.platform }}.sh ${{ matrix.receiver.version }}
- name: Run tests.
shell: bash
run: ./dev/ocm-test-suite.sh share-with ${{ matrix.sender.platform }} ${{ matrix.sender.version }} ci electron ${{ matrix.receiver.platform }} ${{ matrix.receiver.version }}

- name: Upload Cypress video artifacts.
uses: actions/upload-artifact@v4
if: always()
with:
name: share-with from ${{ matrix.sender.platform }} ${{ matrix.sender.version }} to ${{ matrix.receiver.platform }} ${{ matrix.receiver.version }}
path: ./cypress/ocm-test-suite/cypress/videos
271 changes: 271 additions & 0 deletions dev/ocm-test-suite/share-with/ocmstub-nextcloud.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
#!/usr/bin/env bash

# @michielbdejong halt on error in docker init scripts.
set -e

# find this scripts location.
SOURCE=${BASH_SOURCE[0]}
while [ -L "${SOURCE}" ]; do # resolve "${SOURCE}" until the file is no longer a symlink.
DIR=$( cd -P "$( dirname "${SOURCE}" )" >/dev/null 2>&1 && pwd )
SOURCE=$(readlink "${SOURCE}")
# if "${SOURCE}" was a relative symlink, we need to resolve it relative to the path where the symlink file was located.
[[ "${SOURCE}" != /* ]] && SOURCE="${DIR}/${SOURCE}"
done
DIR=$( cd -P "$( dirname "${SOURCE}" )" >/dev/null 2>&1 && pwd )

cd "${DIR}/../../.." || exit

ENV_ROOT=$(pwd)
export ENV_ROOT=${ENV_ROOT}


# ocmstub version:
# - v1.0
EFSS_PLATFORM_1_VERSION=${1:-"1.0"}

# nextcloud version:
# - v27.1.11
# - v28.0.12
EFSS_PLATFORM_2_VERSION=${2:-"v27.1.11"}

# script mode: dev, ci. default is dev.
SCRIPT_MODE=${3:-"dev"}

# browser platform: chrome, edge, firefox, electron. default is electron.
# only applies on SCRIPT_MODE=ci
BROWSER_PLATFORM=${4:-"electron"}

function redirect_to_null_cmd() {
if [ "${SCRIPT_MODE}" = "ci" ]; then
"$@" >/dev/null 2>&1
else
"$@"
fi
}

function waitForPort () {
redirect_to_null_cmd echo waitForPort "${1} ${2}"
# the "| cat" after the "| grep" is to prevent the command from exiting with 1 if no match is found by grep.
x=$(docker exec "${1}" ss -tulpn | grep -c "${2}" | cat)
until [ "${x}" -ne 0 ]
do
redirect_to_null_cmd echo Waiting for "${1} to open port ${2}, this usually takes about 10 seconds ... ${x}"
sleep 1
x=$(docker exec "${1}" ss -tulpn | grep -c "${2}" | cat)
done
redirect_to_null_cmd echo "${1} port ${2} is open"
}

function createNextcloud() {
local platform="${1}"
local number="${2}"
local user="${3}"
local password="${4}"
local init_script="${5}"
local tag="${6-latest}"
local image="${7}"

if [[ -z "${image}" ]]; then
local image="pondersource/dev-stock-${platform}"
else
local image="pondersource/dev-stock-${platform}-${image}"
fi

redirect_to_null_cmd echo "creating efss ${platform} ${number}"

redirect_to_null_cmd docker run --detach --network=testnet \
--name="maria${platform}${number}.docker" \
-e MARIADB_ROOT_PASSWORD=eilohtho9oTahsuongeeTh7reedahPo1Ohwi3aek \
mariadb:11.4.2 \
--transaction-isolation=READ-COMMITTED \
--binlog-format=ROW \
--innodb-file-per-table=1 \
--skip-innodb-read-only-compressed

redirect_to_null_cmd docker run --detach --network=testnet \
--name="${platform}${number}.docker" \
--add-host "host.docker.internal:host-gateway" \
-e HOST="${platform}${number}" \
-e DBHOST="maria${platform}${number}.docker" \
-e USER="${user}" \
-e PASS="${password}" \
-v "${ENV_ROOT}/docker/tls/certificates:/certificates" \
-v "${ENV_ROOT}/docker/tls/certificate-authority:/certificate-authority" \
-v "${ENV_ROOT}/temp/${init_script}:/${platform}-init.sh" \
-v "${ENV_ROOT}/docker/scripts/entrypoint.sh:/entrypoint.sh" \
"${image}:${tag}"

# wait for hostname port to be open.
waitForPort "maria${platform}${number}.docker" 3306
waitForPort "${platform}${number}.docker" 443

# add self-signed certificates to os and trust them. (use >/dev/null 2>&1 to shut these up)
docker exec "${platform}${number}.docker" bash -c "cp -f /certificates/*.crt /usr/local/share/ca-certificates/ || true" >/dev/null 2>&1
docker exec "${platform}${number}.docker" bash -c "cp -f /certificate-authority/*.crt /usr/local/share/ca-certificates/ || true" >/dev/null 2>&1
docker exec "${platform}${number}.docker" bash -c "cp -f /tls/*.crt /usr/local/share/ca-certificates/ || true" >/dev/null 2>&1
docker exec "${platform}${number}.docker" update-ca-certificates >/dev/null 2>&1
docker exec "${platform}${number}.docker" bash -c "cat /etc/ssl/certs/ca-certificates.crt >> /var/www/html/resources/config/ca-bundle.crt" >/dev/null 2>&1

# run init script inside efss.
redirect_to_null_cmd docker exec -u www-data "${platform}${number}.docker" bash "/${platform}-init.sh"

redirect_to_null_cmd echo ""
}

function createOcmStub() {
local platform="${1}"
local number="${2}"
local user="${3}"
local password="${4}"
local init_script="${5}"
local tag="${6-latest}"
local image="${7}"

if [[ -z "${image}" ]]; then
local image="pondersource/dev-stock-${platform}"
else
local image="pondersource/dev-stock-${platform}-${image}"
fi

redirect_to_null_cmd echo "creating efss ${platform} ${number}"

redirect_to_null_cmd docker run --detach --network=testnet \
--name="${platform}${number}.docker" \
--add-host "host.docker.internal:host-gateway" \
-v "${ENV_ROOT}/docker/tls/certificates/${platform}${number}.crt:/tls/${platform}${number}.crt" \
-v "${ENV_ROOT}/docker/tls/certificates/${platform}${number}.key:/tls/${platform}${number}.key" \
-e HOST="${platform}${number}" \
"${image}:${tag}"

# wait for hostname port to be open.
waitForPort "${platform}${number}.docker" 443

redirect_to_null_cmd echo ""
}

# delete and create temp directory.
rm -rf "${ENV_ROOT}/temp" && mkdir -p "${ENV_ROOT}/temp"

# copy init files.
cp -f "${ENV_ROOT}/docker/scripts/init/nextcloud-ocm-test-suite.sh" "${ENV_ROOT}/temp/nextcloud.sh"

# auto clean before starting.
"${ENV_ROOT}/scripts/clean.sh" "no"

# make sure network exists.
docker network inspect testnet >/dev/null 2>&1 || docker network create testnet >/dev/null 2>&1

#################
### Nextcloud ###
#################

# syntax:
# createNextcloud platform number username password image.
#
#
# platform: owncloud, nextcloud.
# number: should be unique for each platform, for example: you cannot have two Nextclouds with same number.
# username: username for sign in into efss.
# password: password for sign in into efss.
# init script: script for initializing efss.
# tag: tag for the image, use latest if not sure.
# image: which image variation to use for container.

# EFSSs.
createNextcloud nextcloud 1 einstein relativity nextcloud.sh "${EFSS_PLATFORM_1_VERSION}"

# ocmstub only has the latest tag so we don't need this "${EFSS_PLATFORM_VERSION}"
createOcmStub ocmstub 2

if [ "${SCRIPT_MODE}" = "dev" ]; then
###############
### Firefox ###
###############

docker run --detach --network=testnet \
--name=firefox \
-p 5800:5800 \
--shm-size 2g \
-e USER_ID="${UID}" \
-e GROUP_ID="${UID}" \
-e DARK_MODE=1 \
-v "${ENV_ROOT}/docker/tls/browsers/firefox/cert9.db:/config/profile/cert9.db:rw" \
-v "${ENV_ROOT}/docker/tls/browsers/firefox/cert_override.txt:/config/profile/cert_override.txt:rw" \
jlesage/firefox:latest \
>/dev/null 2>&1

##################
### VNC Server ###
##################

# remove previous x11 unix socket file, avoid any problems while mounting new one.
sudo rm -rf "${ENV_ROOT}/temp/.X11-unix"

# try to change DISPLAY_WIDTH, DISPLAY_HEIGHT to make it fit in your screen,
# NOTE: please do not commit any change related to resolution.
docker run --detach --network=testnet \
--name=vnc-server \
-p 5700:8080 \
-e RUN_XTERM=no \
-e DISPLAY_WIDTH=1920 \
-e DISPLAY_HEIGHT=1080 \
-v "${ENV_ROOT}/temp/.X11-unix:/tmp/.X11-unix" \
theasp/novnc:latest

###############
### Cypress ###
###############

# create cypress and attach its display to the VNC server container.
# this way you can view inside cypress container through vnc server.
docker run --detach --network=testnet \
--name="cypress.docker" \
-e DISPLAY=vnc-server:0.0 \
-v "${ENV_ROOT}/cypress/ocm-test-suite:/ocm" \
-v "${ENV_ROOT}/temp/.X11-unix:/tmp/.X11-unix" \
-w /ocm \
--entrypoint cypress \
cypress/included:13.13.1 \
open --project .

# print instructions.
clear
echo "Now browse to :"
echo "Cypress inside VNC Server -> http://localhost:5700/vnc_auto.html, scale VNC to get to the Continue button, and run the appropriate test from ./cypress/ocm-test-suite/cypress/e2e/"
echo "Embedded Firefox -> http://localhost:5800"
echo ""
echo "Inside Embedded Firefox browse to EFSS hostname and enter the related credentials:"
echo "https://nextcloud1.docker -> username: einstein password: relativity"
echo "https://ocmstub1.docker/? -> just click 'Log in'"
else
# only record when testing on electron.
if [ "${BROWSER_PLATFORM}" != "electron" ]; then
sed -i 's/.*video: true,.*/video: false,/' "${ENV_ROOT}/cypress/ocm-test-suite/cypress.config.js"
sed -i 's/.*videoCompression: true,.*/videoCompression: false,/' "${ENV_ROOT}/cypress/ocm-test-suite/cypress.config.js"
fi
##################
### Cypress CI ###
##################

# extract version up until first dot . , example: v27.1.17 becomes v27
P1_VER="$( cut -d '.' -f 1 <<< "${EFSS_PLATFORM_1_VERSION}" )"
P2_VER="$( cut -d '.' -f 1 <<< "${EFSS_PLATFORM_2_VERSION}" )"

# run Cypress test suite headlessly and with the defined browser.
docker run --network=testnet \
--name="cypress.docker" \
-v "${ENV_ROOT}/cypress/ocm-test-suite:/ocm" \
-w /ocm \
cypress/included:13.13.1 cypress run \
--browser "${BROWSER_PLATFORM}" \
--spec "cypress/e2e/share-with/ocmstub-${P1_VER}-to-nextcloud-${P2_VER}.cy.js"

# revert config file back to normal.
if [ "${BROWSER_PLATFORM}" != "electron" ]; then
sed -i 's/.*video: false,.*/ video: true,/' "${ENV_ROOT}/cypress/ocm-test-suite/cypress.config.js"
sed -i 's/.*videoCompression: false,.*/ videoCompression: true,/' "${ENV_ROOT}/cypress/ocm-test-suite/cypress.config.js"
fi

# auto clean after running tests in ci mode. do not clear terminal.
"${ENV_ROOT}/scripts/clean.sh" "no"
fi

0 comments on commit 9da9907

Please sign in to comment.