Merge pull request #359 from kabalin/MDL-83424

Support new directory structure

Author: andrewnicols

composer.json

@@ -55,8 +55,8 @@
   ],
   "require": {
     "php": ">=7.4",
-    "moodlehq/moodle-cs": "^3.4.10",
-    "moodlehq/moodle-local_ci": "^1.0.31",
+    "moodlehq/moodle-cs": "^3.4.11",
+    "moodlehq/moodle-local_ci": "^1.0.32",
     "moodlehq/moodle-local_moodlecheck": "^1.3.2",
     "sebastian/phpcpd": "^6.0.3",
     "sebastian/version": "^3.0.2",

composer.lock

@@ -12,6 +12,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
 ### Changed
 - Bump default Selenium version to 4.
 
+### Fixed
+- Add support for public directory structure in 5.1 (MDL-83424).
+
 ## [4.5.7] - 2025-03-26
 ### Changed
 - Allow to run with PHP 8.4 (supported in Moodle 5.0)

docs/CHANGELOG.md

@@ -39,6 +39,17 @@ public function __construct(string $directory)
         $this->directory = $directory;
     }
 
+    /**
+     * Get the absolute path to the public directory.
+     *
+     * @return string
+     */
+    public function getPublicDirectory(): string
+    {
+        // Moodle 5.1+ is using 'public' directory structure.
+        return file_exists($this->directory . '/public/version.php') ? $this->directory . '/public' : $this->directory;
+    }
+
     /**
      * Load Moodle config so we can use Moodle APIs.
      */
@@ -125,7 +136,7 @@ public function getBranch(): int
         $filter = new StatementFilter();
         $parser = new CodeParser();
 
-        $statements = $parser->parseFile($this->directory . '/version.php');
+        $statements = $parser->parseFile($this->getPublicDirectory() . '/version.php');
         $assign     = $filter->findFirstVariableAssignment($statements, 'branch', 'Failed to find $branch in Moodle version.php');
 
         if ($assign->expr instanceof String_) {

src/Bridge/Moodle.php

@@ -79,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 '--enable',
                 '--add-core-features-to-theme',
                 '--scss-deprecations',
-            ], $this->moodle->directory, null, null, null);
+            ], $this->moodle->getPublicDirectory(), null, null, null);
             $this->execute->passThroughProcess($enableprocess);
         }
 
@@ -102,7 +102,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $cmd[] = '--colors';
         }
 
-        $process = $this->execute->passThroughProcess(new Process($cmd, $this->moodle->directory, null, null, null));
+        $process = $this->execute->passThroughProcess(new Process($cmd, $this->moodle->getPublicDirectory(), null, null, null));
 
         $servers && $this->stopServerProcesses();
 
@@ -167,7 +167,10 @@ private function startServerProcesses(InputInterface $input): void
             'php',
             '-S',
             $phpWebserverHost,
+            '-t',
+            $this->moodle->getPublicDirectory(),
         ];
+
         $web = new Process($cmd, $this->moodle->directory);
         $web->setTimeout(0);
         $web->disableOutput();

src/Command/BehatCommand.php

@@ -73,7 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $wrapper,
                 '--filename=' . $file,
                 '--validator=' . $jarTmpFile,
-                '--basename=' . $this->moodle->directory,
+                '--basename=' . $this->moodle->getPublicDirectory(),
             ];
             // _JAVA_OPTIONS is something Travis CI started to set in Trusty.  This breaks Mustache because
             // the output from vnu.jar needs to be captured and JSON decoded.  When _JAVA_OPTIONS is present,

src/Command/MustacheCommand.php

@@ -69,7 +69,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             '-f=text',
         ];
 
-        $process = $this->execute->passThroughProcess(new Process($cmd, $this->moodle->directory, null, null, null));
+        $process = $this->execute->passThroughProcess(new Process($cmd, $this->moodle->getPublicDirectory(), null, null, null));
 
         if (isset($filesystem)) {
             // Remove plugin if we added it, so we leave things clean.

src/Command/PHPDocCommand.php

@@ -43,7 +43,7 @@ public function __construct(Moodle $moodle, MoodlePlugin $plugin, Execute $execu
      */
     private function getBehatUtility(): string
     {
-        return $this->moodle->directory . '/admin/tool/behat/cli/util_single_run.php';
+        return $this->moodle->getPublicDirectory() . '/admin/tool/behat/cli/util_single_run.php';
     }
 
     public function install(): void
@@ -104,7 +104,7 @@ public function getUnitTestInstallProcesses(): array
 
         return [
             new MoodleProcess([
-                $this->moodle->directory . '/admin/tool/phpunit/cli/util.php',
+                $this->moodle->getPublicDirectory() . '/admin/tool/phpunit/cli/util.php',
                 '--install',
             ]),
         ];
@@ -130,15 +130,15 @@ public function getPostInstallProcesses(): array
         if ($this->plugin->hasUnitTests()) {
             $this->getOutput()->debug('Build PHPUnit config');
             $processes[] = new MoodleProcess([
-                $this->moodle->directory . '/admin/tool/phpunit/cli/util.php',
+                $this->moodle->getPublicDirectory() . '/admin/tool/phpunit/cli/util.php',
                 '--buildconfig',
             ]);
             // Only create the PHPUnit config file (phpunit.xml) if it does not exist.
             // This is to avoid overwriting the file if it has been customized by the developer.
             if (!$this->plugin->hasPHPUnitConfig()) {
                 $this->getOutput()->debug('Build PHPUnit component config');
                 $processes[] = new MoodleProcess([
-                    $this->moodle->directory . '/admin/tool/phpunit/cli/util.php',
+                    $this->moodle->getPublicDirectory() . '/admin/tool/phpunit/cli/util.php',
                     '--buildcomponentconfigs',
                 ]);
             }