Usage examples::

# One command. $ MDKDOCKERNAME=sm mdk phpunit

# Multiple commands. $ set -x MDKDOCKERNAME sm $ mdk run dev $ mdk phpunit

# Enable automatic resolution. $ mdk config set docker.automaticContainerLookup true

# With automatic resolution. $ cd /path/to/sm $ mdk phpunit

Compatible containers

# From the instance directory. mdk docker up --port 8800 --php 8.2

# From anywhere when the container already exists. mdk docker up sm

# To start the default docker Postgres instance mdk docker db up pgsql-docker

You may create the containers manually but MDK handles the volumes, the network, and other details.

Create & install flow

To create a new instance and install it::

set -x MDKDOCKERNAME example mdk create --identifier example mdk docker up --port 8800 example mdk install --engine pgsql-docker example mdk open example

To remove it completely::

mdk docker down example mdk remove example

PHP executable ==============

VScode settings

::

{ "php.validate.executablePath": "/path/to/custom/executable/php-mdk" "mdlcode.cli.phpPath": "mdk php", }

Custom PHP executable

#!/bin/bash mdk php $@

Then make it executable::

chmod 0700 ~/.local/bin/php-mdk

Installation ============

Python package

On Debian-based systems, install the following packages::

sudo apt-get install python-pip libmysqlclient-dev libpq-dev python-dev unixodbc-dev

pip install moodle-sdk --user mdk init

Notes ^^^^^

# Set PATH so it includes user's private local bin if it exists. if [ -d "$HOME/.local/bin" ] ; then PATH="$HOME/.local/bin:$PATH" fi

Homebrew

For development

Clone the repository::

git clone https://github.com/FMCorz/mdk.git moodle-sdk

On Debian-based systems, you will need to install the following packages::

sudo apt-get install python3-pip libmysqlclient-dev libpq-dev python3-dev unixodbc-dev

Then from the directory where you cloned the repository::

pip3 install --user -e . --break-system-packages mdk init

Shell completion

Fish completion ^^^^^^^^^^^^^^^

To activate fish completion::

sudo ln -s /path/to/moodle-sdk/extra/fish_completion.fish ~/.config/fish/completions/mdk.fish

Bash completion ^^^^^^^^^^^^^^^

To activate bash completion::

sudo ln -s /path/to/moodle-sdk/extra/bashcompletion /etc/bashcompletion.d/moodle-sdk

if [ -f /path/to/moodle-sdk/extra/goto_instance ]; then . /path/to/moodle-sdk/extra/goto_instance . /path/to/moodle-sdk/extra/gotoinstance.bashcompletion fi

Upgrading =========

If you installed MDK using PIP, run the following command::

pip install --user --upgrade moodle-sdk

It is possible that a new version of MDK requires new files, directories, etc... and while we try to make it easy to upgrade, it can happen that some features get broken in your environment. So after each upgrade, consider running the following to get more information::

mdk doctor --all

Command list ============

Set up aliases of your Moodle commands.

Example

This line defines the alias 'upall', for 'moodle update --all'

::

mdk alias add upall "update --all"

backport

Backport a branch to another instance of Moodle.

Examples

Assuming we are in a Moodle instance, this backports the current branch to the version 2.2 and 2.3

::

mdk backport --version 22 23

Backports the branch MDL-12345-23 from the instance stable23 to the instance stable22, and pushes the new branch to your remote

::

mdk backport stable_23 --branch MDL-12345-23 --version 22 --push

behat

Get the instance ready for acceptance testing (Behat), and run the test feature(s).

Examples

::

mdk behat -r --tags=@core_completion

create

Create a new instance of Moodle. It will be named according to your config file.

Examples

Create a new instance of Moodle 2.1

::

mdk create --version 21

Create an instance of Moodle 2.2 using PostgreSQL from the integration remote, and run the installation script.

::

mdk create --version 22 --engine pgsql --integration --install

config

Set your MDK settings from the command line.

Examples

Show the list of your settings

::

mdk config list

::

mdk config set dirs.storage /var/www/repositories

doctor

Perform some checks on the environment to identify possible problems, and attempt to fix them automatically.

fix

Create a branch from an issue number on the tracker (MDL-12345) and sets it to track the right branch.

Examples

In a Moodle 2.2 instance, this will create (and checkout) a branch named MDL-12345-22 which will track upstream/MOODLE22STABLE.

::

mdk fix MDL-12345 mdk fix 12345

info

Display information about the instances on the system.

Examples

List the instances

::

mdk info --list

Display the information known about the instance stable_main

::

mdk info stable_main

install

Run the command line installation script with all parameters set on an existing instance.

Examples

::

mdk install --engine mysqli stable_main

path

Resolve paths to and inside a Moodle instance.

Examples

::

mdk path mdk path --component mod_assign mdk path --class \\core\\event\\coursemoduleupdated mdk path --subpath foo/bar/example.php --exists

php

Invoke a PHP command in the context of the instance.

Examples

::

mdk php admin/cli/purge_caches.php

phpunit

Get the instance ready for PHPUnit tests, and run the test(s).

Examples

::

mdk phpunit -u repository/tests/repository_test.php

plugin

Look for a plugin on moodle.org and downloads it into your instance.

Example

::

mdk plugin download repository_evernote

precheck

Pre-checks a patch on the CI server.

Example

::

mdk precheck

purge

Purge the cache.

Example

To purge the cache of all the instances

::

mdk purge --all

pull

Pulls a patch using the information from a tracker issue.

Example

Assuming we type that command on a 2.3 instance, pulls the corresponding patch from the issue MDL-12345 in a testing branch

::

mdk pull --testing 12345

push

Shortcut to push a branch to your remote.

Examples

Push the current branch to your repository

::

mdk push

Force a push of the branch MDL-12345-22 from the instance stable_22 to your remote

::

mdk push --force --branch MDL-12345-22 stable_22

rebase

Fetch the latest branches from the upstream remote and rebase your local branches.

Examples

This will rebase the branches MDL-12345-xx and MDL-56789-xx on the instances stable22, stable23 and stable_main. And push them to your remote if successful.

::

mdk rebase --issues 12345 56789 --version 22 23 main --push mdk rebase --issues MDL-12345 MDL-56789 --push stable22 stable23 stable_main

remove

Remove an instance, deleting every thing including the database.

Example

::

mdk remove stable_main

run

Execute a script on an instance. The scripts are stored in the scripts directory.

Example

Set the instance stable_main ready for development

::

mdk run dev stable_main

tracker

Gets some information about the issue on the tracker.

Example

::

$ mdk tracker 34543 ------------------------------------------------------------------------ MDL-34543: New assignment module - Feedback file exists for an assignment but not shown in the Feedback files picker Bug - Critical - https://moodle.atlassian.net/browse/MDL-34543 Closed (Fixed) 2012-08-17 07:25 -------------------------------------------------------[ V: 7 - W: 7 ]-- Reporter : Paul Hague (paulhague) on 2012-07-26 08:30 Assignee : Eric Merrill (emerrill) Peer reviewer : Damyon Wiese (damyon) Integrator : Dan Poltawski (poltawski) Tester : Tim Barker (timb) ------------------------------------------------------------------------

uninstall

Uninstall an instance: removes config file, drops the database, deletes dataroot content, ...

update

Fetch the latest stables branches from the upstream remote and pull the changes into the local stable branch.

Examples

This updates the instances stable22 and stable23

::

mdk update stable22 stable23

This updates all your integration instances and runs the upgrade script of Moodle.

::

mdk update --integration --upgrade

upgrade

Run the upgrade script of your instance.

Examples

The following runs an upgrade on your stable branches

::

mdk upgrade --stable

This will run an update an each instance before performing the upgrade process

::

mdk upgrade --all --update

Scripts =======

::

# From anywhere on the system $ mdk run helloworld stable_main

# Is similar to typing the following command $ cp /path/to/script/helloworld.php /path/to/moodle/instances/stable_main $ cd /path/to/moodle/instances/stable_main $ php helloworld.php

Scripts are very handy when it comes to performing more complexed tasks.

Shipped scripts

The following scripts are available with MDK: