Merge branch 'master' into fix-wiki-workspace-version-14

.github/helper/install.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+set -e
+cd ~ || exit
+
+echo "Setting Up Bench..."
+
+pip install frappe-bench
+bench -v init frappe-bench --skip-assets --python "$(which python)"
+cd ./frappe-bench || exit
+
+bench -v setup requirements
+
+echo "Setting Up Wiki App..."
+bench get-app wiki "${GITHUB_WORKSPACE}"
+
+echo "Setting Up Sites & Database..."
+
+mkdir ~/frappe-bench/sites/wiki.test
+cp "${GITHUB_WORKSPACE}/.github/helper/site_config.json" ~/frappe-bench/sites/wiki.test/site_config.json
+
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL character_set_server = 'utf8mb4'";
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'";
+
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE DATABASE test_wiki";
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE USER 'test_wiki'@'localhost' IDENTIFIED BY 'test_wiki'";
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "GRANT ALL PRIVILEGES ON \`test_wiki\`.* TO 'test_wiki'@'localhost'";
+
+mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "FLUSH PRIVILEGES";
+
+
+echo "Setting Up Procfile..."
+
+sed -i 's/^watch:/# watch:/g' Procfile
+sed -i 's/^schedule:/# schedule:/g' Procfile
+
+echo "Setting up redisearch module..."
+echo "loadmodule ${GITHUB_WORKSPACE}/.github/helper/redisearch.so" >> ./config/redis_cache.conf
+chmod +x "${GITHUB_WORKSPACE}/.github/helper/redisearch.so"
+cat ./config/redis_cache.conf
+
+echo "Starting Bench..."
+
+bench start &> bench_start.log &
+
+CI=Yes bench build &
+build_pid=$!
+
+bench --site wiki.test reinstall --yes
+bench --site wiki.test install-app wiki
+bench --site wiki.test execute wiki.wiki.doctype.wiki_page.search.rebuild_index
+
+# wait till assets are built succesfully
+wait $build_pid

.github/helper/install_dependencies.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+
+echo "Setting Up System Dependencies..."
+
+# redis repository
+curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
+echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
+
+sudo apt update
+sudo apt install libcups2-dev redis mariadb-client-10.6
+
+install_wkhtmltopdf() {
+ wget -q https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-1/wkhtmltox_0.12.6-1.focal_amd64.deb
+ sudo apt install ./wkhtmltox_0.12.6-1.focal_amd64.deb
+}
+install_wkhtmltopdf &

.github/helper/site_config.json

@@ -0,0 +1,20 @@
+{
+ "db_host": "127.0.0.1",
+ "db_port": 3306,
+ "db_name": "test_wiki",
+ "db_password": "test_wiki",
+ "allow_tests": true,
+ "enable_ui_tests": true,
+ "db_type": "mariadb",
+ "auto_email_id": "[email protected]",
+ "mail_server": "smtp.example.com",
+ "mail_login": "[email protected]",
+ "mail_password": "test",
+ "admin_password": "admin",
+ "root_login": "root",
+ "root_password": "123",
+ "host_name": "http://wiki.test:8000",
+ "monitor": 1,
+ "server_script_enabled": true,
+ "mute_emails": true
+}

.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+ workflow_dispatch:
+concurrency:
+ group: develop-wiki-${{ github.event.number }}
+ cancel-in-progress: true
+jobs:
+ tests:
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ name: Server
+ services:
+ redis-cache:
+ image: redis:alpine
+ ports:
+ - 13000:6379
+ redis-queue:
+ image: redis:alpine
+ ports:
+ - 11000:6379
+ redis-socketio:
+ image: redis:alpine
+ ports:
+ - 12000:6379
+ mariadb:
+ image: mariadb:10.6
+ env:
+ MYSQL_ROOT_PASSWORD: root
+ ports:
+ - 3306:3306
+ options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+ steps:
+ - name: Clone
+ uses: actions/checkout@v3
+ - name: Setup Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ check-latest: true
+ - name: Cache pip
+ uses: actions/cache@v3
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py', '**/setup.cfg') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-
+ ${{ runner.os }}-
+ - name: Get yarn cache directory path
+ id: yarn-cache-dir-path
+ run: 'echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT'
+ - uses: actions/cache@v3
+ id: yarn-cache
+ with:
+ path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+ key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-yarn-
+ - name: Setup
+ run: |
+ pip install frappe-bench
+ bench init --skip-redis-config-generation --skip-assets --python "$(which python)" ~/frappe-bench
+ mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"
+ mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"
+ - name: Install
+ working-directory: /home/runner/frappe-bench
+ run: |
+ bench get-app wiki $GITHUB_WORKSPACE
+ bench setup requirements --dev
+ bench new-site --db-root-password root --admin-password admin test_site
+ bench --site test_site install-app wiki
+ bench build
+ env:
+ CI: 'Yes'
+ - name: Run Tests
+ working-directory: /home/runner/frappe-bench
+ run: |
+ bench --site test_site set-config allow_tests true
+ bench --site test_site run-tests --app wiki
+ env:
+ TYPE: server

.github/workflows/linters.yml

@@ -0,0 +1,59 @@
+name: Linters
+
+on:
+ pull_request:
+ workflow_dispatch:
+ push:
+ branches: [ master ]
+
+permissions:
+ contents: read
+
+concurrency:
+ group: commitcheck-frappe-${{ github.event_name }}-${{ github.event.number }}
+ cancel-in-progress: true
+
+jobs:
+ commit-lint:
+ name: 'Semantic Commits'
+ runs-on: ubuntu-latest
+ if: github.event_name == 'pull_request'
+
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ fetch-depth: 200
+ - uses: actions/setup-node@v3
+ with:
+ node-version: 16
+ check-latest: true
+
+ - name: Check commit titles
+ run: |
+ npm install @commitlint/cli @commitlint/config-conventional
+ npx commitlint --verbose --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }}
+
+ linter:
+ name: 'Frappe Linter'
+ runs-on: ubuntu-latest
+ if: github.event_name == 'pull_request'
+
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: pre-commit/[email protected]
+
+ deps-vulnerable-check:
+ name: 'Vulnerable Dependency Check'
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/checkout@v3
+ - run: |
+ pip install pip-audit
+ pip-audit -r ${GITHUB_WORKSPACE}/requirements.txt

.github/workflows/ui-tests.yml

@@ -0,0 +1,111 @@
+name: UI Test
+
+on:
+ pull_request:
+ push:
+ branches: [ master ]
+
+permissions:
+ contents: read
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ if: ${{ github.repository_owner == 'frappe' }}
+ timeout-minutes: 60
+
+ strategy:
+ fail-fast: false
+
+ name: UI Tests (Cypress)
+
+ services:
+ mariadb:
+ image: mariadb:10.6
+ env:
+ MARIADB_ROOT_PASSWORD: 123
+ ports:
+ - 3306:3306
+ options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+
+ steps:
+ - name: Clone
+ uses: actions/checkout@v3
+
+ - name: Setup Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+
+ - name: Check for valid Python & Merge Conflicts
+ run: |
+ python -m compileall -q -f "${GITHUB_WORKSPACE}"
+ if grep -lr --exclude-dir=node_modules "^<<<<<<< " "${GITHUB_WORKSPACE}"
+ then echo "Found merge conflicts"
+ exit 1
+ fi
+ - uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ check-latest: true
+
+ - name: Add to Hosts
+ run: |
+ echo "127.0.0.1 wiki.test" | sudo tee -a /etc/hosts
+ - name: Cache pip
+ uses: actions/cache@v3
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-
+ ${{ runner.os }}-
+ - name: Get yarn cache directory path
+ id: yarn-cache-dir-path
+ run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+
+ - uses: actions/cache@v3
+ id: yarn-cache
+ with:
+ path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+ key: ${{ runner.os }}-yarn-ui-${{ hashFiles('**/yarn.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-yarn-ui-
+ - name: Cache cypress binary
+ uses: actions/cache@v3
+ with:
+ path: ~/.cache/Cypress
+ key: ${{ runner.os }}-cypress
+
+ - name: Install Dependencies
+ run: |
+ bash ${GITHUB_WORKSPACE}/.github/helper/install_dependencies.sh
+ bash ${GITHUB_WORKSPACE}/.github/helper/install.sh
+ env:
+ BEFORE: ${{ env.GITHUB_EVENT_PATH.before }}
+ AFTER: ${{ env.GITHUB_EVENT_PATH.after }}
+
+ - name: Site Setup
+ run: |
+ cd ~/frappe-bench/
+ bench --site wiki.test execute frappe.utils.install.complete_setup_wizard
+ bench --site wiki.test execute frappe.tests.ui_test_helpers.create_test_user
+
+ - name: cypress pre-requisites
+ run: |
+ cd ~/frappe-bench/apps/wiki
+ yarn add cypress@^10 --no-lockfile
+
+ - name: UI Tests
+ run: cd ~/frappe-bench && bench --site wiki.test run-ui-tests wiki --headless
+ env:
+ CYPRESS_BASE_URL: http://wiki.test:8000
+ CYPRESS_RECORD_KEY: 2e746aa8-d98b-4dac-8bc0-6e35ce9111d2
+
+ - name: Stop server
+ run: |
+ ps -ef | grep "[f]rappe serve" | awk '{print $2}' | xargs kill -s SIGINT
+ sleep 5
+ - name: Show bench output
+ if: ${{ always() }}
+ run: cat ~/frappe-bench/bench_start.log || true

.gitignore

@@ -7,4 +7,10 @@ wiki/docs/current
 wiki/public/css
 wiki/public/dist
 dist/
-css-rtl/
+css-rtl/
+node_modules/*
+wiki/public/node_modules
+.cypress-coverage
+cypress/screenshots
+cypress/videos
+__pycache__/