diff --git a/.copier-answers.yml b/.copier-answers.yml deleted file mode 100644 index e451e42..0000000 --- a/.copier-answers.yml +++ /dev/null @@ -1,27 +0,0 @@ -# Do NOT update manually; changes here will be overwritten by Copier -_commit: v1.33 -_src_path: https://github.com/OCA/oca-addons-repo-template.git -additional_ruff_rules: [] -ci: GitHub -convert_readme_fragments_to_markdown: true -enable_checklog_odoo: false -generate_requirements_txt: true -github_check_license: true -github_ci_extra_env: {} -github_enable_codecov: true -github_enable_makepot: true -github_enable_stale_action: true -github_enforce_dev_status_compatibility: true -include_wkhtmltopdf: false -odoo_test_flavor: Both -odoo_version: 17.0 -org_name: Odoonix -org_slug: odoonix -rebel_module_groups: [] -repo_description: Education management tools -repo_name: Education, moderl education management system -repo_slug: education -repo_website: https://github.com/odoonix/education -use_pyproject_toml: true -use_ruff: true - diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..c359efa --- /dev/null +++ b/.dockerignore @@ -0,0 +1,20 @@ +__pycache__ +*.pyc +*.pyo +*.pyd +.Python +env/ +venv/ +.idea +.vscode +*.swp +*.sock +/dist +/build +*.egg-info +/.git +/.venv +.DS_Store +.env +.env.* +.pytest_cache/ \ No newline at end of file diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index bfd7ac5..0000000 --- a/.editorconfig +++ /dev/null @@ -1,20 +0,0 @@ -# Configuration for known file extensions -[*.{css,js,json,less,md,py,rst,sass,scss,xml,yaml,yml}] -charset = utf-8 -end_of_line = lf -indent_size = 4 -indent_style = space -insert_final_newline = true -trim_trailing_whitespace = true - -[*.{json,yml,yaml,rst,md}] -indent_size = 2 - -# Do not configure editor for libs and autogenerated content -[{*/static/{lib,src/lib}/**,*/static/description/index.html,*/readme/../README.rst}] -charset = unset -end_of_line = unset -indent_size = unset -indent_style = unset -insert_final_newline = false -trim_trailing_whitespace = false diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..d3a1bc3 --- /dev/null +++ b/.env.example @@ -0,0 +1,12 @@ +# --- PostgreSQL (sync target DB) --- +DATABASE_NAME=sync_db +DATABASE_USER=sync +DATABASE_PASSWORD=change_me +DATABASE_HOST=localhost +DATABASE_PORT=5432 + +# --- Odoo (XML-RPC source) --- +ODOO_URL=http://localhost:8069 +ODOO_USERNAME=admin +ODOO_DB_NAME=odoo_test +ODOO_PASSWORD=change_me diff --git a/.eslintrc.yml b/.eslintrc.yml deleted file mode 100644 index 0b38203..0000000 --- a/.eslintrc.yml +++ /dev/null @@ -1,188 +0,0 @@ -env: - browser: true - es6: true - -# See https://github.com/OCA/odoo-community.org/issues/37#issuecomment-470686449 -parserOptions: - ecmaVersion: 2022 - -overrides: - - files: - - "**/*.esm.js" - parserOptions: - sourceType: module - -# Globals available in Odoo that shouldn't produce errorings -globals: - _: readonly - $: readonly - fuzzy: readonly - jQuery: readonly - moment: readonly - odoo: readonly - openerp: readonly - owl: readonly - luxon: readonly - -# Styling is handled by Prettier, so we only need to enable AST rules; -# see https://github.com/OCA/maintainer-quality-tools/pull/618#issuecomment-558576890 -rules: - accessor-pairs: warn - array-callback-return: warn - callback-return: warn - capitalized-comments: - - warn - - always - - ignoreConsecutiveComments: true - ignoreInlineComments: true - complexity: - - warn - - 15 - constructor-super: warn - dot-notation: warn - eqeqeq: warn - global-require: warn - handle-callback-err: warn - id-blacklist: warn - id-match: warn - init-declarations: error - max-depth: warn - max-nested-callbacks: warn - max-statements-per-line: warn - no-alert: warn - no-array-constructor: warn - no-caller: warn - no-case-declarations: warn - no-class-assign: warn - no-cond-assign: error - no-const-assign: error - no-constant-condition: warn - no-control-regex: warn - no-debugger: error - no-delete-var: warn - no-div-regex: warn - no-dupe-args: error - no-dupe-class-members: error - no-dupe-keys: error - no-duplicate-case: error - no-duplicate-imports: error - no-else-return: warn - no-empty-character-class: warn - no-empty-function: error - no-empty-pattern: error - no-empty: warn - no-eq-null: error - no-eval: error - no-ex-assign: error - no-extend-native: warn - no-extra-bind: warn - no-extra-boolean-cast: warn - no-extra-label: warn - no-fallthrough: warn - no-func-assign: error - no-global-assign: error - no-implicit-coercion: - - warn - - allow: ["~"] - no-implicit-globals: warn - no-implied-eval: warn - no-inline-comments: warn - no-inner-declarations: warn - no-invalid-regexp: warn - no-irregular-whitespace: warn - no-iterator: warn - no-label-var: warn - no-labels: warn - no-lone-blocks: warn - no-lonely-if: error - no-mixed-requires: error - no-multi-str: warn - no-native-reassign: error - no-negated-condition: warn - no-negated-in-lhs: error - no-new-func: warn - no-new-object: warn - no-new-require: warn - no-new-symbol: warn - no-new-wrappers: warn - no-new: warn - no-obj-calls: warn - no-octal-escape: warn - no-octal: warn - no-param-reassign: warn - no-path-concat: warn - no-process-env: warn - no-process-exit: warn - no-proto: warn - no-prototype-builtins: warn - no-redeclare: warn - no-regex-spaces: warn - no-restricted-globals: warn - no-restricted-imports: warn - no-restricted-modules: warn - no-restricted-syntax: warn - no-return-assign: error - no-script-url: warn - no-self-assign: warn - no-self-compare: warn - no-sequences: warn - no-shadow-restricted-names: warn - no-shadow: warn - no-sparse-arrays: warn - no-sync: warn - no-this-before-super: warn - no-throw-literal: warn - no-undef-init: warn - no-undef: error - no-unmodified-loop-condition: warn - no-unneeded-ternary: error - no-unreachable: error - no-unsafe-finally: error - no-unused-expressions: error - no-unused-labels: error - no-unused-vars: error - no-use-before-define: error - no-useless-call: warn - no-useless-computed-key: warn - no-useless-concat: warn - no-useless-constructor: warn - no-useless-escape: warn - no-useless-rename: warn - no-void: warn - no-with: warn - operator-assignment: [error, always] - prefer-const: warn - radix: warn - require-yield: warn - sort-imports: warn - spaced-comment: [error, always] - strict: [error, function] - use-isnan: error - valid-jsdoc: - - warn - - prefer: - arg: param - argument: param - augments: extends - constructor: class - exception: throws - func: function - method: function - prop: property - return: returns - virtual: abstract - yield: yields - preferType: - array: Array - bool: Boolean - boolean: Boolean - number: Number - object: Object - str: String - string: String - requireParamDescription: false - requireReturn: false - requireReturnDescription: false - requireReturnType: false - valid-typeof: warn - yoda: warn diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml deleted file mode 100644 index d19e491..0000000 --- a/.github/workflows/pre-commit.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: pre-commit - -on: - pull_request: - branches: - - "17.0*" - push: - branches: - - "17.0" - - "17.0-ocabot-*" - -jobs: - pre-commit: - runs-on: ubuntu-22.04 - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: "3.11" - - name: Get python version - run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV - - uses: actions/cache@v4 - with: - path: ~/.cache/pre-commit - key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }} - - name: Install pre-commit - run: pip install pre-commit - - name: Run pre-commit - run: pre-commit run --all-files --show-diff-on-failure --color=always - env: - # Consider valid a PR that changes README fragments but doesn't - # change the README.rst file itself. It's not really a problem - # because the bot will update it anyway after merge. This way, we - # lower the barrier for functional contributors that want to fix the - # readme fragments, while still letting developers get README - # auto-generated (which also helps functionals when using runboat). - # DOCS https://pre-commit.com/#temporarily-disabling-hooks - SKIP: oca-gen-addon-readme - - name: Check that all files generated by pre-commit are in git - run: | - newfiles="$(git ls-files --others --exclude-from=.gitignore)" - if [ "$newfiles" != "" ] ; then - echo "Please check-in the following files:" - echo "$newfiles" - exit 1 - fi diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml deleted file mode 100644 index fa17fcd..0000000 --- a/.github/workflows/stale.yml +++ /dev/null @@ -1,69 +0,0 @@ -name: Mark stale issues and pull requests - -on: - schedule: - - cron: "0 12 * * 0" - -jobs: - stale: - runs-on: ubuntu-latest - steps: - - name: Stale PRs and issues policy - uses: actions/stale@v9 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - # General settings. - ascending: true - remove-stale-when-updated: true - # Pull Requests settings. - # 120+30 day stale policy for PRs - # * Except PRs marked as "no stale" - days-before-pr-stale: 120 - days-before-pr-close: 30 - exempt-pr-labels: "no stale" - stale-pr-label: "stale" - stale-pr-message: > - There hasn't been any activity on this pull request in the past 4 months, so - it has been marked as stale and it will be closed automatically if no - further activity occurs in the next 30 days. - - If you want this PR to never become stale, please ask a PSC member to apply - the "no stale" label. - # Issues settings. - # 180+30 day stale policy for open issues - # * Except Issues marked as "no stale" - days-before-issue-stale: 180 - days-before-issue-close: 30 - exempt-issue-labels: "no stale,needs more information" - stale-issue-label: "stale" - stale-issue-message: > - There hasn't been any activity on this issue in the past 6 months, so it has - been marked as stale and it will be closed automatically if no further - activity occurs in the next 30 days. - - If you want this issue to never become stale, please ask a PSC member to - apply the "no stale" label. - - # 15+30 day stale policy for issues pending more information - # * Issues that are pending more information - # * Except Issues marked as "no stale" - - name: Needs more information stale issues policy - uses: actions/stale@v9 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - ascending: true - only-labels: "needs more information" - exempt-issue-labels: "no stale" - days-before-stale: 15 - days-before-close: 30 - days-before-pr-stale: -1 - days-before-pr-close: -1 - remove-stale-when-updated: true - stale-issue-label: "stale" - stale-issue-message: > - This issue needs more information and there hasn't been any activity - recently, so it has been marked as stale and it will be closed automatically - if no further activity occurs in the next 30 days. - - If you think this is a mistake, please ask a PSC member to remove the "needs - more information" label. diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml deleted file mode 100644 index 64c25a9..0000000 --- a/.github/workflows/test.yml +++ /dev/null @@ -1,71 +0,0 @@ -name: tests - -on: - pull_request: - branches: - - "17.0*" - push: - branches: - - "17.0" - - "17.0-ocabot-*" - -jobs: - unreleased-deps: - runs-on: ubuntu-latest - name: Detect unreleased dependencies - steps: - - uses: actions/checkout@v4 - - run: | - for reqfile in requirements.txt test-requirements.txt ; do - if [ -f ${reqfile} ] ; then - result=0 - # reject non-comment lines that contain a / (i.e. URLs, relative paths) - grep "^[^#].*/" ${reqfile} || result=$? - if [ $result -eq 0 ] ; then - echo "Unreleased dependencies found in ${reqfile}." - exit 1 - fi - fi - done - test: - runs-on: ubuntu-22.04 - container: ${{ matrix.container }} - name: ${{ matrix.name }} - strategy: - fail-fast: false - matrix: - include: - - container: ghcr.io/oca/oca-ci/py3.10-odoo17.0:latest - name: test with Odoo - - container: ghcr.io/oca/oca-ci/py3.10-ocb17.0:latest - name: test with OCB - makepot: "true" - services: - postgres: - image: postgres:12.0 - env: - POSTGRES_USER: odoo - POSTGRES_PASSWORD: odoo - POSTGRES_DB: odoo - ports: - - 5432:5432 - steps: - - uses: actions/checkout@v4 - with: - persist-credentials: false - - name: Install addons and dependencies - run: oca_install_addons - - name: Check licenses - run: manifestoo -d . check-licenses - - name: Check development status - run: manifestoo -d . check-dev-status --default-dev-status=Beta - - name: Initialize test db - run: oca_init_test_database - - name: Run tests - run: oca_run_tests - - uses: codecov/codecov-action@v4 - with: - token: ${{ secrets.CODECOV_TOKEN }} - - name: Update .pot files - run: oca_export_and_push_pot https://x-access-token:${{ secrets.GIT_PUSH_TOKEN }}@github.com/${{ github.repository }} - if: ${{ matrix.makepot == 'true' && github.event_name == 'push' && github.repository_owner == 'odoonix' }} diff --git a/.gitignore b/.gitignore index 6ec07a0..e70b723 100644 --- a/.gitignore +++ b/.gitignore @@ -1,42 +1,36 @@ # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] -/.venv -/.pytest_cache -/.ruff_cache +*$py.class # C extensions *.so # Distribution / packaging .Python -env/ -bin/ build/ develop-eggs/ dist/ +downloads/ eggs/ +.eggs/ +lib/ lib64/ parts/ sdist/ var/ +wheels/ +share/python-wheels/ *.egg-info/ .installed.cfg *.egg -*.eggs - -# Windows installers -*.msi - -# Debian packages -*.deb +MANIFEST -# Redhat packages -*.rpm - -# MacOS packages -*.dmg -*.pkg +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec # Installer logs pip-log.txt @@ -45,44 +39,144 @@ pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ +.nox/ .coverage +.coverage.* .cache nosetests.xml coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ # Translations *.mo +*.pot -# Pycharm -.idea +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal -# Eclipse -.settings +# Flask stuff: +instance/ +.webassets-cache -# Visual Studio cache/options directory -.vs/ -.vscode +# Scrapy stuff: +.scrapy -# OSX Files -.DS_Store +# Sphinx documentation +docs/_build/ -# Django stuff: -*.log +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env* +!.env.example +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ -# Mr Developer -.mr.developer.cfg -.project -.pydevproject +# Spyder project settings +.spyderproject +.spyproject -# Rope +# Rope project settings .ropeproject -# Sphinx documentation -docs/_build/ +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ -# Backup files -*~ -*.swp +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ -# OCA rules -!static/lib/ +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + + +# Vscode +.vscode/ + +# Mac +.DS_Store diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 791ab54..f81c53c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,138 +1,26 @@ -exclude: | - (?x) - # NOT INSTALLABLE ADDONS - # END NOT INSTALLABLE ADDONS - # Files and folders generated by bots, to avoid loops - ^setup/|/static/description/index\.html$| - # We don't want to mess with tool-generated files - .svg$|/tests/([^/]+/)?cassettes/|^.copier-answers.yml$|^.github/|^eslint.config.cjs|^prettier.config.cjs| - # Maybe reactivate this when all README files include prettier ignore tags? - ^README\.md$| - # Library files can have extraneous formatting (even minimized) - /static/(src/)?lib/| - # Repos using Sphinx to generate docs don't need prettying - ^docs/_templates/.*\.html$| - # Don't bother non-technical authors with formatting issues in docs - readme/.*\.(rst|md)$| - # Ignore build and dist directories in addons - /build/|/dist/| - # Ignore test files in addons - /tests/samples/.*| - # You don't usually want a bot to modify your legal texts - (LICENSE.*|COPYING.*) -default_language_version: - python: python3 - node: "16.17.0" +default_stages: [pre-commit] +exclude: '^(venv|\.venv|env|\.env|build|dist|__pycache__)/' + repos: - - repo: local - hooks: - # These files are most likely copier diff rejection junks; if found, - # review them manually, fix the problem (if needed) and remove them - - id: forbidden-files - name: forbidden files - entry: found forbidden files; remove them - language: fail - files: "\\.rej$" - - id: en-po-files - name: en.po files cannot exist - entry: found a en.po file - language: fail - files: '[a-zA-Z0-9_]*/i18n/en\.po$' - - repo: https://github.com/sbidoul/whool - rev: v1.2 - hooks: - - id: whool-init - - repo: https://github.com/oca/maintainer-tools - rev: f9b919b9868143135a9c9cb03021089cabba8223 - hooks: - # update the NOT INSTALLABLE ADDONS section above - - id: oca-update-pre-commit-excluded-addons - - id: oca-fix-manifest-website - args: ["https://github.com/odoonix/education"] - - id: oca-gen-addon-readme - args: - - --addons-dir=. - - --branch=17.0 - - --org-name=odoonix - - --repo-name=education - - --if-source-changed - - --keep-source-digest - - --convert-fragments-to-markdown - - id: oca-gen-external-dependencies - - repo: https://github.com/OCA/odoo-pre-commit-hooks - rev: v0.0.25 - hooks: - - id: oca-checks-odoo-module - - id: oca-checks-po - args: - - --disable=po-pretty-format - - repo: local - hooks: - - id: prettier - name: prettier (with plugin-xml) - entry: prettier - args: - - --write - - --list-different - - --ignore-unknown - types: [text] - files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$ - language: node - additional_dependencies: - - "prettier@2.7.1" - - "@prettier/plugin-xml@2.2.0" - - repo: local - hooks: - - id: eslint - name: eslint - entry: eslint - args: - - --color - - --fix - verbose: true - types: [javascript] - language: node - additional_dependencies: - - "eslint@8.24.0" - - "eslint-plugin-jsdoc@" - - "globals@" - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.3.0 + rev: v5.0.0 hooks: - id: trailing-whitespace - # exclude autogenerated files - exclude: /README\.rst$|\.pot?$ - - id: end-of-file-fixer - # exclude autogenerated files - exclude: /README\.rst$|\.pot?$ - - id: debug-statements - - id: fix-encoding-pragma - args: ["--remove"] - - id: check-case-conflict - - id: check-docstring-first - - id: check-executables-have-shebangs - - id: check-merge-conflict - # exclude files where underlines are not distinguishable from merge conflicts - exclude: /README\.rst$|^docs/.*\.rst$ - - id: check-symlinks - - id: check-xml - - id: mixed-line-ending - args: ["--fix=lf"] + - id: check-yaml + - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.1.3 + rev: v0.12.2 hooks: - - id: ruff - args: [--fix, --exit-non-zero-on-fix] + - id: ruff-check + name: ruff-linter + types_or: [python, pyi] + args: [--fix] + - id: ruff-format - - repo: https://github.com/OCA/pylint-odoo - rev: v9.0.4 - hooks: - - id: pylint_odoo - name: pylint with optional checks - args: - - --rcfile=.pylintrc - - --exit-zero - verbose: true - - id: pylint_odoo - args: - - --rcfile=.pylintrc-mandatory + name: ruff-formatter + types_or: [python, pyi] + + - id: ruff + name: ruff-import-sort + args: ["--select", "I", "--fix"] + types_or: [python, pyi] diff --git a/.prettierrc.yml b/.prettierrc.yml deleted file mode 100644 index 5b6d4b3..0000000 --- a/.prettierrc.yml +++ /dev/null @@ -1,8 +0,0 @@ -# Defaults for all prettier-supported languages. -# Prettier will complete this with settings from .editorconfig file. -bracketSpacing: false -printWidth: 88 -proseWrap: always -semi: true -trailingComma: "es5" -xmlWhitespaceSensitivity: "strict" diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index ac1af91..0000000 --- a/.pylintrc +++ /dev/null @@ -1,123 +0,0 @@ - - -[MASTER] -load-plugins=pylint_odoo -score=n - -[ODOOLINT] -readme-template-url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" -manifest-required-authors=Odoonix -manifest-required-keys=license -manifest-deprecated-keys=description,active -license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 -valid-odoo-versions=17.0 - -[MESSAGES CONTROL] -disable=all - -# This .pylintrc contains optional AND mandatory checks and is meant to be -# loaded in an IDE to have it check everything, in the hope this will make -# optional checks more visible to contributors who otherwise never look at a -# green travis to see optional checks that failed. -# .pylintrc-mandatory containing only mandatory checks is used the pre-commit -# config as a blocking check. - -enable=anomalous-backslash-in-string, - api-one-deprecated, - api-one-multi-together, - assignment-from-none, - attribute-deprecated, - class-camelcase, - dangerous-default-value, - dangerous-view-replace-wo-priority, - development-status-allowed, - duplicate-id-csv, - duplicate-key, - duplicate-xml-fields, - duplicate-xml-record-id, - eval-referenced, - eval-used, - incoherent-interpreter-exec-perm, - license-allowed, - manifest-author-string, - manifest-deprecated-key, - manifest-required-author, - manifest-required-key, - manifest-version-format, - method-compute, - method-inverse, - method-required-super, - method-search, - openerp-exception-warning, - pointless-statement, - pointless-string-statement, - print-used, - redundant-keyword-arg, - redundant-modulename-xml, - reimported, - relative-import, - return-in-init, - rst-syntax-error, - sql-injection, - too-few-format-args, - translation-field, - translation-required, - unreachable, - use-vim-comment, - wrong-tabs-instead-of-spaces, - xml-syntax-error, - attribute-string-redundant, - character-not-valid-in-resource-link, - consider-merging-classes-inherited, - context-overridden, - create-user-wo-reset-password, - dangerous-filter-wo-user, - dangerous-qweb-replace-wo-priority, - deprecated-data-xml-node, - deprecated-openerp-xml-node, - duplicate-po-message-definition, - except-pass, - file-not-used, - invalid-commit, - manifest-maintainers-list, - missing-newline-extrafiles, - missing-readme, - missing-return, - odoo-addons-relative-import, - old-api7-method-defined, - po-msgstr-variables, - po-syntax-error, - renamed-field-parameter, - resource-not-exist, - str-format-used, - test-folder-imported, - translation-contains-variable, - translation-positional-used, - unnecessary-utf8-coding-comment, - website-manifest-key-not-valid-uri, - xml-attribute-translatable, - xml-deprecated-qweb-directive, - xml-deprecated-tree-attribute, - external-request-timeout, - # messages that do not cause the lint step to fail - consider-merging-classes-inherited, - create-user-wo-reset-password, - dangerous-filter-wo-user, - deprecated-module, - file-not-used, - invalid-commit, - missing-manifest-dependency, - missing-newline-extrafiles, - missing-readme, - no-utf8-coding-comment, - odoo-addons-relative-import, - old-api7-method-defined, - redefined-builtin, - too-complex, - unnecessary-utf8-coding-comment - - -[REPORTS] -msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} -output-format=colorized -reports=no diff --git a/.pylintrc-mandatory b/.pylintrc-mandatory deleted file mode 100644 index e886309..0000000 --- a/.pylintrc-mandatory +++ /dev/null @@ -1,98 +0,0 @@ - -[MASTER] -load-plugins=pylint_odoo -score=n - -[ODOOLINT] -readme-template-url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" -manifest-required-authors=Odoonix -manifest-required-keys=license -manifest-deprecated-keys=description,active -license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 -valid-odoo-versions=17.0 - -[MESSAGES CONTROL] -disable=all - -enable=anomalous-backslash-in-string, - api-one-deprecated, - api-one-multi-together, - assignment-from-none, - attribute-deprecated, - class-camelcase, - dangerous-default-value, - dangerous-view-replace-wo-priority, - development-status-allowed, - duplicate-id-csv, - duplicate-key, - duplicate-xml-fields, - duplicate-xml-record-id, - eval-referenced, - eval-used, - incoherent-interpreter-exec-perm, - license-allowed, - manifest-author-string, - manifest-deprecated-key, - manifest-required-author, - manifest-required-key, - manifest-version-format, - method-compute, - method-inverse, - method-required-super, - method-search, - openerp-exception-warning, - pointless-statement, - pointless-string-statement, - print-used, - redundant-keyword-arg, - redundant-modulename-xml, - reimported, - relative-import, - return-in-init, - rst-syntax-error, - sql-injection, - too-few-format-args, - translation-field, - translation-required, - unreachable, - use-vim-comment, - wrong-tabs-instead-of-spaces, - xml-syntax-error, - attribute-string-redundant, - character-not-valid-in-resource-link, - consider-merging-classes-inherited, - context-overridden, - create-user-wo-reset-password, - dangerous-filter-wo-user, - dangerous-qweb-replace-wo-priority, - deprecated-data-xml-node, - deprecated-openerp-xml-node, - duplicate-po-message-definition, - except-pass, - file-not-used, - invalid-commit, - manifest-maintainers-list, - missing-newline-extrafiles, - missing-readme, - missing-return, - odoo-addons-relative-import, - old-api7-method-defined, - po-msgstr-variables, - po-syntax-error, - renamed-field-parameter, - resource-not-exist, - str-format-used, - test-folder-imported, - translation-contains-variable, - translation-positional-used, - unnecessary-utf8-coding-comment, - website-manifest-key-not-valid-uri, - xml-attribute-translatable, - xml-deprecated-qweb-directive, - xml-deprecated-tree-attribute, - external-request-timeout - -[REPORTS] -msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} -output-format=colorized -reports=no diff --git a/.ruff.toml b/.ruff.toml deleted file mode 100644 index 8e8eccb..0000000 --- a/.ruff.toml +++ /dev/null @@ -1,31 +0,0 @@ - -target-version = "py310" -fix = true - -[lint] -extend-select = [ - "B", - "C90", - "E501", # line too long (default 88) - "I", # isort - "UP", # pyupgrade -] -extend-safe-fixes = ["UP008"] -exclude = ["setup/*"] - -[format] -exclude = ["setup/*"] - -[per-file-ignores] -"__init__.py" = ["F401", "I001"] # ignore unused and unsorted imports in __init__.py -"__manifest__.py" = ["B018"] # useless expression - -[isort] -section-order = ["future", "standard-library", "third-party", "odoo", "odoo-addons", "first-party", "local-folder"] - -[isort.sections] -"odoo" = ["odoo"] -"odoo-addons" = ["odoo.addons"] - -[mccabe] -max-complexity = 16 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..af6de05 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,12 @@ +FROM python:3.12-slim + +ENV PYTHONUNBUFFERED=1 \ + PYTHONDONTWRITEBYTECODE=1 + +WORKDIR /app + +COPY . . + +RUN pip install --no-cache-dir -e . + +CMD ["sh", "docker/entrypoint.sh"] diff --git a/LICENSE b/LICENSE deleted file mode 100644 index be3f7b2..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/README.md b/README.md index 080d724..9cad86d 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,54 @@ +# Odoo → PostgreSQL Sync - -[![Pre-commit Status](https://github.com/odoonix/education/actions/workflows/pre-commit.yml/badge.svg?branch=17.0)](https://github.com/odoonix/education/actions/workflows/pre-commit.yml?query=branch%3A17.0) -[![Build Status](https://github.com/odoonix/education/actions/workflows/test.yml/badge.svg?branch=17.0)](https://github.com/odoonix/education/actions/workflows/test.yml?query=branch%3A17.0) -[![codecov](https://codecov.io/gh/odoonix/education/branch/17.0/graph/badge.svg)](https://codecov.io/gh/odoonix/education) - +A backend service that pulls **Contacts, Products, Sale Orders and Sale Order +Lines** from Odoo (XML-RPC), maps them to an internal model, and stores them in +PostgreSQL. Re-runnable and idempotent (no duplicates), with per-record error +isolation and a full audit trail in `sync_runs` / `sync_logs`. - +``` +Odoo ──XML-RPC──▶ Python Backend ──Mapping / Upsert──▶ PostgreSQL +``` -# Education, moderl education management system +## Quick start (Docker) -Education management tools +```bash +docker compose up --build +``` - +This brings up the whole environment: Odoo + its database, seeds Odoo with test +data, then runs migrations and the sync. Watch the `odoo_backend` logs for the +result. See [docs/USER.md](docs/USER.md) for details and verification. - +## Local run (without Docker) -[//]: # (addons) +```bash +cp .env.example .env # then edit values +pip install -e . +alembic upgrade head # create tables +python -m app.main # run the sync +``` -This part will be replaced when running the oca-gen-addons-table script from OCA/maintainer-tools. +## Tests -[//]: # (end addons) +```bash +pytest --cov=app +``` - +21 tests (entities, mappers, repositories, and the sync use case), ~77% coverage. -## Licenses +## Layout -This repository is licensed under [AGPL-3.0](LICENSE). +``` +app/ + domain/ entities, repository interfaces, ports + application/ DTOs, mappers, sync services, use cases + infrastructure/ Odoo client, SQLAlchemy models/repos, DI container +alembic/ database migrations +scripts/ Odoo test-data seeder +docs/ technical & user documentation +``` -However, each module can have a totally different license, as long as they adhere to Odoonix -policy. Consult each module's `__manifest__.py` file, which contains a `license` key -that explains its license. +## Documentation ----- - +- [Technical documentation](docs/TECHNICAL.md) — architecture & design decisions +- [User documentation](docs/USER.md) — how to run and verify diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..121d8cc --- /dev/null +++ b/alembic.ini @@ -0,0 +1,149 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s +# Or organize into date-based subdirectories (requires recursive_version_locations = true) +# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be installed by adding +# `alembic[tz]` to the pip requirements. +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to /versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +# sqlalchemy.url is set dynamically in alembic/env.py from app settings (.env) + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/alembic/README b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..2db8e9b --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,105 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from app.config.settings import settings +from app.infrastructure.database.models import Base + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Build the database URL from application settings and force the +# psycopg (v3) driver, since only psycopg[binary] is installed. +config.set_main_option( + "sqlalchemy.url", + str(settings.POSTGRES_DATABASE_URL).replace( + "postgresql://", "postgresql+psycopg://", 1 + ), +) + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# Metadata of the ORM models, used for 'autogenerate' support. +target_metadata = Base.metadata + + +def include_name(name, type_, parent_names): + """Restrict autogenerate to the tables defined in our metadata. + + The target database may host other tables (e.g. Odoo's own schema); + those must never be reflected, compared, or dropped by our migrations. + """ + if type_ == "table": + return name in target_metadata.tables + return True + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + compare_type=True, + include_name=include_name, + include_schemas=False, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + compare_type=True, + include_name=include_name, + include_schemas=False, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/4d14337fb951_initial_schema.py b/alembic/versions/4d14337fb951_initial_schema.py new file mode 100644 index 0000000..6775f2c --- /dev/null +++ b/alembic/versions/4d14337fb951_initial_schema.py @@ -0,0 +1,71 @@ +"""initial schema + +Revision ID: 4d14337fb951 +Revises: +Create Date: 2026-07-23 22:45:58.652617 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '4d14337fb951' +down_revision: Union[str, Sequence[str], None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('contacts', + sa.Column('odoo_id', sa.Integer(), autoincrement=False, nullable=False), + sa.Column('name', sa.String(length=255), nullable=False), + sa.Column('email', sa.String(length=255), nullable=True), + sa.Column('phone', sa.String(length=64), nullable=True), + sa.Column('mobile', sa.String(length=64), nullable=True), + sa.PrimaryKeyConstraint('odoo_id') + ) + op.create_table('products', + sa.Column('odoo_id', sa.Integer(), autoincrement=False, nullable=False), + sa.Column('name', sa.String(length=255), nullable=False), + sa.Column('internal_reference', sa.String(length=64), nullable=True), + sa.Column('sale_price', sa.Numeric(precision=12, scale=2), nullable=True), + sa.Column('product_type', sa.String(length=32), nullable=True), + sa.PrimaryKeyConstraint('odoo_id') + ) + op.create_table('sale_orders', + sa.Column('odoo_id', sa.Integer(), autoincrement=False, nullable=False), + sa.Column('order_number', sa.String(length=64), nullable=False), + sa.Column('customer_id', sa.Integer(), nullable=False), + sa.Column('order_date', sa.DateTime(), nullable=False), + sa.Column('state', sa.String(length=32), nullable=False), + sa.Column('total_amount', sa.Numeric(precision=14, scale=2), nullable=False), + sa.ForeignKeyConstraint(['customer_id'], ['contacts.odoo_id'], ), + sa.PrimaryKeyConstraint('odoo_id') + ) + op.create_table('sale_order_lines', + sa.Column('odoo_id', sa.Integer(), autoincrement=False, nullable=False), + sa.Column('sale_order_id', sa.Integer(), nullable=False), + sa.Column('product_id', sa.Integer(), nullable=False), + sa.Column('quantity', sa.Float(), nullable=False), + sa.Column('unit_price', sa.Numeric(precision=12, scale=2), nullable=False), + sa.Column('subtotal', sa.Numeric(precision=14, scale=2), nullable=False), + sa.ForeignKeyConstraint(['product_id'], ['products.odoo_id'], ), + sa.ForeignKeyConstraint(['sale_order_id'], ['sale_orders.odoo_id'], ), + sa.PrimaryKeyConstraint('odoo_id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('sale_order_lines') + op.drop_table('sale_orders') + op.drop_table('products') + op.drop_table('contacts') + # ### end Alembic commands ### diff --git a/alembic/versions/52aa2866a364_add_sync_runs_and_sync_logs.py b/alembic/versions/52aa2866a364_add_sync_runs_and_sync_logs.py new file mode 100644 index 0000000..1df23a4 --- /dev/null +++ b/alembic/versions/52aa2866a364_add_sync_runs_and_sync_logs.py @@ -0,0 +1,54 @@ +"""add sync_runs and sync_logs + +Revision ID: 52aa2866a364 +Revises: 4d14337fb951 +Create Date: 2026-07-24 10:34:31.468682 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '52aa2866a364' +down_revision: Union[str, Sequence[str], None] = '4d14337fb951' +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('sync_runs', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('operation_type', sa.String(length=64), nullable=False), + sa.Column('started_at', sa.DateTime(), nullable=False), + sa.Column('finished_at', sa.DateTime(), nullable=True), + sa.Column('records_received', sa.Integer(), nullable=False), + sa.Column('records_saved', sa.Integer(), nullable=False), + sa.Column('records_updated', sa.Integer(), nullable=False), + sa.Column('records_failed', sa.Integer(), nullable=False), + sa.Column('status', sa.String(length=16), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('sync_logs', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('sync_run_id', sa.Integer(), nullable=False), + sa.Column('level', sa.String(length=16), nullable=False), + sa.Column('odoo_id', sa.Integer(), nullable=True), + sa.Column('message', sa.Text(), nullable=False), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False), + sa.ForeignKeyConstraint(['sync_run_id'], ['sync_runs.id'], ondelete='CASCADE'), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('sync_logs') + op.drop_table('sync_runs') + # ### end Alembic commands ### diff --git a/bookland_account/__init__.py b/app/__init__.py similarity index 100% rename from bookland_account/__init__.py rename to app/__init__.py diff --git a/bookland/README.md b/app/application/dto/__init__.py similarity index 100% rename from bookland/README.md rename to app/application/dto/__init__.py diff --git a/app/application/dto/contact_dto.py b/app/application/dto/contact_dto.py new file mode 100644 index 0000000..0bad305 --- /dev/null +++ b/app/application/dto/contact_dto.py @@ -0,0 +1,10 @@ +from dataclasses import dataclass + + +@dataclass +class ContactDTO: + odoo_id: int + name: str + email: str | None + phone: str | None + mobile: str | None \ No newline at end of file diff --git a/app/application/dto/product_dto.py b/app/application/dto/product_dto.py new file mode 100644 index 0000000..b561845 --- /dev/null +++ b/app/application/dto/product_dto.py @@ -0,0 +1,12 @@ +from dataclasses import dataclass +from decimal import Decimal + + +@dataclass +class ProductDTO: + odoo_id: int + name: str + internal_reference: str | None + sale_price: Decimal | None + product_type: str | None + \ No newline at end of file diff --git a/app/application/dto/sale_order_dto.py b/app/application/dto/sale_order_dto.py new file mode 100644 index 0000000..8d3c4a4 --- /dev/null +++ b/app/application/dto/sale_order_dto.py @@ -0,0 +1,13 @@ +from dataclasses import dataclass +from datetime import datetime +from decimal import Decimal + + +@dataclass +class SaleOrderDTO: + odoo_id: int + order_number: str + customer_id: int + order_date: datetime + state: str + total_amount: Decimal diff --git a/app/application/dto/sale_order_line_dto.py b/app/application/dto/sale_order_line_dto.py new file mode 100644 index 0000000..6c6e4a7 --- /dev/null +++ b/app/application/dto/sale_order_line_dto.py @@ -0,0 +1,12 @@ +from dataclasses import dataclass +from decimal import Decimal + + +@dataclass +class SaleOrderLineDTO: + odoo_id: int + sale_order_id: int + product_id: int + quantity: float + unit_price: Decimal + subtotal: Decimal diff --git a/bookland_account/README.md b/app/application/mappers/__init__.py similarity index 100% rename from bookland_account/README.md rename to app/application/mappers/__init__.py diff --git a/app/application/mappers/contact_mapper.py b/app/application/mappers/contact_mapper.py new file mode 100644 index 0000000..a41195f --- /dev/null +++ b/app/application/mappers/contact_mapper.py @@ -0,0 +1,15 @@ +from app.application.dto.contact_dto import ContactDTO +from app.domain.entities.contact import Contact + + +class ContactMapper: + + @staticmethod + def to_entity(dto: ContactDTO) -> Contact: + return Contact( + odoo_id=dto.odoo_id, + name=dto.name, + email=dto.email, + phone=dto.phone, + mobile=dto.mobile, + ) diff --git a/app/application/mappers/product_mapper.py b/app/application/mappers/product_mapper.py new file mode 100644 index 0000000..461cffd --- /dev/null +++ b/app/application/mappers/product_mapper.py @@ -0,0 +1,15 @@ +from app.application.dto.product_dto import ProductDTO +from app.domain.entities.product import Product + + +class ProductMapper: + + @staticmethod + def to_entity(dto: ProductDTO) -> Product: + return Product( + odoo_id=dto.odoo_id, + name=dto.name, + internal_reference=dto.internal_reference, + sale_price=dto.sale_price, + product_type=dto.product_type, + ) diff --git a/app/application/mappers/sale_order_line_mapper.py b/app/application/mappers/sale_order_line_mapper.py new file mode 100644 index 0000000..9a3c56d --- /dev/null +++ b/app/application/mappers/sale_order_line_mapper.py @@ -0,0 +1,16 @@ +from app.application.dto.sale_order_line_dto import SaleOrderLineDTO +from app.domain.entities.sale_order_line import SaleOrderLine + + +class SaleOrderLineMapper: + + @staticmethod + def to_entity(dto: SaleOrderLineDTO) -> SaleOrderLine: + return SaleOrderLine( + odoo_id=dto.odoo_id, + sale_order_id=dto.sale_order_id, + product_id=dto.product_id, + quantity=dto.quantity, + unit_price=dto.unit_price, + subtotal=dto.subtotal, + ) diff --git a/app/application/mappers/sale_order_mapper.py b/app/application/mappers/sale_order_mapper.py new file mode 100644 index 0000000..ab75bd7 --- /dev/null +++ b/app/application/mappers/sale_order_mapper.py @@ -0,0 +1,16 @@ +from app.application.dto.sale_order_dto import SaleOrderDTO +from app.domain.entities.sale_order import SaleOrder + + +class SaleOrderMapper: + + @staticmethod + def to_entity(dto: SaleOrderDTO) -> SaleOrder: + return SaleOrder( + odoo_id=dto.odoo_id, + order_number=dto.order_number, + customer_id=dto.customer_id, + order_date=dto.order_date, + state=dto.state, + total_amount=dto.total_amount, + ) diff --git a/bookland_account/readme/HISTORY.md b/app/application/services/__init__.py similarity index 100% rename from bookland_account/readme/HISTORY.md rename to app/application/services/__init__.py diff --git a/app/application/services/contact_sync_service.py b/app/application/services/contact_sync_service.py new file mode 100644 index 0000000..8fe5763 --- /dev/null +++ b/app/application/services/contact_sync_service.py @@ -0,0 +1,30 @@ +from app.infrastructure.odoo.client import OdooClient +from app.application.dto.contact_dto import ContactDTO +from app.application.mappers.contact_mapper import ContactMapper + + +class ContactSyncService: + + def __init__(self, odoo_client: OdooClient): + self.odoo_client = odoo_client + + def sync(self): + + contacts = self.odoo_client.get_contacts() + + entities = [] + + for contact in contacts: + dto = ContactDTO( + odoo_id=contact["id"], + name=contact["name"], + email=contact.get("email") or None, + phone=contact.get("phone") or None, + mobile=contact.get("mobile") or None, + ) + + entity = ContactMapper.to_entity(dto) + + entities.append(entity) + + return entities diff --git a/app/application/services/product_sync_service.py b/app/application/services/product_sync_service.py new file mode 100644 index 0000000..f453e38 --- /dev/null +++ b/app/application/services/product_sync_service.py @@ -0,0 +1,42 @@ +from decimal import Decimal + +from app.infrastructure.odoo.client import OdooClient +from app.application.dto.product_dto import ProductDTO +from app.application.mappers.product_mapper import ProductMapper + + +class ProductSyncService: + + def __init__( + self, + odoo_client: OdooClient, + ): + self.odoo_client = odoo_client + + def sync(self): + + products = self.odoo_client.get_products() + + entities = [] + + for product in products: + + dto = ProductDTO( + odoo_id=product["id"], + name=product["name"], + internal_reference=product.get( + "default_code" + ) or None, + sale_price=Decimal( + str(product["list_price"]) + ) + if product.get("list_price") + else None, + product_type=product.get("type"), + ) + + entity = ProductMapper.to_entity(dto) + + entities.append(entity) + + return entities \ No newline at end of file diff --git a/app/application/services/sale_order_line_sync_service.py b/app/application/services/sale_order_line_sync_service.py new file mode 100644 index 0000000..39711db --- /dev/null +++ b/app/application/services/sale_order_line_sync_service.py @@ -0,0 +1,44 @@ +from decimal import Decimal + +from app.infrastructure.odoo.client import OdooClient +from app.application.dto.sale_order_line_dto import SaleOrderLineDTO +from app.application.mappers.sale_order_line_mapper import SaleOrderLineMapper + + +class SaleOrderLineSyncService: + + def __init__( + self, + odoo_client: OdooClient, + ): + self.odoo_client = odoo_client + + def sync(self): + + sale_order_lines = self.odoo_client.get_sale_order_lines() + + entities = [] + + for sale_order_line in sale_order_lines: + + if not sale_order_line.get("product_id"): + continue + + dto = SaleOrderLineDTO( + odoo_id=sale_order_line["id"], + sale_order_id=sale_order_line["order_id"][0], + product_id=sale_order_line["product_id"][0], + quantity=sale_order_line["product_uom_qty"], + unit_price=Decimal( + str(sale_order_line["price_unit"]) + ), + subtotal=Decimal( + str(sale_order_line["price_subtotal"]) + ), + ) + + entity = SaleOrderLineMapper.to_entity(dto) + + entities.append(entity) + + return entities diff --git a/app/application/services/sale_order_sync_service.py b/app/application/services/sale_order_sync_service.py new file mode 100644 index 0000000..f3e6216 --- /dev/null +++ b/app/application/services/sale_order_sync_service.py @@ -0,0 +1,43 @@ +from datetime import datetime +from decimal import Decimal + +from app.infrastructure.odoo.client import OdooClient +from app.application.dto.sale_order_dto import SaleOrderDTO +from app.application.mappers.sale_order_mapper import SaleOrderMapper + + +class SaleOrderSyncService: + + def __init__( + self, + odoo_client: OdooClient, + ): + self.odoo_client = odoo_client + + def sync(self): + + sale_orders = self.odoo_client.get_sale_orders() + + entities = [] + + for sale_order in sale_orders: + + dto = SaleOrderDTO( + odoo_id=sale_order["id"], + order_number=sale_order["name"], + customer_id=sale_order["partner_id"][0], + order_date=datetime.strptime( + sale_order["date_order"], + "%Y-%m-%d %H:%M:%S", + ), + state=sale_order["state"], + total_amount=Decimal( + str(sale_order["amount_total"]) + ), + ) + + entity = SaleOrderMapper.to_entity(dto) + + entities.append(entity) + + return entities diff --git a/app/application/use_cases/__init__.py b/app/application/use_cases/__init__.py new file mode 100644 index 0000000..7ba1d02 --- /dev/null +++ b/app/application/use_cases/__init__.py @@ -0,0 +1,6 @@ +from app.application.use_cases.sync_entity_use_case import SyncEntityUseCase + + +__all__ = [ + "SyncEntityUseCase", +] diff --git a/app/application/use_cases/sync_entity_use_case.py b/app/application/use_cases/sync_entity_use_case.py new file mode 100644 index 0000000..70235d8 --- /dev/null +++ b/app/application/use_cases/sync_entity_use_case.py @@ -0,0 +1,101 @@ +from datetime import datetime +from typing import Protocol + +from app.domain.entities.sync_run import SyncRun, SyncStatus +from app.domain.entities.sync_log import SyncLog, SyncLogLevel +from app.domain.repositories.sync_run_repository import SyncRunRepository + + +class SyncSource(Protocol): + """Anything that can fetch and map records from the source system.""" + + def sync(self) -> list: ... + + +class EntityRepository(Protocol): + """Common shape of the per-entity repositories (upsert by odoo_id).""" + + def get_by_odoo_id(self, odoo_id: int): ... + + def save(self, entity) -> None: ... + + def update(self, entity) -> None: ... + + +class SyncEntityUseCase: + """Synchronizes one entity type from the source into the database. + + Each record is processed independently: an error on one record is + logged and counted, but never stops the rest of the batch. + """ + + def __init__( + self, + operation_type: str, + source: SyncSource, + repository: EntityRepository, + sync_run_repository: SyncRunRepository, + ): + self._operation_type = operation_type + self._source = source + self._repository = repository + self._sync_run_repository = sync_run_repository + + def execute(self) -> SyncRun: + run = SyncRun( + operation_type=self._operation_type, + started_at=datetime.now(), + ) + run = self._sync_run_repository.create(run) + + try: + entities = self._source.sync() + except Exception as exc: + return self._fail_run(run, f"Failed to fetch from source: {exc}") + + run.records_received = len(entities) + + for entity in entities: + try: + if self._repository.get_by_odoo_id(entity.odoo_id) is None: + self._repository.save(entity) + run.records_saved += 1 + else: + self._repository.update(entity) + run.records_updated += 1 + except Exception as exc: + run.records_failed += 1 + self._sync_run_repository.add_log( + SyncLog( + sync_run_id=run.id, + level=SyncLogLevel.ERROR, + message=str(exc), + odoo_id=getattr(entity, "odoo_id", None), + ) + ) + + run.finished_at = datetime.now() + run.status = self._resolve_status(run) + self._sync_run_repository.finish(run) + return run + + def _fail_run(self, run: SyncRun, message: str) -> SyncRun: + self._sync_run_repository.add_log( + SyncLog( + sync_run_id=run.id, + level=SyncLogLevel.ERROR, + message=message, + ) + ) + run.finished_at = datetime.now() + run.status = SyncStatus.FAILED + self._sync_run_repository.finish(run) + return run + + @staticmethod + def _resolve_status(run: SyncRun) -> SyncStatus: + if run.records_failed == 0: + return SyncStatus.SUCCESS + if run.records_saved == 0 and run.records_updated == 0: + return SyncStatus.FAILED + return SyncStatus.PARTIAL diff --git a/app/config/__init__.py b/app/config/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/config/settings.py b/app/config/settings.py new file mode 100644 index 0000000..7458592 --- /dev/null +++ b/app/config/settings.py @@ -0,0 +1,49 @@ +from pydantic_settings import BaseSettings, SettingsConfigDict +from pydantic import PostgresDsn, field_validator, ValidationInfo +from pathlib import Path +from typing import Optional + +class Settings(BaseSettings): + + model_config = SettingsConfigDict(case_sensitive=True) + + # Database + DATABASE_NAME: str + DATABASE_USER: str + DATABASE_PASSWORD: str + DATABASE_HOST: str + DATABASE_PORT: str + + # Odoo + ODOO_URL: str + ODOO_USERNAME: str + ODOO_DB_NAME: str + ODOO_PASSWORD: str + + POSTGRES_DATABASE_URL: PostgresDsn | None = None + + @field_validator("POSTGRES_DATABASE_URL", mode="after") + def assemble_postgresql_url(cls, v: Optional[str], values: ValidationInfo): + if isinstance(v, str): + return v + return PostgresDsn.build( + scheme="postgresql", + username=values.data["DATABASE_USER"], + password=values.data["DATABASE_PASSWORD"], + host=values.data["DATABASE_HOST"], + port=int(values.data["DATABASE_PORT"]), + path=values.data["DATABASE_NAME"], + ) + + +class GetSettings(Settings): + model_config = SettingsConfigDict( + env_file=Path(__file__).parent.parent.parent / ".env", + case_sensitive=True + ) + +def get_settings() -> Settings: + return GetSettings() + + +settings = get_settings() \ No newline at end of file diff --git a/app/domain/__init__.py b/app/domain/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/domain/entities/__init__.py b/app/domain/entities/__init__.py new file mode 100644 index 0000000..6ea7fe8 --- /dev/null +++ b/app/domain/entities/__init__.py @@ -0,0 +1,12 @@ +from .product import Product +from .contact import Contact +from .sale_order import SaleOrder +from .sale_order_line import SaleOrderLine + + +__all__ = [ + "Contact", + "Product", + "SaleOrder", + "SaleOrderLine", +] \ No newline at end of file diff --git a/app/domain/entities/contact.py b/app/domain/entities/contact.py new file mode 100644 index 0000000..8cc6f26 --- /dev/null +++ b/app/domain/entities/contact.py @@ -0,0 +1,10 @@ +from dataclasses import dataclass + + +@dataclass +class Contact: + odoo_id: int + name: str + email: str | None = None + phone: str | None = None + mobile: str | None = None \ No newline at end of file diff --git a/app/domain/entities/product.py b/app/domain/entities/product.py new file mode 100644 index 0000000..7a3970d --- /dev/null +++ b/app/domain/entities/product.py @@ -0,0 +1,11 @@ +from dataclasses import dataclass +from decimal import Decimal + + +@dataclass +class Product: + odoo_id: int + name: str + internal_reference: str | None = None + sale_price: Decimal | None = None + product_type: str | None = None \ No newline at end of file diff --git a/app/domain/entities/sale_order.py b/app/domain/entities/sale_order.py new file mode 100644 index 0000000..4aa16f2 --- /dev/null +++ b/app/domain/entities/sale_order.py @@ -0,0 +1,13 @@ +from dataclasses import dataclass +from datetime import datetime +from decimal import Decimal + + +@dataclass +class SaleOrder: + odoo_id: int + order_number: str + customer_id: int + order_date: datetime + state: str + total_amount: Decimal \ No newline at end of file diff --git a/app/domain/entities/sale_order_line.py b/app/domain/entities/sale_order_line.py new file mode 100644 index 0000000..f690c5a --- /dev/null +++ b/app/domain/entities/sale_order_line.py @@ -0,0 +1,12 @@ +from dataclasses import dataclass +from decimal import Decimal + + +@dataclass +class SaleOrderLine: + odoo_id: int + sale_order_id: int + product_id: int + quantity: float + unit_price: Decimal + subtotal: Decimal \ No newline at end of file diff --git a/app/domain/entities/sync_log.py b/app/domain/entities/sync_log.py new file mode 100644 index 0000000..98b2da9 --- /dev/null +++ b/app/domain/entities/sync_log.py @@ -0,0 +1,19 @@ +from dataclasses import dataclass +from datetime import datetime +from enum import Enum + + +class SyncLogLevel(str, Enum): + INFO = "info" + WARNING = "warning" + ERROR = "error" + + +@dataclass +class SyncLog: + sync_run_id: int + level: SyncLogLevel + message: str + odoo_id: int | None = None + created_at: datetime | None = None + id: int | None = None diff --git a/app/domain/entities/sync_run.py b/app/domain/entities/sync_run.py new file mode 100644 index 0000000..095b389 --- /dev/null +++ b/app/domain/entities/sync_run.py @@ -0,0 +1,23 @@ +from dataclasses import dataclass +from datetime import datetime +from enum import Enum + + +class SyncStatus(str, Enum): + RUNNING = "running" + SUCCESS = "success" + PARTIAL = "partial" + FAILED = "failed" + + +@dataclass +class SyncRun: + operation_type: str + started_at: datetime + status: SyncStatus = SyncStatus.RUNNING + records_received: int = 0 + records_saved: int = 0 + records_updated: int = 0 + records_failed: int = 0 + finished_at: datetime | None = None + id: int | None = None diff --git a/app/domain/exceptions/__init__.py b/app/domain/exceptions/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/domain/ports/db_session.py b/app/domain/ports/db_session.py new file mode 100644 index 0000000..dbaf094 --- /dev/null +++ b/app/domain/ports/db_session.py @@ -0,0 +1,19 @@ +from abc import ABC, abstractmethod +from typing import Generator +from sqlalchemy.orm import Session + + +class IDBConnection(ABC): + + @abstractmethod + def get_session(self) -> Session: + pass + + @abstractmethod + def get_session_generator(self) -> Generator[Session, None, None]: + pass + + @abstractmethod + def dispose(self) -> None: + pass + \ No newline at end of file diff --git a/app/domain/repositories/__init__.py b/app/domain/repositories/__init__.py new file mode 100644 index 0000000..e448e3d --- /dev/null +++ b/app/domain/repositories/__init__.py @@ -0,0 +1,12 @@ +from .contact_repository import ContactRepository +from .product_repository import ProductRepository +from .sale_order_repository import SaleOrderRepository +from .sale_order_line_repository import SaleOrderLineRepository + + +__all__ = [ + "ContactRepository", + "ProductRepository", + "SaleOrderRepository", + "SaleOrderLineRepository", +] diff --git a/app/domain/repositories/contact_repository.py b/app/domain/repositories/contact_repository.py new file mode 100644 index 0000000..9c763a8 --- /dev/null +++ b/app/domain/repositories/contact_repository.py @@ -0,0 +1,18 @@ +from abc import ABC, abstractmethod + +from app.domain.entities.contact import Contact + + +class ContactRepository(ABC): + + @abstractmethod + def save(self, contact: Contact) -> None: + pass + + @abstractmethod + def get_by_odoo_id(self, odoo_id: int) -> Contact | None: + pass + + @abstractmethod + def update(self, contact: Contact) -> None: + pass diff --git a/app/domain/repositories/product_repository.py b/app/domain/repositories/product_repository.py new file mode 100644 index 0000000..a54c1c9 --- /dev/null +++ b/app/domain/repositories/product_repository.py @@ -0,0 +1,18 @@ +from abc import ABC, abstractmethod + +from app.domain.entities.product import Product + + +class ProductRepository(ABC): + + @abstractmethod + def save(self, product: Product) -> None: + pass + + @abstractmethod + def get_by_odoo_id(self, odoo_id: int) -> Product | None: + pass + + @abstractmethod + def update(self, product: Product) -> None: + pass \ No newline at end of file diff --git a/app/domain/repositories/sale_order_line_repository.py b/app/domain/repositories/sale_order_line_repository.py new file mode 100644 index 0000000..bd7b01b --- /dev/null +++ b/app/domain/repositories/sale_order_line_repository.py @@ -0,0 +1,18 @@ +from abc import ABC, abstractmethod + +from app.domain.entities.sale_order_line import SaleOrderLine + + +class SaleOrderLineRepository(ABC): + + @abstractmethod + def save(self, line: SaleOrderLine) -> None: + pass + + @abstractmethod + def get_by_odoo_id(self, odoo_id: int) -> SaleOrderLine | None: + pass + + @abstractmethod + def update(self, line: SaleOrderLine) -> None: + pass \ No newline at end of file diff --git a/app/domain/repositories/sale_order_repository.py b/app/domain/repositories/sale_order_repository.py new file mode 100644 index 0000000..82c3ce2 --- /dev/null +++ b/app/domain/repositories/sale_order_repository.py @@ -0,0 +1,18 @@ +from abc import ABC, abstractmethod + +from app.domain.entities.sale_order import SaleOrder + + +class SaleOrderRepository(ABC): + + @abstractmethod + def save(self, order: SaleOrder) -> None: + pass + + @abstractmethod + def get_by_odoo_id(self, odoo_id: int) -> SaleOrder | None: + pass + + @abstractmethod + def update(self, order: SaleOrder) -> None: + pass diff --git a/app/domain/repositories/sync_run_repository.py b/app/domain/repositories/sync_run_repository.py new file mode 100644 index 0000000..955178d --- /dev/null +++ b/app/domain/repositories/sync_run_repository.py @@ -0,0 +1,19 @@ +from abc import ABC, abstractmethod + +from app.domain.entities.sync_run import SyncRun +from app.domain.entities.sync_log import SyncLog + + +class SyncRunRepository(ABC): + + @abstractmethod + def create(self, sync_run: SyncRun) -> SyncRun: + pass + + @abstractmethod + def finish(self, sync_run: SyncRun) -> None: + pass + + @abstractmethod + def add_log(self, sync_log: SyncLog) -> None: + pass diff --git a/app/infrastructure/__init__.py b/app/infrastructure/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/infrastructure/database/__init__.py b/app/infrastructure/database/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/infrastructure/database/models/__init__.py b/app/infrastructure/database/models/__init__.py new file mode 100644 index 0000000..acda963 --- /dev/null +++ b/app/infrastructure/database/models/__init__.py @@ -0,0 +1,18 @@ +from app.infrastructure.database.models.base import Base +from app.infrastructure.database.models.contact import ContactModel +from app.infrastructure.database.models.product import ProductModel +from app.infrastructure.database.models.sale_order import SaleOrderModel +from app.infrastructure.database.models.sale_order_line import SaleOrderLineModel +from app.infrastructure.database.models.sync_run import SyncRunModel +from app.infrastructure.database.models.sync_log import SyncLogModel + + +__all__ = [ + "Base", + "ContactModel", + "ProductModel", + "SaleOrderModel", + "SaleOrderLineModel", + "SyncRunModel", + "SyncLogModel", +] diff --git a/app/infrastructure/database/models/base.py b/app/infrastructure/database/models/base.py new file mode 100644 index 0000000..fa2b68a --- /dev/null +++ b/app/infrastructure/database/models/base.py @@ -0,0 +1,5 @@ +from sqlalchemy.orm import DeclarativeBase + + +class Base(DeclarativeBase): + pass diff --git a/app/infrastructure/database/models/contact.py b/app/infrastructure/database/models/contact.py new file mode 100644 index 0000000..06e56e5 --- /dev/null +++ b/app/infrastructure/database/models/contact.py @@ -0,0 +1,23 @@ +from typing import TYPE_CHECKING + +from sqlalchemy import String +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.sale_order import SaleOrderModel + + +class ContactModel(Base): + __tablename__ = "contacts" + + odoo_id: Mapped[int] = mapped_column(primary_key=True, autoincrement=False) + name: Mapped[str] = mapped_column(String(255)) + email: Mapped[str | None] = mapped_column(String(255)) + phone: Mapped[str | None] = mapped_column(String(64)) + mobile: Mapped[str | None] = mapped_column(String(64)) + + sale_orders: Mapped[list["SaleOrderModel"]] = relationship( + back_populates="customer", + ) diff --git a/app/infrastructure/database/models/product.py b/app/infrastructure/database/models/product.py new file mode 100644 index 0000000..10b8736 --- /dev/null +++ b/app/infrastructure/database/models/product.py @@ -0,0 +1,24 @@ +from decimal import Decimal +from typing import TYPE_CHECKING + +from sqlalchemy import String, Numeric +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.sale_order_line import SaleOrderLineModel + + +class ProductModel(Base): + __tablename__ = "products" + + odoo_id: Mapped[int] = mapped_column(primary_key=True, autoincrement=False) + name: Mapped[str] = mapped_column(String(255)) + internal_reference: Mapped[str | None] = mapped_column(String(64)) + sale_price: Mapped[Decimal | None] = mapped_column(Numeric(12, 2)) + product_type: Mapped[str | None] = mapped_column(String(32)) + + sale_order_lines: Mapped[list["SaleOrderLineModel"]] = relationship( + back_populates="product", + ) diff --git a/app/infrastructure/database/models/sale_order.py b/app/infrastructure/database/models/sale_order.py new file mode 100644 index 0000000..fcf8a0f --- /dev/null +++ b/app/infrastructure/database/models/sale_order.py @@ -0,0 +1,30 @@ +from datetime import datetime +from decimal import Decimal +from typing import TYPE_CHECKING + +from sqlalchemy import String, Numeric, DateTime, ForeignKey +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.contact import ContactModel + from app.infrastructure.database.models.sale_order_line import SaleOrderLineModel + + +class SaleOrderModel(Base): + __tablename__ = "sale_orders" + + odoo_id: Mapped[int] = mapped_column(primary_key=True, autoincrement=False) + order_number: Mapped[str] = mapped_column(String(64)) + customer_id: Mapped[int] = mapped_column(ForeignKey("contacts.odoo_id")) + order_date: Mapped[datetime] = mapped_column(DateTime) + state: Mapped[str] = mapped_column(String(32)) + total_amount: Mapped[Decimal] = mapped_column(Numeric(14, 2)) + + customer: Mapped["ContactModel"] = relationship( + back_populates="sale_orders", + ) + lines: Mapped[list["SaleOrderLineModel"]] = relationship( + back_populates="sale_order", + ) diff --git a/app/infrastructure/database/models/sale_order_line.py b/app/infrastructure/database/models/sale_order_line.py new file mode 100644 index 0000000..0e9eb07 --- /dev/null +++ b/app/infrastructure/database/models/sale_order_line.py @@ -0,0 +1,29 @@ +from decimal import Decimal +from typing import TYPE_CHECKING + +from sqlalchemy import Numeric, Float, ForeignKey +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.product import ProductModel + from app.infrastructure.database.models.sale_order import SaleOrderModel + + +class SaleOrderLineModel(Base): + __tablename__ = "sale_order_lines" + + odoo_id: Mapped[int] = mapped_column(primary_key=True, autoincrement=False) + sale_order_id: Mapped[int] = mapped_column(ForeignKey("sale_orders.odoo_id")) + product_id: Mapped[int] = mapped_column(ForeignKey("products.odoo_id")) + quantity: Mapped[float] = mapped_column(Float) + unit_price: Mapped[Decimal] = mapped_column(Numeric(12, 2)) + subtotal: Mapped[Decimal] = mapped_column(Numeric(14, 2)) + + sale_order: Mapped["SaleOrderModel"] = relationship( + back_populates="lines", + ) + product: Mapped["ProductModel"] = relationship( + back_populates="sale_order_lines", + ) diff --git a/app/infrastructure/database/models/sync_log.py b/app/infrastructure/database/models/sync_log.py new file mode 100644 index 0000000..7a452e0 --- /dev/null +++ b/app/infrastructure/database/models/sync_log.py @@ -0,0 +1,25 @@ +from datetime import datetime +from typing import TYPE_CHECKING + +from sqlalchemy import String, Text, DateTime, ForeignKey, func +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.sync_run import SyncRunModel + + +class SyncLogModel(Base): + __tablename__ = "sync_logs" + + id: Mapped[int] = mapped_column(primary_key=True) + sync_run_id: Mapped[int] = mapped_column(ForeignKey("sync_runs.id", ondelete="CASCADE")) + level: Mapped[str] = mapped_column(String(16)) + odoo_id: Mapped[int | None] = mapped_column() + message: Mapped[str] = mapped_column(Text) + created_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now()) + + sync_run: Mapped["SyncRunModel"] = relationship( + back_populates="logs", + ) diff --git a/app/infrastructure/database/models/sync_run.py b/app/infrastructure/database/models/sync_run.py new file mode 100644 index 0000000..738ef99 --- /dev/null +++ b/app/infrastructure/database/models/sync_run.py @@ -0,0 +1,29 @@ +from datetime import datetime +from typing import TYPE_CHECKING + +from sqlalchemy import String, DateTime +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from app.infrastructure.database.models.base import Base + +if TYPE_CHECKING: + from app.infrastructure.database.models.sync_log import SyncLogModel + + +class SyncRunModel(Base): + __tablename__ = "sync_runs" + + id: Mapped[int] = mapped_column(primary_key=True) + operation_type: Mapped[str] = mapped_column(String(64)) + started_at: Mapped[datetime] = mapped_column(DateTime) + finished_at: Mapped[datetime | None] = mapped_column(DateTime) + records_received: Mapped[int] = mapped_column(default=0) + records_saved: Mapped[int] = mapped_column(default=0) + records_updated: Mapped[int] = mapped_column(default=0) + records_failed: Mapped[int] = mapped_column(default=0) + status: Mapped[str] = mapped_column(String(16)) + + logs: Mapped[list["SyncLogModel"]] = relationship( + back_populates="sync_run", + cascade="all, delete-orphan", + ) diff --git a/app/infrastructure/database/repositories/__init__.py b/app/infrastructure/database/repositories/__init__.py new file mode 100644 index 0000000..ab95509 --- /dev/null +++ b/app/infrastructure/database/repositories/__init__.py @@ -0,0 +1,24 @@ +from app.infrastructure.database.repositories.contact_repository import ( + SQLAlchemyContactRepository, +) +from app.infrastructure.database.repositories.product_repository import ( + SQLAlchemyProductRepository, +) +from app.infrastructure.database.repositories.sale_order_repository import ( + SQLAlchemySaleOrderRepository, +) +from app.infrastructure.database.repositories.sale_order_line_repository import ( + SQLAlchemySaleOrderLineRepository, +) +from app.infrastructure.database.repositories.sync_run_repository import ( + SQLAlchemySyncRunRepository, +) + + +__all__ = [ + "SQLAlchemyContactRepository", + "SQLAlchemyProductRepository", + "SQLAlchemySaleOrderRepository", + "SQLAlchemySaleOrderLineRepository", + "SQLAlchemySyncRunRepository", +] diff --git a/app/infrastructure/database/repositories/contact_repository.py b/app/infrastructure/database/repositories/contact_repository.py new file mode 100644 index 0000000..26510fb --- /dev/null +++ b/app/infrastructure/database/repositories/contact_repository.py @@ -0,0 +1,60 @@ +from app.domain.entities.contact import Contact +from app.domain.ports.db_session import IDBConnection +from app.domain.repositories.contact_repository import ContactRepository +from app.infrastructure.database.models.contact import ContactModel + + +class SQLAlchemyContactRepository(ContactRepository): + + def __init__(self, db_connection: IDBConnection): + self._db = db_connection + + def save(self, contact: Contact) -> None: + session = self._db.get_session() + try: + session.add(self._to_model(contact)) + session.commit() + finally: + session.close() + + def get_by_odoo_id(self, odoo_id: int) -> Contact | None: + session = self._db.get_session() + try: + model = session.get(ContactModel, odoo_id) + return self._to_entity(model) if model else None + finally: + session.close() + + def update(self, contact: Contact) -> None: + session = self._db.get_session() + try: + model = session.get(ContactModel, contact.odoo_id) + if model is None: + return + model.name = contact.name + model.email = contact.email + model.phone = contact.phone + model.mobile = contact.mobile + session.commit() + finally: + session.close() + + @staticmethod + def _to_model(contact: Contact) -> ContactModel: + return ContactModel( + odoo_id=contact.odoo_id, + name=contact.name, + email=contact.email, + phone=contact.phone, + mobile=contact.mobile, + ) + + @staticmethod + def _to_entity(model: ContactModel) -> Contact: + return Contact( + odoo_id=model.odoo_id, + name=model.name, + email=model.email, + phone=model.phone, + mobile=model.mobile, + ) diff --git a/app/infrastructure/database/repositories/product_repository.py b/app/infrastructure/database/repositories/product_repository.py new file mode 100644 index 0000000..8a1351a --- /dev/null +++ b/app/infrastructure/database/repositories/product_repository.py @@ -0,0 +1,60 @@ +from app.domain.entities.product import Product +from app.domain.ports.db_session import IDBConnection +from app.domain.repositories.product_repository import ProductRepository +from app.infrastructure.database.models.product import ProductModel + + +class SQLAlchemyProductRepository(ProductRepository): + + def __init__(self, db_connection: IDBConnection): + self._db = db_connection + + def save(self, product: Product) -> None: + session = self._db.get_session() + try: + session.add(self._to_model(product)) + session.commit() + finally: + session.close() + + def get_by_odoo_id(self, odoo_id: int) -> Product | None: + session = self._db.get_session() + try: + model = session.get(ProductModel, odoo_id) + return self._to_entity(model) if model else None + finally: + session.close() + + def update(self, product: Product) -> None: + session = self._db.get_session() + try: + model = session.get(ProductModel, product.odoo_id) + if model is None: + return + model.name = product.name + model.internal_reference = product.internal_reference + model.sale_price = product.sale_price + model.product_type = product.product_type + session.commit() + finally: + session.close() + + @staticmethod + def _to_model(product: Product) -> ProductModel: + return ProductModel( + odoo_id=product.odoo_id, + name=product.name, + internal_reference=product.internal_reference, + sale_price=product.sale_price, + product_type=product.product_type, + ) + + @staticmethod + def _to_entity(model: ProductModel) -> Product: + return Product( + odoo_id=model.odoo_id, + name=model.name, + internal_reference=model.internal_reference, + sale_price=model.sale_price, + product_type=model.product_type, + ) diff --git a/app/infrastructure/database/repositories/sale_order_line_repository.py b/app/infrastructure/database/repositories/sale_order_line_repository.py new file mode 100644 index 0000000..19bf01c --- /dev/null +++ b/app/infrastructure/database/repositories/sale_order_line_repository.py @@ -0,0 +1,63 @@ +from app.domain.entities.sale_order_line import SaleOrderLine +from app.domain.ports.db_session import IDBConnection +from app.domain.repositories.sale_order_line_repository import SaleOrderLineRepository +from app.infrastructure.database.models.sale_order_line import SaleOrderLineModel + + +class SQLAlchemySaleOrderLineRepository(SaleOrderLineRepository): + + def __init__(self, db_connection: IDBConnection): + self._db = db_connection + + def save(self, line: SaleOrderLine) -> None: + session = self._db.get_session() + try: + session.add(self._to_model(line)) + session.commit() + finally: + session.close() + + def get_by_odoo_id(self, odoo_id: int) -> SaleOrderLine | None: + session = self._db.get_session() + try: + model = session.get(SaleOrderLineModel, odoo_id) + return self._to_entity(model) if model else None + finally: + session.close() + + def update(self, line: SaleOrderLine) -> None: + session = self._db.get_session() + try: + model = session.get(SaleOrderLineModel, line.odoo_id) + if model is None: + return + model.sale_order_id = line.sale_order_id + model.product_id = line.product_id + model.quantity = line.quantity + model.unit_price = line.unit_price + model.subtotal = line.subtotal + session.commit() + finally: + session.close() + + @staticmethod + def _to_model(line: SaleOrderLine) -> SaleOrderLineModel: + return SaleOrderLineModel( + odoo_id=line.odoo_id, + sale_order_id=line.sale_order_id, + product_id=line.product_id, + quantity=line.quantity, + unit_price=line.unit_price, + subtotal=line.subtotal, + ) + + @staticmethod + def _to_entity(model: SaleOrderLineModel) -> SaleOrderLine: + return SaleOrderLine( + odoo_id=model.odoo_id, + sale_order_id=model.sale_order_id, + product_id=model.product_id, + quantity=model.quantity, + unit_price=model.unit_price, + subtotal=model.subtotal, + ) diff --git a/app/infrastructure/database/repositories/sale_order_repository.py b/app/infrastructure/database/repositories/sale_order_repository.py new file mode 100644 index 0000000..0de4c54 --- /dev/null +++ b/app/infrastructure/database/repositories/sale_order_repository.py @@ -0,0 +1,63 @@ +from app.domain.entities.sale_order import SaleOrder +from app.domain.ports.db_session import IDBConnection +from app.domain.repositories.sale_order_repository import SaleOrderRepository +from app.infrastructure.database.models.sale_order import SaleOrderModel + + +class SQLAlchemySaleOrderRepository(SaleOrderRepository): + + def __init__(self, db_connection: IDBConnection): + self._db = db_connection + + def save(self, order: SaleOrder) -> None: + session = self._db.get_session() + try: + session.add(self._to_model(order)) + session.commit() + finally: + session.close() + + def get_by_odoo_id(self, odoo_id: int) -> SaleOrder | None: + session = self._db.get_session() + try: + model = session.get(SaleOrderModel, odoo_id) + return self._to_entity(model) if model else None + finally: + session.close() + + def update(self, order: SaleOrder) -> None: + session = self._db.get_session() + try: + model = session.get(SaleOrderModel, order.odoo_id) + if model is None: + return + model.order_number = order.order_number + model.customer_id = order.customer_id + model.order_date = order.order_date + model.state = order.state + model.total_amount = order.total_amount + session.commit() + finally: + session.close() + + @staticmethod + def _to_model(order: SaleOrder) -> SaleOrderModel: + return SaleOrderModel( + odoo_id=order.odoo_id, + order_number=order.order_number, + customer_id=order.customer_id, + order_date=order.order_date, + state=order.state, + total_amount=order.total_amount, + ) + + @staticmethod + def _to_entity(model: SaleOrderModel) -> SaleOrder: + return SaleOrder( + odoo_id=model.odoo_id, + order_number=model.order_number, + customer_id=model.customer_id, + order_date=model.order_date, + state=model.state, + total_amount=model.total_amount, + ) diff --git a/app/infrastructure/database/repositories/sync_run_repository.py b/app/infrastructure/database/repositories/sync_run_repository.py new file mode 100644 index 0000000..1cc05de --- /dev/null +++ b/app/infrastructure/database/repositories/sync_run_repository.py @@ -0,0 +1,70 @@ +from app.domain.entities.sync_run import SyncRun +from app.domain.entities.sync_log import SyncLog +from app.domain.ports.db_session import IDBConnection +from app.domain.repositories.sync_run_repository import SyncRunRepository +from app.infrastructure.database.models.sync_run import SyncRunModel +from app.infrastructure.database.models.sync_log import SyncLogModel + + +class SQLAlchemySyncRunRepository(SyncRunRepository): + + def __init__(self, db_connection: IDBConnection): + self._db = db_connection + + def create(self, sync_run: SyncRun) -> SyncRun: + session = self._db.get_session() + try: + model = self._to_run_model(sync_run) + session.add(model) + session.flush() + sync_run.id = model.id + session.commit() + return sync_run + finally: + session.close() + + def finish(self, sync_run: SyncRun) -> None: + session = self._db.get_session() + try: + model = session.get(SyncRunModel, sync_run.id) + if model is None: + return + model.finished_at = sync_run.finished_at + model.records_received = sync_run.records_received + model.records_saved = sync_run.records_saved + model.records_updated = sync_run.records_updated + model.records_failed = sync_run.records_failed + model.status = sync_run.status.value + session.commit() + finally: + session.close() + + def add_log(self, sync_log: SyncLog) -> None: + session = self._db.get_session() + try: + session.add(self._to_log_model(sync_log)) + session.commit() + finally: + session.close() + + @staticmethod + def _to_run_model(sync_run: SyncRun) -> SyncRunModel: + return SyncRunModel( + operation_type=sync_run.operation_type, + started_at=sync_run.started_at, + status=sync_run.status.value, + records_received=sync_run.records_received, + records_saved=sync_run.records_saved, + records_updated=sync_run.records_updated, + records_failed=sync_run.records_failed, + finished_at=sync_run.finished_at, + ) + + @staticmethod + def _to_log_model(sync_log: SyncLog) -> SyncLogModel: + return SyncLogModel( + sync_run_id=sync_log.sync_run_id, + level=sync_log.level.value, + message=sync_log.message, + odoo_id=sync_log.odoo_id, + ) diff --git a/app/infrastructure/database/session.py b/app/infrastructure/database/session.py new file mode 100644 index 0000000..b2184c0 --- /dev/null +++ b/app/infrastructure/database/session.py @@ -0,0 +1,42 @@ +from sqlalchemy.orm import sessionmaker +from sqlalchemy import create_engine +from sqlalchemy.engine import Engine +from sqlalchemy.orm import Session +from typing import Generator + +from app.config.settings import settings +from app.domain.ports.db_session import IDBConnection + + +class PostgreSQLConnection(IDBConnection): + + def __init__(self): + database_url = str(settings.POSTGRES_DATABASE_URL).replace( + "postgresql://", "postgresql+psycopg://", 1 + ) + self._engine: Engine = create_engine( + database_url, + echo=False, + pool_pre_ping=True, + pool_size=10, + max_overflow=20 + ) + self._session_factory: sessionmaker = sessionmaker( + bind=self._engine, + autocommit=False, + autoflush=False + ) + + def get_session(self) -> Session: + return self._session_factory() + + def get_session_generator(self) -> Generator[Session, None, None]: + session = self.get_session() + try: + yield session + finally: + session.close() + + def dispose(self) -> None: + self._engine.dispose() + \ No newline at end of file diff --git a/app/infrastructure/di_container.py b/app/infrastructure/di_container.py new file mode 100644 index 0000000..cff379e --- /dev/null +++ b/app/infrastructure/di_container.py @@ -0,0 +1,126 @@ +from dependency_injector import containers, providers + +from app.config.settings import settings +from app.infrastructure.odoo.client import OdooClient +from app.infrastructure.database.session import PostgreSQLConnection +from app.infrastructure.database.repositories.contact_repository import ( + SQLAlchemyContactRepository, +) +from app.infrastructure.database.repositories.product_repository import ( + SQLAlchemyProductRepository, +) +from app.infrastructure.database.repositories.sale_order_repository import ( + SQLAlchemySaleOrderRepository, +) +from app.infrastructure.database.repositories.sale_order_line_repository import ( + SQLAlchemySaleOrderLineRepository, +) +from app.infrastructure.database.repositories.sync_run_repository import ( + SQLAlchemySyncRunRepository, +) +from app.application.services.contact_sync_service import ContactSyncService +from app.application.services.product_sync_service import ProductSyncService +from app.application.services.sale_order_sync_service import SaleOrderSyncService +from app.application.services.sale_order_line_sync_service import ( + SaleOrderLineSyncService, +) +from app.application.use_cases.sync_entity_use_case import SyncEntityUseCase + + +def _build_odoo_client() -> OdooClient: + client = OdooClient( + url=settings.ODOO_URL, + database=settings.ODOO_DB_NAME, + username=settings.ODOO_USERNAME, + password=settings.ODOO_PASSWORD, + ) + client.authenticate() + return client + + +class Container(containers.DeclarativeContainer): + + # Infrastructure / external adapters + db_connection = providers.Singleton(PostgreSQLConnection) + + odoo_client = providers.Singleton(_build_odoo_client) + + # Repositories + contact_repository = providers.Factory( + SQLAlchemyContactRepository, + db_connection=db_connection, + ) + + product_repository = providers.Factory( + SQLAlchemyProductRepository, + db_connection=db_connection, + ) + + sale_order_repository = providers.Factory( + SQLAlchemySaleOrderRepository, + db_connection=db_connection, + ) + + sale_order_line_repository = providers.Factory( + SQLAlchemySaleOrderLineRepository, + db_connection=db_connection, + ) + + sync_run_repository = providers.Factory( + SQLAlchemySyncRunRepository, + db_connection=db_connection, + ) + + # Sync services (Odoo readers) + contact_sync_service = providers.Factory( + ContactSyncService, + odoo_client=odoo_client, + ) + + product_sync_service = providers.Factory( + ProductSyncService, + odoo_client=odoo_client, + ) + + sale_order_sync_service = providers.Factory( + SaleOrderSyncService, + odoo_client=odoo_client, + ) + + sale_order_line_sync_service = providers.Factory( + SaleOrderLineSyncService, + odoo_client=odoo_client, + ) + + # Use cases + contact_sync_use_case = providers.Factory( + SyncEntityUseCase, + operation_type="contacts", + source=contact_sync_service, + repository=contact_repository, + sync_run_repository=sync_run_repository, + ) + + product_sync_use_case = providers.Factory( + SyncEntityUseCase, + operation_type="products", + source=product_sync_service, + repository=product_repository, + sync_run_repository=sync_run_repository, + ) + + sale_order_sync_use_case = providers.Factory( + SyncEntityUseCase, + operation_type="sale_orders", + source=sale_order_sync_service, + repository=sale_order_repository, + sync_run_repository=sync_run_repository, + ) + + sale_order_line_sync_use_case = providers.Factory( + SyncEntityUseCase, + operation_type="sale_order_lines", + source=sale_order_line_sync_service, + repository=sale_order_line_repository, + sync_run_repository=sync_run_repository, + ) diff --git a/app/infrastructure/logging/__init__.py b/app/infrastructure/logging/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/infrastructure/odoo/__init__.py b/app/infrastructure/odoo/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/infrastructure/odoo/client.py b/app/infrastructure/odoo/client.py new file mode 100644 index 0000000..5255c09 --- /dev/null +++ b/app/infrastructure/odoo/client.py @@ -0,0 +1,167 @@ +import xmlrpc.client + +from app.infrastructure.odoo.constants import ( + ODOO_COMMON_ENDPOINT, + ODOO_OBJECT_ENDPOINT, +) + +from app.infrastructure.odoo.exceptions import ( + OdooAuthenticationError, + OdooConnectionError, +) + +class OdooClient: + + def __init__( + self, + url: str, + database: str, + username: str, + password: str, + ): + self.url = url + self.database = database + self.username = username + self.password = password + + self.uid = None + + self.common = xmlrpc.client.ServerProxy( + f"{url}{ODOO_COMMON_ENDPOINT}" + ) + + self.models = xmlrpc.client.ServerProxy( + f"{url}{ODOO_OBJECT_ENDPOINT}" + ) + + + def authenticate(self) -> int: + try: + uid = self.common.authenticate( + self.database, + self.username, + self.password, + {}, + ) + + except Exception as exc: + raise OdooConnectionError(str(exc)) + + + if not uid: + raise OdooAuthenticationError( + "Invalid Odoo credentials" + ) + + self.uid = uid + + return uid + + def get_contacts(self): + if not self.uid: + raise OdooAuthenticationError( + "Authenticate first" + ) + + contacts = self.models.execute_kw( + self.database, + self.uid, + self.password, + "res.partner", + "search_read", + [], + { + "fields": [ + "id", + "name", + "email", + "phone", + "mobile", + ] + }, + ) + + return contacts + + def get_products(self): + + if not self.uid: + raise OdooAuthenticationError( + "Authenticate first" + ) + + products = self.models.execute_kw( + self.database, + self.uid, + self.password, + "product.product", + "search_read", + [], + { + "fields": [ + "id", + "name", + "default_code", + "list_price", + "type", + ] + }, + ) + + return products + + def get_sale_orders(self): + + if not self.uid: + raise OdooAuthenticationError( + "Authenticate first" + ) + + sale_orders = self.models.execute_kw( + self.database, + self.uid, + self.password, + "sale.order", + "search_read", + [], + { + "fields": [ + "id", + "name", + "partner_id", + "date_order", + "state", + "amount_total", + ] + }, + ) + + return sale_orders + + def get_sale_order_lines(self): + + if not self.uid: + raise OdooAuthenticationError( + "Authenticate first" + ) + + sale_order_lines = self.models.execute_kw( + self.database, + self.uid, + self.password, + "sale.order.line", + "search_read", + [], + { + "fields": [ + "id", + "order_id", + "product_id", + "product_uom_qty", + "price_unit", + "price_subtotal", + ] + }, + ) + + return sale_order_lines \ No newline at end of file diff --git a/app/infrastructure/odoo/constants.py b/app/infrastructure/odoo/constants.py new file mode 100644 index 0000000..f401efb --- /dev/null +++ b/app/infrastructure/odoo/constants.py @@ -0,0 +1,2 @@ +ODOO_COMMON_ENDPOINT = "/xmlrpc/2/common" +ODOO_OBJECT_ENDPOINT = "/xmlrpc/2/object" diff --git a/app/infrastructure/odoo/exceptions.py b/app/infrastructure/odoo/exceptions.py new file mode 100644 index 0000000..79f98f3 --- /dev/null +++ b/app/infrastructure/odoo/exceptions.py @@ -0,0 +1,6 @@ +class OdooConnectionError(Exception): + pass + + +class OdooAuthenticationError(Exception): + pass \ No newline at end of file diff --git a/app/main.py b/app/main.py new file mode 100644 index 0000000..6e408fc --- /dev/null +++ b/app/main.py @@ -0,0 +1,34 @@ +from app.infrastructure.di_container import Container + + +def main() -> None: + container = Container() + + # Executed in FK-safe order: + # contacts -> products -> sale_orders -> sale_order_lines + use_cases = [ + container.contact_sync_use_case(), + container.product_sync_use_case(), + container.sale_order_sync_use_case(), + container.sale_order_line_sync_use_case(), + ] + + runs = [] + for use_case in use_cases: + run = use_case.execute() + runs.append(run) + print( + f"[{run.operation_type}] " + f"status={run.status.value} " + f"received={run.records_received} " + f"saved={run.records_saved} " + f"updated={run.records_updated} " + f"failed={run.records_failed}" + ) + + has_errors = any(run.records_failed > 0 for run in runs) + raise SystemExit(1 if has_errors else 0) + + +if __name__ == "__main__": + main() diff --git a/bookland/README.rst b/bookland/README.rst deleted file mode 100644 index 62d7ade..0000000 --- a/bookland/README.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. image:: https://odoo-community.org/readme-banner-image - :target: https://odoo-community.org/get-involved?utm_source=readme - :alt: Odoo Community Association - -============================================ -Book land a modern library management system -============================================ - -.. - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! This file is generated by oca-gen-addon-readme !! - !! changes will be overwritten. !! - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:6e9bd71f9df246f05e4bc098c4bf905387b718570abfb0c2ca222227f560fa69 - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - -.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png - :target: https://odoo-community.org/page/development-status - :alt: Beta -.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png - :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html - :alt: License: LGPL-3 -.. |badge3| image:: https://img.shields.io/badge/github-odoonix%2Feducation-lightgray.png?logo=github - :target: https://github.com/odoonix/education/tree/17.0/bookland - :alt: odoonix/education - -|badge1| |badge2| |badge3| - -این یک اپلیکشن برای مدیریت کتابخانه‌های دانشگاه است. - -در این نرم افزار شما امکانات متفاوتی خواهی داشت. - -**Table of contents** - -.. contents:: - :local: - -Changelog -========= - -نسخه ۱.۰.۰ -========== - -در این نسخه ساختار اولیه نرم افزار ایجاد شده و امکانات زیر ایجاد شده -است. - -- TODO: - -Bug Tracker -=========== - -Bugs are tracked on `GitHub Issues `_. -In case of trouble, please check there if your issue has already been reported. -If you spotted it first, help us to smash it by providing a detailed and welcomed -`feedback `_. - -Do not contact contributors directly about support or help with technical issues. - -Credits -======= - -Authors -------- - -* Odoonix - -Maintainers ------------ - -This module is part of the `odoonix/education `_ project on GitHub. - -You are welcome to contribute. diff --git a/bookland/__init__.py b/bookland/__init__.py deleted file mode 100644 index 38718f0..0000000 --- a/bookland/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from . import models -from . import controllers \ No newline at end of file diff --git a/bookland/__manifest__.py b/bookland/__manifest__.py deleted file mode 100644 index 8b724fc..0000000 --- a/bookland/__manifest__.py +++ /dev/null @@ -1,19 +0,0 @@ -# pylint: disable=W0104 - -{ - "name": "Book land a modern library management system", - "website": "https://github.com/odoonix/education", - "author": "Odoonix", - "license": "LGPL-3", - "depends":["website"], - "data": [ - # Security - "security/bookland_security.xml", - "security/ir.model.access.csv", - # Views - "views/books_template.xml", - "views/book_views.xml", - # Datas - "datas/menu_website.xml", - ], -} diff --git a/bookland/controllers/__init__.py b/bookland/controllers/__init__.py deleted file mode 100644 index deec4a8..0000000 --- a/bookland/controllers/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from . import main \ No newline at end of file diff --git a/bookland/controllers/main.py b/bookland/controllers/main.py deleted file mode 100644 index ec53c48..0000000 --- a/bookland/controllers/main.py +++ /dev/null @@ -1,12 +0,0 @@ -from odoo import http, _ -from odoo.http import request - -class BookController(http.Controller): - - @http.route('/books', type='http', auth="user", website=True) - def books_details(self): - book_ids =request.env['bookland.book'].sudo().search([]) - values = { - 'books': book_ids, - } - return request.render('bookland.books_details_template', values) \ No newline at end of file diff --git a/bookland/datas/menu_website.xml b/bookland/datas/menu_website.xml deleted file mode 100644 index 8818611..0000000 --- a/bookland/datas/menu_website.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - Books - /books - - 10 - - \ No newline at end of file diff --git a/bookland/docs/data-model-class-diagram.uxf b/bookland/docs/data-model-class-diagram.uxf deleted file mode 100644 index b56f3eb..0000000 --- a/bookland/docs/data-model-class-diagram.uxf +++ /dev/null @@ -1,58 +0,0 @@ -10UMLClass5051025090Book --- -+ title -+ price -+ ?? - ---UMLClass65048025090Partner -<<res.partner>> -UMLClass69066025090Language -<<res.lang>> -Relation290560420180book language - -lt=- - -r1=lang_id -m1=1..1 - -// r2=book_ids -m2=0..n - -400;160;10;10Relation290520380120Wirte -<<book_partner_auther_rel>> - -lt=- - -r1=author_ids -m1=1..n - -r2=book_ids -m2=0..n - -360;20;10;20UMLClass350260250110Loan -<<book.loan>> --- -+ date -+ expire_date -+ note ---Relation590310230190get a loan - -lt=- - -r1=loaner_id -m1=1..1 - -r2=loan_ids -m2=0..n - -170;170;10;10Relation140310230220give loan - -lt=- - -r1=book_id -m1=1..1 - -r2=loan_ids -m2=0..n - -10;200;210;10 \ No newline at end of file diff --git a/bookland/models/__init__.py b/bookland/models/__init__.py deleted file mode 100644 index 4696309..0000000 --- a/bookland/models/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from . import book -from . import book_tag diff --git a/bookland/models/book.py b/bookland/models/book.py deleted file mode 100644 index fa2f90b..0000000 --- a/bookland/models/book.py +++ /dev/null @@ -1,124 +0,0 @@ -import random - -from attr import field -import logging - -from odoo.exceptions import UserError, ValidationError -from odoo import fields, models, api, Command -from datetime import date - -_logger = logging.getLogger(__name__) - -class BooklandBook(models.Model): - # Model Attributes - _name = "bookland.book" - _inherit = ['image.mixin'] - _description = "Book" - - # Fields - name = fields.Char( - string="Book Title", - help="Store the title of the book", - translate=True, - required=True, - index=True, - size=512, - ) - - active = fields.Boolean(default="True") - - display_name = fields.Char( - string="Book Display Title", - translate=True, - ) - description = fields.Html( - # string="Description" - required=False, - translate=True, - index=False, - ) - publish_date = fields.Date(string="Publish") - - # time_to_market_date = { - # "type": "date", - # "name": "present_date", - # "note": "This is when the book is present to market" - # } - time_to_market_date = fields.Date(required=False) - - price = fields.Float( - string="Book Price", - ) - - age_in_days = fields.Integer( - string="Days Since Publish", - compute="_compute_age_in_days", # the function computed - store=True, - ) - - tag_ids = fields.Many2many("bookland.book.tag") - - @api.onchange("publish_date") - def _compute_age_in_days(self): - for record in self: - if record.publish_date: - delta = date.today() - record.publish_date - record.age_in_days = delta.days - else: - record.age_in_days = 0 - - @api.model - def action_create_random_book(self, *args, **kwargs): - self.env["bookland.book"].create({ - "name": "Name" + str(random.randint(0, 1500)), - "description": "", - "tag_ids": [Command.create({ - "name": "tag1" - })] - }) - - @api.model - def action_test_erro(self, *args, **kwargs): - # self.ensore_once() - raise UserError("There is something bad") - - @api.onchange('name') - def _onchange_name(self): - for record in self: - record.update({ - "display_name": f"Book {record.name}" - }) - # self.unlink() - - - # def _get_bookss_name(self, parents): - # names = parents.mapped('name') - # return names - - - def create(self,vals_list): - res = super().create(vals_list) - - grouped_result = self.read_group( - [], #domain - ['name', 'price:sum'], #fields - ['name'] #group_by - ) - - - # Search - # all_record = self.env['bookland.book'].search([],order='publish_date asc') - # names=self._get_bookss_name(all_record) - # record12 = self.env['bookland.book'].browse(1) - # for record in all_record: - # _logger.info(record.name) - # Logs vals_list - for val in vals_list: - _logger.info(val) - return res - - def write(self,vals_list): - res = super().write(vals_list) - for val in vals_list: - _logger.info(val) - return res \ No newline at end of file diff --git a/bookland/models/book_tag.py b/bookland/models/book_tag.py deleted file mode 100644 index d2f2d29..0000000 --- a/bookland/models/book_tag.py +++ /dev/null @@ -1,21 +0,0 @@ -import random - -from odoo.exceptions import UserError, ValidationError -from odoo import fields, models, api -from datetime import date - - -class BooklandBookTag(models.Model): - # Model Attributes - _name = "bookland.book.tag" - _description = "Book Tag" - - # Fields - name = fields.Char( - string="Book Title", - help="Store the title of the book", - translate=True, - required=True, - index=True, - size=512, - ) diff --git a/bookland/pyproject.toml b/bookland/pyproject.toml deleted file mode 100644 index 4231d0c..0000000 --- a/bookland/pyproject.toml +++ /dev/null @@ -1,3 +0,0 @@ -[build-system] -requires = ["whool"] -build-backend = "whool.buildapi" diff --git a/bookland/readme/DESCRIPTION.md b/bookland/readme/DESCRIPTION.md deleted file mode 100644 index 33ffcb1..0000000 --- a/bookland/readme/DESCRIPTION.md +++ /dev/null @@ -1,3 +0,0 @@ -این یک اپلیکشن برای مدیریت کتابخانه‌های دانشگاه است. - -در این نرم افزار شما امکانات متفاوتی خواهی داشت. \ No newline at end of file diff --git a/bookland/readme/HISTORY.md b/bookland/readme/HISTORY.md deleted file mode 100644 index 8c4627e..0000000 --- a/bookland/readme/HISTORY.md +++ /dev/null @@ -1,7 +0,0 @@ - - -# نسخه ۱.۰.۰ - -در این نسخه ساختار اولیه نرم افزار ایجاد شده و امکانات زیر ایجاد شده است. - -* TODO: \ No newline at end of file diff --git a/bookland/security/bookland_security.xml b/bookland/security/bookland_security.xml deleted file mode 100644 index 10a00b6..0000000 --- a/bookland/security/bookland_security.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Bookland Management - Manage books and related data. - 10 - - - - - Bookland Manager - - Users in this group can manage all books. - - - - Bookland User - - Users in this group can view and edit their own books. - - - - - Bookland: User can see own books - - - [('create_uid', '=', user.id)] - - - diff --git a/bookland/security/ir.model.access.csv b/bookland/security/ir.model.access.csv deleted file mode 100644 index 820992a..0000000 --- a/bookland/security/ir.model.access.csv +++ /dev/null @@ -1,4 +0,0 @@ -id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink -book_global_access,Book Global Access,model_bookland_book,bookland.group_bookland_user,1,1,1,0 -book_base_users_access,Book Global Access,model_bookland_book,base.group_system,1,1,1,1 -bookland_book_tag_users_access,bookland_book_tag Access,model_bookland_book_tag,base.group_user,1,1,1,1 diff --git a/bookland/static/description/index.html b/bookland/static/description/index.html deleted file mode 100644 index aacd0df..0000000 --- a/bookland/static/description/index.html +++ /dev/null @@ -1,429 +0,0 @@ - - - - - -README.rst - - - -
- - - -Odoo Community Association - -
-

Book land a modern library management system

- -

Beta License: LGPL-3 odoonix/education

-

این یک اپلیکشن برای مدیریت کتابخانه‌های دانشگاه است.

-

در این نرم افزار شما امکانات متفاوتی خواهی داشت.

-

Table of contents

- - -
-

نسخه ۱.۰.۰

-

در این نسخه ساختار اولیه نرم افزار ایجاد شده و امکانات زیر ایجاد شده -است.

-
    -
  • TODO:
  • -
-
-
-

Bug Tracker

-

Bugs are tracked on GitHub Issues. -In case of trouble, please check there if your issue has already been reported. -If you spotted it first, help us to smash it by providing a detailed and welcomed -feedback.

-

Do not contact contributors directly about support or help with technical issues.

-
-
-

Credits

-
-

Authors

-
    -
  • Odoonix
  • -
-
-
-

Maintainers

-

This module is part of the odoonix/education project on GitHub.

-

You are welcome to contribute.

-
-
-
-
- - diff --git a/bookland/views/book_views.xml b/bookland/views/book_views.xml deleted file mode 100644 index dc81963..0000000 --- a/bookland/views/book_views.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Book Form - bookland.book - -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Book List - bookland.book - - - - - - - - - - - book.search - bookland.book - - - - - - - - - - - - - - - - - Book List - bookland.book - tree,form - - - - - - Bookland - - - - - Books - - - - - -
diff --git a/bookland/views/books_template.xml b/bookland/views/books_template.xml deleted file mode 100644 index 0fa75e3..0000000 --- a/bookland/views/books_template.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - \ No newline at end of file diff --git a/bookland_account/README.rst b/bookland_account/README.rst deleted file mode 100644 index d76fd5f..0000000 --- a/bookland_account/README.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. image:: https://odoo-community.org/readme-banner-image - :target: https://odoo-community.org/get-involved?utm_source=readme - :alt: Odoo Community Association - -============================ -Book land accounting feature -============================ - -.. - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! This file is generated by oca-gen-addon-readme !! - !! changes will be overwritten. !! - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:aea4cf208e370fcf4ea7f54b5f62c2319c1c78e6263fdafba294eed37a30cd2e - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - -.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png - :target: https://odoo-community.org/page/development-status - :alt: Beta -.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png - :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html - :alt: License: LGPL-3 -.. |badge3| image:: https://img.shields.io/badge/github-odoonix%2Feducation-lightgray.png?logo=github - :target: https://github.com/odoonix/education/tree/17.0/bookland_account - :alt: odoonix/education - -|badge1| |badge2| |badge3| - -این ماژول امکانات حسابداری را اضافه می‌کند - -**Table of contents** - -.. contents:: - :local: - -Known issues / Roadmap -====================== - -V2.0.0 -====== - -- connect to invoice - -Changelog -========= - - - -Bug Tracker -=========== - -Bugs are tracked on `GitHub Issues `_. -In case of trouble, please check there if your issue has already been reported. -If you spotted it first, help us to smash it by providing a detailed and welcomed -`feedback `_. - -Do not contact contributors directly about support or help with technical issues. - -Credits -======= - -Authors -------- - -* Odoonix - -Maintainers ------------ - -This module is part of the `odoonix/education `_ project on GitHub. - -You are welcome to contribute. diff --git a/bookland_account/__manifest__.py b/bookland_account/__manifest__.py deleted file mode 100644 index f2fa465..0000000 --- a/bookland_account/__manifest__.py +++ /dev/null @@ -1,7 +0,0 @@ -# pylint: disable=W0104 -{ - "name": "Book land accounting feature", - "website": "https://github.com/odoonix/education", - "author": "Odoonix", - "license": "LGPL-3", -} diff --git a/bookland_account/pyproject.toml b/bookland_account/pyproject.toml deleted file mode 100644 index 4231d0c..0000000 --- a/bookland_account/pyproject.toml +++ /dev/null @@ -1,3 +0,0 @@ -[build-system] -requires = ["whool"] -build-backend = "whool.buildapi" diff --git a/bookland_account/readme/DESCRIPTION.md b/bookland_account/readme/DESCRIPTION.md deleted file mode 100644 index eae8616..0000000 --- a/bookland_account/readme/DESCRIPTION.md +++ /dev/null @@ -1 +0,0 @@ -این ماژول امکانات حسابداری را اضافه می‌کند \ No newline at end of file diff --git a/bookland_account/readme/ROADMAP.md b/bookland_account/readme/ROADMAP.md deleted file mode 100644 index 4f44150..0000000 --- a/bookland_account/readme/ROADMAP.md +++ /dev/null @@ -1,5 +0,0 @@ - - -# V2.0.0 - -- connect to invoice \ No newline at end of file diff --git a/bookland_account/static/description/index.html b/bookland_account/static/description/index.html deleted file mode 100644 index 4ee816a..0000000 --- a/bookland_account/static/description/index.html +++ /dev/null @@ -1,430 +0,0 @@ - - - - - -README.rst - - - -
- - - -Odoo Community Association - -
-

Book land accounting feature

- -

Beta License: LGPL-3 odoonix/education

-

این ماژول امکانات حسابداری را اضافه می‌کند

-

Table of contents

- - -
-

V2.0.0

-
    -
  • connect to invoice
  • -
-
- -
-

Bug Tracker

-

Bugs are tracked on GitHub Issues. -In case of trouble, please check there if your issue has already been reported. -If you spotted it first, help us to smash it by providing a detailed and welcomed -feedback.

-

Do not contact contributors directly about support or help with technical issues.

-
-
-

Credits

-
-

Authors

-
    -
  • Odoonix
  • -
-
-
-

Maintainers

-

This module is part of the odoonix/education project on GitHub.

-

You are welcome to contribute.

-
-
-
-
- - diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..1785f7e --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,116 @@ +services: + + # --- Odoo's own database --- + postgres: + image: postgres:16 + container_name: odoo_postgres + environment: + POSTGRES_DB: postgres + POSTGRES_USER: odoo + POSTGRES_PASSWORD: odoo + volumes: + - postgres_data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U odoo -d postgres"] + interval: 5s + timeout: 5s + retries: 10 + + # --- One-shot: create the Odoo database and install Sales --- + odoo_init: + image: odoo:17 + container_name: odoo_init + depends_on: + postgres: + condition: service_healthy + environment: + HOST: postgres + USER: odoo + PASSWORD: odoo + volumes: + - odoo_data:/var/lib/odoo + command: + - odoo + - -d + - odoo_test + - -i + - base,sale_management + - --without-demo=all + - --stop-after-init + restart: "no" + + # --- Odoo server --- + odoo: + image: odoo:17 + container_name: odoo_app + depends_on: + odoo_init: + condition: service_completed_successfully + ports: + - "8069:8069" + environment: + HOST: postgres + USER: odoo + PASSWORD: odoo + volumes: + - odoo_data:/var/lib/odoo + command: ["odoo", "--db-filter=^odoo_test$$"] + + # --- Sync target database --- + app_db: + image: postgres:16 + container_name: odoo_app_db + environment: + POSTGRES_DB: sync_db + POSTGRES_USER: sync + POSTGRES_PASSWORD: sync + volumes: + - app_db_data:/var/lib/postgresql/data + ports: + - "5433:5432" + healthcheck: + test: ["CMD-SHELL", "pg_isready -U sync -d sync_db"] + interval: 5s + timeout: 5s + retries: 10 + + # --- One-shot: seed test data into Odoo --- + odoo_seed: + build: . + container_name: odoo_seed + depends_on: + odoo: + condition: service_started + environment: + ODOO_URL: http://odoo:8069 + ODOO_DB_NAME: odoo_test + ODOO_USERNAME: admin + ODOO_PASSWORD: admin + command: ["python", "-m", "scripts.seed_odoo"] + restart: "no" + + # --- Backend: migrate + run the sync pipeline --- + backend: + build: . + container_name: odoo_backend + depends_on: + app_db: + condition: service_healthy + odoo_seed: + condition: service_completed_successfully + environment: + DATABASE_NAME: sync_db + DATABASE_USER: sync + DATABASE_PASSWORD: sync + DATABASE_HOST: app_db + DATABASE_PORT: "5432" + ODOO_URL: http://odoo:8069 + ODOO_DB_NAME: odoo_test + ODOO_USERNAME: admin + ODOO_PASSWORD: admin + restart: "no" + +volumes: + postgres_data: + odoo_data: + app_db_data: diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh new file mode 100644 index 0000000..a3ca531 --- /dev/null +++ b/docker/entrypoint.sh @@ -0,0 +1,8 @@ +#!/bin/sh +set -e + +echo ">> Applying database migrations (alembic upgrade head)..." +alembic upgrade head + +echo ">> Running sync pipeline..." +python -m app.main diff --git a/docs/TECHNICAL.md b/docs/TECHNICAL.md new file mode 100644 index 0000000..ea0e775 --- /dev/null +++ b/docs/TECHNICAL.md @@ -0,0 +1,75 @@ +# Technical Documentation + +## Architecture + +Clean / hexagonal architecture, dependencies point **inward**: + +| Layer | Contents | Depends on | +|---|---|---| +| **domain** | entities, repository interfaces, `IDBConnection` port | nothing | +| **application** | DTOs, mappers, sync services, use cases | domain | +| **infrastructure** | Odoo XML-RPC client, SQLAlchemy models/repos, DI container | domain + application | + +Flow of one sync run: + +``` +OdooClient ─▶ SyncService (fetch + map to entity) + │ + SyncEntityUseCase (upsert + error isolation + record run/logs) + │ + Repository (IDBConnection) ─▶ PostgreSQL +``` + +The **DI container** (`dependency-injector`) wires everything; `main.py` is the +composition root and orchestrator (runs the 4 use cases in FK-safe order). + +## Key design decisions + +- **Adapter separate from service** — Odoo access is isolated in `OdooClient` + (infrastructure). Swapping ERPs means writing one adapter; services/use cases + stay unchanged. +- **Repository pattern over a port** — repos depend on the `IDBConnection` + abstraction, not on SQLAlchemy directly. Swapping PostgreSQL for another DB + means one new adapter. +- **`odoo_id` as primary key** for the 4 synced tables — the source id *is* the + identity, so foreign keys line up directly without id translation. + `sync_runs` / `sync_logs` use their own auto-increment ids. +- **Idempotency (no duplicates)** — the use case looks up each record by + `odoo_id`; found → `update`, missing → `save`. Re-runs update in place. +- **Per-record error isolation** — each record is processed in its own + `try/except` and its own transaction. One failure is logged to `sync_logs` + and counted; the batch continues. A single error never rolls back the run. +- **Type hints + generic interfaces** throughout; enums for run status / log level. + +## Data model + +`contacts`, `products`, `sale_orders`, `sale_order_lines` (+ FKs: +`sale_orders.customer_id → contacts`, `sale_order_lines → sale_orders, products`). + +Observability: `sync_runs` (one row per operation: type, start/end, counts, +status) and `sync_logs` (per-error detail, FK → `sync_runs`, `ON DELETE CASCADE`). + +Schema is managed by **Alembic** migrations. + +## Defense notes + +- **One error → full rollback?** No. Per-record transactions, so other records + still commit. This matches the requirement to keep processing on failure. +- **Hundreds of thousands of orders?** Add pagination + batch reads on the Odoo + side, bulk upserts, and indexing; move to incremental sync by `write_date`. +- **Extensibility** — a new entity type = one service + one repository + one use + case provider; the generic `SyncEntityUseCase` is reused. + +## Testing strategy + +- **Unit** — entities, mappers, and the use case (error isolation, counting, + status) with fakes; repositories against in-memory SQLite. +- **Integration** — the full pipeline is validated end-to-end via + `docker compose up` (real Odoo + PostgreSQL). + +## Known limitations + +- No retry / pagination / incremental sync yet (single full pull per run). +- Odoo credentials are passed via environment; production should use a secrets + manager. +- `odoo_init` re-installs modules on every `up` (slower, but non-destructive). diff --git a/docs/USER.md b/docs/USER.md new file mode 100644 index 0000000..2c8783b --- /dev/null +++ b/docs/USER.md @@ -0,0 +1,73 @@ +# User Documentation + +## Prerequisites + +- Docker + Docker Compose + +## Run everything + +```bash +docker compose up --build +``` + +Startup order (handled automatically via healthchecks / dependencies): + +1. `postgres` — Odoo's database +2. `odoo_init` — creates the `odoo_test` DB and installs Sales *(first run: a few minutes)* +3. `odoo` — Odoo server +4. `odoo_seed` — inserts test data into Odoo (idempotent) +5. `app_db` — the sync target PostgreSQL +6. `odoo_backend` — runs `alembic upgrade head`, then the sync + +Success looks like this in the `odoo_backend` logs: + +``` +[contacts] status=success received=7 saved=7 failed=0 +[products] status=success received=5 saved=5 failed=0 +[sale_orders] status=success received=7 saved=7 failed=0 +[sale_order_lines] status=success received=12 saved=12 failed=0 +``` + +The backend is a batch job: it exits with code `0` when done (Odoo/DB keep running). + +## Verify the data + +```bash +docker compose exec app_db psql -U sync -d sync_db \ + -c "select operation_type, status, records_received, records_saved, records_updated from sync_runs order by id;" +``` + +Row counts: + +```bash +docker compose exec app_db psql -U sync -d sync_db \ + -c "select 'contacts', count(*) from contacts union all select 'products', count(*) from products union all select 'sale_orders', count(*) from sale_orders union all select 'sale_order_lines', count(*) from sale_order_lines;" +``` + +## Re-run (idempotency) + +```bash +docker compose up +``` + +The second run reports `updated` instead of `saved` — no duplicates are created. + +## Reset everything + +```bash +docker compose down -v # also removes the database volumes +``` + +## Run locally (without Docker) + +```bash +cp .env.example .env # point it at your Odoo + PostgreSQL +pip install -e . +alembic upgrade head +python -m app.main +``` + +## Ports + +- Odoo UI: http://localhost:8069 (login `admin` / `admin`) +- Sync target PostgreSQL: `localhost:5433` (user `sync`, db `sync_db`) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..4a84166 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[project] +name = "education" +version = "0.1.0" +description = "Odoo to PostgreSQL synchronization service" +readme = "README.md" +requires-python = ">=3.12" + +dependencies = [ + "SQLAlchemy==2.0.46", + "alembic==1.18.4", + "psycopg[binary]", + "pydantic==2.12.5", + "dependency-injector==4.48.3", + "pydantic-settings==2.13.1", + "python-dotenv", + "pytest", + "pytest-cov", +] + +[tool.setuptools] +packages = ["app"] + +[tool.setuptools.package-dir] +app = "app" + +[tool.pytest.ini_options] +testpaths = ["tests"] + +[tool.coverage.run] +source = ["app"] + +[build-system] +requires = ["setuptools>=61"] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/scripts/seed_odoo.py b/scripts/seed_odoo.py new file mode 100644 index 0000000..2c5cb9e --- /dev/null +++ b/scripts/seed_odoo.py @@ -0,0 +1,140 @@ +"""Seed the Odoo instance with test data (idempotent). + +Runs standalone and reads ODOO_* from the environment. Used by the +`odoo_seed` service so that `docker compose up` produces a populated +Odoo for the sync to read from. Safe to run repeatedly. +""" +import os +import time +import xmlrpc.client + + +ODOO_URL = os.getenv("ODOO_URL", "http://localhost:8069") +ODOO_DB = os.getenv("ODOO_DB_NAME", "odoo_test") +ODOO_USER = os.getenv("ODOO_USERNAME", "admin") +ODOO_PASSWORD = os.getenv("ODOO_PASSWORD", "admin") + + +CONTACTS = [ + {"name": "Ali Ahmadi", "email": "ali.ahmadi@test.com", + "phone": "+98 21 8877 0001", "mobile": "+98 912 345 6789"}, + {"name": "Reza Karimi", "email": "reza@test.com", + "phone": "+98 21 4411 2233", "mobile": "+98 912 333 4455"}, + {"name": "Sara Mohammadi", "email": "sara@test.com", + "phone": "+98 71 3222 3344", "mobile": "+98 912 999 8877"}, + {"name": "TechVision Co", "email": "info@techvision.test", + "phone": "+98 21 8877 6655", "mobile": "+98 912 123 4567"}, + {"name": "Pars Data Solutions", "email": "contact@parsdata.test", + "phone": "+98 71 3222 1144", "mobile": "+98 912 555 6677"}, +] + +PRODUCTS = [ + {"name": "Laptop Dell XPS", "default_code": "LAP-001", + "list_price": 2500.0, "type": "consu"}, + {"name": "Mechanical Keyboard", "default_code": "KEY-001", + "list_price": 120.0, "type": "consu"}, + {"name": "Wireless Mouse", "default_code": "MOU-001", + "list_price": 45.0, "type": "consu"}, + {"name": '27" Monitor', "default_code": "MON-001", + "list_price": 320.0, "type": "consu"}, + {"name": "USB-C Dock", "default_code": "DOC-001", + "list_price": 180.0, "type": "consu"}, +] + +# ref, customer email, [(product default_code, qty, unit_price), ...] +ORDERS = [ + {"ref": "SEED-1", "customer": "info@techvision.test", + "lines": [("LAP-001", 2, 2500.0), ("MOU-001", 3, 45.0)]}, + {"ref": "SEED-2", "customer": "contact@parsdata.test", + "lines": [("MON-001", 1, 320.0), ("KEY-001", 4, 120.0)]}, + {"ref": "SEED-3", "customer": "reza@test.com", + "lines": [("DOC-001", 5, 180.0)]}, +] + + +def wait_for_odoo(common, retries=60, delay=5): + for attempt in range(1, retries + 1): + try: + common.version() + print(f"Odoo reachable (attempt {attempt})") + return + except Exception as exc: + print(f"Waiting for Odoo... ({attempt}/{retries}): {exc}") + time.sleep(delay) + raise RuntimeError("Odoo did not become reachable in time") + + +def main(): + common = xmlrpc.client.ServerProxy(f"{ODOO_URL}/xmlrpc/2/common") + wait_for_odoo(common) + + uid = common.authenticate(ODOO_DB, ODOO_USER, ODOO_PASSWORD, {}) + if not uid: + raise RuntimeError("Odoo authentication failed") + + models = xmlrpc.client.ServerProxy(f"{ODOO_URL}/xmlrpc/2/object") + + def execute(model, method, *args): + return models.execute_kw( + ODOO_DB, uid, ODOO_PASSWORD, model, method, list(args) + ) + + def get_or_create(model, domain, values): + found = execute(model, "search", domain) + if found: + return found[0] + return execute(model, "create", values) + + # Installing sale_management with --without-demo does not add the admin + # user to the Sales group, so grant it before touching sale.order. + sales_group = models.execute_kw( + ODOO_DB, uid, ODOO_PASSWORD, + "ir.model.data", "search_read", + [[["name", "=", "group_sale_manager"], + ["module", "in", ["sales_team", "sale"]]]], + {"fields": ["res_id"], "limit": 1}, + ) + if sales_group: + execute("res.users", "write", + [uid], {"groups_id": [(4, sales_group[0]["res_id"])]}) + print("granted Sales group to admin") + + partner_ids = {} + for c in CONTACTS: + partner_ids[c["email"]] = get_or_create( + "res.partner", [["email", "=", c["email"]]], c + ) + print(f"contacts ready: {len(partner_ids)}") + + product_ids = {} + for p in PRODUCTS: + product_ids[p["default_code"]] = get_or_create( + "product.product", [["default_code", "=", p["default_code"]]], p + ) + print(f"products ready: {len(product_ids)}") + + created = 0 + for o in ORDERS: + if execute("sale.order", "search", + [["client_order_ref", "=", o["ref"]]]): + continue + order_lines = [ + (0, 0, { + "product_id": product_ids[code], + "product_uom_qty": qty, + "price_unit": price, + }) + for code, qty, price in o["lines"] + ] + execute("sale.order", "create", { + "partner_id": partner_ids[o["customer"]], + "client_order_ref": o["ref"], + "order_line": order_lines, + }) + created += 1 + print(f"sale orders created this run: {created}") + print("Seed complete.") + + +if __name__ == "__main__": + main() diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/application/mappers/test_mappers.py b/tests/application/mappers/test_mappers.py new file mode 100644 index 0000000..244a977 --- /dev/null +++ b/tests/application/mappers/test_mappers.py @@ -0,0 +1,69 @@ +from datetime import datetime +from decimal import Decimal + +from app.application.dto.contact_dto import ContactDTO +from app.application.dto.product_dto import ProductDTO +from app.application.dto.sale_order_dto import SaleOrderDTO +from app.application.dto.sale_order_line_dto import SaleOrderLineDTO +from app.application.mappers.contact_mapper import ContactMapper +from app.application.mappers.product_mapper import ProductMapper +from app.application.mappers.sale_order_mapper import SaleOrderMapper +from app.application.mappers.sale_order_line_mapper import SaleOrderLineMapper +from app.domain.entities.contact import Contact +from app.domain.entities.product import Product +from app.domain.entities.sale_order import SaleOrder +from app.domain.entities.sale_order_line import SaleOrderLine + + +def test_contact_mapper_to_entity(): + dto = ContactDTO(odoo_id=1, name="Ali", email="a@x.com", + phone="021", mobile="0912") + entity = ContactMapper.to_entity(dto) + + assert isinstance(entity, Contact) + assert entity.odoo_id == 1 + assert entity.name == "Ali" + assert entity.email == "a@x.com" + assert entity.phone == "021" + assert entity.mobile == "0912" + + +def test_product_mapper_to_entity(): + dto = ProductDTO(odoo_id=2, name="Laptop", internal_reference="LAP-001", + sale_price=Decimal("2500.00"), product_type="consu") + entity = ProductMapper.to_entity(dto) + + assert isinstance(entity, Product) + assert entity.odoo_id == 2 + assert entity.internal_reference == "LAP-001" + assert entity.sale_price == Decimal("2500.00") + assert entity.product_type == "consu" + + +def test_sale_order_mapper_to_entity(): + dt = datetime(2026, 7, 24, 10, 0, 0) + dto = SaleOrderDTO(odoo_id=3, order_number="S00001", customer_id=7, + order_date=dt, state="sale", + total_amount=Decimal("100.00")) + entity = SaleOrderMapper.to_entity(dto) + + assert isinstance(entity, SaleOrder) + assert entity.order_number == "S00001" + assert entity.customer_id == 7 + assert entity.order_date == dt + assert entity.state == "sale" + assert entity.total_amount == Decimal("100.00") + + +def test_sale_order_line_mapper_to_entity(): + dto = SaleOrderLineDTO(odoo_id=4, sale_order_id=3, product_id=2, + quantity=2.0, unit_price=Decimal("50.00"), + subtotal=Decimal("100.00")) + entity = SaleOrderLineMapper.to_entity(dto) + + assert isinstance(entity, SaleOrderLine) + assert entity.sale_order_id == 3 + assert entity.product_id == 2 + assert entity.quantity == 2.0 + assert entity.unit_price == Decimal("50.00") + assert entity.subtotal == Decimal("100.00") diff --git a/tests/application/use_cases/test_sync_entity_use_case.py b/tests/application/use_cases/test_sync_entity_use_case.py new file mode 100644 index 0000000..6f40ab8 --- /dev/null +++ b/tests/application/use_cases/test_sync_entity_use_case.py @@ -0,0 +1,153 @@ +from dataclasses import dataclass + +from app.application.use_cases.sync_entity_use_case import SyncEntityUseCase +from app.domain.entities.sync_run import SyncStatus +from app.domain.entities.sync_log import SyncLogLevel + + +@dataclass +class FakeEntity: + odoo_id: int + + +class FakeSource: + def __init__(self, entities=None, error=None): + self._entities = entities or [] + self._error = error + + def sync(self): + if self._error: + raise self._error + return self._entities + + +class FakeEntityRepo: + def __init__(self, existing_ids=(), fail_on=()): + self.saved = [] + self.updated = [] + self._existing = set(existing_ids) + self._fail_on = set(fail_on) + + def get_by_odoo_id(self, odoo_id): + return FakeEntity(odoo_id) if odoo_id in self._existing else None + + def save(self, entity): + if entity.odoo_id in self._fail_on: + raise ValueError(f"save failed for {entity.odoo_id}") + self.saved.append(entity.odoo_id) + + def update(self, entity): + if entity.odoo_id in self._fail_on: + raise ValueError(f"update failed for {entity.odoo_id}") + self.updated.append(entity.odoo_id) + + +class FakeSyncRunRepo: + def __init__(self): + self.logs = [] + self.finished = None + self._seq = 0 + + def create(self, run): + self._seq += 1 + run.id = self._seq + return run + + def finish(self, run): + self.finished = run + + def add_log(self, log): + self.logs.append(log) + + +def _use_case(source, repo, run_repo): + return SyncEntityUseCase("contacts", source, repo, run_repo) + + +def test_all_new_records_are_saved(): + repo = FakeEntityRepo() + run = _use_case( + FakeSource([FakeEntity(1), FakeEntity(2), FakeEntity(3)]), + repo, + FakeSyncRunRepo(), + ).execute() + + assert run.records_received == 3 + assert run.records_saved == 3 + assert run.records_updated == 0 + assert run.records_failed == 0 + assert run.status == SyncStatus.SUCCESS + assert repo.saved == [1, 2, 3] + + +def test_existing_records_are_updated_not_duplicated(): + repo = FakeEntityRepo(existing_ids={1, 3}) + run = _use_case( + FakeSource([FakeEntity(1), FakeEntity(2), FakeEntity(3)]), + repo, + FakeSyncRunRepo(), + ).execute() + + assert run.records_saved == 1 + assert run.records_updated == 2 + assert run.status == SyncStatus.SUCCESS + assert repo.saved == [2] + assert repo.updated == [1, 3] + + +def test_record_error_is_isolated_logged_and_processing_continues(): + repo = FakeEntityRepo(fail_on={2}) + run_repo = FakeSyncRunRepo() + run = _use_case( + FakeSource([FakeEntity(1), FakeEntity(2), FakeEntity(3), FakeEntity(4)]), + repo, + run_repo, + ).execute() + + assert run.records_received == 4 + assert run.records_saved == 3 + assert run.records_failed == 1 + assert run.status == SyncStatus.PARTIAL + # record 4 was processed even though record 2 failed + assert repo.saved == [1, 3, 4] + assert len(run_repo.logs) == 1 + assert run_repo.logs[0].odoo_id == 2 + assert run_repo.logs[0].level == SyncLogLevel.ERROR + + +def test_all_records_failing_yields_failed_status(): + repo = FakeEntityRepo(fail_on={1, 2}) + run_repo = FakeSyncRunRepo() + run = _use_case( + FakeSource([FakeEntity(1), FakeEntity(2)]), + repo, + run_repo, + ).execute() + + assert run.records_failed == 2 + assert run.records_saved == 0 + assert run.status == SyncStatus.FAILED + assert len(run_repo.logs) == 2 + + +def test_empty_source_is_success(): + run = _use_case( + FakeSource([]), FakeEntityRepo(), FakeSyncRunRepo() + ).execute() + + assert run.records_received == 0 + assert run.status == SyncStatus.SUCCESS + + +def test_fetch_failure_fails_the_run_and_is_logged(): + run_repo = FakeSyncRunRepo() + run = _use_case( + FakeSource(error=RuntimeError("odoo down")), + FakeEntityRepo(), + run_repo, + ).execute() + + assert run.status == SyncStatus.FAILED + assert run.records_received == 0 + assert len(run_repo.logs) == 1 + assert run_repo.logs[0].level == SyncLogLevel.ERROR diff --git a/tests/domain/entities/test_contact.py b/tests/domain/entities/test_contact.py new file mode 100644 index 0000000..50d565c --- /dev/null +++ b/tests/domain/entities/test_contact.py @@ -0,0 +1,18 @@ +from app.domain.entities.contact import Contact + + +def test_create_contact(): + contact = Contact( + odoo_id=1, + name="Ali Ahmadi", + email="ali@example.com", + phone="02112345678", + mobile="09121234567", + ) + + assert contact.odoo_id == 1 + assert contact.name == "Ali Ahmadi" + assert contact.email == "ali@example.com" + assert contact.phone == "02112345678" + assert contact.mobile == "09121234567" + \ No newline at end of file diff --git a/tests/domain/entities/test_product.py b/tests/domain/entities/test_product.py new file mode 100644 index 0000000..14899e5 --- /dev/null +++ b/tests/domain/entities/test_product.py @@ -0,0 +1,19 @@ +from decimal import Decimal + +from app.domain.entities.product import Product + + +def test_create_product(): + product = Product( + odoo_id=10, + name="Laptop Dell", + internal_reference="LAP-001", + sale_price=Decimal("1500.00"), + product_type="product", + ) + + assert product.odoo_id == 10 + assert product.name == "Laptop Dell" + assert product.internal_reference == "LAP-001" + assert product.sale_price == Decimal("1500.00") + assert product.product_type == "product" diff --git a/tests/domain/entities/test_sale_order_line.py b/tests/domain/entities/test_sale_order_line.py new file mode 100644 index 0000000..777a75f --- /dev/null +++ b/tests/domain/entities/test_sale_order_line.py @@ -0,0 +1,21 @@ +from decimal import Decimal + +from app.domain.entities.sale_order_line import SaleOrderLine + + +def test_create_sale_order_line(): + line = SaleOrderLine( + odoo_id=500, + sale_order_id=100, + product_id=10, + quantity=2, + unit_price=Decimal("100.00"), + subtotal=Decimal("200.00"), + ) + + assert line.odoo_id == 500 + assert line.sale_order_id == 100 + assert line.product_id == 10 + assert line.quantity == 2 + assert line.unit_price == Decimal("100.00") + assert line.subtotal == Decimal("200.00") \ No newline at end of file diff --git a/tests/domain/entities/test_sale_roder.py b/tests/domain/entities/test_sale_roder.py new file mode 100644 index 0000000..1476152 --- /dev/null +++ b/tests/domain/entities/test_sale_roder.py @@ -0,0 +1,22 @@ +from datetime import datetime +from decimal import Decimal + +from app.domain.entities.sale_order import SaleOrder + + +def test_create_sale_order(): + order = SaleOrder( + odoo_id=100, + order_number="SO0001", + customer_id=1, + order_date=datetime(2026, 7, 23), + state="sale", + total_amount=Decimal("2000.00"), + ) + + assert order.odoo_id == 100 + assert order.order_number == "SO0001" + assert order.customer_id == 1 + assert order.state == "sale" + assert order.total_amount == Decimal("2000.00") + \ No newline at end of file diff --git a/tests/domain/entities/test_sync_log.py b/tests/domain/entities/test_sync_log.py new file mode 100644 index 0000000..c77c703 --- /dev/null +++ b/tests/domain/entities/test_sync_log.py @@ -0,0 +1,17 @@ +from app.domain.entities.sync_log import SyncLog, SyncLogLevel + + +def test_create_sync_log(): + log = SyncLog( + sync_run_id=1, + level=SyncLogLevel.ERROR, + message="failed to save record", + odoo_id=42, + ) + + assert log.sync_run_id == 1 + assert log.level == SyncLogLevel.ERROR + assert log.message == "failed to save record" + assert log.odoo_id == 42 + assert log.created_at is None + assert log.id is None diff --git a/tests/domain/entities/test_sync_run.py b/tests/domain/entities/test_sync_run.py new file mode 100644 index 0000000..6e3059d --- /dev/null +++ b/tests/domain/entities/test_sync_run.py @@ -0,0 +1,21 @@ +from datetime import datetime + +from app.domain.entities.sync_run import SyncRun, SyncStatus + + +def test_create_sync_run(): + started = datetime(2026, 7, 24, 10, 0, 0) + run = SyncRun( + operation_type="contacts", + started_at=started, + ) + + assert run.operation_type == "contacts" + assert run.started_at == started + assert run.status == SyncStatus.RUNNING + assert run.records_received == 0 + assert run.records_saved == 0 + assert run.records_updated == 0 + assert run.records_failed == 0 + assert run.finished_at is None + assert run.id is None diff --git a/tests/infrastructure/database/repositories/test_repositories.py b/tests/infrastructure/database/repositories/test_repositories.py new file mode 100644 index 0000000..9935fef --- /dev/null +++ b/tests/infrastructure/database/repositories/test_repositories.py @@ -0,0 +1,166 @@ +from datetime import datetime +from decimal import Decimal + +import pytest +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from sqlalchemy.pool import StaticPool + +import app.infrastructure.database.models # noqa: F401 (register metadata) +from app.infrastructure.database.models.base import Base +from app.infrastructure.database.models.sync_run import SyncRunModel +from app.infrastructure.database.models.sync_log import SyncLogModel +from app.domain.entities.contact import Contact +from app.domain.entities.product import Product +from app.domain.entities.sale_order import SaleOrder +from app.domain.entities.sale_order_line import SaleOrderLine +from app.domain.entities.sync_run import SyncRun, SyncStatus +from app.domain.entities.sync_log import SyncLog, SyncLogLevel +from app.infrastructure.database.repositories.contact_repository import ( + SQLAlchemyContactRepository, +) +from app.infrastructure.database.repositories.product_repository import ( + SQLAlchemyProductRepository, +) +from app.infrastructure.database.repositories.sale_order_repository import ( + SQLAlchemySaleOrderRepository, +) +from app.infrastructure.database.repositories.sale_order_line_repository import ( + SQLAlchemySaleOrderLineRepository, +) +from app.infrastructure.database.repositories.sync_run_repository import ( + SQLAlchemySyncRunRepository, +) + + +class InMemoryConnection: + """Test double for IDBConnection backed by shared in-memory SQLite.""" + + def __init__(self): + self._engine = create_engine( + "sqlite://", + connect_args={"check_same_thread": False}, + poolclass=StaticPool, + ) + Base.metadata.create_all(self._engine) + self._session_factory = sessionmaker(bind=self._engine) + + def get_session(self): + return self._session_factory() + + def get_session_generator(self): + session = self.get_session() + try: + yield session + finally: + session.close() + + def dispose(self): + self._engine.dispose() + + +@pytest.fixture +def db(): + conn = InMemoryConnection() + yield conn + conn.dispose() + + +def test_contact_repository_save_get_update(db): + repo = SQLAlchemyContactRepository(db) + + assert repo.get_by_odoo_id(1) is None + + repo.save(Contact(odoo_id=1, name="Ali", email="a@x.com", + phone="021", mobile="0912")) + assert repo.get_by_odoo_id(1) == Contact( + odoo_id=1, name="Ali", email="a@x.com", phone="021", mobile="0912" + ) + + repo.update(Contact(odoo_id=1, name="Ali Updated", email="new@x.com", + phone="022", mobile="0913")) + updated = repo.get_by_odoo_id(1) + assert updated.name == "Ali Updated" + assert updated.email == "new@x.com" + + +def test_product_repository_save_get_update(db): + repo = SQLAlchemyProductRepository(db) + + repo.save(Product(odoo_id=1, name="Laptop", internal_reference="LAP-001", + sale_price=Decimal("2500.00"), product_type="consu")) + product = repo.get_by_odoo_id(1) + assert product.name == "Laptop" + assert product.sale_price == Decimal("2500.00") + + repo.update(Product(odoo_id=1, name="Laptop v2", + internal_reference="LAP-001", + sale_price=Decimal("2600.00"), product_type="consu")) + assert repo.get_by_odoo_id(1).sale_price == Decimal("2600.00") + + +def test_sale_order_repository_save_get_update(db): + repo = SQLAlchemySaleOrderRepository(db) + dt = datetime(2026, 7, 24, 10, 0, 0) + + repo.save(SaleOrder(odoo_id=1, order_number="S00001", customer_id=7, + order_date=dt, state="sale", + total_amount=Decimal("100.00"))) + order = repo.get_by_odoo_id(1) + assert order.order_number == "S00001" + assert order.state == "sale" + + repo.update(SaleOrder(odoo_id=1, order_number="S00001", customer_id=7, + order_date=dt, state="done", + total_amount=Decimal("100.00"))) + assert repo.get_by_odoo_id(1).state == "done" + + +def test_sale_order_line_repository_save_get_update(db): + repo = SQLAlchemySaleOrderLineRepository(db) + + repo.save(SaleOrderLine(odoo_id=1, sale_order_id=10, product_id=20, + quantity=2.0, unit_price=Decimal("50.00"), + subtotal=Decimal("100.00"))) + line = repo.get_by_odoo_id(1) + assert line.sale_order_id == 10 + assert line.quantity == 2.0 + + repo.update(SaleOrderLine(odoo_id=1, sale_order_id=10, product_id=20, + quantity=5.0, unit_price=Decimal("50.00"), + subtotal=Decimal("250.00"))) + assert repo.get_by_odoo_id(1).quantity == 5.0 + + +def test_sync_run_repository_lifecycle(db): + repo = SQLAlchemySyncRunRepository(db) + + run = repo.create(SyncRun(operation_type="contacts", + started_at=datetime.now())) + assert run.id is not None + + repo.add_log(SyncLog(sync_run_id=run.id, level=SyncLogLevel.ERROR, + message="boom", odoo_id=42)) + + run.records_received = 5 + run.records_saved = 4 + run.records_failed = 1 + run.finished_at = datetime.now() + run.status = SyncStatus.PARTIAL + repo.finish(run) + + session = db.get_session() + model = session.get(SyncRunModel, run.id) + assert model.status == "partial" + assert model.records_failed == 1 + assert model.finished_at is not None + + logs = ( + session.query(SyncLogModel) + .filter_by(sync_run_id=run.id) + .all() + ) + assert len(logs) == 1 + assert logs[0].level == "error" + assert logs[0].odoo_id == 42 + session.close()