Merge branch 'wip-mdl-55986' of https://github.com/rajeshtaneja/moodle
[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 all contexts in theme suite.
60      */
61     private $themesuitecontexts;
63     /**
64      * @var array list of overridden theme contexts.
65      */
66     private $overriddenthemescontexts;
68     /**
69      * @var array list of components with tests.
70      */
71     private $componentswithtests;
73     /**
74      * @var bool keep track of theme to return suite with all core features included or not.
75      */
76     private $themesuitewithallfeatures = false;
78     /**
79      * @var string filter features which have tags.
80      */
81     private $tags = '';
83     /**
84      * @var int number of parallel runs.
85      */
86     private $parallelruns = 0;
88     /**
89      * @var int current run.
90      */
91     private $currentrun = 0;
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 $val
98      */
99     public function set_theme_suite_to_include_core_features($val) {
100         $this->themesuitewithallfeatures = $val;
101     }
103     /**
104      * Set the value for tags, so features which are returned will be using filtered by this.
105      *
106      * @param string $tags
107      */
108     public function set_tag_for_feature_filter($tags) {
109         $this->tags = $tags;
110     }
112     /**
113      * Set parallel run to be used for generating config.
114      *
115      * @param int $parallelruns number of parallel runs.
116      * @param int $currentrun current run
117      */
118     public function set_parallel_run($parallelruns, $currentrun) {
120         if ($parallelruns < $currentrun) {
121             behat_error(BEHAT_EXITCODE_REQUIREMENT,
122                 'Parallel runs('.$parallelruns.') should be more then current run('.$currentrun.')');
123         }
125         $this->parallelruns = $parallelruns;
126         $this->currentrun = $currentrun;
127     }
129     /**
130      * Return parallel runs
131      *
132      * @return int number of parallel runs.
133      */
134     public function get_number_of_parallel_run() {
135         // Get number of parallel runs if not passed.
136         if (empty($this->parallelruns) && ($this->parallelruns !== false)) {
137             $this->parallelruns = behat_config_manager::get_parallel_test_runs();
138         }
140         return $this->parallelruns;
141     }
143     /**
144      * Return current run
145      *
146      * @return int current run.
147      */
148     public function get_current_run() {
149         global $CFG;
151         // Get number of parallel runs if not passed.
152         if (empty($this->currentrun) && ($this->currentrun !== false) && !empty($CFG->behatrunprocess)) {
153             $this->currentrun = $CFG->behatrunprocess;
154         }
156         return $this->currentrun;
157     }
159     /**
160      * Return list of features.
161      *
162      * @param string $tags tags.
163      * @return array
164      */
165     public function get_components_features($tags = '') {
166         global $CFG;
168         // If we already have a list created then just return that, as it's up-to-date.
169         // If tags are passed then it's a new filter of features we need.
170         if (!empty($this->features) && empty($tags)) {
171             return $this->features;
172         }
174         // Gets all the components with features.
175         $features = array();
176         $featurespaths = array();
177         $components = $this->get_components_with_tests();
179         if ($components) {
180             foreach ($components as $componentname => $path) {
181                 $path = $this->clean_path($path) . self::get_behat_tests_path();
182                 if (empty($featurespaths[$path]) && file_exists($path)) {
183                     list($key, $featurepath) = $this->get_clean_feature_key_and_path($path);
184                     $featurespaths[$key] = $featurepath;
185                 }
186             }
187             foreach ($featurespaths as $path) {
188                 $additional = glob("$path/*.feature");
190                 $additionalfeatures = array();
191                 foreach ($additional as $featurepath) {
192                     list($key, $path) = $this->get_clean_feature_key_and_path($featurepath);
193                     $additionalfeatures[$key] = $path;
194                 }
196                 $features = array_merge($features, $additionalfeatures);
197             }
198         }
200         // Optionally include features from additional directories.
201         if (!empty($CFG->behat_additionalfeatures)) {
202             $additional = array_map("realpath", $CFG->behat_additionalfeatures);
203             $additionalfeatures = array();
204             foreach ($additional as $featurepath) {
205                 list($key, $path) = $this->get_clean_feature_key_and_path($featurepath);
206                 $additionalfeatures[$key] = $path;
207             }
208             $features = array_merge($features, $additionalfeatures);
209         }
211         $this->features = $features;
213         // If tags are passed then filter features which has sepecified tags.
214         if (!empty($tags)) {
215             $features = $this->filtered_features_with_tags($features, $tags);
216         }
218         // Return sorted list.
219         ksort($features);
221         return $features;
222     }
224     /**
225      * Return feature key for featurepath
226      *
227      * @param string $featurepath
228      * @return array key and featurepath.
229      */
230     public function get_clean_feature_key_and_path($featurepath) {
231         global $CFG;
233         // Fix directory path.
234         $featurepath = testing_cli_fix_directory_separator($featurepath);
235         $dirroot = testing_cli_fix_directory_separator($CFG->dirroot . DIRECTORY_SEPARATOR);
237         $key = basename($featurepath, '.feature');
239         // Get relative path.
240         $featuredirname = str_replace($dirroot , '', $featurepath);
241         // Get 5 levels of feature path to ensure we have a unique key.
242         for ($i = 0; $i < 5; $i++) {
243             if (($featuredirname = dirname($featuredirname)) && $featuredirname !== '.') {
244                 if ($basename = basename($featuredirname)) {
245                     $key .= '_' . $basename;
246                 }
247             }
248         }
250         return array($key, $featurepath);
251     }
253     /**
254      * Get component contexts.
255      *
256      * @param string $component component name.
257      * @return array
258      */
259     private function get_component_contexts($component) {
261         if (empty($component)) {
262             return $this->contexts;
263         }
265         $componentcontexts = array();
266         foreach ($this->contexts as $key => $path) {
267             if ($component == '' || $component === $key) {
268                 $componentcontexts[$key] = $path;
269             }
270         }
272         return $componentcontexts;
273     }
275     /**
276      * Gets the list of Moodle behat contexts
277      *
278      * Class name as a key and the filepath as value
279      *
280      * Externalized from update_config_file() to use
281      * it from the steps definitions web interface
282      *
283      * @param  string $component Restricts the obtained steps definitions to the specified component
284      * @return array
285      */
286     public function get_components_contexts($component = '') {
288         // If we already have a list created then just return that, as it's up-to-date.
289         if (!empty($this->contexts)) {
290             return $this->get_component_contexts($component);
291         }
293         $components = $this->get_components_with_tests();
295         $this->contexts = array();
296         foreach ($components as $componentname => $componentpath) {
297             $componentpath = self::clean_path($componentpath);
299             if (!file_exists($componentpath . self::get_behat_tests_path())) {
300                 continue;
301             }
302             $diriterator = new DirectoryIterator($componentpath . self::get_behat_tests_path());
303             $regite = new RegexIterator($diriterator, '|behat_.*\.php$|');
305             // All behat_*.php inside self::get_behat_tests_path() are added as steps definitions files.
306             foreach ($regite as $file) {
307                 $key = $file->getBasename('.php');
308                 $this->contexts[$key] = $file->getPathname();
309             }
310         }
312         // Sort contexts with there name.
313         ksort($this->contexts);
315         return $this->get_component_contexts($component);
316     }
318     /**
319      * Behat config file specifing the main context class,
320      * the required Behat extensions and Moodle test wwwroot.
321      *
322      * @param array $features The system feature files
323      * @param array $contexts The system steps definitions
324      * @param string $tags filter features with specified tags.
325      * @param int $parallelruns number of parallel runs.
326      * @param int $currentrun current run for which config file is needed.
327      * @return string
328      */
329     public function get_config_file_contents($features = '', $contexts = '', $tags = '', $parallelruns = 0, $currentrun = 0) {
330         global $CFG;
332         // Set current run and parallel run.
333         if (!empty($parallelruns) && !empty($currentrun)) {
334             $this->set_parallel_run($parallelruns, $currentrun);
335         }
337         // If tags defined then use them. This is for BC.
338         if (!empty($tags)) {
339             $this->set_tag_for_feature_filter($tags);
340         }
342         // If features not passed then get it. Empty array means we don't need to include features.
343         if (empty($features) && !is_array($features)) {
344             $features = $this->get_components_features();
345         } else {
346             $this->features = $features;
347         }
349         // If stepdefinitions not passed then get the list.
350         if (empty($contexts)) {
351             $this->get_components_contexts();
352         } else {
353             $this->contexts = $contexts;
354         }
356         // We require here when we are sure behat dependencies are available.
357         require_once($CFG->dirroot . '/vendor/autoload.php');
359         $config = $this->build_config();
361         $config = $this->merge_behat_config($config);
363         $config = $this->merge_behat_profiles($config);
365         // Return config array for phpunit, so it can be tested.
366         if (defined('PHPUNIT_TEST') && PHPUNIT_TEST) {
367             return $config;
368         }
370         return Symfony\Component\Yaml\Yaml::dump($config, 10, 2);
371     }
373     /**
374      * Search feature files for set of tags.
375      *
376      * @param array $features set of feature files.
377      * @param string $tags list of tags (currently support && only.)
378      * @return array filtered list of feature files with tags.
379      */
380     public function filtered_features_with_tags($features = '', $tags = '') {
382         // This is for BC. Features if not passed then we already have a list in this object.
383         if (empty($features)) {
384             $features = $this->features;
385         }
387         // If no tags defined then return full list.
388         if (empty($tags) && empty($this->tags)) {
389             return $features;
390         }
392         // If no tags passed by the caller, then it's already set.
393         if (empty($tags)) {
394             $tags = $this->tags;
395         }
397         $newfeaturelist = array();
398         // Split tags in and and or.
399         $tags = explode('&&', $tags);
400         $andtags = array();
401         $ortags = array();
402         foreach ($tags as $tag) {
403             // Explode all tags seperated by , and add it to ortags.
404             $ortags = array_merge($ortags, explode(',', $tag));
405             // And tags will be the first one before comma(,).
406             $andtags[] = preg_replace('/,.*/', '', $tag);
407         }
409         foreach ($features as $key => $featurefile) {
410             $contents = file_get_contents($featurefile);
411             $includefeature = true;
412             foreach ($andtags as $tag) {
413                 // If negitive tag, then ensure it don't exist.
414                 if (strpos($tag, '~') !== false) {
415                     $tag = substr($tag, 1);
416                     if ($contents && strpos($contents, $tag) !== false) {
417                         $includefeature = false;
418                         break;
419                     }
420                 } else if ($contents && strpos($contents, $tag) === false) {
421                     $includefeature = false;
422                     break;
423                 }
424             }
426             // If feature not included then check or tags.
427             if (!$includefeature && !empty($ortags)) {
428                 foreach ($ortags as $tag) {
429                     if ($contents && (strpos($tag, '~') === false) && (strpos($contents, $tag) !== false)) {
430                         $includefeature = true;
431                         break;
432                     }
433                 }
434             }
436             if ($includefeature) {
437                 $newfeaturelist[$key] = $featurefile;
438             }
439         }
440         return $newfeaturelist;
441     }
443     /**
444      * Build config for behat.yml.
445      *
446      * @param int $parallelruns how many parallel runs feature needs to be divided.
447      * @param int $currentrun current run for which features should be returned.
448      * @return array
449      */
450     protected function build_config($parallelruns = 0, $currentrun = 0) {
451         global $CFG;
453         if (!empty($parallelruns) && !empty($currentrun)) {
454             $this->set_parallel_run($parallelruns, $currentrun);
455         } else {
456             $currentrun = $this->get_current_run();
457             $parallelruns = $this->get_number_of_parallel_run();
458         }
460         $selenium2wdhost = array('wd_host' => 'http://localhost:4444/wd/hub');
461         // If parallel run, then set wd_host if specified.
462         if (!empty($currentrun) && !empty($parallelruns)) {
463             // Set proper selenium2 wd_host if defined.
464             if (!empty($CFG->behat_parallel_run[$currentrun - 1]['wd_host'])) {
465                 $selenium2wdhost = array('wd_host' => $CFG->behat_parallel_run[$currentrun - 1]['wd_host']);
466             }
467         }
469         // It is possible that it has no value as we don't require a full behat setup to list the step definitions.
470         if (empty($CFG->behat_wwwroot)) {
471             $CFG->behat_wwwroot = 'http://itwillnotbeused.com';
472         }
474         $suites = $this->get_behat_suites($parallelruns, $currentrun);
476         $overriddenthemescontexts = $this->get_overridden_theme_contexts();
477         if (!empty($overriddenthemescontexts)) {
478             $allcontexts = array_merge($this->contexts, $overriddenthemescontexts);
479         } else {
480             $allcontexts = $this->contexts;
481         }
483         // Remove selectors from step definitions.
484         $themes = $this->get_list_of_themes();
485         foreach ($themes as $theme) {
486             $selectorclass = self::get_behat_theme_selector_override_classname($theme);
487             if (isset($allcontexts[$selectorclass])) {
488                 unset($allcontexts[$selectorclass]);
489             }
490         }
492         // Comments use black color, so failure path is not visible. Using color other then black/white is safer.
493         // https://github.com/Behat/Behat/pull/628.
494         $config = array(
495             'default' => array(
496                 'formatters' => array(
497                     'moodle_progress' => array(
498                         'output_styles' => array(
499                             'comment' => array('magenta'))
500                     )
501                 ),
502                 'suites' => $suites,
503                 'extensions' => array(
504                     'Behat\MinkExtension' => array(
505                         'base_url' => $CFG->behat_wwwroot,
506                         'goutte' => null,
507                         'selenium2' => $selenium2wdhost
508                     ),
509                     'Moodle\BehatExtension' => array(
510                         'moodledirroot' => $CFG->dirroot,
511                         'steps_definitions' => $allcontexts,
512                     )
513                 )
514             )
515         );
517         return $config;
518     }
520     /**
521      * Divide features between the runs and return list.
522      *
523      * @param array $features list of features to be divided.
524      * @param int $parallelruns how many parallel runs feature needs to be divided.
525      * @param int $currentrun current run for which features should be returned.
526      * @return array
527      */
528     protected function get_features_for_the_run($features, $parallelruns, $currentrun) {
530         // If no features are passed then just return.
531         if (empty($features)) {
532             return $features;
533         }
535         $allocatedfeatures = $features;
537         // If parallel run, then only divide features.
538         if (!empty($currentrun) && !empty($parallelruns)) {
540             $featurestodivide['withtags'] = $features;
541             $allocatedfeatures = array();
543             // If tags are set then split features with tags first.
544             if (!empty($this->tags)) {
545                 $featurestodivide['withtags'] = $this->filtered_features_with_tags($features);
546                 $featurestodivide['withouttags'] = $this->remove_blacklisted_features_from_list($features,
547                     $featurestodivide['withtags']);
548             }
550             // Attempt to split into weighted buckets using timing information, if available.
551             foreach ($featurestodivide as $tagfeatures) {
552                 if ($alloc = $this->profile_guided_allocate($tagfeatures, max(1, $parallelruns), $currentrun)) {
553                     $allocatedfeatures = array_merge($allocatedfeatures, $alloc);
554                 } else {
555                     // Divide the list of feature files amongst the parallel runners.
556                     // Pull out the features for just this worker.
557                     if (count($tagfeatures)) {
558                         $splitfeatures = array_chunk($tagfeatures, ceil(count($tagfeatures) / max(1, $parallelruns)));
560                         // Check if there is any feature file for this process.
561                         if (!empty($splitfeatures[$currentrun - 1])) {
562                             $allocatedfeatures = array_merge($allocatedfeatures, $splitfeatures[$currentrun - 1]);
563                         }
564                     }
565                 }
566             }
567         }
569         return $allocatedfeatures;
570     }
572     /**
573      * Parse $CFG->behat_profile and return the array with required config structure for behat.yml.
574      *
575      * $CFG->behat_profiles = array(
576      *     'profile' = array(
577      *         'browser' => 'firefox',
578      *         'tags' => '@javascript',
579      *         'wd_host' => 'http://127.0.0.1:4444/wd/hub',
580      *         'capabilities' => array(
581      *             'platform' => 'Linux',
582      *             'version' => 44
583      *         )
584      *     )
585      * );
586      *
587      * @param string $profile profile name
588      * @param array $values values for profile.
589      * @return array
590      */
591     protected function get_behat_profile($profile, $values) {
592         // Values should be an array.
593         if (!is_array($values)) {
594             return array();
595         }
597         // Check suite values.
598         $behatprofilesuites = array();
599         // Fill tags information.
600         if (isset($values['tags'])) {
601             $behatprofilesuites = array(
602                 'suites' => array(
603                     'default' => array(
604                         'filters' => array(
605                             'tags' => $values['tags'],
606                         )
607                     )
608                 )
609             );
610         }
612         // Selenium2 config values.
613         $behatprofileextension = array();
614         $seleniumconfig = array();
615         if (isset($values['browser'])) {
616             $seleniumconfig['browser'] = $values['browser'];
617         }
618         if (isset($values['wd_host'])) {
619             $seleniumconfig['wd_host'] = $values['wd_host'];
620         }
621         if (isset($values['capabilities'])) {
622             $seleniumconfig['capabilities'] = $values['capabilities'];
623         }
624         if (!empty($seleniumconfig)) {
625             $behatprofileextension = array(
626                 'extensions' => array(
627                     'Behat\MinkExtension' => array(
628                         'selenium2' => $seleniumconfig,
629                     )
630                 )
631             );
632         }
634         return array($profile => array_merge($behatprofilesuites, $behatprofileextension));
635     }
637     /**
638      * Attempt to split feature list into fairish buckets using timing information, if available.
639      * Simply add each one to lightest buckets until all files allocated.
640      * PGA = Profile Guided Allocation. I made it up just now.
641      * CAUTION: workers must agree on allocation, do not be random anywhere!
642      *
643      * @param array $features Behat feature files array
644      * @param int $nbuckets Number of buckets to divide into
645      * @param int $instance Index number of this instance
646      * @return array|bool Feature files array, sorted into allocations
647      */
648     public function profile_guided_allocate($features, $nbuckets, $instance) {
650         // No profile guided allocation is required in phpunit.
651         if (defined('PHPUNIT_TEST')) {
652             return false;
653         }
655         $behattimingfile = defined('BEHAT_FEATURE_TIMING_FILE') &&
656         @filesize(BEHAT_FEATURE_TIMING_FILE) ? BEHAT_FEATURE_TIMING_FILE : false;
658         if (!$behattimingfile || !$behattimingdata = @json_decode(file_get_contents($behattimingfile), true)) {
659             // No data available, fall back to relying on steps data.
660             $stepfile = "";
661             if (defined('BEHAT_FEATURE_STEP_FILE') && BEHAT_FEATURE_STEP_FILE) {
662                 $stepfile = BEHAT_FEATURE_STEP_FILE;
663             }
664             // We should never get this. But in case we can't do this then fall back on simple splitting.
665             if (empty($stepfile) || !$behattimingdata = @json_decode(file_get_contents($stepfile), true)) {
666                 return false;
667             }
668         }
670         arsort($behattimingdata); // Ensure most expensive is first.
672         $realroot = realpath(__DIR__.'/../../../').'/';
673         $defaultweight = array_sum($behattimingdata) / count($behattimingdata);
674         $weights = array_fill(0, $nbuckets, 0);
675         $buckets = array_fill(0, $nbuckets, array());
676         $totalweight = 0;
678         // Re-key the features list to match timing data.
679         foreach ($features as $k => $file) {
680             $key = str_replace($realroot, '', $file);
681             $features[$key] = $file;
682             unset($features[$k]);
683             if (!isset($behattimingdata[$key])) {
684                 $behattimingdata[$key] = $defaultweight;
685             }
686         }
688         // Sort features by known weights; largest ones should be allocated first.
689         $behattimingorder = array();
690         foreach ($features as $key => $file) {
691             $behattimingorder[$key] = $behattimingdata[$key];
692         }
693         arsort($behattimingorder);
695         // Finally, add each feature one by one to the lightest bucket.
696         foreach ($behattimingorder as $key => $weight) {
697             $file = $features[$key];
698             $lightbucket = array_search(min($weights), $weights);
699             $weights[$lightbucket] += $weight;
700             $buckets[$lightbucket][] = $file;
701             $totalweight += $weight;
702         }
704         if ($totalweight && !defined('BEHAT_DISABLE_HISTOGRAM') && $instance == $nbuckets && !defined('PHPUNIT_TEST')) {
705             echo "Bucket weightings:\n";
706             foreach ($weights as $k => $weight) {
707                 echo $k + 1 . ": " . str_repeat('*', 70 * $nbuckets * $weight / $totalweight) . PHP_EOL;
708             }
709         }
711         // Return the features for this worker.
712         return $buckets[$instance - 1];
713     }
715     /**
716      * Overrides default config with local config values
717      *
718      * array_merge does not merge completely the array's values
719      *
720      * @param mixed $config The node of the default config
721      * @param mixed $localconfig The node of the local config
722      * @return mixed The merge result
723      */
724     public function merge_config($config, $localconfig) {
726         if (!is_array($config) && !is_array($localconfig)) {
727             return $localconfig;
728         }
730         // Local overrides also deeper default values.
731         if (is_array($config) && !is_array($localconfig)) {
732             return $localconfig;
733         }
735         foreach ($localconfig as $key => $value) {
737             // If defaults are not as deep as local values let locals override.
738             if (!is_array($config)) {
739                 unset($config);
740             }
742             // Add the param if it doesn't exists or merge branches.
743             if (empty($config[$key])) {
744                 $config[$key] = $value;
745             } else {
746                 $config[$key] = $this->merge_config($config[$key], $localconfig[$key]);
747             }
748         }
750         return $config;
751     }
753     /**
754      * Merges $CFG->behat_config with the one passed.
755      *
756      * @param array $config existing config.
757      * @return array merged config with $CFG->behat_config
758      */
759     public function merge_behat_config($config) {
760         global $CFG;
762         // In case user defined overrides respect them over our default ones.
763         if (!empty($CFG->behat_config)) {
764             foreach ($CFG->behat_config as $profile => $values) {
765                 $config = $this->merge_config($config, $this->get_behat_config_for_profile($profile, $values));
766             }
767         }
769         return $config;
770     }
772     /**
773      * Parse $CFG->behat_config and return the array with required config structure for behat.yml
774      *
775      * @param string $profile profile name
776      * @param array $values values for profile
777      * @return array
778      */
779     public function get_behat_config_for_profile($profile, $values) {
780         // Only add profile which are compatible with Behat 3.x
781         // Just check if any of Bheat 2.5 config is set. Not checking for 3.x as it might have some other configs
782         // Like : rerun_cache etc.
783         if (!isset($values['filters']['tags']) && !isset($values['extensions']['Behat\MinkExtension\Extension'])) {
784             return array($profile => $values);
785         }
787         // Parse 2.5 format and get related values.
788         $oldconfigvalues = array();
789         if (isset($values['extensions']['Behat\MinkExtension\Extension'])) {
790             $extensionvalues = $values['extensions']['Behat\MinkExtension\Extension'];
791             if (isset($extensionvalues['selenium2']['browser'])) {
792                 $oldconfigvalues['browser'] = $extensionvalues['selenium2']['browser'];
793             }
794             if (isset($extensionvalues['selenium2']['wd_host'])) {
795                 $oldconfigvalues['wd_host'] = $extensionvalues['selenium2']['wd_host'];
796             }
797             if (isset($extensionvalues['capabilities'])) {
798                 $oldconfigvalues['capabilities'] = $extensionvalues['capabilities'];
799             }
800         }
802         if (isset($values['filters']['tags'])) {
803             $oldconfigvalues['tags'] = $values['filters']['tags'];
804         }
806         if (!empty($oldconfigvalues)) {
807             behat_config_manager::$autoprofileconversion = true;
808             return $this->get_behat_profile($profile, $oldconfigvalues);
809         }
811         // If nothing set above then return empty array.
812         return array();
813     }
815     /**
816      * Merges $CFG->behat_profiles with the one passed.
817      *
818      * @param array $config existing config.
819      * @return array merged config with $CFG->behat_profiles
820      */
821     public function merge_behat_profiles($config) {
822         global $CFG;
824         // Check for Moodle custom ones.
825         if (!empty($CFG->behat_profiles) && is_array($CFG->behat_profiles)) {
826             foreach ($CFG->behat_profiles as $profile => $values) {
827                 $config = $this->merge_config($config, $this->get_behat_profile($profile, $values));
828             }
829         }
831         return $config;
832     }
834     /**
835      * Cleans the path returned by get_components_with_tests() to standarize it
836      *
837      * @see tests_finder::get_all_directories_with_tests() it returns the path including /tests/
838      * @param string $path
839      * @return string The string without the last /tests part
840      */
841     public final function clean_path($path) {
843         $path = rtrim($path, DIRECTORY_SEPARATOR);
845         $parttoremove = DIRECTORY_SEPARATOR . 'tests';
847         $substr = substr($path, strlen($path) - strlen($parttoremove));
848         if ($substr == $parttoremove) {
849             $path = substr($path, 0, strlen($path) - strlen($parttoremove));
850         }
852         return rtrim($path, DIRECTORY_SEPARATOR);
853     }
855     /**
856      * The relative path where components stores their behat tests
857      *
858      * @return string
859      */
860     public static final function get_behat_tests_path() {
861         return DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'behat';
862     }
864     /**
865      * Return context name of behat_theme selector to use.
866      *
867      * @param string $themename name of the theme.
868      * @param bool $includeclass if class should be included.
869      * @return string
870      */
871     public static final function get_behat_theme_selector_override_classname($themename, $includeclass = false) {
872         global $CFG;
874         $overridebehatclassname = 'behat_theme_'.$themename.'_behat_selectors';
876         if ($includeclass) {
877             $themeoverrideselector = $CFG->dirroot . DIRECTORY_SEPARATOR . 'theme' . DIRECTORY_SEPARATOR . $themename .
878                 self::get_behat_tests_path() . DIRECTORY_SEPARATOR . $overridebehatclassname . '.php';
880             if (file_exists($themeoverrideselector)) {
881                 require_once($themeoverrideselector);
882             }
883         }
885         return $overridebehatclassname;
886     }
888     /**
889      * List of components which contain behat context or features.
890      *
891      * @return array
892      */
893     protected function get_components_with_tests() {
894         if (empty($this->componentswithtests)) {
895             $this->componentswithtests = tests_finder::get_components_with_tests('behat');
896         }
898         return $this->componentswithtests;
899     }
901     /**
902      * Remove list of blacklisted features from the feature list.
903      *
904      * @param array $features list of original features.
905      * @param array|string $blacklist list of features which needs to be removed.
906      * @return array features - blacklisted features.
907      */
908     protected function remove_blacklisted_features_from_list($features, $blacklist) {
910         // If no blacklist passed then return.
911         if (empty($blacklist)) {
912             return $features;
913         }
915         // If there is no feature in suite then just return what was passed.
916         if (empty($features)) {
917             return $features;
918         }
920         if (!is_array($blacklist)) {
921             $blacklist = array($blacklist);
922         }
924         // Remove blacklisted features.
925         foreach ($blacklist as $blacklistpath) {
927             list($key, $featurepath) = $this->get_clean_feature_key_and_path($blacklistpath);
929             if (isset($features[$key])) {
930                 $features[$key] = null;
931                 unset($features[$key]);
932             } else {
933                 $featurestocheck = $this->get_components_features();
934                 if (!isset($featurestocheck[$key]) && !defined('PHPUNIT_TEST')) {
935                     behat_error(BEHAT_EXITCODE_REQUIREMENT, 'Blacklisted feature "' . $blacklistpath . '" not found.');
936                 }
937             }
938         }
940         return $features;
941     }
943     /**
944      * Return list of behat suites. Multiple suites are returned if theme
945      * overrides default step definitions/features.
946      *
947      * @param int $parallelruns number of parallel runs
948      * @param int $currentrun current run.
949      * @return array list of suites.
950      */
951     protected function get_behat_suites($parallelruns = 0, $currentrun = 0) {
952         $features = $this->get_components_features();
953         $contexts = $this->get_components_contexts();
955         // Get number of parallel runs and current run.
956         if (!empty($parallelruns) && !empty($currentrun)) {
957             $this->set_parallel_run($parallelruns, $currentrun);
958         } else {
959             $parallelruns = $this->get_number_of_parallel_run();
960             $currentrun = $this->get_current_run();;
961         }
963         $themefeatures = array();
964         $themecontexts = array();
966         $themes = $this->get_list_of_themes();
968         // Create list of theme suite features and contexts.
969         foreach ($themes as $theme) {
970             // Get theme features.
971             $themefeatures[$theme] = $this->get_behat_features_for_theme($theme);
973             $themecontexts[$theme] = $this->get_behat_contexts_for_theme($theme);
974         }
976         // Remove list of theme features for default suite, as default suite should not run theme specific features.
977         foreach ($themefeatures as $removethemefeatures) {
978             if (!empty($removethemefeatures['features'])) {
979                 $features = $this->remove_blacklisted_features_from_list($features, $removethemefeatures['features']);
980             }
981         }
983         // Remove list of theme features for default suite, as default suite should not run theme specific features.
984         foreach ($themecontexts as $themename => $themecontext) {
985             if (!empty($themecontext['contexts'])) {
986                 foreach ($themecontext['contexts'] as $contextkey => $contextpath) {
987                     // Remove theme specific contexts from default contexts.
988                     unset($contexts[$contextkey]);
990                     // Remove theme specific contexts from other themes.
991                     foreach ($themes as $currenttheme) {
992                         if (($currenttheme != $themename) && isset($themecontexts[$currenttheme]['suitecontexts'][$contextkey])) {
993                             unset($themecontexts[$currenttheme]['suitecontexts'][$contextkey]);
994                         }
995                     }
996                 }
997             }
998         }
1000         $featuresforrun = $this->get_features_for_the_run($features, $parallelruns, $currentrun);
1002         // Default suite.
1003         $suites = array(
1004             'default' => array(
1005                 'paths' => array_values($featuresforrun),
1006                 'contexts' => array_keys($contexts),
1007             )
1008         );
1010         // Set suite for each theme.
1011         foreach ($themes as $theme) {
1012             // Get list of features which will be included in theme.
1013             // If theme suite with all features is set, then we want all core features to be part of theme suite.
1014             if ($this->themesuitewithallfeatures) {
1015                 // If there is no theme specific feature. Then it's just core features.
1016                 if (empty($themefeatures[$theme]['features'])) {
1017                     $themesuitefeatures = $features;
1018                 } else {
1019                     $themesuitefeatures = array_merge($features, $themefeatures[$theme]['features']);
1020                 }
1021             } else {
1022                 $themesuitefeatures = $themefeatures[$theme]['features'];
1023             }
1025             // Remove blacklisted features.
1026             $themesuitefeatures = $this->remove_blacklisted_features_from_list($themesuitefeatures,
1027                 $themefeatures[$theme]['blacklistfeatures']);
1029             // Return sub-set of features if parallel run.
1030             $themesuitefeatures = $this->get_features_for_the_run($themesuitefeatures, $parallelruns, $currentrun);
1032             // Add suite no matter what. If there is no feature in suite then it will just exist successfully with no
1033             // scenarios. But if we don't set this then the user has to know which run doesn't have suite and which run do.
1034             $suites = array_merge($suites, array(
1035                 $theme => array(
1036                     'paths'    => array_values($themesuitefeatures),
1037                     'contexts' => array_keys($themecontexts[$theme]['suitecontexts']),
1038                 )
1039             ));
1040         }
1042         return $suites;
1043     }
1045     /**
1046      * Return list of themes which can be set in moodle.
1047      *
1048      * @return array list of themes with tests.
1049      */
1050     protected function get_list_of_themes() {
1051         $selectablethemes = array();
1053         // Get all themes installed on site.
1054         $themes = core_component::get_plugin_list('theme');
1055         ksort($themes);
1057         foreach ($themes as $themename => $themedir) {
1058             // Load the theme config.
1059             try {
1060                 $theme = theme_config::load($themename);
1061             } catch (Exception $e) {
1062                 // Bad theme, just skip it for now.
1063                 continue;
1064             }
1065             if ($themename !== $theme->name) {
1066                 // Obsoleted or broken theme, just skip for now.
1067                 continue;
1068             }
1069             if ($theme->hidefromselector) {
1070                 // The theme doesn't want to be shown in the theme selector and as theme
1071                 // designer mode is switched off we will respect that decision.
1072                 continue;
1073             }
1074             if ($themename == theme_config::DEFAULT_THEME) {
1075                 // Don't include default theme, as default suite will be running with this theme.
1076                 continue;
1077             }
1078             $selectablethemes[] = $themename;
1079         }
1081         return $selectablethemes;
1082     }
1084     /**
1085      * Return theme directory.
1086      *
1087      * @param string $themename
1088      * @return string theme directory
1089      */
1090     protected function get_theme_test_directory($themename) {
1091         global $CFG;
1093         $themetestdir = "/theme/" . $themename;
1095         return $CFG->dirroot . $themetestdir  . self::get_behat_tests_path();
1096     }
1098     /**
1099      * Returns all the directories having overridden tests.
1100      *
1101      * @param string $theme name of theme
1102      * @param string $testtype The kind of test we are looking for
1103      * @return array all directories having tests
1104      */
1105     protected function get_test_directories_overridden_for_theme($theme, $testtype) {
1106         global $CFG;
1108         $testtypes = array(
1109             'contexts' => '|behat_.*\.php$|',
1110             'features' => '|.*\.feature$|',
1111         );
1112         $themetestdirfullpath = $this->get_theme_test_directory($theme);
1114         // If test directory doesn't exist then return.
1115         if (!is_dir($themetestdirfullpath)) {
1116             return array();
1117         }
1119         $directoriestosearch = glob($themetestdirfullpath . DIRECTORY_SEPARATOR . '*' , GLOB_ONLYDIR);
1121         // Include theme directory to find tests.
1122         $dirs[realpath($themetestdirfullpath)] = trim(str_replace('/', '_', $themetestdirfullpath), '_');
1124         // Search for tests in valid directories.
1125         foreach ($directoriestosearch as $dir) {
1126             $dirite = new RecursiveDirectoryIterator($dir);
1127             $iteite = new RecursiveIteratorIterator($dirite);
1128             $regexp = $testtypes[$testtype];
1129             $regite = new RegexIterator($iteite, $regexp);
1130             foreach ($regite as $path => $element) {
1131                 $key = dirname($path);
1132                 $value = trim(str_replace(DIRECTORY_SEPARATOR, '_', str_replace($CFG->dirroot, '', $key)), '_');
1133                 $dirs[$key] = $value;
1134             }
1135         }
1136         ksort($dirs);
1138         return array_flip($dirs);
1139     }
1141     /**
1142      * Return blacklisted contexts or features for a theme, as defined in blacklist.json.
1143      *
1144      * @param string $theme themename
1145      * @param string $testtype test type (contexts|features)
1146      * @return array list of blacklisted contexts or features
1147      */
1148     protected function get_blacklisted_tests_for_theme($theme, $testtype) {
1150         $themetestpath = $this->get_theme_test_directory($theme);
1152         if (file_exists($themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json')) {
1153             // Blacklist file exist. Leave it for last to clear the feature and contexts.
1154             $blacklisttests = @json_decode(file_get_contents($themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json'), true);
1155             if (empty($blacklisttests)) {
1156                 behat_error(BEHAT_EXITCODE_REQUIREMENT, $themetestpath . DIRECTORY_SEPARATOR . 'blacklist.json is empty');
1157             }
1159             // If features or contexts not defined then no problem.
1160             if (!isset($blacklisttests[$testtype])) {
1161                 $blacklisttests[$testtype] = array();
1162             }
1163             return $blacklisttests[$testtype];
1164         }
1166         return array();
1167     }
1169     /**
1170      * Return list of features and step definitions in theme.
1171      *
1172      * @param string $theme theme name
1173      * @param string $testtype test type, either features or contexts
1174      * @return array list of contexts $contexts or $features
1175      */
1176     protected function get_tests_for_theme($theme, $testtype) {
1178         $tests = array();
1179         $testtypes = array(
1180             'contexts' => '|behat_.*\.php$|',
1181             'features' => '|.*\.feature$|',
1182         );
1184         // Get all the directories having overridden tests.
1185         $directories = $this->get_test_directories_overridden_for_theme($theme, $testtype);
1187         // Get overridden test contexts.
1188         foreach ($directories as $dirpath) {
1189             // All behat_*.php inside overridden directory.
1190             $diriterator = new DirectoryIterator($dirpath);
1191             $regite = new RegexIterator($diriterator, $testtypes[$testtype]);
1193             // All behat_*.php inside behat_config_manager::get_behat_tests_path() are added as steps definitions files.
1194             foreach ($regite as $file) {
1195                 $key = $file->getBasename('.php');
1196                 $tests[$key] = $file->getPathname();
1197             }
1198         }
1200         return $tests;
1201     }
1203     /**
1204      * Return list of blacklisted behat features for theme and features defined by theme only.
1205      *
1206      * @param string $theme theme name.
1207      * @return array ($blacklistfeatures, $blacklisttags, $features)
1208      */
1209     protected function get_behat_features_for_theme($theme) {
1211         // Get list of features defined by theme.
1212         $themefeatures = $this->get_tests_for_theme($theme, 'features');
1213         $themeblacklistfeatures = $this->get_blacklisted_tests_for_theme($theme, 'features');
1215         // Clean feature key and path.
1216         $features = array();
1217         $blacklistfeatures = array();
1219         foreach ($themefeatures as $themefeature) {
1220             list($featurekey, $featurepath) = $this->get_clean_feature_key_and_path($themefeature);
1221             $features[$featurekey] = $featurepath;
1222         }
1223         foreach ($themeblacklistfeatures as $themeblacklistfeature) {
1224             list($blacklistfeaturekey, $blacklistfeaturepath) = $this->get_clean_feature_key_and_path($themeblacklistfeature);
1225             $blacklistfeatures[$blacklistfeaturekey] = $blacklistfeaturepath;
1226         }
1228         ksort($features);
1230         $retval = array(
1231             'blacklistfeatures' => $blacklistfeatures,
1232             'features' => $features
1233         );
1235         return $retval;
1236     }
1238     /**
1239      * Return list of contexts overridden by themes.
1240      *
1241      * @return array.
1242      */
1243     protected function get_overridden_theme_contexts() {
1244         if (empty($this->overriddenthemescontexts)) {
1245             $this->overriddenthemescontexts = array();
1246         }
1248         return $this->overriddenthemescontexts;
1249     }
1251     /**
1252      * Return list of behat contexts for theme and update $this->stepdefinitions list.
1253      *
1254      * @param string $theme theme name.
1255      * @return array list($themecontexts, $themesuitecontexts)
1256      */
1257     protected function get_behat_contexts_for_theme($theme) {
1259         // If we already have this list then just return. This will not change by run.
1260         if (!empty($this->themecontexts[$theme]) && !empty($this->themesuitecontexts)) {
1261             return array(
1262                 'contexts' => $this->themecontexts[$theme],
1263                 'suitecontexts' => $this->themesuitecontexts[$theme],
1264             );
1265         }
1267         if (empty($this->overriddenthemescontexts)) {
1268             $this->overriddenthemescontexts = array();
1269         }
1271         $contexts = $this->get_components_contexts();
1273         // Create list of contexts used by theme suite.
1274         $themecontexts = $this->get_tests_for_theme($theme, 'contexts');
1275         $blacklistedcontexts = $this->get_blacklisted_tests_for_theme($theme, 'contexts');
1277         // Theme suite will use all core contexts, except the one overridden by theme.
1278         $themesuitecontexts = $contexts;
1280         foreach ($themecontexts as $context => $path) {
1282             // If a context in theme starts with behat_theme_{themename}_behat_* then it's overriding core context.
1283             if (preg_match('/^behat_theme_'.$theme.'_(\w+)$/', $context, $match)) {
1285                 if (!empty($themesuitecontexts[$match[1]])) {
1286                     unset($themesuitecontexts[$match[1]]);
1287                 }
1289                 // Add this to the list of overridden paths, so it can be added to final contexts list for class resolver.
1290                 $this->overriddenthemescontexts[$context] = $path;
1291             }
1293             // Don't include behat_selectors.
1294             if ($context === self::get_behat_theme_selector_override_classname($theme)) {
1295                 unset($this->contexts[$context]);
1296                 unset($themesuitecontexts[$context]);
1297                 continue;
1298             }
1300             // Add theme specific contexts with suffix to steps definitions.
1301             $themesuitecontexts[$context] = $path;
1302         }
1304         // Remove blacklisted contexts.
1305         foreach ($blacklistedcontexts as $blacklistpath) {
1306             $blacklistcontext = basename($blacklistpath, '.php');
1308             unset($themesuitecontexts[$blacklistcontext]);
1309         }
1311         // We are only interested in the class name of context.
1312         $this->themesuitecontexts[$theme] = $themesuitecontexts;
1313         $this->themecontexts[$theme] = $themecontexts;
1315         $retval = array(
1316             'contexts' => $themecontexts,
1317             'suitecontexts' => $themesuitecontexts,
1318         );
1320         return $retval;
1321     }