refactor(cli): migrate 64 legacy scripts to CliFramework (#235)
Platform: moko-platform CI / Gate 2: Unit Tests (8.1) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 2: Unit Tests (8.2) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 2: Unit Tests (8.3) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 3: Self-Health Check (push) Blocked by required conditions
Platform: moko-platform CI / Gate 4: Governance (push) Blocked by required conditions
Platform: moko-platform CI / Gate 5: Template Integrity (push) Blocked by required conditions
Platform: moko-platform CI / CI Summary (push) Blocked by required conditions
Generic: Repo Health / Release configuration (push) Blocked by required conditions
Generic: Repo Health / Scripts governance (push) Blocked by required conditions
Generic: Repo Health / Repository health (push) Blocked by required conditions
Generic: Repo Health / Site Health (push) Has been skipped
Generic: Repo Health / Access control (push) Successful in 2s
Platform: moko-platform CI / Gate 1: Code Quality (push) Failing after 36s
Platform: moko-platform CI / Gate 2: Unit Tests (8.1) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 2: Unit Tests (8.2) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 2: Unit Tests (8.3) (push) Blocked by required conditions
Platform: moko-platform CI / Gate 3: Self-Health Check (push) Blocked by required conditions
Platform: moko-platform CI / Gate 4: Governance (push) Blocked by required conditions
Platform: moko-platform CI / Gate 5: Template Integrity (push) Blocked by required conditions
Platform: moko-platform CI / CI Summary (push) Blocked by required conditions
Generic: Repo Health / Release configuration (push) Blocked by required conditions
Generic: Repo Health / Scripts governance (push) Blocked by required conditions
Generic: Repo Health / Repository health (push) Blocked by required conditions
Generic: Repo Health / Site Health (push) Has been skipped
Generic: Repo Health / Access control (push) Successful in 2s
Platform: moko-platform CI / Gate 1: Code Quality (push) Failing after 36s
Wrap all CLI tools in cli/, automation/, maintenance/, deploy/, and release/ in classes extending CliFramework. Replaces manual $argv parsing with configure()/addArgument(), moves logic into run(): int, and converts fwrite(STDERR,...) to $this->log(). Two CLIApp subclasses (generate_dolibarr_version_txt, generate_joomla_update_xml) converted to extend CliFramework directly. Every script now gets free --help, --verbose, --quiet, --dry-run, --json, --no-color, banners, coloured logging, and progress bars. Authored-by: Moko Consulting Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
+201
-269
@@ -11,309 +11,241 @@
|
||||
* REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||
* PATH: /cli/version_reset_dev.php
|
||||
* BRIEF: Reset platform version to 'development' on a branch via Gitea API
|
||||
*
|
||||
* Usage:
|
||||
* php version_reset_dev.php --token TOKEN --api-base URL
|
||||
* php version_reset_dev.php --token TOKEN --api-base URL --branch dev
|
||||
* php version_reset_dev.php --token TOKEN --api-base URL --platform dolibarr
|
||||
* php version_reset_dev.php --token TOKEN --api-base URL --path /repo/root
|
||||
*
|
||||
* This replaces the inline curl+python3+sed block previously used in
|
||||
* auto-release.yml to reset Dolibarr's $this->version on the dev branch
|
||||
* after a stable release.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// ── Argument parsing ─────────────────────────────────────────────────────────
|
||||
require_once __DIR__ . '/../lib/Enterprise/CliFramework.php';
|
||||
|
||||
$token = null;
|
||||
$apiBase = null;
|
||||
$branch = 'dev';
|
||||
$platform = null;
|
||||
$path = null;
|
||||
use MokoEnterprise\CliFramework;
|
||||
|
||||
foreach ($argv as $i => $arg) {
|
||||
if ($arg === '--token' && isset($argv[$i + 1])) {
|
||||
$token = $argv[$i + 1];
|
||||
}
|
||||
if ($arg === '--api-base' && isset($argv[$i + 1])) {
|
||||
$apiBase = rtrim($argv[$i + 1], '/');
|
||||
}
|
||||
if ($arg === '--branch' && isset($argv[$i + 1])) {
|
||||
$branch = $argv[$i + 1];
|
||||
}
|
||||
if ($arg === '--platform' && isset($argv[$i + 1])) {
|
||||
$platform = $argv[$i + 1];
|
||||
}
|
||||
if ($arg === '--path' && isset($argv[$i + 1])) {
|
||||
$path = $argv[$i + 1];
|
||||
}
|
||||
if ($arg === '--help' || $arg === '-h') {
|
||||
printUsage();
|
||||
exit(0);
|
||||
}
|
||||
}
|
||||
|
||||
// Allow token from environment
|
||||
if ($token === null) {
|
||||
$envToken = getenv('MOKOGITEA_TOKEN');
|
||||
if ($envToken !== false && $envToken !== '') {
|
||||
$token = $envToken;
|
||||
}
|
||||
}
|
||||
if ($token === null) {
|
||||
$envToken = getenv('GITEA_TOKEN');
|
||||
if ($envToken !== false && $envToken !== '') {
|
||||
$token = $envToken;
|
||||
}
|
||||
}
|
||||
|
||||
if ($token === null || $apiBase === null) {
|
||||
fwrite(STDERR, "Error: --token and --api-base are required.\n\n");
|
||||
printUsage();
|
||||
exit(1);
|
||||
}
|
||||
|
||||
// ── Platform detection ───────────────────────────────────────────────────────
|
||||
|
||||
if ($platform === null && $path !== null) {
|
||||
$platform = detectPlatform($path);
|
||||
if ($platform !== null) {
|
||||
echo "Detected platform: {$platform}\n";
|
||||
}
|
||||
}
|
||||
|
||||
if ($platform === null) {
|
||||
fwrite(STDERR, "Error: could not determine platform. Use --platform or --path.\n");
|
||||
exit(1);
|
||||
}
|
||||
|
||||
// ── Dispatch by platform ─────────────────────────────────────────────────────
|
||||
|
||||
$changed = 0;
|
||||
|
||||
if (in_array($platform, ['dolibarr', 'crm-module'], true)) {
|
||||
$changed = resetDolibarrVersion($apiBase, $token, $branch);
|
||||
} elseif (in_array($platform, ['joomla', 'waas-component'], true)) {
|
||||
echo "Joomla version reset is not yet implemented — skipping.\n";
|
||||
} else {
|
||||
echo "Platform '{$platform}' has no version-reset logic — skipping.\n";
|
||||
}
|
||||
|
||||
echo "Reset {$changed} file(s) to 'development' on branch '{$branch}'.\n";
|
||||
exit(0);
|
||||
|
||||
// ══════════════════════════════════════════════════════════════════════════════
|
||||
// Helper functions
|
||||
// ══════════════════════════════════════════════════════════════════════════════
|
||||
|
||||
/**
|
||||
* Print usage information to stdout.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
function printUsage(): void
|
||||
class VersionResetDevCli extends CliFramework
|
||||
{
|
||||
echo <<<'USAGE'
|
||||
Reset platform version to 'development' on a branch via Gitea API.
|
||||
|
||||
Usage:
|
||||
php version_reset_dev.php --token TOKEN --api-base URL [options]
|
||||
|
||||
Required:
|
||||
--token TOKEN Gitea API token (also reads MOKOGITEA_TOKEN / GITEA_TOKEN env)
|
||||
--api-base URL Gitea API base URL for the repo
|
||||
e.g. https://git.mokoconsulting.tech/api/v1/repos/Org/Repo
|
||||
|
||||
Options:
|
||||
--branch BRANCH Target branch (default: dev)
|
||||
--platform TYPE Platform type: dolibarr, crm-module, joomla, waas-component
|
||||
--path DIR Repo root for auto-detecting platform from manifest.xml
|
||||
--help Show this help
|
||||
|
||||
USAGE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect the platform type from a repo's .mokogitea/manifest.xml file.
|
||||
*
|
||||
* @param string $repoPath Path to the repository root
|
||||
* @return string|null The detected platform, or null if detection fails
|
||||
*/
|
||||
function detectPlatform(string $repoPath): ?string
|
||||
{
|
||||
$root = realpath($repoPath) ?: $repoPath;
|
||||
$manifestXml = "{$root}/.mokogitea/manifest.xml";
|
||||
|
||||
if (!file_exists($manifestXml)) {
|
||||
return null;
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->setDescription('Reset platform version to development on a branch via Gitea API');
|
||||
$this->addArgument('--token', 'Gitea API token (also reads MOKOGITEA_TOKEN / GITEA_TOKEN env)', '');
|
||||
$this->addArgument('--api-base', 'Gitea API base URL for the repo', '');
|
||||
$this->addArgument('--branch', 'Target branch (default: dev)', 'dev');
|
||||
$this->addArgument('--platform', 'Platform type: dolibarr, crm-module, joomla, waas-component', '');
|
||||
$this->addArgument('--path', 'Repo root for auto-detecting platform from manifest.xml', '');
|
||||
}
|
||||
|
||||
$xml = @simplexml_load_file($manifestXml);
|
||||
if ($xml === false) {
|
||||
return null;
|
||||
}
|
||||
protected function run(): int
|
||||
{
|
||||
$token = $this->getArgument('--token');
|
||||
$apiBase = $this->getArgument('--api-base');
|
||||
$branch = $this->getArgument('--branch');
|
||||
$platform = $this->getArgument('--platform');
|
||||
$path = $this->getArgument('--path');
|
||||
|
||||
if (isset($xml->governance->platform)) {
|
||||
$platform = (string) $xml->governance->platform;
|
||||
if ($platform !== '') {
|
||||
return $platform;
|
||||
// Allow token from environment
|
||||
if ($token === '') {
|
||||
$envToken = getenv('MOKOGITEA_TOKEN');
|
||||
if ($envToken !== false && $envToken !== '') {
|
||||
$token = $envToken;
|
||||
}
|
||||
}
|
||||
if ($token === '') {
|
||||
$envToken = getenv('GITEA_TOKEN');
|
||||
if ($envToken !== false && $envToken !== '') {
|
||||
$token = $envToken;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
if ($token === '' || $apiBase === '') {
|
||||
$this->log('ERROR', '--token and --api-base are required.');
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a Gitea API call and return the decoded JSON response.
|
||||
*
|
||||
* @param string $url Full API URL
|
||||
* @param string $token Gitea API token
|
||||
* @param string $method HTTP method (GET, PUT, POST, DELETE)
|
||||
* @param string|null $body JSON request body, or null for bodiless requests
|
||||
* @return array<string, mixed>|null Decoded JSON response, or null on failure
|
||||
*/
|
||||
function giteaApiCall(string $url, string $token, string $method = 'GET', ?string $body = null): ?array
|
||||
{
|
||||
$ch = curl_init($url);
|
||||
if ($ch === false) {
|
||||
fwrite(STDERR, "Error: curl_init() failed for {$url}\n");
|
||||
return null;
|
||||
}
|
||||
$apiBase = rtrim($apiBase, '/');
|
||||
|
||||
$headers = [
|
||||
"Authorization: token {$token}",
|
||||
'Accept: application/json',
|
||||
];
|
||||
if ($body !== null) {
|
||||
$headers[] = 'Content-Type: application/json';
|
||||
}
|
||||
// ── Platform detection ───────────────────────────────────────────────────────
|
||||
|
||||
curl_setopt_array($ch, [
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
CURLOPT_HTTPHEADER => $headers,
|
||||
CURLOPT_TIMEOUT => 30,
|
||||
CURLOPT_CUSTOMREQUEST => $method,
|
||||
]);
|
||||
if ($platform === '' && $path !== '') {
|
||||
$platform = $this->detectPlatform($path) ?? '';
|
||||
if ($platform !== '') {
|
||||
echo "Detected platform: {$platform}\n";
|
||||
}
|
||||
}
|
||||
|
||||
if ($body !== null) {
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
|
||||
}
|
||||
if ($platform === '') {
|
||||
$this->log('ERROR', 'Could not determine platform. Use --platform or --path.');
|
||||
return 1;
|
||||
}
|
||||
|
||||
$response = curl_exec($ch);
|
||||
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
|
||||
curl_close($ch);
|
||||
// ── Dispatch by platform ─────────────────────────────────────────────────────
|
||||
|
||||
if ($httpCode < 200 || $httpCode >= 300 || !is_string($response) || $response === '') {
|
||||
return null;
|
||||
}
|
||||
$changed = 0;
|
||||
|
||||
$data = json_decode($response, true);
|
||||
if (!is_array($data)) {
|
||||
return null;
|
||||
}
|
||||
if (in_array($platform, ['dolibarr', 'crm-module'], true)) {
|
||||
$changed = $this->resetDolibarrVersion($apiBase, $token, $branch);
|
||||
} elseif (in_array($platform, ['joomla', 'waas-component'], true)) {
|
||||
echo "Joomla version reset is not yet implemented — skipping.\n";
|
||||
} else {
|
||||
echo "Platform '{$platform}' has no version-reset logic — skipping.\n";
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset Dolibarr module version to 'development' on the target branch.
|
||||
*
|
||||
* Searches the repository tree for mod*.class.php files that contain
|
||||
* `extends DolibarrModules`, then replaces `$this->version = '...'`
|
||||
* with `$this->version = 'development'` via the Gitea file contents API.
|
||||
*
|
||||
* @param string $apiBase Gitea API base URL for the repo
|
||||
* @param string $token Gitea API token
|
||||
* @param string $branch Target branch name
|
||||
* @return int Number of files modified
|
||||
*/
|
||||
function resetDolibarrVersion(string $apiBase, string $token, string $branch): int
|
||||
{
|
||||
// Search the repo tree for mod*.class.php files
|
||||
$treeUrl = "{$apiBase}/git/trees/{$branch}?recursive=true";
|
||||
$tree = giteaApiCall($treeUrl, $token);
|
||||
|
||||
if ($tree === null || !isset($tree['tree']) || !is_array($tree['tree'])) {
|
||||
fwrite(STDERR, "Error: could not read repository tree for branch '{$branch}'.\n");
|
||||
echo "Reset {$changed} file(s) to 'development' on branch '{$branch}'.\n";
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Find candidate files: mod*.class.php anywhere in the tree
|
||||
$candidates = [];
|
||||
foreach ($tree['tree'] as $entry) {
|
||||
if (!isset($entry['path']) || !is_string($entry['path'])) {
|
||||
continue;
|
||||
private function detectPlatform(string $repoPath): ?string
|
||||
{
|
||||
$root = realpath($repoPath) ?: $repoPath;
|
||||
$manifestXml = "{$root}/.mokogitea/manifest.xml";
|
||||
|
||||
if (!file_exists($manifestXml)) {
|
||||
return null;
|
||||
}
|
||||
$basename = basename($entry['path']);
|
||||
if (preg_match('/^mod[A-Za-z0-9_]+\.class\.php$/', $basename)) {
|
||||
$candidates[] = $entry['path'];
|
||||
|
||||
$xml = @simplexml_load_file($manifestXml);
|
||||
if ($xml === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (isset($xml->governance->platform)) {
|
||||
$platform = (string) $xml->governance->platform;
|
||||
if ($platform !== '') {
|
||||
return $platform;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
if (empty($candidates)) {
|
||||
echo "No mod*.class.php files found on branch '{$branch}'.\n";
|
||||
return 0;
|
||||
}
|
||||
|
||||
$changed = 0;
|
||||
|
||||
foreach ($candidates as $filePath) {
|
||||
// GET file contents via API
|
||||
$encodedPath = implode('/', array_map('rawurlencode', explode('/', $filePath)));
|
||||
$fileUrl = "{$apiBase}/contents/{$encodedPath}?ref={$branch}";
|
||||
$fileData = giteaApiCall($fileUrl, $token);
|
||||
|
||||
if ($fileData === null || !isset($fileData['content'])) {
|
||||
echo "Skipping {$filePath}: could not fetch contents.\n";
|
||||
continue;
|
||||
private function giteaApiCall(string $url, string $token, string $method = 'GET', ?string $body = null): ?array
|
||||
{
|
||||
$ch = curl_init($url);
|
||||
if ($ch === false) {
|
||||
$this->log('ERROR', "curl_init() failed for {$url}");
|
||||
return null;
|
||||
}
|
||||
|
||||
// Decode base64 content
|
||||
$rawContent = is_string($fileData['content']) ? $fileData['content'] : '';
|
||||
$content = base64_decode($rawContent, true);
|
||||
if ($content === false) {
|
||||
echo "Skipping {$filePath}: could not decode content.\n";
|
||||
continue;
|
||||
$headers = [
|
||||
"Authorization: token {$token}",
|
||||
'Accept: application/json',
|
||||
];
|
||||
if ($body !== null) {
|
||||
$headers[] = 'Content-Type: application/json';
|
||||
}
|
||||
|
||||
// Verify this file extends DolibarrModules
|
||||
if (!str_contains($content, 'extends DolibarrModules')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Replace $this->version = '...' with $this->version = 'development'
|
||||
$updated = preg_replace(
|
||||
'/(\$this->version\s*=\s*)[\'"][^\'"]*[\'"]/',
|
||||
"\${1}'development'",
|
||||
$content
|
||||
);
|
||||
|
||||
if ($updated === null || $updated === $content) {
|
||||
echo "Skipping {$filePath}: no version change needed.\n";
|
||||
continue;
|
||||
}
|
||||
|
||||
// PUT updated content back via API
|
||||
$sha = $fileData['sha'] ?? '';
|
||||
$putBody = json_encode([
|
||||
'content' => base64_encode($updated),
|
||||
'message' => 'chore(version): reset dev version [skip ci]',
|
||||
'branch' => $branch,
|
||||
'sha' => $sha,
|
||||
curl_setopt_array($ch, [
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
CURLOPT_HTTPHEADER => $headers,
|
||||
CURLOPT_TIMEOUT => 30,
|
||||
CURLOPT_CUSTOMREQUEST => $method,
|
||||
]);
|
||||
|
||||
$putUrl = "{$apiBase}/contents/{$encodedPath}";
|
||||
$result = giteaApiCall($putUrl, $token, 'PUT', $putBody);
|
||||
|
||||
if ($result !== null) {
|
||||
echo "Reset: {$filePath} -> \$this->version = 'development'\n";
|
||||
$changed++;
|
||||
} else {
|
||||
fwrite(STDERR, "Error: failed to update {$filePath} on branch '{$branch}'.\n");
|
||||
if ($body !== null) {
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
|
||||
}
|
||||
|
||||
$response = curl_exec($ch);
|
||||
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
|
||||
curl_close($ch);
|
||||
|
||||
if ($httpCode < 200 || $httpCode >= 300 || !is_string($response) || $response === '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$data = json_decode($response, true);
|
||||
if (!is_array($data)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
return $changed;
|
||||
private function resetDolibarrVersion(string $apiBase, string $token, string $branch): int
|
||||
{
|
||||
// Search the repo tree for mod*.class.php files
|
||||
$treeUrl = "{$apiBase}/git/trees/{$branch}?recursive=true";
|
||||
$tree = $this->giteaApiCall($treeUrl, $token);
|
||||
|
||||
if ($tree === null || !isset($tree['tree']) || !is_array($tree['tree'])) {
|
||||
$this->log('ERROR', "Could not read repository tree for branch '{$branch}'.");
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Find candidate files: mod*.class.php anywhere in the tree
|
||||
$candidates = [];
|
||||
foreach ($tree['tree'] as $entry) {
|
||||
if (!isset($entry['path']) || !is_string($entry['path'])) {
|
||||
continue;
|
||||
}
|
||||
$basename = basename($entry['path']);
|
||||
if (preg_match('/^mod[A-Za-z0-9_]+\.class\.php$/', $basename)) {
|
||||
$candidates[] = $entry['path'];
|
||||
}
|
||||
}
|
||||
|
||||
if (empty($candidates)) {
|
||||
echo "No mod*.class.php files found on branch '{$branch}'.\n";
|
||||
return 0;
|
||||
}
|
||||
|
||||
$changed = 0;
|
||||
|
||||
foreach ($candidates as $filePath) {
|
||||
// GET file contents via API
|
||||
$encodedPath = implode('/', array_map('rawurlencode', explode('/', $filePath)));
|
||||
$fileUrl = "{$apiBase}/contents/{$encodedPath}?ref={$branch}";
|
||||
$fileData = $this->giteaApiCall($fileUrl, $token);
|
||||
|
||||
if ($fileData === null || !isset($fileData['content'])) {
|
||||
echo "Skipping {$filePath}: could not fetch contents.\n";
|
||||
continue;
|
||||
}
|
||||
|
||||
// Decode base64 content
|
||||
$rawContent = is_string($fileData['content']) ? $fileData['content'] : '';
|
||||
$content = base64_decode($rawContent, true);
|
||||
if ($content === false) {
|
||||
echo "Skipping {$filePath}: could not decode content.\n";
|
||||
continue;
|
||||
}
|
||||
|
||||
// Verify this file extends DolibarrModules
|
||||
if (!str_contains($content, 'extends DolibarrModules')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Replace $this->version = '...' with $this->version = 'development'
|
||||
$updated = preg_replace(
|
||||
'/(\$this->version\s*=\s*)[\'"][^\'"]*[\'"]/',
|
||||
"\${1}'development'",
|
||||
$content
|
||||
);
|
||||
|
||||
if ($updated === null || $updated === $content) {
|
||||
echo "Skipping {$filePath}: no version change needed.\n";
|
||||
continue;
|
||||
}
|
||||
|
||||
// PUT updated content back via API
|
||||
$sha = $fileData['sha'] ?? '';
|
||||
$putBody = json_encode([
|
||||
'content' => base64_encode($updated),
|
||||
'message' => 'chore(version): reset dev version [skip ci]',
|
||||
'branch' => $branch,
|
||||
'sha' => $sha,
|
||||
]);
|
||||
|
||||
$putUrl = "{$apiBase}/contents/{$encodedPath}";
|
||||
$result = $this->giteaApiCall($putUrl, $token, 'PUT', $putBody);
|
||||
|
||||
if ($result !== null) {
|
||||
echo "Reset: {$filePath} -> \$this->version = 'development'\n";
|
||||
$changed++;
|
||||
} else {
|
||||
$this->log('ERROR', "Failed to update {$filePath} on branch '{$branch}'.");
|
||||
}
|
||||
}
|
||||
|
||||
return $changed;
|
||||
}
|
||||
}
|
||||
|
||||
$app = new VersionResetDevCli();
|
||||
exit($app->execute());
|
||||
|
||||
Reference in New Issue
Block a user