8bd3815009e998feffc6ff5f981df2390119b366
[moodle.git] / lib / behat / classes / behat_config_util.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Utils to set Behat config
19  *
20  * @package    core
21  * @copyright  2016 Rajesh Taneja
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once(__DIR__ . '/../lib.php');
28 require_once(__DIR__ . '/behat_command.php');
29 require_once(__DIR__ . '/../../testing/classes/tests_finder.php');
31 /**
32  * Behat configuration manager
33  *
34  * Creates/updates Behat config files getting tests
35  * and steps from Moodle codebase
36  *
37  * @package    core
38  * @copyright  2016 Rajesh Taneja
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_config_util {
43     /**
44      * @var array list of features in core.
45      */
46     private $features;
48     /**
49      * @var array list of contexts in core.
50      */
51     private $contexts;
53     /**
54      * @var array list of theme specific contexts.
55      */
56     private $themecontexts;
58     /**
59      * @var array list of overridden theme contexts.
60      */
61     private $overriddenthemescontexts;
63     /**
64      * @var array list of components with tests.
65      */
66     private $componentswithtests;
68     /**
69      * @var array|string keep track of theme to return suite with all core features included or not.
70      */
71     private $themesuitewithallfeatures = array();
73     /**
74      * @var string filter features which have tags.
75      */
76     private $tags = '';
78     /**
79      * @var int number of parallel runs.
80      */
81     private $parallelruns = 0;
83     /**
84      * @var int current run.
85      */
86     private $currentrun = 0;
88     /**
89      * @var string used to specify if behat should be initialised with all themes.
90      */
91     const ALL_THEMES_TO_RUN = 'ALL';
93     /**
94      * Set value for theme suite to include all core features. This should be used if your want all core features to be
95      * run with theme.
96      *
97      * @param bool $themetoset
98      */
99     public function set_theme_suite_to_include_core_features($themetoset) {
100         // If no value passed to --add-core-features-to-theme or ALL is passed, then set core features for all themes.
101         if (!empty($themetoset)) {
102             if (is_number($themetoset) || is_bool($themetoset) || (self::ALL_THEMES_TO_RUN === strtoupper($themetoset))) {
103                 $this->themesuitewithallfeatures = self::ALL_THEMES_TO_RUN;
104             } else {
105                 $this->themesuitewithallfeatures = explode(',', $themetoset);
106                 $this->themesuitewithallfeatures = array_map('trim', $this->themesuitewithallfeatures);
107             }
108         }
109     }
111     /**
112      * Set the value for tags, so features which are returned will be using filtered by this.
113      *
114      * @param string $tags
115      */
116     public function set_tag_for_feature_filter($tags) {
117         $this->tags = $tags;
118     }
120     /**
121      * Set parallel run to be used for generating config.
122      *
123      * @param int $parallelruns number of parallel runs.
124      * @param int $currentrun current run
125      */
126     public function set_parallel_run($parallelruns, $currentrun) {
128         if ($parallelruns < $currentrun) {
129             behat_error(BEHAT_EXITCODE_REQUIREMENT,
130                 'Parallel runs('.$parallelruns.') should be more then current run('.$currentrun.')');
131         }
133         $this->parallelruns = $parallelruns;
134         $this->currentrun = $currentrun;
135     }
137     /**
138      * Return parallel runs
139      *
140      * @return int number of parallel runs.
141      */
142     public function get_number_of_parallel_run() {
143         // Get number of parallel runs if not passed.
144         if (empty($this->parallelruns) && ($this->parallelruns !== false)) {
145             $this->parallelruns = behat_config_manager::get_behat_run_config_value('parallel');
146         }
148         return $this->parallelruns;
149     }
151     /**
152      * Return current run
153      *
154      * @return int current run.
155      */
156     public function get_current_run() {
157         global $CFG;
159         // Get number of parallel runs if not passed.
160         if (empty($this->currentrun) && ($this->currentrun !== false) && !empty($CFG->behatrunprocess)) {
161             $this->currentrun = $CFG->behatrunprocess;
162         }
164         return $this->currentrun;
165     }
167     /**
168      * Return list of features.
169      *
170      * @param string $tags tags.
171      * @return array
172      */
173     public function get_components_features($tags = '') {
174         global $CFG;
176         // If we already have a list created then just return that, as it's up-to-date.
177         // If tags are passed then it's a new filter of features we need.
178         if (!empty($this->features) && empty($tags)) {
179             return $this->features;
180         }
182         // Gets all the components with features.
183         $features = array();
184         $featurespaths = array();
185         $components = $this->get_components_with_tests();
187         if ($components) {
188             foreach ($components as $componentname => $path) {
189                 $path = $this->clean_path($path) . self::get_behat_tests_path();
190                 if (empty($featurespaths[$path]) && file_exists($path)) {
191                     list($key, $featurepath) = $this->get_clean_feature_key_and_path($path);
192                     $featurespaths[$key] = $featurepath;
193                 }
194             }
195             foreach ($featurespaths as $path) {
196                 $additional = glob("$path/*.feature");
198                 $additionalfeatures = array();
199                 foreach ($additional as $featurepath) {
200                     list($key, $path) = $this->get_clean_feature_key_and_path($featurepath);
201                     $additionalfeatures[$key] = $path;
202                 }
204                 $features = array_merge($features, $additionalfeatures);
205             }
206         }
208         // Optionally include features from additional directories.
209         if (!empty($CFG->behat_additionalfeatures)) {
210             $additional = array_map("realpath", $CFG->behat_additionalfeatures);
211             $additionalfeatures = array();
212             foreach ($additional as $featurepath) {
213                 list($key, $path) = $this->get_clean_feature_key_and_path($featurepath);
214                 $additionalfeatures[$key] = $path;
215             }
216             $features = array_merge($features, $additionalfeatures);
217         }
219         // Sanitize feature key.
220         $cleanfeatures = array();
221         foreach ($features as $featurepath) {
222             list($key, $path) = $this->get_clean_feature_key_and_path($featurepath);
223             $cleanfeatures[$key] = $path;
224         }
226         // Sort feature list.
227         ksort($cleanfeatures);
229         $this->features = $cleanfeatures;
231         // If tags are passed then filter features which has sepecified tags.
232         if (!empty($tags)) {
233             $cleanfeatures = $this->filtered_features_with_tags($cleanfeatures, $tags);
234         }
236         return $cleanfeatures;
237     }
239     /**
240      * Return feature key for featurepath
241      *
242      * @param string $featurepath
243      * @return array key and featurepath.
244      */
245     public function get_clean_feature_key_and_path($featurepath) {
246         global $CFG;
248         // Fix directory path.
249         $featurepath = testing_cli_fix_directory_separator($featurepath);
250         $dirroot = testing_cli_fix_directory_separator($CFG->dirroot . DIRECTORY_SEPARATOR);
252         $key = basename($featurepath, '.feature');
254         // Get relative path.
255         $featuredirname = str_replace($dirroot , '', $featurepath);
256         // Get 5 levels of feature path to ensure we have a unique key.
257         for ($i = 0; $i < 5; $i++) {
258             if (($featuredirname = dirname($featuredirname)) && $featuredirname !== '.') {
259                 if ($basename = basename($featuredirname)) {
260                     $key .= '_' . $basename;
261                 }
262             }
263         }
265         return array($key, $featurepath);
266     }
268     /**
269      * Get component contexts.
270      *
271      * @param string $component component name.
272      * @return array
273      */
274     private function get_component_contexts($component) {
276         if (empty($component)) {
277             return $this->contexts;
278         }
280         $componentcontexts = array();
281         foreach ($this->contexts as $key => $path) {
282             if ($component == '' || $component === $key) {
283                 $componentcontexts[$key] = $path;
284             }
285         }
287         return $componentcontexts;
288     }
290     /**
291      * Gets the list of Moodle behat contexts
292      *
293      * Class name as a key and the filepath as value
294      *
295      * Externalized from update_config_file() to use
296      * it from the steps definitions web interface
297      *
298      * @param  string $component Restricts the obtained steps definitions to the specified component
299      * @return array
300      */
301     public function get_components_contexts($component = '') {
303         // If we already have a list created then just return that, as it's up-to-date.
304         if (!empty($this->contexts)) {
305             return $this->get_component_contexts($component);
306         }
308         $components = $this->get_components_with_tests();
310         $this->contexts = array();
311         foreach ($components as $componentname => $componentpath) {
312             if (false !== strpos($componentname, 'theme_')) {
313                 continue;
314             }
315             $componentpath = self::clean_path($componentpath);
317             if (!file_exists($componentpath . self::get_behat_tests_path())) {
318                 continue;
319             }
320             $diriterator = new DirectoryIterator($componentpath . self::get_behat_tests_path());
321             $regite = new RegexIterator($diriterator, '|^behat_.*\.php$|');
323             // All behat_*.php inside self::get_behat_tests_path() are added as steps definitions files.
324             foreach ($regite as $file) {
325                 $key = $file->getBasename('.php');
326                 $this->contexts[$key] = $file->getPathname();
327             }
328         }
330         // Sort contexts with there name.
331         ksort($this->contexts);
333         return $this->get_component_contexts($component);
334     }
336     /**
337      * Behat config file specifing the main context class,
338      * the required Behat extensions and Moodle test wwwroot.
339      *
340      * @param array $features The system feature files
341      * @param array $contexts The system steps definitions
342      * @param string $tags filter features with specified tags.
343      * @param int $parallelruns number of parallel runs.
344      * @param int $currentrun current run for which config file is needed.
345      * @return string
346      */
347     public function get_config_file_contents($features = '', $contexts = '', $tags = '', $parallelruns = 0, $currentrun = 0) {
348         global $CFG;
350         // Set current run and parallel run.
351         if (!empty($parallelruns) && !empty($currentrun)) {
352             $this->set_parallel_run($parallelruns, $currentrun);
353         }
355         // If tags defined then use them. This is for BC.
356         if (!empty($tags)) {
357             $this->set_tag_for_feature_filter($tags);
358         }
360         // If features not passed then get it. Empty array means we don't need to include features.
361         if (empty($features) && !is_array($features)) {
362             $features = $this->get_components_features();
363         } else {
364             $this->features = $features;
365         }
367         // If stepdefinitions not passed then get the list.
368         if (empty($contexts)) {
369             $this->get_components_contexts();
370         } else {
371             $this->contexts = $contexts;
372         }
374         // We require here when we are sure behat dependencies are available.
375         require_once($CFG->dirroot . '/vendor/autoload.php');
377         $config = $this->build_config();
379         $config = $this->merge_behat_config($config);
381         $config = $this->merge_behat_profiles($config);
383         // Return config array for phpunit, so it can be tested.
384         if (defined('PHPUNIT_TEST') && PHPUNIT_TEST) {
385             return $config;
386         }
388         return Symfony\Component\Yaml\Yaml::dump($config, 10, 2);
389     }
391     /**
392      * Search feature files for set of tags.
393      *
394      * @param array $features set of feature files.
395      * @param string $tags list of tags (currently support && only.)
396      * @return array filtered list of feature files with tags.
397      */
398     public function filtered_features_with_tags($features = '', $tags = '') {
400         // This is for BC. Features if not passed then we already have a list in this object.
401         if (empty($features)) {
402             $features = $this->features;
403         }
405         // If no tags defined then return full list.
406         if (empty($tags) && empty($this->tags)) {
407             return $features;
408         }
410         // If no tags passed by the caller, then it's already set.
411         if (empty($tags)) {
412             $tags = $this->tags;
413         }
415         $newfeaturelist = array();
416         // Split tags in and and or.
417         $tags = explode('&&', $tags);
418         $andtags = array();
419         $ortags = array();
420         foreach ($tags as $tag) {
421             // Explode all tags seperated by , and add it to ortags.
422             $ortags = array_merge($ortags, explode(',', $tag));
423             // And tags will be the first one before comma(,).
424             $andtags[] = preg_replace('/,.*/', '', $tag);
425         }
427         foreach ($features as $key => $featurefile) {
428             $contents = file_get_contents($featurefile);
429             $includefeature = true;
430             foreach ($andtags as $tag) {
431                 // If negitive tag, then ensure it don't exist.
432                 if (strpos($tag, '~') !== false) {
433                     $tag = substr($tag, 1);
434                     if ($contents && strpos($contents, $tag) !== false) {
435                         $includefeature = false;
436                         break;
437                     }
438                 } else if ($contents && strpos($contents, $tag) === false) {
439                     $includefeature = false;
440                     break;
441                 }
442             }
444             // If feature not included then check or tags.
445             if (!$includefeature && !empty($ortags)) {
446                 foreach ($ortags as $tag) {
447                     if ($contents && (strpos($tag, '~') === false) && (strpos($contents, $tag) !== false)) {
448                         $includefeature = true;
449                         break;
450                     }
451                 }
452             }
454             if ($includefeature) {
455                 $newfeaturelist[$key] = $featurefile;
456             }
457         }
458         return $newfeaturelist;
459     }
461     /**
462      * Build config for behat.yml.
463      *
464      * @param int $parallelruns how many parallel runs feature needs to be divided.
465      * @param int $currentrun current run for which features should be returned.
466      * @return array
467      */
468     protected function build_config($parallelruns = 0, $currentrun = 0) {
469         global $CFG;
471         if (!empty($parallelruns) && !empty($currentrun)) {
472             $this->set_parallel_run($parallelruns, $currentrun);
473         } else {
474             $currentrun = $this->get_current_run();
475             $parallelruns = $this->get_number_of_parallel_run();
476         }
478         $selenium2wdhost = array('wd_host' => 'http://localhost:4444/wd/hub');
479         // If parallel run, then set wd_host if specified.
480         if (!empty($currentrun) && !empty($parallelruns)) {
481             // Set proper selenium2 wd_host if defined.
482             if (!empty($CFG->behat_parallel_run[$currentrun - 1]['wd_host'])) {
483                 $selenium2wdhost = array('wd_host' => $CFG->behat_parallel_run[$currentrun - 1]['wd_host']);
484             }
485         }
487         // It is possible that it has no value as we don't require a full behat setup to list the step definitions.
488         if (empty($CFG->behat_wwwroot)) {
489             $CFG->behat_wwwroot = 'http://itwillnotbeused.com';
490         }
492         $suites = $this->get_behat_suites($parallelruns, $currentrun);
494         $selectortypes = ['named_partial', 'named_exact'];
495         $allpaths = [];
496         foreach (array_keys($suites) as $theme) {
497             // Remove selectors from step definitions.
498             foreach ($selectortypes as $selectortype) {
499                 // Don't include selector classes.
500                 $selectorclass = self::get_behat_theme_selector_override_classname($theme, $selectortype);
501                 if (isset($suites[$theme]['contexts'][$selectorclass])) {
502                     unset($suites[$theme]['contexts'][$selectorclass]);
503                 }
504             }
506             // Get a list of all step definition paths.
507             $allpaths = array_merge($allpaths, $suites[$theme]['contexts']);
509             // Convert the contexts array to a list of names only.
510             $suites[$theme]['contexts'] = array_keys($suites[$theme]['contexts']);
511         }
513         // Comments use black color, so failure path is not visible. Using color other then black/white is safer.
514         // https://github.com/Behat/Behat/pull/628.
515         $config = array(
516             'default' => array(
517                 'formatters' => array(
518                     'moodle_progress' => array(
519                         'output_styles' => array(
520                             'comment' => array('magenta'))
521                     )
522                 ),
523                 'suites' => $suites,
524                 'extensions' => array(
525                     'Behat\MinkExtension' => array(
526                         'base_url' => $CFG->behat_wwwroot,
527                         'goutte' => null,
528                         'selenium2' => $selenium2wdhost
529                     ),
530                     'Moodle\BehatExtension' => array(
531                         'moodledirroot' => $CFG->dirroot,
532                         'steps_definitions' => $allpaths,
533                     )
534                 )
535             )
536         );
538         return $config;
539     }
541     /**
542      * Divide features between the runs and return list.
543      *
544      * @param array $features list of features to be divided.
545      * @param int $parallelruns how many parallel runs feature needs to be divided.
546      * @param int $currentrun current run for which features should be returned.
547      * @return array
548      */
549     protected function get_features_for_the_run($features, $parallelruns, $currentrun) {
551         // If no features are passed then just return.
552         if (empty($features)) {
553             return $features;
554         }
556         $allocatedfeatures = $features;
558         // If parallel run, then only divide features.
559         if (!empty($currentrun) && !empty($parallelruns)) {
561             $featurestodivide['withtags'] = $features;
562             $allocatedfeatures = array();
564             // If tags are set then split features with tags first.
565             if (!empty($this->tags)) {
566                 $featurestodivide['withtags'] = $this->filtered_features_with_tags($features);
567                 $featurestodivide['withouttags'] = $this->remove_blacklisted_features_from_list($features,
568                     $featurestodivide['withtags']);
569             }
571             // Attempt to split into weighted buckets using timing information, if available.
572             foreach ($featurestodivide as $tagfeatures) {
573                 if ($alloc = $this->profile_guided_allocate($tagfeatures, max(1, $parallelruns), $currentrun)) {
574                     $allocatedfeatures = array_merge($allocatedfeatures, $alloc);
575                 } else {
576                     // Divide the list of feature files amongst the parallel runners.
577                     // Pull out the features for just this worker.
578                     if (count($tagfeatures)) {
579                         $splitfeatures = array_chunk($tagfeatures, ceil(count($tagfeatures) / max(1, $parallelruns)));
581                         // Check if there is any feature file for this process.
582                         if (!empty($splitfeatures[$currentrun - 1])) {
583                             $allocatedfeatures = array_merge($allocatedfeatures, $splitfeatures[$currentrun - 1]);
584                         }
585                     }
586                 }
587             }
588         }
590         return $allocatedfeatures;
591     }
593     /**
594      * Parse $CFG->behat_profile and return the array with required config structure for behat.yml.
595      *
596      * $CFG->behat_profiles = array(
597      *     'profile' = array(
598      *         'browser' => 'firefox',
599      *         'tags' => '@javascript',
600      *         'wd_host' => 'http://127.0.0.1:4444/wd/hub',
601      *         'capabilities' => array(
602      *             'platform' => 'Linux',
603      *             'version' => 44
604      *         )
605      *     )
606      * );
607      *
608      * @param string $profile profile name
609      * @param array $values values for profile.
610      * @return array
611      */
612     protected function get_behat_profile($profile, $values) {
613         // Values should be an array.
614         if (!is_array($values)) {
615             return array();
616         }
618         // Check suite values.
619         $behatprofilesuites = array();
621         // Automatically set tags information to skip app testing if necessary. We skip app testing
622         // if the browser is not Chrome. (Note: We also skip if it's not configured, but that is
623         // done on the theme/suite level.)
624         if (empty($values['browser']) || $values['browser'] !== 'chrome') {
625             if (!empty($values['tags'])) {
626                 $values['tags'] .= ' && ~@app';
627             } else {
628                 $values['tags'] = '~@app';
629             }
630         }
632         // Automatically add Chrome command line option to skip the prompt about allowing file
633         // storage - needed for mobile app testing (won't hurt for everything else either).
634         // We also need to disable web security, otherwise it can't make CSS requests to the server
635         // on localhost due to CORS restrictions.
636         if (!empty($values['browser']) && $values['browser'] === 'chrome') {
637             if (!isset($values['capabilities'])) {
638                 $values['capabilities'] = [];
639             }
640             if (!isset($values['capabilities']['chrome'])) {
641                 $values['capabilities']['chrome'] = [];
642             }
643             if (!isset($values['capabilities']['chrome']['switches'])) {
644                 $values['capabilities']['chrome']['switches'] = [];
645             }
646             $values['capabilities']['chrome']['switches'][] = '--unlimited-storage';
647             $values['capabilities']['chrome']['switches'][] = '--disable-web-security';
649             // If the mobile app is enabled, check its version and add appropriate tags.
650             if ($mobiletags = $this->get_mobile_version_tags()) {
651                 if (!empty($values['tags'])) {
652                     $values['tags'] .= ' && ' . $mobiletags;
653                 } else {
654                     $values['tags'] = $mobiletags;
655                 }
656             }
657         }
659         // Fill tags information.
660         if (isset($values['tags'])) {
661             $behatprofilesuites = array(
662                 'suites' => array(
663                     'default' => array(
664                         'filters' => array(
665                             'tags' => $values['tags'],
666                         )
667                     )
668                 )
669             );
670         }
672         // Selenium2 config values.
673         $behatprofileextension = array();
674         $seleniumconfig = array();
675         if (isset($values['browser'])) {
676             $seleniumconfig['browser'] = $values['browser'];
677         }
678         if (isset($values['wd_host'])) {
679             $seleniumconfig['wd_host'] = $values['wd_host'];
680         }
681         if (isset($values['capabilities'])) {
682             $seleniumconfig['capabilities'] = $values['capabilities'];
683         }
684         if (!empty($seleniumconfig)) {
685             $behatprofileextension = array(
686                 'extensions' => array(
687                     'Behat\MinkExtension' => array(
688                         'selenium2' => $seleniumconfig,
689                     )
690                 )
691             );
692         }
694         return array($profile => array_merge($behatprofilesuites, $behatprofileextension));
695     }
697     /**
698      * Gets version tags to use for the mobile app.
699      *
700      * This is based on the current mobile app version (from its package.json) and all known
701      * mobile app versions (based on the list appversions.json in the lib/behat directory).
702      *
703      * @param bool $verbose If true, outputs information about installed app version
704      * @return string List of tags or '' if not supporting mobile
705      */
706     protected function get_mobile_version_tags($verbose = true) : string {
707         global $CFG;
709         if (!empty($CFG->behat_ionic_dirroot)) {
710             // Get app version from package.json.
711             $jsonpath = $CFG->behat_ionic_dirroot . '/package.json';
712             $json = @file_get_contents($jsonpath);
713             if (!$json) {
714                 throw new coding_exception('Unable to load app version from ' . $jsonpath);
715             }
716             $package = json_decode($json);
717             if ($package === null || empty($package->version)) {
718                 throw new coding_exception('Invalid app package data in ' . $jsonpath);
719             }
720             $installedversion = $package->version;
721         } else if (!empty($CFG->behat_ionic_wwwroot)) {
722             // Get app version from config.json inside wwwroot.
723             $jsonurl = $CFG->behat_ionic_wwwroot . '/config.json';
724             $json = @download_file_content($jsonurl);
725             if (!$json) {
726                 throw new coding_exception('Unable to load app version from ' . $jsonurl);
727             }
728             $config = json_decode($json);
729             if ($config === null || empty($config->versionname)) {
730                 throw new coding_exception('Invalid app config data in ' . $jsonurl);
731             }
732             $installedversion = str_replace('-dev', '', $config->versionname);
733         } else {
734             return '';
735         }
737         // Read all feature files to check which mobile tags are used. (Note: This could be cached
738         // but ideally, it is the sort of thing that really ought to be refreshed by doing a new
739         // Behat init. Also, at time of coding it only takes 0.3 seconds and only if app enabled.)
740         $usedtags = [];
741         foreach ($this->features as $filepath) {
742             $feature = file_get_contents($filepath);
743             // This may incorrectly detect versions used e.g. in a comment or something, but it
744             // doesn't do much harm if we have extra ones.
745             if (preg_match_all('~@app_(?:from|upto)(?:[0-9]+(?:\.[0-9]+)*)~', $feature, $matches)) {
746                 foreach ($matches[0] as $tag) {
747                     // Store as key in array so we don't get duplicates.
748                     $usedtags[$tag] = true;
749                 }
750             }
751         }
753         // Set up relevant tags for each version.
754         $tags = [];
755         foreach ($usedtags as $usedtag => $ignored) {
756             if (!preg_match('~^@app_(from|upto)([0-9]+(?:\.[0-9]+)*)$~', $usedtag, $matches)) {
757                 throw new coding_exception('Unexpected tag format');
758             }
759             $direction = $matches[1];
760             $version = $matches[2];
762             switch (version_compare($installedversion, $version)) {
763                 case -1:
764                     // Installed version OLDER than the one being considered, so do not
765                     // include any scenarios that only run from the considered version up.
766                     if ($direction === 'from') {
767                         $tags[] = '~@app_from' . $version;
768                     }
769                     break;
771                 case 0:
772                     // Installed version EQUAL to the one being considered - no tags need
773                     // excluding.
774                     break;
776                 case 1:
777                     // Installed version NEWER than the one being considered, so do not
778                     // include any scenarios that only run up to that version.
779                     if ($direction === 'upto') {
780                         $tags[] = '~@app_upto' . $version;
781                     }
782                     break;
783             }
784         }
786         if ($verbose) {
787             mtrace('Configured app tests for version ' . $installedversion);
788         }
790         return join(' && ', $tags);
791     }
793     /**
794      * Attempt to split feature list into fairish buckets using timing information, if available.
795      * Simply add each one to lightest buckets until all files allocated.
796      * PGA = Profile Guided Allocation. I made it up just now.
797      * CAUTION: workers must agree on allocation, do not be random anywhere!
798      *
799      * @param array $features Behat feature files array
800      * @param int $nbuckets Number of buckets to divide into
801      * @param int $instance Index number of this instance
802      * @return array|bool Feature files array, sorted into allocations
803      */
804     public function profile_guided_allocate($features, $nbuckets, $instance) {
806         // No profile guided allocation is required in phpunit.
807         if (defined('PHPUNIT_TEST') && PHPUNIT_TEST) {
808             return false;
809         }
811         $behattimingfile = defined('BEHAT_FEATURE_TIMING_FILE') &&
812         @filesize(BEHAT_FEATURE_TIMING_FILE) ? BEHAT_FEATURE_TIMING_FILE : false;
814         if (!$behattimingfile || !$behattimingdata = @json_decode(file_get_contents($behattimingfile), true)) {
815             // No data available, fall back to relying on steps data.
816             $stepfile = "";
817             if (defined('BEHAT_FEATURE_STEP_FILE') && BEHAT_FEATURE_STEP_FILE) {
818                 $stepfile = BEHAT_FEATURE_STEP_FILE;
819             }
820             // We should never get this. But in case we can't do this then fall back on simple splitting.
821             if (empty($stepfile) || !$behattimingdata = @json_decode(file_get_contents($stepfile), true)) {
822                 return false;
823             }
824         }
826         arsort($behattimingdata); // Ensure most expensive is first.
828         $realroot = realpath(__DIR__.'/../../../').'/';
829         $defaultweight = array_sum($behattimingdata) / count($behattimingdata);
830         $weights = array_fill(0, $nbuckets, 0);
831         $buckets = array_fill(0, $nbuckets, array());
832         $totalweight = 0;
834         // Re-key the features list to match timing data.
835         foreach ($features as $k => $file) {
836             $key = str_replace($realroot, '', $file);
837             $features[$key] = $file;
838             unset($features[$k]);
839             if (!isset($behattimingdata[$key])) {
840                 $behattimingdata[$key] = $defaultweight;
841             }
842         }
844         // Sort features by known weights; largest ones should be allocated first.
845         $behattimingorder = array();
846         foreach ($features as $key => $file) {
847             $behattimingorder[$key] = $behattimingdata[$key];
848         }
849         arsort($behattimingorder);
851         // Finally, add each feature one by one to the lightest bucket.
852         foreach ($behattimingorder as $key => $weight) {
853             $file = $features[$key];
854             $lightbucket = array_search(min($weights), $weights);
855             $weights[$lightbucket] += $weight;
856             $buckets[$lightbucket][] = $file;
857             $totalweight += $weight;
858         }
860         if ($totalweight && !defined('BEHAT_DISABLE_HISTOGRAM') && $instance == $nbuckets
861                 && (!defined('PHPUNIT_TEST') || !PHPUNIT_TEST)) {
862             echo "Bucket weightings:\n";
863             foreach ($weights as $k => $weight) {
864                 echo $k + 1 . ": " . str_repeat('*', 70 * $nbuckets * $weight / $totalweight) . PHP_EOL;
865             }
866         }
868         // Return the features for this worker.
869         return $buckets[$instance - 1];
870     }
872     /**
873      * Overrides default config with local config values
874      *
875      * array_merge does not merge completely the array's values
876      *
877      * @param mixed $config The node of the default config
878      * @param mixed $localconfig The node of the local config
879      * @return mixed The merge result
880      */
881     public function merge_config($config, $localconfig) {
883         if (!is_array($config) && !is_array($localconfig)) {
884             return $localconfig;
885         }
887         // Local overrides also deeper default values.
888         if (is_array($config) && !is_array($localconfig)) {
889             return $localconfig;
890         }
892         foreach ($localconfig as $key => $value) {
894             // If defaults are not as deep as local values let locals override.
895             if (!is_array($config)) {
896                 unset($config);
897             }
899             // Add the param if it doesn't exists or merge branches.
900             if (empty($config[$key])) {
901                 $config[$key] = $value;
902             } else {
903                 $config[$key] = $this->merge_config($config[$key], $localconfig[$key]);
904             }
905         }
907         return $config;
908     }
910     /**
911      * Merges $CFG->behat_config with the one passed.
912      *
913      * @param array $config existing config.
914      * @return array merged config with $CFG->behat_config
915      */
916     public function merge_behat_config($config) {
917         global $CFG;
919         // In case user defined overrides respect them over our default ones.
920         if (!empty($CFG->behat_config)) {
921             foreach ($CFG->behat_config as $profile => $values) {
922                 $config = $this->merge_config($config, $this->get_behat_config_for_profile($profile, $values));
923             }
924         }
926         return $config;
927     }
929     /**
930      * Parse $CFG->behat_config and return the array with required config structure for behat.yml
931      *
932      * @param string $profile profile name
933      * @param array $values values for profile
934      * @return array
935      */
936     public function get_behat_config_for_profile($profile, $values) {
937         // Only add profile which are compatible with Behat 3.x
938         // Just check if any of Bheat 2.5 config is set. Not checking for 3.x as it might have some other configs
939         // Like : rerun_cache etc.
940         if (!isset($values['filters']['tags']) && !isset($values['extensions']['Behat\MinkExtension\Extension'])) {
941             return array($profile => $values);
942         }
944         // Parse 2.5 format and get related values.
945         $oldconfigvalues = array();
946         if (isset($values['extensions']['Behat\MinkExtension\Extension'])) {
947             $extensionvalues = $values['extensions']['Behat\MinkExtension\Extension'];
948             if (isset($extensionvalues['selenium2']['browser'])) {
949                 $oldconfigvalues['browser'] = $extensionvalues['selenium2']['browser'];
950             }
951             if (isset($extensionvalues['selenium2']['wd_host'])) {
952                 $oldconfigvalues['wd_host'] = $extensionvalues['selenium2']['wd_host'];
953             }
954             if (isset($extensionvalues['capabilities'])) {
955                 $oldconfigvalues['capabilities'] = $extensionvalues['capabilities'];
956             }
957         }
959         if (isset($values['filters']['tags'])) {
960             $oldconfigvalues['tags'] = $values['filters']['tags'];
961         }
963         if (!empty($oldconfigvalues)) {
964             behat_config_manager::$autoprofileconversion = true;
965             return $this->get_behat_profile($profile, $oldconfigvalues);
966         }
968         // If nothing set above then return empty array.
969         return array();
970     }
972     /**
973      * Merges $CFG->behat_profiles with the one passed.
974      *
975      * @param array $config existing config.
976      * @return array merged config with $CFG->behat_profiles
977      */
978     public function merge_behat_profiles($config) {
979         global $CFG;
981         // Check for Moodle custom ones.
982         if (!empty($CFG->behat_profiles) && is_array($CFG->behat_profiles)) {
983             foreach ($CFG->behat_profiles as $profile => $values) {
984                 $config = $this->merge_config($config, $this->get_behat_profile($profile, $values));
985             }
986         }
988         return $config;
989     }
991     /**
992      * Cleans the path returned by get_components_with_tests() to standarize it
993      *
994      * @see tests_finder::get_all_directories_with_tests() it returns the path including /tests/
995      * @param string $path
996      * @return string The string without the last /tests part
997      */
998     public final function clean_path($path) {
1000         $path = rtrim($path, DIRECTORY_SEPARATOR);
1002         $parttoremove = DIRECTORY_SEPARATOR . 'tests';
1004         $substr = substr($path, strlen($path) - strlen($parttoremove));
1005         if ($substr == $parttoremove) {
1006             $path = substr($path, 0, strlen($path) - strlen($parttoremove));
1007         }
1009         return rtrim($path, DIRECTORY_SEPARATOR);
1010     }
1012     /**
1013      * The relative path where components stores their behat tests
1014      *
1015      * @return string
1016      */
1017     public static final function get_behat_tests_path() {
1018         return DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'behat';
1019     }
1021     /**
1022      * Return context name of behat_theme selector to use.
1023      *
1024      * @param string $themename name of the theme.
1025      * @param string $selectortype The type of selector (partial or exact at this stage)
1026      * @param bool $includeclass if class should be included.
1027      * @return string
1028      */
1029     public static final function get_behat_theme_selector_override_classname($themename, $selectortype, $includeclass = false) {
1030         global $CFG;
1032         if ($selectortype !== 'named_partial' && $selectortype !== 'named_exact') {
1033             throw new coding_exception("Unknown selector override type '{$selectortype}'");
1034         }
1036         $overridebehatclassname = "behat_theme_{$themename}_behat_{$selectortype}_selectors";
1038         if ($includeclass) {
1039             $themeoverrideselector = $CFG->dirroot . DIRECTORY_SEPARATOR . 'theme' . DIRECTORY_SEPARATOR . $themename .
1040                 self::get_behat_tests_path() . DIRECTORY_SEPARATOR . $overridebehatclassname . '.php';
1042             if (file_exists($themeoverrideselector)) {
1043                 require_once($themeoverrideselector);
1044             }
1045         }
1047         return $overridebehatclassname;
1048     }
1050     /**
1051      * List of components which contain behat context or features.
1052      *
1053      * @return array
1054      */
1055     protected function get_components_with_tests() {
1056         if (empty($this->componentswithtests)) {
1057             $this->componentswithtests = tests_finder::get_components_with_tests('behat');
1058         }
1060         return $this->componentswithtests;
1061     }
1063     /**
1064      * Remove list of blacklisted features from the feature list.
1065      *
1066      * @param array $features list of original features.
1067      * @param array|string $blacklist list of features which needs to be removed.
1068      * @return array features - blacklisted features.
1069      */
1070     protected function remove_blacklisted_features_from_list($features, $blacklist) {
1072         // If no blacklist passed then return.
1073         if (empty($blacklist)) {
1074             return $features;
1075         }
1077         // If there is no feature in suite then just return what was passed.
1078         if (empty($features)) {
1079             return $features;
1080         }
1082         if (!is_array($blacklist)) {
1083             $blacklist = array($blacklist);
1084         }
1086         // Remove blacklisted features.
1087         foreach ($blacklist as $blacklistpath) {
1089             list($key, $featurepath) = $this->get_clean_feature_key_and_path($blacklistpath);
1091             if (isset($features[$key])) {
1092                 $features[$key] = null;
1093                 unset($features[$key]);
1094             } else {
1095                 $featurestocheck = $this->get_components_features();
1096                 if (!isset($featurestocheck[$key]) && (!defined('PHPUNIT_TEST') || !PHPUNIT_TEST)) {
1097                     behat_error(BEHAT_EXITCODE_REQUIREMENT, 'Blacklisted feature "' . $blacklistpath . '" not found.');
1098                 }
1099             }
1100         }
1102         return $features;
1103     }
1105     /**
1106      * Return list of behat suites. Multiple suites are returned if theme
1107      * overrides default step definitions/features.
1108      *
1109      * @param int $parallelruns number of parallel runs
1110      * @param int $currentrun current run.
1111      * @return array list of suites.
1112      */
1113     protected function get_behat_suites($parallelruns = 0, $currentrun = 0) {
1114         $features = $this->get_components_features();
1116         // Get number of parallel runs and current run.
1117         if (!empty($parallelruns) && !empty($currentrun)) {
1118             $this->set_parallel_run($parallelruns, $currentrun);
1119         } else {
1120             $parallelruns = $this->get_number_of_parallel_run();
1121             $currentrun = $this->get_current_run();;
1122         }
1124         $themefeatures = array();
1125         $themecontexts = array();
1127         $themes = $this->get_list_of_themes();
1129         // Create list of theme suite features and contexts.
1130         foreach ($themes as $theme) {
1131             // Get theme features and contexts.
1132             $themefeatures[$theme] = $this->get_behat_features_for_theme($theme);
1133             $themecontexts[$theme] = $this->get_behat_contexts_for_theme($theme);
1134         }
1136         // Remove list of theme features for default suite, as default suite should not run theme specific features.
1137         foreach ($themefeatures as $themename => $removethemefeatures) {
1138             if (!empty($removethemefeatures['features'])) {
1139                 $features = $this->remove_blacklisted_features_from_list($features, $removethemefeatures['features']);
1140             }
1141         }
1143         // Set suite for each theme.
1144         $suites = array();
1145         foreach ($themes as $theme) {
1146             // Get list of features which will be included in theme.
1147             // If theme suite with all features or default theme, then we want all core features to be part of theme suite.
1148             if ((is_string($this->themesuitewithallfeatures) && ($this->themesuitewithallfeatures === self::ALL_THEMES_TO_RUN)) ||
1149                 in_array($theme, $this->themesuitewithallfeatures) || ($this->get_default_theme() === $theme)) {
1150                 // If there is no theme specific feature. Then it's just core features.
1151                 if (empty($themefeatures[$theme]['features'])) {
1152                     $themesuitefeatures = $features;
1153                 } else {
1154                     $themesuitefeatures = array_merge($features, $themefeatures[$theme]['features']);
1155                 }
1156             } else {
1157                 $themesuitefeatures = $themefeatures[$theme]['features'];
1158             }
1160             // Remove blacklisted features.
1161             $themesuitefeatures = $this->remove_blacklisted_features_from_list($themesuitefeatures,
1162                 $themefeatures[$theme]['blacklistfeatures']);
1164             // Return sub-set of features if parallel run.
1165             $themesuitefeatures = $this->get_features_for_the_run($themesuitefeatures, $parallelruns, $currentrun);
1167             // Default theme is part of default suite.
1168             if ($this->get_default_theme() === $theme) {
1169                 $suitename = 'default';
1170             } else {
1171                 $suitename = $theme;
1172             }
1174             // Add suite no matter what. If there is no feature in suite then it will just exist successfully with no scenarios.
1175             // But if we don't set this then the user has to know which run doesn't have suite and which run do.
1176             $suites = array_merge($suites, array(
1177                 $suitename => array(
1178                     'paths'    => array_values($themesuitefeatures),
1179                     'contexts' => $themecontexts[$theme],
1180                 )
1181             ));
1182         }
1184         return $suites;
1185     }
1187     /**
1188      * Return name of default theme.
1189      *
1190      * @return string
1191      */
1192     protected function get_default_theme() {
1193         return theme_config::DEFAULT_THEME;
1194     }
1196     /**
1197      * Return list of themes which can be set in moodle.
1198      *
1199      * @return array list of themes with tests.
1200      */
1201     protected function get_list_of_themes() {
1202         $selectablethemes = array();
1204         // Get all themes installed on site.
1205         $themes = core_component::get_plugin_list('theme');
1206         ksort($themes);
1208         foreach ($themes as $themename => $themedir) {
1209             // Load the theme config.
1210             try {
1211                 $theme = $this->get_theme_config($themename);
1212             } catch (Exception $e) {
1213                 // Bad theme, just skip it for now.
1214                 continue;
1215             }
1216             if ($themename !== $theme->name) {
1217                 // Obsoleted or broken theme, just skip for now.
1218                 continue;
1219             }
1220             if ($theme->hidefromselector) {
1221                 // The theme doesn't want to be shown in the theme selector and as theme
1222                 // designer mode is switched off we will respect that decision.
1223                 continue;
1224             }
1225             $selectablethemes[] = $themename;
1226         }
1228         return $selectablethemes;
1229     }
1231     /**
1232      * Return the theme config for a given theme name.
1233      * This is done so we can mock it in PHPUnit.
1234      *
1235      * @param string $themename name of theme
1236      * @return theme_config
1237      */
1238     public function get_theme_config($themename) {
1239         return theme_config::load($themename);
1240     }
1242     /**
1243      * Return theme directory.
1244      *
1245      * @param string $themename name of theme
1246      * @return string theme directory
1247      */
1248     protected function get_theme_test_directory($themename) {
1249         global $CFG;
1251         $themetestdir = "/theme/" . $themename;
1253         return $CFG->dirroot . $themetestdir  . self::get_behat_tests_path();
1254     }
1256     /**
1257      * Returns all the directories having overridden tests.
1258      *
1259      * @param string $theme name of theme
1260      * @param string $testtype The kind of test we are looking for
1261      * @return array all directories having tests
1262      */
1263     protected function get_test_directories_overridden_for_theme($theme, $testtype) {
1264         global $CFG;
1266         $testtypes = array(
1267             'contexts' => '|behat_.*\.php$|',
1268             'features' => '|.*\.feature$|',
1269         );
1270         $themetestdirfullpath = $this->get_theme_test_directory($theme);
1272         // If test directory doesn't exist then return.
1273         if (!is_dir($themetestdirfullpath)) {
1274             return array();
1275         }
1277         $directoriestosearch = glob($themetestdirfullpath . DIRECTORY_SEPARATOR . '*' , GLOB_ONLYDIR);
1279         // Include theme directory to find tests.
1280         $dirs[realpath($themetestdirfullpath)] = trim(str_replace('/', '_', $themetestdirfullpath), '_');
1282         // Search for tests in valid directories.
1283         foreach ($directoriestosearch as $dir) {
1284             $dirite = new RecursiveDirectoryIterator($dir);
1285             $iteite = new RecursiveIteratorIterator($dirite);
1286             $regexp = $testtypes[$testtype];
1287             $regite = new RegexIterator($iteite, $regexp);
1288             foreach ($regite as $path => $element) {
1289                 $key = dirname($path);
1290                 $value = trim(str_replace(DIRECTORY_SEPARATOR, '_', str_replace($CFG->dirroot, '', $key)), '_');
1291                 $dirs[$key] = $value;
1292             }
1293         }
1294         ksort($dirs);
1296         return array_flip($dirs);
1297     }
1299     /**
1300      * Return blacklisted contexts or features for a theme, as defined in blacklist.json.
1301      *
1302      * @param string $theme themename
1303      * @param string $testtype test type (contexts|features)
1304      * @return array list of blacklisted contexts or features
1305      */
1306     protected function get_blacklisted_tests_for_theme($theme, $testtype) {
1308         $themetestpath = $this->get_theme_test_directory($theme);
1310         if (file_exists($themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json')) {
1311             // Blacklist file exist. Leave it for last to clear the feature and contexts.
1312             $blacklisttests = @json_decode(file_get_contents($themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json'), true);
1313             if (empty($blacklisttests)) {
1314                 behat_error(BEHAT_EXITCODE_REQUIREMENT, $themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json is empty');
1315             }
1317             // If features or contexts not defined then no problem.
1318             if (!isset($blacklisttests[$testtype])) {
1319                 $blacklisttests[$testtype] = array();
1320             }
1321             return $blacklisttests[$testtype];
1322         }
1324         return array();
1325     }
1327     /**
1328      * Return list of features and step definitions in theme.
1329      *
1330      * @param string $theme theme name
1331      * @param string $testtype test type, either features or contexts
1332      * @return array list of contexts $contexts or $features
1333      */
1334     protected function get_tests_for_theme($theme, $testtype) {
1336         $tests = array();
1337         $testtypes = array(
1338             'contexts' => '|^behat_.*\.php$|',
1339             'features' => '|.*\.feature$|',
1340         );
1342         // Get all the directories having overridden tests.
1343         $directories = $this->get_test_directories_overridden_for_theme($theme, $testtype);
1345         // Get overridden test contexts.
1346         foreach ($directories as $dirpath) {
1347             // All behat_*.php inside overridden directory.
1348             $diriterator = new DirectoryIterator($dirpath);
1349             $regite = new RegexIterator($diriterator, $testtypes[$testtype]);
1351             // All behat_*.php inside behat_config_manager::get_behat_tests_path() are added as steps definitions files.
1352             foreach ($regite as $file) {
1353                 $key = $file->getBasename('.php');
1354                 $tests[$key] = $file->getPathname();
1355             }
1356         }
1358         return $tests;
1359     }
1361     /**
1362      * Return list of blacklisted behat features for theme and features defined by theme only.
1363      *
1364      * @param string $theme theme name.
1365      * @return array ($blacklistfeatures, $blacklisttags, $features)
1366      */
1367     protected function get_behat_features_for_theme($theme) {
1368         global $CFG;
1370         // Get list of features defined by theme.
1371         $themefeatures = $this->get_tests_for_theme($theme, 'features');
1372         $themeblacklistfeatures = $this->get_blacklisted_tests_for_theme($theme, 'features');
1373         $themeblacklisttags = $this->get_blacklisted_tests_for_theme($theme, 'tags');
1375         // Mobile app tests are not theme-specific, so run only for the default theme (and if
1376         // configured).
1377         if ((empty($CFG->behat_ionic_dirroot) && empty($CFG->behat_ionic_wwwroot)) ||
1378                 $theme !== $this->get_default_theme()) {
1379             $themeblacklisttags[] = '@app';
1380         }
1382         // Clean feature key and path.
1383         $features = array();
1384         $blacklistfeatures = array();
1386         foreach ($themefeatures as $themefeature) {
1387             list($featurekey, $featurepath) = $this->get_clean_feature_key_and_path($themefeature);
1388             $features[$featurekey] = $featurepath;
1389         }
1391         foreach ($themeblacklistfeatures as $themeblacklistfeature) {
1392             list($blacklistfeaturekey, $blacklistfeaturepath) = $this->get_clean_feature_key_and_path($themeblacklistfeature);
1393             $blacklistfeatures[$blacklistfeaturekey] = $blacklistfeaturepath;
1394         }
1396         // If blacklist tags then add those features to list.
1397         if (!empty($themeblacklisttags)) {
1398             // Remove @ if given, so we are sure we have only tag names.
1399             $themeblacklisttags = array_map(function($v) {
1400                 return ltrim($v, '@');
1401             }, $themeblacklisttags);
1403             $themeblacklisttags = '@' . implode(',@', $themeblacklisttags);
1404             $blacklistedfeatureswithtag = $this->filtered_features_with_tags($this->get_components_features(),
1405                 $themeblacklisttags);
1407             // Add features with blacklisted tags.
1408             if (!empty($blacklistedfeatureswithtag)) {
1409                 foreach ($blacklistedfeatureswithtag as $themeblacklistfeature) {
1410                     list($key, $path) = $this->get_clean_feature_key_and_path($themeblacklistfeature);
1411                     $blacklistfeatures[$key] = $path;
1412                 }
1413             }
1414         }
1416         ksort($features);
1418         $retval = array(
1419             'blacklistfeatures' => $blacklistfeatures,
1420             'features' => $features
1421         );
1423         return $retval;
1424     }
1426     /**
1427      * Return list of behat contexts for theme and update $this->stepdefinitions list.
1428      *
1429      * @param string $theme theme name.
1430      * @return  List of contexts
1431      */
1432     protected function get_behat_contexts_for_theme($theme) : array {
1433         // If we already have this list then just return. This will not change by run.
1434         if (!empty($this->themecontexts[$theme])) {
1435             return $this->themecontexts[$theme];
1436         }
1438         try {
1439             $themeconfig = $this->get_theme_config($theme);
1440         } catch (Exception $e) {
1441             // This theme has no theme config.
1442             return [];
1443         }
1445         // The theme will use all core contexts, except the one overridden by theme or its parent.
1446         $parentcontexts = [];
1447         if (isset($themeconfig->parents)) {
1448             foreach ($themeconfig->parents as $parent) {
1449                 if ($parentcontexts = $this->get_behat_contexts_for_theme($parent)) {
1450                     break;
1451                 }
1452             }
1453         }
1455         if (empty($parentcontexts)) {
1456             $parentcontexts = $this->get_components_contexts();
1457         }
1459         // Remove contexts which have been actively blacklisted.
1460         $blacklistedcontexts = $this->get_blacklisted_tests_for_theme($theme, 'contexts');
1461         foreach ($blacklistedcontexts as $blacklistpath) {
1462             $blacklistcontext = basename($blacklistpath, '.php');
1464             unset($parentcontexts[$blacklistcontext]);
1465         }
1467         // Apply overrides.
1468         $contexts = array_merge($parentcontexts, $this->get_tests_for_theme($theme, 'contexts'));
1470         // Remove classes which are overridden.
1471         foreach ($contexts as $contextclass => $path) {
1472             require_once($path);
1473             if (!class_exists($contextclass)) {
1474                 // This may be a Poorly named class.
1475                 continue;
1476             }
1478             $rc = new \ReflectionClass($contextclass);
1479             while ($rc = $rc->getParentClass()) {
1480                 if (isset($contexts[$rc->name])) {
1481                     unset($contexts[$rc->name]);
1482                 }
1483             }
1484         }
1486         // Sort the list of contexts.
1487         ksort($contexts);
1489         $this->themecontexts[$theme] = $contexts;
1491         return $contexts;
1492     }