Abstract Wikipedia/Abstract developer cheatsheet

e.g.

git clone "ssh://gengh@gerrit.wikimedia.org:29418/mediawiki/extensions/WikiLambda"

git clone --recurse-submodules git@gitlab.wikimedia.org:repos/abstract-wiki/wikifunctions/function-orchestrator.git

git clone --recurse-submodules git@gitlab.wikimedia.org:repos/abstract-wiki/wikifunctions/function-evaluator.git

git clone git@gitlab.wikimedia.org:repos/abstract-wiki/wikifunctions/function-schemata.git

git submodule update --init --recursive

git clone "ssh://gengh@gerrit.wikimedia.org:29418/mediawiki/extensions/WikifunctionsClient"

$ git checkout -b mynewfeature
# do stuff and and stage
$ git commit
# Write message and description with Bug: <Phabricator task> at the bottom
$ git review
# Maybe do some more modifications on your patch
$ git commit --amend
$ git review

$ git fetch  # to make sure you have the most up-to-date version of master
$ git checkout origin/master
$ git checkout -b my-new-branch

$ git review -d <gerrit patch ID> # you can see it on the gerrit url of a given patch
# do stuff and and stage
$ git commit --amend
# modify the commit message or leave it the same
$ git review

$ git checkout master
$ git pull origin master
$ git checkout <your branch>
$ git rebase master
$ git commit --amend
$ git review

$ git review -s --verbose  # Setup git review
$ git review -d 643568     # -d change (--download=change) downloads a change ID into a local branch.
$ git review
$ git review -R            # Git review but without performing rebase (--no-rebase)
$ git review -f            # Submit a change for review and close local branch (--finish)
$ php maintenance/run.php createAndPromote --custom-groups functioneer,functionmaintainer --force Admin
$ # or for docker compose environment:
$ docker compose exec mediawiki php maintenance/run.php createAndPromote --custom-groups functioneer,functionmaintainer --force Admin

$wgVueDevelopmentMode = true;
require "$IP/includes/DevelopmentSettings.php";

$wgResourceLoaderEnableSourceMapLinks = true;

wfLoadExtension( 'UniversalLanguageSelector' );
wfLoadExtension( 'MobileFrontend' );
wfLoadSkin( 'MinervaNeue' );
$wgDefaultMobileSkin = 'minerva';

git submodule update --init --recursive
$ ./bin/updateSubmodule.sh
$ git review

# mediawiki should be current directory for all these commands

# Run all test suite using local settings:
$ docker compose exec mediawiki composer phpunit:entrypoint

# Run WikiLambda tests:
$ docker compose exec mediawiki composer phpunit:entrypoint extensions/WikiLambda/tests/phpunit/

# Run a particular test file:
$ docker compose exec mediawiki composer phpunit:entrypoint extensions/WikiLambda/tests/phpunit/integration/ZObjectStoreTest.php

# Filter by files:
$ docker compose exec mediawiki composer phpunit:entrypoint extensions/WikiLambda -- --filter "ZObjectAuthorization|ZObjectStore"

# Run a particular test method:
$ docker compose exec mediawiki composer phpunit:entrypoint -- extensions/WikiLambda/tests/phpunit/integration/API/ApiFunctionCallTest.php --filter testExecuteSuccessfulViaBetaCluster

# Run tests and generate coverage in HTML
$ docker compose exec mediawiki composer phpunit:entrypoint --coverage-html="./docs/coverage" extensions/WikiLambda/tests/phpunit/ --whitelist="./extensions/WikiLambda"

# Run tests and generate coverage in txt (and print it)
$ docker compose exec mediawiki composer phpunit:entrypoint --coverage-text="./docs/coverage.txt" extensions/WikiLambda/tests/phpunit/ --whitelist="./extensions/WikiLambda" ; cat ./docs/coverage.txt

# Apply automatic fixes
docker compose exec mediawiki composer fix extensions/WikiLambda/

# Check other PHP CodeSniffer errors (fix manually)
docker compose exec mediawiki composer phpcs extensions/WikiLambda/

Run the standard CI linting tests locally
docker run --rm -it -u "$(id -u):$(id -g)" -v "$PWD/.git:/src/.git:ro" -v "$PWD/:/src" -w /src docker-registry.wikimedia.org/releng/composer-php81:latest test

Try to automatically fix any linting isses
docker run --rm -it -u "$(id -u):$(id -g)" -v "$PWD/.git:/src/.git:ro" -v "$PWD/:/src" -w /src docker-registry.wikimedia.org/releng/composer-php81:latest fix

Run the Phan CI linting tests locally (on PHP 7.4 as Phan has issues on 8.1)
docker run --rm --it --volume "$PWD/../..":/src -v "$PWD/.git:/src/.git:ro" docker-registry.wikimedia.org/releng/composer-php74:latest --working-dir=/src/extensions/WikiLambda phan

# From the directory Wikilambda, 
# Source .env file from the mediawiki docker compose environment
$ source ../../.env

# Unset the DISPLAY environment variable
$ unset DISPLAY
# Or set it starting with a colon if you want to trigger ffmpeg recording
$ export DISPLAY=:1

# And run the tests
$ npm run browser-test

# To run a particular test file
$ clear; npm run browser-test -- --spec tests/selenium/specs/function.js

# Or to run a specific test by test name
$ clear; npm run browser-test -- --spec tests/selenium/specs/function.js --mochaOpts.grep CUJ1

# With mediawiki/extensions/WikiLambda as current directory
# Install npm dependencies
npm ci

# Run tests
npm test

# Run linter
npm run lint:fix

# Run unit tests
npm run test:unit

# Run a particular test file
clear; npm run test:unit tests/jest/components/widgets/FunctionEvaluator.test.js 

# Run one particular test
clear; npm run test:unit tests/jest/store/modules/zobject.test.js -- -t 'currentZFunctionInvalidInputs'
clear; npm run test:unit -- -t 'currentZFunctionInvalidInputs'

# Install npm dependencies
npm ci

# Run tets
npm test
npm run test:nolint

npm run test:nolint -- -f <substring matching test name>

# For example:
npm run test:nolint -- -f "canonical lists"

npm run test:unit tests/jest/integration/EditFunction.test.js

npm run test:unit tests/jest/store/modules/zobject.test.js

wfDebugLog("error", "Here's some error information about the variable $var" );
# For function orchestrator
docker build -f .pipeline/blubber.yaml --target development -t local-orchestrator .

# For function evaluator (javascript)
docker build -f .pipeline/blubber.yaml --target development-javascript-all-wasm -t local-evaluator-js .

# For function evaluator (python)
docker build -f .pipeline/blubber.yaml --target development-python3-all-wasm -t local-evaluator-py .

docker compose up -d
# Show all container logs and follow
docker compose logs -f

# Show only function-orchestrator logs and follow
docker compose logs function-orchestrator -f

# Alternate logs command--runs from any directory with cleaner output, but is less comprehensible.
docker logs mediawiki-function-orchestrator-1
import logging
logging.exception("this is some error")

# from function-orchestrator directory
npm install

# make mocha easy to find (this can go in .bashrc or OS equivalent)
alias mocha='./node_modules/mocha/bin/mocha'

# run tests (you can filter like "mocha -g 'substring of test name'")
mocha
docker-compose down

# If you are running tests with npm:
npm run test:nolint -- -g 'TEXT'

# If you are running tests directly with mocha:
mocha -g 'TEXT'

# place in /usr/local/bin/build-run-blubber or elsewhere on $PATH
#!/bin/bash

set -e

if [ -z $2 ]; then
    echo "Please invoke as $ build-run-blubber <Blubber variant> <image name>."
    exit 1
fi

docker build -f .pipeline/blubber.yaml --target ${1} -t ${2} . && \
    docker run ${2}
# run these commands from function-evaluator directory
# run the full test suite for the Node services, including eslint for JavaScript files
build-run-blubber test-python3-all-evaluator testpyall
build-run-blubber test-python3-all-wasm-evaluator testwhyall
build-run-blubber test-javascript-all-evaluator testjsall
build-run-blubber test-javascript-all-wasm-evaluator testjswall

# run the tests for the Python executor
build-run-blubber test-python3-executor testpy

# run the tests for the JS executor
build-run-blubber test-javascript-executor testjs

# run format testing for python files
build-run-blubber format-python3 formatpy
blubber .pipeline/blubber.yaml development | docker build -t local-orchestrator -f - .
docker build -t local-orchestrator -f SOMEVARIANT.DOCKER .

Abstract Wikipedia/Abstract developer cheatsheet

Wikifunctions Repositories

WikiLambda

Continuous Integration for WikiLambda in Gerrit

Function Orchestrator

Function Evaluator

Function Schemata

WikifunctionsClient

Gerrit Cheatsheet

Updating mediawiki installation

Rights and Privileges

Wikifunctions development workflow tips

WikiLambda starting guide

Vue Devtools

Auxiliary extensions

Set up mobile front-end in Dev environment

Unminified Front-End JS code

Git Submodules

Updating Submodules

WikiLambda PHPunit tests

PHP linting

WikiLambda e2e tests

WikiLambda front-end tests

Function-schemata tests

Other entry points and composer commands

Debugging and logs

Debugging and logs in NodeJS services

Testing NodeJS Services

function-orchestrator

function-evaluator

carbon-neutral, packet-negative Green Anarchist coder life

Maintenance scripts

Reload built-in data

Load production dump

Supporting Contributors

Allow list for new contributors

Force Zuul to run tests

Links of Interest