MDL-68070 messaging: Amend lang string to be clearer for any user.
[moodle.git] / .travis.yml
1 # PLEASE NOTE: Travis is not currently utilised by the Moodle core integration
2 # process (which uses our internal CI system) this file is here for the benefit
3 # of community developers git clones - see MDL-51458.
5 notifications:
6   email:
7     if: env(MOODLE_EMAIL) != no
9 language: php
11 os: linux
13 dist: xenial
15 services:
16     - mysql
17     - docker
19 php:
20     # We only run the highest and lowest supported versions to reduce the load on travis-ci.org.
21     - 7.4
22     - 7.2
24 addons:
25   postgresql: "9.6"
27 env:
28     # Although we want to run these jobs and see failures as quickly as possible, we also want to get the slowest job to
29     # start first so that the total run time is not too high.
30     #
31     # We only run MySQL on PHP 7.2, so run that first.
32     # CI Tests should be second-highest in priority as these only take <= 60 seconds to run under normal circumstances.
33     # Postgres is significantly is pretty reasonable in its run-time.
35     # Run CI Tests without running PHPUnit.
36     - DB=none     TASK=CITEST
38     # Run unit tests on Postgres
39     - DB=pgsql    TASK=PHPUNIT
41     # Perform an upgrade test too.
42     - DB=pgsql    TASK=UPGRADE
44 jobs:
45     # Enable fast finish.
46     # This will fail the build if a single job fails (except those in allow_failures).
47     # It will not stop the jobs from running.
48     fast_finish: true
50     include:
51           # Run mysql only on highest - it's just too slow
52         - php: 7.4
53           env: DB=mysqli   TASK=PHPUNIT
54           # Run grunt/npm install on highest version too ('node' is an alias for the latest node.js version.)
55         - php: 7.4
56           env: DB=none     TASK=GRUNT   NVM_VERSION='lts/carbon'
58 cache:
59     directories:
60       - $HOME/.composer/cache
61       - $HOME/.npm
63 before_install:
64     - docker run -d -p 127.0.0.1:8080:80 --name exttests moodlehq/moodle-exttests
65     # Avoid IPv6 default binding as service (causes redis not to start).
66     - sudo service redis-server start --bind 127.0.0.1
68 install:
69     - >
70         if [ "$DB" = 'mysqli' ];
71         then
72             sudo mkdir /mnt/ramdisk
73             sudo mount -t tmpfs -o size=1024m tmpfs /mnt/ramdisk
74             sudo service mysql stop
75             sudo mv /var/lib/mysql /mnt/ramdisk
76             sudo ln -s /mnt/ramdisk/mysql /var/lib/mysql
77             sudo service mysql restart
78         fi
79     - >
80         if [ "$DB" = 'pgsql' ];
81         then
82             sudo mkdir /mnt/ramdisk
83             sudo mount -t tmpfs -o size=1024m tmpfs /mnt/ramdisk
84             sudo service postgresql stop
85             sudo mv /var/lib/postgresql /mnt/ramdisk
86             sudo ln -s /mnt/ramdisk/postgresql /var/lib/postgresql
87             sudo service postgresql start 9.6
88         fi
89     - >
90         if [ "$TASK" = 'PHPUNIT' ];
91         then
92             if [ -n "$GITHUB_APITOKEN" ]; then
93                 composer config github-oauth.github.com $GITHUB_APITOKEN;
94                 echo 'auth.json' >> .git/info/exclude
95             fi
97             echo 'extension="redis.so"' > /tmp/redis.ini
98             phpenv config-add /tmp/redis.ini
100             # Install composer dependencies.
101             # We need --no-interaction in case we hit API limits for composer. This causes it to fall back to a standard clone.
102             # Typically it should be able to use the Composer cache if any other job has already completed before we started here.
103             travis_retry composer install --prefer-dist --no-interaction;
104         fi
106     - >
107         if [ "$TASK" = 'GRUNT' ];
108         then
109             nvm install $NVM_VERSION ;
110             nvm use $NVM_VERSION ;
111         fi
113 before_script:
114     - phpenv config-rm xdebug.ini
115     - >
116       if [ "$TASK" = 'PHPUNIT' -o "$TASK" = 'UPGRADE' ];
117       then
118         # Copy generic configuration in place.
119         cp config-dist.php config.php ;
121         # Create the moodledata directory.
122         mkdir -p "$HOME"/roots/base
124         # The database name and password.
125         sed -i \
126           -e "s%= 'moodle'%= 'travis_ci_test'%" \
127           -e "s%= 'password'%= ''%" \
128           config.php ;
130         # The wwwroot and dataroot.
131         sed -i \
132           -e "s%http://example.com/moodle%https://localhost%" \
133           -e "s%/home/example/moodledata%/home/travis/roots/base%" \
134           config.php ;
136         if [ "$DB" = 'pgsql' ];
137         then
138           # Postgres-specific setup.
139           sed -i \
140             -e "s%= 'username'%= 'postgres'%" \
141             config.php ;
143           psql -c 'CREATE DATABASE travis_ci_test;' -U postgres;
144         fi
146         if [ "$DB" = 'mysqli' ];
147         then
148           # MySQL-specific setup.
149           sed -i \
150             -e "s%= 'pgsql'%= 'mysqli'%" \
151             -e "s%= 'username'%= 'travis'%" \
152             -e "s%=> 'utf8mb4_unicode_ci'%=> 'utf8mb4_bin'%" \
153             config.php;
155           mysql -u root -e 'SET GLOBAL innodb_file_format=barracuda;' ;
156           mysql -u root -e 'SET GLOBAL innodb_file_per_table=ON;' ;
157           mysql -u root -e 'SET GLOBAL innodb_large_prefix=ON;' ;
158           mysql -e 'CREATE DATABASE travis_ci_test DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_bin;' ;
159         fi
160       fi
162     - >
163       if [ "$TASK" = 'PHPUNIT' ];
164       then
165         # Create a directory for the phpunit dataroot.
166         mkdir -p "$HOME"/roots/phpunit
168         # The phpunit dataroot and prefix..
169         sed -i \
170           -e "/require_once/i \\\$CFG->phpunit_dataroot = '\/home\/travis\/roots\/phpunit';" \
171           -e "/require_once/i \\\$CFG->phpunit_prefix = 'p_';" \
172           config.php ;
173         # Enable test external resources
174         sed -i \
175           -e "/require_once/i \\define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://127.0.0.1:8080');" \
176           -e "/require_once/i \\define('TEST_EXTERNAL_FILES_HTTPS_URL', 'http://127.0.0.1:8080');" \
177           config.php ;
179         # Redis cache store tests
180         sed -i \
181           -e "/require_once/i \\define('TEST_CACHESTORE_REDIS_TESTSERVERS', '127.0.0.1');" \
182           config.php ;
183         # Redis session tests, but not for PHP 7.2 and up. See MDL-60978 for more info.
184         redissession="define('TEST_SESSION_REDIS_HOST', '127.0.0.1');"
185         sed -i \
186           -e "/require_once/i \\${redissession}" \
187           config.php ;
189         # Initialise PHPUnit for Moodle.
190         php admin/tool/phpunit/cli/init.php
191       fi
193     - >
194       if [ "$TASK" = 'GRUNT' ];
195       then
196         npm install --no-spin;
197         npm install --no-spin -g grunt ;
198       fi
200     ########################################################################
201     # CI Tests
202     ########################################################################
203     - >
204       if [ "$TASK" = 'CITEST' ];
205       then
206         # Note - this is deliberately placed in the script section as we
207         # should not add any code until after phpunit has run.
209         # The following repositories are required.
210         # The local_ci repository does the actual checking.
211         git clone https://github.com/moodlehq/moodle-local_ci.git local/ci
213         # We need the official upstream for comparison
214         git remote add upstream https://github.com/moodle/moodle.git;
216         git fetch upstream MOODLE_310_STABLE;
217         export GIT_PREVIOUS_COMMIT="`git merge-base FETCH_HEAD $TRAVIS_COMMIT`";
218         export GIT_COMMIT="$TRAVIS_COMMIT";
219         export UPSTREAM_FETCH_HEAD=`git rev-parse FETCH_HEAD`
221         # Variables required by our linter.
222         export gitcmd=`which git`;
223         export gitdir="$TRAVIS_BUILD_DIR";
224         export phpcmd=`which php`;
225       fi
227     ########################################################################
228     # Upgrade test
229     ########################################################################
230     - >
231       if [ "$TASK" = 'UPGRADE' ];
232       then
233         # We need the official upstream.
234         git remote add upstream https://github.com/moodle/moodle.git;
236         # Checkout 30 STABLE branch (the first version compatible with PHP 7.x)
237         git fetch upstream MOODLE_30_STABLE;
238         git checkout MOODLE_30_STABLE;
240         # Perform the upgrade
241         php admin/cli/install_database.php --agree-license --adminpass=Password --adminemail=admin@example.com --fullname="Upgrade test" --shortname=Upgrade;
243         # Return to the previous commit
244         git checkout -;
246         # Perform the upgrade
247         php admin/cli/upgrade.php --non-interactive --allow-unstable ;
249         # The local_ci repository can be used to check upgrade savepoints.
250         git clone https://github.com/moodlehq/moodle-local_ci.git local/ci ;
251       fi
253 script:
254     - >
255       if [ "$TASK" = 'PHPUNIT' ];
256       then
257         vendor/bin/phpunit --fail-on-risky --disallow-test-output --verbose;
258       fi
260     - >
261       if [ "$TASK" = 'CITEST' ];
262       then
263         bash local/ci/php_lint/php_lint.sh;
264       fi
266     - >
267       if [ "$TASK" = 'GRUNT' ];
268       then
269         grunt ;
270         # Add all files to the git index and then run diff --cached to see all changes.
271         # This ensures that we get the status of all files, including new files.
272         # We ignore npm-shrinkwrap.json to make the tasks immune to npm changes.
273         git add . ;
274         git reset -- npm-shrinkwrap.json ;
275         git diff --cached --exit-code ;
276       fi
278     ########################################################################
279     # Upgrade test
280     ########################################################################
281     - >
282       if [ "$TASK" = 'UPGRADE' ];
283       then
284         cp local/ci/check_upgrade_savepoints/check_upgrade_savepoints.php ./check_upgrade_savepoints.php
285         result=`php check_upgrade_savepoints.php`;
286         # Check if there are problems
287         count=`echo "$result" | grep -P "ERROR|WARN" | wc -l` ;
288         if (($count > 0));
289         then
290           echo "$result"
291           exit 1 ;
292         fi
293       fi
295 after_script:
296     - >
297       if [ "$TASK" = 'PHPUNIT' ];
298       then
299         EXTTESTS_HITS=$(docker logs exttests 2>&1 | grep -Fv -e 'AH00558' -e '[pid 1]' | wc -l)
300         echo -e "\nTest local resources number of hits: ${EXTTESTS_HITS}.\n"
301       fi