imp: project

Author: Tardo

README.md

@@ -55,24 +55,24 @@
 
 It serves as a starting point for development teams to build, test, and customize their isOdoo-based applications. It facilitates local development, testing environments, and the creation of optimized container images ready for production deployment.
 
+## Environment Variables (dev mode)
+
+| Name | Description | Default |
+| ---- | ----------- | ------- |
+| DEBUGPY_ENABLED | Enable debugpy | false |
+| ODOO_DEV_MODES | Development modes | all |
+
+** Check available "dev modes" here: https://www.odoo.com/documentation/19.0/developer/reference/cli.html#cmdoption-odoo-bin-dev
+
 ## Simple Usage
 
 ```sh
 cruft create https://github.com/GrupoIsonor/isodoo-template.git
+cd <project_folder>
+inv db init
+docker compose up
 ```
 
-Due to security policies, this template does not prompt for passwords. Default values are used. The best way to control these values is through the python API or by forcing the values in the Cookiecutter configuration file.
-
-Default values:
-- Postgres Superuser Password: postgres
-- Odoo DB Password: odoo
-- Odoo Admin DB Manager Password: superadmin
-
-Cookiecutter keys:
-- Postgres Superuser Password: _default_postgres_superuser_password
-- Odoo DB Password: _default_odoo_db_password
-- Odoo Admin DB Manager Password:: _default_odoo_admin_passwd
-
 ## Advance Usage
 
 The best way to have full control is to fork this project and customize it (Don't forget to share anything you find interesting!)

cookiecutter.json

@@ -1,27 +1,27 @@
 {
     "project_name": "My isOdoo Project",
-    "project_slug": "my-isodoo-project",
+    "project_slug": "{{ cookiecutter.project_name | lower | replace(' ', '_') }}",
     "project_owner": "Grupo Isonor",
     "project_owner_url": "https://www.grupoisonor.es",
     "project_license": ["AGPL-3", "GPL-2", "GPL-2 or any later version", "GPL-3", "GPL-3 or any later version", "LGPL-3", "Proprietary"],
-    "project_repository": "",
+    "project_repository": "{{ 'https://www.gitlab.com/' ~ cookiecutter.project_owner | replace(' ', '') ~ cookiecutter.project_slug }}",
     "odoo_version": "19.0",
     "odoo_db_name": "odoodb",
     "odoo_db_user": "odoo",
+    "odoo_db_password": "odoo",
     "odoo_db_filter": "^{{ cookiecutter.odoo_db_name }}$",
+    "odoo_admin_passwd": "superadmin",
+    "odoo_base_language": "{{ get_odoo_lang('en_US') }}",
     "odoo_dependencies_apt": "",
     "odoo_dependencies_npm": "",
     "odoo_dependencies_pip": "",
-    "postgres_version": "18",
+    "postgres_version": "{{ get_odoo_pg_version(cookiecutter.odoo_version) }}",
     "postgres_superuser_user": "postgres",
-    "squid_allowed_domains": ".google.com,.googleapis.com,.cdnjs.cloudflare.com,.gravatar.com,.github.com",
+    "postgres_superuser_password": "postgres",
+    "squid_allowed_domains": ".unsplash.com,.google.com,.googleapis.com,.cdnjs.cloudflare.com,.gravatar.com,.github.com",
     "squid_allowed_ips": "",
     "squid_allowed_ports": "80,443",
     "greenmail_users": "admin:admin@example.com,demo:demo@example.com",
-    "_default_odoo_db_password": "odoo",
-    "_default_odoo_admin_passwd": "superadmin",
-    "_default_postgres_superuser_password": "postgres",
-    "_default_backup_password": "super_secret_backup_password",
     "_precommit_node_version": "24.13.0",
     "_precommit_maintainer_tools_rev": "71aa4caec15e8c1456b4da19e9f39aa0aa7377a9",
     "_precommit_odoo_hooks_rev": "v0.2.20",
@@ -32,15 +32,18 @@
     "_precommit_eslint_rev": "v9.39.1",
     "_debugpy_port": "5678",
     "_squid_debug_options": "ALL,1 28,3 33,2",
+    "_squid_no_proxy": "localhost,127.0.0.1,::1,*.local,10.0.0.0/8,192.168.0.0/16",
+    "_bind_ip": "127.0.0.1",
 
     "__use_squid_allow": "{{ cookiecutter.squid_allowed_domains | length > 0 or cookiecutter.squid_allowed_ips | length > 0 or cookiecutter.squid_allowed_ports | length > 0 }}",
+    "__postgres_pgdata": "{{ '/var/lib/postgresql' if cookiecutter.postgres_version|float >= 18 else '/var/lib/postgresql/data' }}",
 
     "_copy_without_render": [
         ".module-readme.rst.j2"
     ],
 
     "_extensions": [
-        "local_extensions.CPUExtension",
+        "local_extensions.isOdooAutoConfig",
         "jinja2_ansible_filters.AnsibleCoreFiltersExtension"
     ]
 }

hooks/post_gen_project.py

@@ -35,4 +35,4 @@
 shutil.rmtree(project_root / "macros")
 
 ### Prepare Dev Environment
-subprocess.run(["inv", "mode", "dev"], check=True)
+subprocess.run(["inv", "mode", "dev"], check=True, capture_output=True)

local_extensions/__init__.py

@@ -1,3 +1,3 @@
 #!/usr/bin/env python3
 # Copyright Grupo Isonor - Alexandre D. <dev@redneboa.es>
-from .hardware import CPUExtension
+from .isodoo import isOdooAutoConfig

local_extensions/hardware.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+# Copyright Grupo Isonor - Alexandre D. <dev@redneboa.es>
+import locale
+from jinja2.ext import Extension
+
+PG_VERSIONS = {
+    "6.0": "9.6",
+    "6.1": "9.6",
+    "7.0": "9.6",
+    "8.0": "9.6",
+    "9.0": "11",
+    "10.0": "12",
+    "11.0": "13",
+    "12.0": "14",
+    "13.0": "15",
+    "14.0": "16",
+    "15.0": "16",
+    "16.0": "16",
+    "17.0": "17",
+    "18.0": "17",
+    "19.0": "18",
+}
+
+class isOdooAutoConfig(Extension):
+    def __init__(self, environment):
+        super().__init__(environment)
+        environment.globals.update(
+            get_odoo_pg_version=self.getPGVersion,
+            get_odoo_lang=self.getLang,
+        )
+
+    def getPGVersion(self, odoo_version):
+        return PG_VERSIONS.get(odoo_version)
+
+    def getLang(self, default_lang):
+        return locale.getlocale()[0] or default_lang

local_extensions/isodoo.py

@@ -9,4 +9,5 @@ dependencies = [
     "invoke>=3.0.3",
     "jinja2-ansible-filters>=1.3.2",
     "pytest>=9.0.3",
+    "pyyaml>=6.0.3",
 ]

pyproject.toml

@@ -6,12 +6,33 @@
 import sys
 import os
 import shutil
+import time
+import requests
 from io import StringIO
 from invoke import Context, Collection, Config
 import contextlib
 import pytest
+import yaml
 from cookiecutter.main import cookiecutter
 
+EXTRA_ADDONS = {
+    "6.0": ("l10n-spain", "city"),
+    "6.1": ("reporting-engine", "report_xls"),
+    "7.0": ("reporting-engine", "report_xls"),
+    "8.0": ("reporting-engine", "report_xlsx"),
+    "9.0": ("reporting-engine", "report_xlsx"),
+    "10.0": ("reporting-engine", "report_xlsx"),
+    "11.0": ("reporting-engine", "report_xlsx"),
+    "12.0": ("reporting-engine", "report_xlsx"),
+    "13.0": ("reporting-engine", "report_xlsx_boilerplate"),
+    "14.0": ("reporting-engine", "report_fillpdf"),
+    "15.0": ("reporting-engine", "report_xlsx"),
+    "16.0": ("reporting-engine", "sql_export_excel"),
+    "17.0": ("reporting-engine", "sql_export_excel"),
+    "18.0": ("reporting-engine", "sql_export_excel"),
+    "19.0": ("reporting-engine", "report_xlsx"),
+}
+
 
 def _get_preferred_client_type():
     if shutil.which("podman"):
@@ -24,6 +45,21 @@ def switch_project_mode(container_engine: str, project_path: str |  Path, mode:
     invoke_task(container_engine, project_path, "down")
     return invoke_task(container_engine, project_path, "mode", mode)
 
+def wait_for_odoo(ip_address, port):
+    from requests.exceptions import RequestException
+
+    url = f"http://{ip_address}:{port}"
+    for _ in range(60):
+        try:
+            r = requests.get(url, timeout=5)
+            if r.status_code == 200:
+                break
+        except RequestException:
+            pass
+        time.sleep(2)
+    else:
+        raise TimeoutError("Odoo did not start on time")
+
 def invoke_task(container_engine: str, project_path: str | Path, task_name: str, *args, **kwargs):
     project_path = Path(project_path).resolve()
     tasks_path = project_path / "tasks.py"
@@ -53,6 +89,10 @@ def invoke_task(container_engine: str, project_path: str | Path, task_name: str,
         ctx.config.run.warn = True
         ctx.config.run.in_stream = False
         ctx.config["isodoo_container_engine"] = container_engine
+        invoke_env = kwargs.get("invoke_env")
+        if invoke_env:
+            ctx.config.run.env.update(invoke_env)
+            kwargs.pop("invoke_env")
         with contextlib.redirect_stdout(stdout_capture), contextlib.redirect_stderr(stderr_capture):
             result = task(ctx, *args, **kwargs)
         return {
@@ -79,6 +119,9 @@ def env_info(pytestconfig):
         "ip": "127.0.0.1",
         "ports": {
             "odoo": f"{odoo_ver_int}069",
+            "pgweb": f"{odoo_ver_int}081",
+            "roundcube": f"{odoo_ver_int}090",
+            "debugpy": "5678",
         },
         "options": {
             "odoo_version": odoo_ver,
@@ -101,11 +144,19 @@ def project_tmpl(env_info, tmp_path_factory):
     )
     project_path = Path(result_dir)
     assert project_path.exists(), "The template has not been rendered"
+    with open(project_path / "addons" / "addons.yaml", "r+") as f:
+        data = yaml.safe_load(f) or {}
+        extra_addon_repo, extra_addon_name = EXTRA_ADDONS[env_info["options"]["odoo_version"]]
+        data[extra_addon_repo] = [extra_addon_name]
+        yaml.dump(data, f, sort_keys=False, default_flow_style=False)
     try:
-        # Initialize Odoo
+        # Use CI Mode
         switch_project_mode(env_info["client_type"], project_path, "ci")
-        invoke_task(env_info["client_type"], project_path, "module", "install", "base")
+        # Build
+        invoke_task(env_info["client_type"], project_path, "build", no_cache=True)
+        # Initialize Odoo
+        invoke_task(env_info["client_type"], project_path, "db", "init")
         yield project_path
     finally:
         switch_project_mode(env_info["client_type"], project_path, "dev")
-        invoke_task(env_info["client_type"], project_path, "down", remove_volumes=True)
+        invoke_task(env_info["client_type"], project_path, "destroy-this-project", force=True)

tests/conftest.py

@@ -1,10 +1,55 @@
 #!/usr/bin/env python3
 # Copyright Grupo Isonor - Alexandre D. <dev@redneboa.es>
 
+import time
+import socket
+import json
+import pytest
+from conftest import invoke_task, switch_project_mode
+
 
 def test_project_structure(project_tmpl):
     assert (project_tmpl / "addons" / "git").is_dir()
     assert (project_tmpl / "compose.yaml").is_file()
     assert not (project_tmpl / "macros").exists()
     assert not (project_tmpl / "recipes").exists()
     assert not (project_tmpl / "_helpers.jinja").exists()
+
+def test_debugpy(project_tmpl, env_info):
+    switch_project_mode(env_info["client_type"], project_tmpl, "dev")
+    invoke_task(env_info["client_type"], project_tmpl, "build", mode="dev")
+    # Up
+    invoke_task(env_info["client_type"], project_tmpl, "up", detach=True, invoke_env={'DEBUGPY_ENABLED': 'true'})
+    # Test Basic Connection
+    host = env_info['ip']
+    port = int(env_info['ports']['debugpy'])
+    for _ in range(30):
+        try:
+            with socket.create_connection((host, port), timeout=3) as s:
+                req = {
+                    "seq": 1,
+                    "type": "request",
+                    "command": "initialize",
+                    "arguments": {"adapterID": "python"}
+                }
+                msg = json.dumps(req)
+                s.sendall(f"Content-Length: {len(msg)}\r\n\r\n{msg}".encode())
+                response = s.recv(8192).decode(errors='ignore')
+                if any(x in response for x in ["debugpySockets", "success", "output"]):
+                    break
+        except:
+            time.sleep(2)
+    else:
+        pytest.fail("debugpy is not working")
+    # Down
+    invoke_task(env_info["client_type"], project_tmpl, "down")
+    # Restore Image
+    switch_project_mode(env_info["client_type"], project_tmpl, "ci")
+    invoke_task(env_info["client_type"], project_tmpl, "build")
+
+def test_squid(project_tmpl, env_info):
+    switch_project_mode(env_info["client_type"], project_tmpl, "dev")
+    result = invoke_task(env_info["client_type"], project_tmpl, "check-connection-code", dst="http://www.amazon.com")
+    assert "403" in result["return"]
+    result = invoke_task(env_info["client_type"], project_tmpl, "check-connection-code", dst="http://www.google.com")
+    assert "200" in result["return"]