mokocli/cli/release_validate.php

#!/usr/bin/env php
<?php

/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * FILE INFORMATION
<<<<<<< HEAD
 * DEFGROUP: MokoCLI.CLI
 * INGROUP: MokoCLI
 * REPO: https://git.mokoconsulting.tech/MokoConsulting/mokocli
=======
 * DEFGROUP: mokoplatform.CLI
 * INGROUP: mokoplatform
 * REPO: https://git.mokoconsulting.tech/MokoConsulting/mokoplatform
>>>>>>> main
 * PATH: /cli/release_validate.php
 * BRIEF: Pre-release validation -- version consistency, required files, manifest checks
 */

declare(strict_types=1);

require_once __DIR__ . '/../lib/Enterprise/CliFramework.php';

use MokoCli\{CliFramework, SourceResolver};

class ReleaseValidateCli extends CliFramework
{
    private int $pass = 0;
    private int $fail = 0;
    private int $warn = 0;
    private array $results = [];

    protected function configure(): void
    {
        $this->setDescription('Pre-release validation -- version consistency, required files, manifest checks');
        $this->addArgument('--path', 'Repository root', '.');
        $this->addArgument('--version', 'Expected version string', null);
        $this->addArgument('--platform', 'joomla|dolibarr|generic', null);
        $this->addArgument('--output-summary', 'Write markdown to $GITHUB_STEP_SUMMARY', false);
        $this->addArgument('--github-output', 'Export counts to $GITHUB_OUTPUT', false);
    }

    protected function run(): int
    {
        $path = $this->getArgument('--path');
        $version = $this->getArgument('--version');
        $platform = $this->getArgument('--platform');
        $outputSummary = (bool) $this->getArgument('--output-summary');
        $githubOutput = (bool) $this->getArgument('--github-output');
        if ($version === null) {
            $this->log('ERROR', "Usage: release_validate.php --path . --version XX.YY.ZZ [--platform joomla]");
            return 1;
        }
        $root = realpath($path) ?: $path;
        if ($platform === null) {
            $manifestXml = "{$root}/.mokogitea/manifest.xml";
            if (file_exists($manifestXml)) {
                $mContent = file_get_contents($manifestXml);
                if (preg_match('/<platform>([^<]+)<\/platform>/', $mContent, $pm)) {
                    $platform = trim($pm[1]);
                }
            }
            if (in_array($platform, ['waas-component'], true)) {
                $platform = 'joomla';
            }
            if (in_array($platform, ['crm-module'], true)) {
                $platform = 'dolibarr';
            }
            if ($platform === null) {
                $platform = 'generic';
            }
        }
        $hasSource = SourceResolver::resolveAbsolute($root) !== null;
        SourceResolver::warnIfLegacy($root);
        $srcDirName = SourceResolver::resolve($root);
        $this->addVResult('Source directory', $hasSource ? 'PASS' : 'WARN', $hasSource ? "{$srcDirName}/ found" : 'No source/ or src/ directory');
        if (!file_exists("{$root}/README.md")) {
            $this->addVResult('README.md', 'FAIL', 'Not found');
        } else {
            $readme = file_get_contents("{$root}/README.md");
            $quotedVer = preg_quote($version, '/');
            $readmeHasVer = preg_match(
                '/VERSION:\s*' . $quotedVer . '/',
                $readme
            ) || strpos($readme, $version) !== false;
            $this->addVResult(
                'README.md version',
                $readmeHasVer ? 'PASS' : 'FAIL',
                $readmeHasVer
                    ? "`{$version}` found"
                    : "`{$version}` not found"
            );
        }
        if (!file_exists("{$root}/CHANGELOG.md")) {
            $this->addVResult('CHANGELOG.md', 'WARN', 'Not found');
        } else {
            $cl = file_get_contents("{$root}/CHANGELOG.md");
            $clHasVer = preg_match(
                '/^##\s.*' . preg_quote($version, '/') . '/m',
                $cl
            );
            $this->addVResult(
                'CHANGELOG.md version',
                $clHasVer ? 'PASS' : 'WARN',
                $clHasVer ? "Section found" : "No section header"
            );
        }
        $licenseFound = false;
        foreach (['LICENSE', 'LICENSE.md', 'LICENSE.txt', 'COPYING'] as $lf) {
            if (file_exists("{$root}/{$lf}")) {
                $licenseFound = true;
                break;
            }
        }
        $this->addVResult('LICENSE', $licenseFound ? 'PASS' : 'FAIL', $licenseFound ? 'Found' : 'Not found');
        if ($platform === 'joomla') {
            $manifest = null;
            $srcAbs = SourceResolver::resolveAbsolute($root);
            foreach (array_filter([$srcAbs, $root]) as $dir) {
                if (!is_dir($dir)) {
                    continue;
                } foreach (glob("{$dir}/*.xml") as $xmlFile) {
                    $content = file_get_contents($xmlFile);
                    if (strpos($content, '<extension') !== false) {
                        $manifest = $xmlFile;
                        break 2;
                    }
                }
            }
            if ($manifest === null) {
                $this->addVResult('XML manifest', 'FAIL', 'No Joomla manifest found');
            } else {
                $manifestContent = file_get_contents($manifest);
                if (preg_match('/<version>([^<]+)<\/version>/', $manifestContent, $m)) {
                    $mVer = trim($m[1]);
                    $this->addVResult(
                        'Manifest version',
                        $mVer === $version ? 'PASS' : 'FAIL',
                        $mVer === $version
                            ? "`{$mVer}` matches"
                            : "`{$mVer}` != `{$version}`"
                    );
                } else {
                    $this->addVResult('Manifest version', 'FAIL', 'No <version> tag');
                }
            }
            if (!file_exists("{$root}/updates.xml")) {
                $this->addVResult('updates.xml', 'WARN', 'Not found');
            } else {
                $ux = file_get_contents("{$root}/updates.xml");
                $uxHasVer = preg_match(
                    '/<version>' . preg_quote($version, '/')
                    . '<\/version>/',
                    $ux
                );
                $this->addVResult(
                    'updates.xml version',
                    $uxHasVer ? 'PASS' : 'FAIL',
                    $uxHasVer
                        ? "`{$version}` found"
                        : "`{$version}` not found"
                );
            }
        } elseif ($platform === 'dolibarr') {
            $modFile = null;
            foreach (SourceResolver::getCandidates() as $sd) {
                $matches = glob("{$root}/{$sd}/mod*.class.php");
                if (!empty($matches)) {
                    $modFile = $matches[0];
                    break;
                }
            }
            if ($modFile === null) {
                $this->addVResult('Dolibarr mod file', 'FAIL', 'No mod*.class.php found');
            } else {
                $mc = file_get_contents($modFile);
                $dolPattern = "/\\\$this->version\s*=\s*'"
                    . preg_quote($version, '/') . "'/";
                $dolMatch = preg_match($dolPattern, $mc);
                $this->addVResult(
                    'Dolibarr version',
                    $dolMatch ? 'PASS' : 'FAIL',
                    $dolMatch
                        ? "`{$version}` matches"
                        : "`{$version}` not found"
                );
            }
        }
        if (file_exists("{$root}/composer.json")) {
            $composer = json_decode(file_get_contents("{$root}/composer.json"), true);
            if (isset($composer['version'])) {
                $compMatch = $composer['version'] === $version;
                $this->addVResult(
                    'composer.json version',
                    $compMatch ? 'PASS' : 'WARN',
                    $compMatch
                        ? "`{$version}` matches"
                        : "`{$composer['version']}` != `{$version}`"
                );
            }
        }
        $table = "| Check | Result | Details |\n|-------|--------|--------|\n";
        foreach ($this->results as $r) {
            $table .= "| {$r['check']} | {$r['status']} | {$r['details']} |\n";
        }
        $table .= "\n**Validation: {$this->pass} passed, {$this->fail} failed, {$this->warn} warnings**\n";
        echo $table;
        if ($outputSummary) {
            $summaryFile = getenv('GITHUB_STEP_SUMMARY');
            if ($summaryFile) {
                file_put_contents($summaryFile, "## Pre-Release Sanity Checks ({$platform})\n\n{$table}\n", FILE_APPEND);
            }
        }
        if ($githubOutput) {
            $ghOutput = getenv('GITHUB_OUTPUT');
            if ($ghOutput) {
                file_put_contents(
                    $ghOutput,
                    "validation_pass={$this->pass}\n"
                    . "validation_fail={$this->fail}\n"
                    . "validation_warn={$this->warn}\n"
                    . "validation_platform={$platform}\n",
                    FILE_APPEND
                );
            }
        }
        return $this->fail > 0 ? 1 : 0;
    }

    private function addVResult(string $check, string $status, string $details): void
    {
        $this->results[] = ['check' => $check, 'status' => $status, 'details' => $details];
        if ($status === 'PASS') {
            $this->pass++;
        } elseif ($status === 'FAIL') {
            $this->fail++;
        } elseif ($status === 'WARN') {
            $this->warn++;
        }
    }
}

$app = new ReleaseValidateCli();
exit($app->execute());