create-odoo-module 1.0.0

package/src/generators/deploy-generator.js

@@ -0,0 +1,390 @@
+'use strict';
+
+const path = require('path');
+const { writeFile, mkdirp } = require('../utils/file-system');
+const logger = require('../utils/logger');
+
+/**
+ * Generate deploy scripts: Linux bash, Windows PowerShell, Docker Compose.
+ */
+async function generateDeployScripts(targetDir, config) {
+  const s = config.moduleNameSnake;
+  const L = config.moduleNameLabel;
+  const M = config.moduleNameOdoo;
+
+  logger.verbose('Generating deploy scripts...');
+
+  const scriptsDir = path.join(targetDir, 'scripts');
+  await mkdirp(scriptsDir);
+
+  const files = [
+    [path.join(scriptsDir, 'deploy.sh'),           genDeployBash(s, L, M, config)],
+    [path.join(scriptsDir, 'deploy.ps1'),          genDeployPowershell(s, L, M, config)],
+    [path.join(scriptsDir, 'docker-compose.yml'),  genDockerCompose(s, config)],
+  ];
+
+  if (config.withCi) {
+    await mkdirp(path.join(targetDir, '.github', 'workflows'));
+    files.push([
+      path.join(targetDir, '.github', 'workflows', 'ci.yml'),
+      genGithubActions(s, L, M, config),
+    ]);
+  }
+
+  await Promise.all(files.map(([f, c]) => writeFile(f, c)));
+
+  // Make bash scripts executable (best effort)
+  try {
+    const { execa } = require('execa');
+    await execa('chmod', ['+x', path.join(scriptsDir, 'deploy.sh')]);
+  } catch (_) {}
+}
+
+// ─── Bash deploy ─────────────────────────────────────────────────────────────
+function genDeployBash(s, L, M, config) {
+  return `#!/usr/bin/env bash
+# ═══════════════════════════════════════════════════════════════════════════
+# ${L} — Deploy Script (Linux / macOS)
+# Generated by create-odoo-module — https://create-odoo-module.dev
+# ═══════════════════════════════════════════════════════════════════════════
+set -euo pipefail
+
+# ── Load environment ────────────────────────────────────────────────────────
+if [[ -f ".env" ]]; then
+  set -a && source .env && set +a
+else
+  echo "⚠  .env file not found. Copy .env.example to .env and fill in your credentials."
+  exit 1
+fi
+
+MODULE_NAME="${s}"
+ODOO_URL="\${ODOO_URL:-http://localhost:8069}"
+ODOO_DB="\${ODOO_DB:-odoo}"
+ODOO_USER="\${ODOO_USER:-admin}"
+ODOO_PASSWORD="\${ODOO_PASSWORD:-admin}"
+ADDONS_PATH="\${ODOO_ADDONS_PATH:-/opt/odoo/custom-addons}"
+SERVICE="\${ODOO_SERVICE:-odoo}"
+
+# ── Colors ──────────────────────────────────────────────────────────────────
+RED='\\033[0;31m'; GREEN='\\033[0;32m'; YELLOW='\\033[1;33m'
+CYAN='\\033[0;36m'; BOLD='\\033[1m'; RESET='\\033[0m'
+
+info()    { echo -e "  \${CYAN}ℹ\${RESET}  \$1"; }
+success() { echo -e "  \${GREEN}✔\${RESET}  \$1"; }
+warn()    { echo -e "  \${YELLOW}⚠\${RESET}  \$1"; }
+error()   { echo -e "  \${RED}✗\${RESET}  \$1"; exit 1; }
+header()  { echo -e "\\n\${BOLD}\${CYAN}\$1\${RESET}\\n"; }
+
+header "Deploying \${MODULE_NAME} → \${ODOO_URL}"
+
+# ── Step 1: Validate source ──────────────────────────────────────────────────
+if [[ ! -d "./odoo_module" ]]; then
+  error "odoo_module/ directory not found. Run this script from the project root."
+fi
+success "Source validated"
+
+# ── Step 2: Copy files ───────────────────────────────────────────────────────
+info "Copying module to \${ADDONS_PATH}/\${MODULE_NAME} ..."
+if [[ -w "\${ADDONS_PATH}" ]]; then
+  cp -r ./odoo_module "\${ADDONS_PATH}/\${MODULE_NAME}"
+else
+  sudo cp -r ./odoo_module "\${ADDONS_PATH}/\${MODULE_NAME}"
+fi
+success "Module files copied"
+
+# ── Step 3: Restart Odoo ─────────────────────────────────────────────────────
+info "Restarting Odoo service (\${SERVICE}) ..."
+if systemctl is-active --quiet "\${SERVICE}" 2>/dev/null; then
+  sudo systemctl restart "\${SERVICE}"
+  sleep 5
+  success "Odoo restarted"
+else
+  warn "Service '\${SERVICE}' not found or not running — skipping restart"
+fi
+
+# ── Step 4: Install / upgrade module ─────────────────────────────────────────
+info "Upgrading module in Odoo database '\${ODOO_DB}' ..."
+python3 - <<PYTHON
+import sys
+try:
+    import xmlrpc.client as rpc
+    url, db, user, pwd = "${'"'}${M}${'"'}".split(':')[0], '${M}'.split(':')[0], '${s}', '${s}'
+    url, db   = "\${ODOO_URL}", "\${ODOO_DB}"
+    user, pwd = "\${ODOO_USER}", "\${ODOO_PASSWORD}"
+
+    common = rpc.ServerProxy(f'{url}/xmlrpc/2/common')
+    uid    = common.authenticate(db, user, pwd, {})
+    if not uid:
+        print("  ✗  Authentication failed. Check ODOO_USER / ODOO_PASSWORD in .env")
+        sys.exit(1)
+
+    models = rpc.ServerProxy(f'{url}/xmlrpc/2/object')
+    mod_ids = models.execute_kw(db, uid, pwd,
+        'ir.module.module', 'search',
+        [[['name', '=', '${s}']]]
+    )
+    if mod_ids:
+        models.execute_kw(db, uid, pwd,
+            'ir.module.module', 'button_immediate_upgrade',
+            [mod_ids]
+        )
+        print("  ✔  Module upgraded successfully")
+    else:
+        models.execute_kw(db, uid, pwd,
+            'ir.module.module', 'update_list', []
+        )
+        mod_ids = models.execute_kw(db, uid, pwd,
+            'ir.module.module', 'search',
+            [[['name', '=', '${s}']]]
+        )
+        if mod_ids:
+            models.execute_kw(db, uid, pwd,
+                'ir.module.module', 'button_immediate_install',
+                [mod_ids]
+            )
+            print("  ✔  Module installed successfully")
+        else:
+            print("  ⚠  Module not found in Odoo registry — check addons path config")
+except Exception as e:
+    print(f"  ✗  {e}")
+    sys.exit(1)
+PYTHON
+
+# ── Done ─────────────────────────────────────────────────────────────────────
+header "Deployment Complete"
+echo -e "  Module : \${BOLD}\${MODULE_NAME}\${RESET}"
+echo -e "  Odoo   : \${CYAN}\${ODOO_URL}\${RESET}"
+echo -e "  DB     : \${ODOO_DB}\\n"
+`;
+}
+
+// ─── PowerShell deploy ───────────────────────────────────────────────────────
+function genDeployPowershell(s, L, M, config) {
+  return `# ═══════════════════════════════════════════════════════════════════════════
+# ${L} — Deploy Script (Windows PowerShell)
+# Generated by create-odoo-module — https://create-odoo-module.dev
+# ═══════════════════════════════════════════════════════════════════════════
+param(
+    [switch]$Force
+)
+Set-StrictMode -Version Latest
+$ErrorActionPreference = "Stop"
+
+# ── Load .env ──────────────────────────────────────────────────────────────
+$envFile = Join-Path $PSScriptRoot "..\\.env"
+if (-not (Test-Path $envFile)) {
+    Write-Error "ERROR: .env file not found. Copy .env.example → .env"
+    exit 1
+}
+Get-Content $envFile | ForEach-Object {
+    if ($_ -match "^([^#][^=]*)=(.*)$") {
+        [System.Environment]::SetEnvironmentVariable($Matches[1].Trim(), $Matches[2].Trim())
+    }
+}
+
+$ModuleName   = "${s}"
+$OdooUrl      = $Env:ODOO_URL     ?? "http://localhost:8069"
+$OdooDb       = $Env:ODOO_DB      ?? "odoo"
+$OdooUser     = $Env:ODOO_USER    ?? "admin"
+$OdooPassword = $Env:ODOO_PASSWORD ?? "admin"
+$AddonsPath   = $Env:ODOO_ADDONS_PATH ?? "C:\\odoo\\custom-addons"
+
+Write-Host ""
+Write-Host "  Deploying $ModuleName → $OdooUrl" -ForegroundColor Cyan
+Write-Host ""
+
+# ── Copy files ─────────────────────────────────────────────────────────────
+$src  = Join-Path $PSScriptRoot "..\\odoo_module"
+$dest = Join-Path $AddonsPath $ModuleName
+Write-Host "  Copying module to $dest..." -ForegroundColor Yellow
+Copy-Item -Path $src -Destination $dest -Recurse -Force
+Write-Host "  ✔  Module files copied" -ForegroundColor Green
+
+# ── Upgrade via XML-RPC ────────────────────────────────────────────────────
+Write-Host "  Upgrading module in Odoo..." -ForegroundColor Yellow
+$pyScript = @"
+import xmlrpc.client as rpc, sys
+url, db, user, pwd = '$OdooUrl', '$OdooDb', '$OdooUser', '$OdooPassword'
+try:
+    uid = rpc.ServerProxy(f'{url}/xmlrpc/2/common').authenticate(db, user, pwd, {})
+    if not uid:
+        print('Auth failed'); sys.exit(1)
+    m = rpc.ServerProxy(f'{url}/xmlrpc/2/object')
+    ids = m.execute_kw(db,uid,pwd,'ir.module.module','search',[[['name','=','$ModuleName']]])
+    m.execute_kw(db,uid,pwd,'ir.module.module','button_immediate_upgrade',[ids])
+    print('OK')
+except Exception as e:
+    print(f'ERR: {e}'); sys.exit(1)
+"@
+$result = python3 -c $pyScript
+if ($result -eq "OK") {
+    Write-Host "  ✔  Module upgraded successfully" -ForegroundColor Green
+} else {
+    Write-Warning "  ⚠  $result"
+}
+
+Write-Host ""
+Write-Host "  ✔ Deployment complete!" -ForegroundColor Green
+Write-Host "  Odoo: $OdooUrl" -ForegroundColor Cyan
+Write-Host ""
+`;
+}
+
+// ─── Docker Compose ──────────────────────────────────────────────────────────
+function genDockerCompose(s, config) {
+  return `# Docker Compose — Local Odoo development environment
+# Generated by create-odoo-module — https://create-odoo-module.dev
+#
+# Usage:
+#   docker-compose up -d          Start services
+#   docker-compose down           Stop services
+#   docker-compose logs -f odoo   Follow Odoo logs
+#   docker exec -it odoo_dev bash Enter Odoo container
+
+version: '3.8'
+
+services:
+
+  # ── PostgreSQL ────────────────────────────────────────────────────────────
+  db:
+    image: postgres:15-alpine
+    container_name: ${s}_db
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: odoo
+      POSTGRES_PASSWORD: odoo
+      POSTGRES_DB: odoo
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U odoo"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  # ── Odoo ─────────────────────────────────────────────────────────────────
+  odoo:
+    image: odoo:${config.odooVersion}
+    container_name: ${s}_odoo
+    restart: unless-stopped
+    depends_on:
+      db:
+        condition: service_healthy
+    ports:
+      - "8069:8069"
+      - "8072:8072"      # Long-polling
+    volumes:
+      - ./odoo_module:/mnt/extra-addons/${s}
+      - odoo-data:/var/lib/odoo
+      - ./scripts/odoo.conf:/etc/odoo/odoo.conf:ro
+    environment:
+      HOST: db
+      USER: odoo
+      PASSWORD: odoo
+    command: >
+      odoo
+      --db_host=db
+      --db_port=5432
+      --db_user=odoo
+      --db_password=odoo
+      --addons-path=/usr/lib/python3/dist-packages/odoo/addons,/mnt/extra-addons
+      --dev=all
+      --log-level=info
+
+volumes:
+  pgdata:
+  odoo-data:
+`;
+}
+
+// ─── GitHub Actions CI ───────────────────────────────────────────────────────
+function genGithubActions(s, L, M, config) {
+  return `name: ${L} CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  # ── Odoo Python tests ─────────────────────────────────────────────────────
+  odoo-test:
+    name: Odoo Module Tests (Python)
+    runs-on: ubuntu-22.04
+
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: odoo
+          POSTGRES_PASSWORD: odoo
+          POSTGRES_DB: odoo_test
+        ports: ["5432:5432"]
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Python dependencies
+        run: |
+          pip install pytest flake8
+
+      - name: Lint Python code
+        run: |
+          flake8 odoo_module/ --max-line-length=120 --exclude=__pycache__
+
+      - name: Run Odoo tests
+        run: |
+          echo "Odoo integration tests require a running Odoo instance."
+          echo "Configure your Odoo test environment here."
+        # Uncomment and configure for full Odoo testing:
+        # run: |
+        #   ./odoo-bin test -d odoo_test --test-tags ${s} --stop-after-init
+
+${config.withUi ? `
+  # ── Flutter tests ──────────────────────────────────────────────────────────
+  flutter-test:
+    name: Flutter App Tests (Dart)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.19.0'
+          channel: 'stable'
+
+      - name: Install Flutter dependencies
+        working-directory: flutter_app
+        run: flutter pub get
+
+      - name: Analyze Dart code
+        working-directory: flutter_app
+        run: flutter analyze
+
+      - name: Run Flutter tests
+        working-directory: flutter_app
+        run: flutter test --coverage
+
+      - name: Build APK (debug)
+        working-directory: flutter_app
+        run: flutter build apk --debug
+` : ''}
+`;
+}
+
+module.exports = { generateDeployScripts };