[MIG] base_import_odoo

.travis.yml

@@ -25,14 +25,16 @@ env:
   matrix:
   - LINT_CHECK="1"
   - TRANSIFEX="1"
-  - TESTS="1" ODOO_REPO="odoo/odoo" EXCLUDE="database_cleanup,auth_session_timeout,auth_brute_force"
-  - TESTS="1" ODOO_REPO="OCA/OCB" EXCLUDE="database_cleanup,auth_session_timeout,auth_brute_force"
+  - TESTS="1" ODOO_REPO="odoo/odoo" EXCLUDE="database_cleanup,auth_session_timeout,auth_brute_force,base_import_odoo"
+  - TESTS="1" ODOO_REPO="OCA/OCB" EXCLUDE="database_cleanup,auth_session_timeout,auth_brute_force,base_import_odoo"
   - TESTS="1" ODOO_REPO="odoo/odoo" INCLUDE="database_cleanup"
   - TESTS="1" ODOO_REPO="OCA/OCB" INCLUDE="database_cleanup"
   - TESTS="1" ODOO_REPO="odoo/odoo" INCLUDE="auth_session_timeout"
   - TESTS="1" ODOO_REPO="OCA/OCB" INCLUDE="auth_session_timeout"
   - TESTS="1" ODOO_REPO="odoo/odoo" INCLUDE="auth_brute_force"
   - TESTS="1" ODOO_REPO="OCA/OCB" INCLUDE="auth_brute_force"
+  - TESTS="1" ODOO_REPO="odoo/odoo" INCLUDE="base_import_odoo"
+  - TESTS="1" ODOO_REPO="OCA/OCB" INCLUDE="base_import_odoo"
 
 virtualenv:
   system_site_packages: true

base_import_odoo/CONFIGURE.rst

@@ -0,0 +1,17 @@
+Go to Settings / Remote Odoo import / Import configurations and create a configuration.
+
+After filling in your credentials, select models you want to import from the remote database. If you only want to import a subset of the records, add an appropriate domain.
+
+The import will copy records of all models listed, and handle links to records of models which are not imported depending on the existing field mappings. Field mappings to local records also are a stopping condition. Without those, the import will have to create some record for all required x2x fields, which you probably don't want.
+
+Probably you'll want to map records of model ``res.company``, and at least the admin user.
+
+The module doesn't import one2many fields, if you want to have those, add the model the field in question points to to the list of imported models, possibly with a domain.
+
+If you don't fill in a remote ID, the addon will use the configured local ID for every record of the model (this way, you can for example map all users in the remote system to some import user in the current system).
+
+For fields that have a uniqueness constraint (like ``res.users#login``), create a field mapping if type ``unique``, then the import will generate a unique value for this field.
+
+For models using references with two fields (like ``ir.attachment``), create a field mapping of type ``by reference`` and select the two fields involved. The import will transform known ids (=ids of models you import) to the respective local id, and clean out the model/id fields for unknown models/ids.
+
+You can add custom defaults per model in case your database has different required fields than the source database. For ``res.partner``, you'll most certainly fill in ``{'name': '/'}`` or somethign similar.

base_import_odoo/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Holger Brunn <hbrunn@therp.nl>

base_import_odoo/DESCRIPTION.rst

@@ -0,0 +1,8 @@
+This module was written to import data from another Odoo database. The idea is that you define which models to import from the other database, and add eventual mappings for records you don't want to import.
+
+Use cases
+=========
+
+- merging databases
+- one way sync
+- aggregating management data from distributed systems

base_import_odoo/README.rst

@@ -1,98 +1 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-    :alt: License: AGPL-3
-
-================================
-Import from remote Odoo database
-================================
-
-This module was written to import data from another Odoo database. The idea is that you define which models to import from the other database, and add eventual mappings for records you don't want to import.
-
-Use cases
-=========
-
-- merging databases
-- one way sync
-- aggregating management data from distributed systems
-
-
-Configuration
-=============
-
-Go to Settings / Remote Odoo import / Import configurations and create a configuration.
-
-After filling in your credentials, select models you want to import from the remote database. If you only want to import a subset of the records, add an appropriate domain.
-
-The import will copy records of all models listed, and handle links to records of models which are not imported depending on the existing field mappings. Field mappings to local records also are a stopping condition. Without those, the import will have to create some record for all required x2x fields, which you probably don't want.
-
-Probably you'll want to map records of model `res.company`, and at least the admin user.
-
-The module doesn't import one2many fields, if you want to have those, add the model the field in question points to to the list of imported models, possibly with a domain.
-
-If you don't fill in a remote ID, the addon will use the configured local ID for every record of the model (this way, you can for example map all users in the remote system to some import user in the current system).
-
-For fields that have a uniqueness constraint (like `res.users#login`), create a field mapping if type `unique`, then the import will generate a unique value for this field.
-
-For models using references with two fields (like `ir.attachment`), create a field mapping of type `by reference` and select the two fields involved. The import will transform known ids (=ids of models you import) to the respective local id, and clean out the model/id fields for unknown models/ids.
-
-Usage
-=====
-
-To use this module, you need to:
-
-#. go to an import configuration and hit the button ``Run import``
-#. be patient, this creates a cronjob which will start up to a minutes afterwards
-#. reload the form, as soon as the cronjob runs you'll see a field ``Progress`` that lets you inspect what was imported already
-#. note that the cronjob also resets the password as soon as it has read it. So for a subsequent import, you'll have to fill it in again
-#. running an import a second time won't duplicate data, it should recognize records imported earlier and just update them
-
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-    :alt: Try me on Runbot
-    :target: https://runbot.odoo-community.org/runbot/149/8.0
-
-Known issues / Roadmap
-======================
-
-* Yes of course this duplicates a lot of connector functionality. Rewrite this with the connector framework, probably collaborate with https://github.com/OCA/connector-odoo2odoo
-* Do something with workflows
-* Support reference fields, while being at it refactor _run_import_map_values to call a function per field type
-* Probably it's safer and faster to disable recomputation during import, and recompute all fields afterwards
-* Add duplicate handling strategy 'Overwrite older'
-
-Bug Tracker
-===========
-
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
-check there if your issue has already been reported. If you spotted it first,
-help us smashing it by providing a detailed and welcomed feedback.
-
-Credits
-=======
-
-Images
-------
-
-* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
-
-Contributors
-------------
-
-* Holger Brunn <hbrunn@therp.nl>
-
-Do not contact contributors directly about help with questions or problems concerning this addon, but use the `community mailing list <mailto:community@mail.odoo.com>`_ or the `appropriate specialized mailinglist <https://odoo-community.org/groups>`_ for help, and the bug tracker linked in `Bug Tracker`_ above for technical issues.
-
-Maintainer
-----------
-
-.. image:: https://odoo-community.org/logo.png
-   :alt: Odoo Community Association
-   :target: https://odoo-community.org
-
-This module is maintained by the OCA.
-
-OCA, or the Odoo Community Association, is a nonprofit organization whose
-mission is to support the collaborative development of Odoo features and
-promote its widespread use.
-
-To contribute to this module, please visit https://odoo-community.org.
+/

base_import_odoo/ROADMAP.rst

@@ -0,0 +1,5 @@
+* Yes of course this duplicates a lot of connector functionality. Rewrite this with the connector framework, probably collaborate with https://github.com/OCA/connector-odoo2odoo
+* Do something with workflows
+* Support reference fields, while being at it refactor _run_import_map_values to call a function per field type
+* Probably it's safer and faster to disable recomputation during import, and recompute all fields afterwards
+* Add duplicate handling strategy 'Overwrite older'

base_import_odoo/USAGE.rst

@@ -0,0 +1,7 @@
+To use this module, you need to:
+
+#. go to an import configuration and hit the button ``Run import``
+#. be patient, this creates a cronjob which will start up to a minutes afterwards
+#. reload the form, as soon as the cronjob runs you'll see a field ``Progress`` that lets you inspect what was imported already
+#. note that the cronjob also resets the password as soon as it has read it. So for a subsequent import, you'll have to fill it in again
+#. running an import a second time won't duplicate data, it should recognize records imported earlier and just update them

base_import_odoo/__init__.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 from . import models

base_import_odoo/__openerp__.py → base_import_odoo/__manifest__.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 {
     "name": "Import from Odoo",
-    "version": "8.0.1.0.1",
+    "version": "10.0.1.0.0",
     "author": "Therp BV,Odoo Community Association (OCA)",
     "license": "AGPL-3",
     "category": "Tools",
     "summary": "Import records from another Odoo instance",
+    "website": "https://github.com/OCA/server-tools",
     "depends": [
         'mail',
     ],

base_import_odoo/demo/import_odoo_database.xml

@@ -1,11 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data noupdate="1">
+<odoo noupdate="1">
     <record id="demodb" model="import.odoo.database">
         <field name="url">http://localhost:8069</field>
         <field name="database">demodb</field>
         <field name="user">admin</field>
         <field name="password" eval="False" />
     </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/demo/import_odoo_database_field.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data noupdate="1">
+<odoo noupdate="1">
     <record id="mapping_partner_id_root" model="import.odoo.database.field">
         <field name="database_id" ref="demodb" />
         <field name="mapping_type">fixed</field>
@@ -68,5 +67,4 @@
         <field name="model_field_id" ref="base.field_ir_attachment_res_model" />
         <field name="id_field_id" ref="base.field_ir_attachment_res_id" />
     </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/demo/import_odoo_database_model.xml

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data noupdate="1">
+<odoo noupdate="1">
     <record id="model_partner" model="import.odoo.database.model">
         <field name="sequence">1</field>
         <field name="model_id" ref="base.model_res_partner" />
         <field name="database_id" ref="demodb" />
         <field name="domain">[(1, '=', 1)]</field>
+        <field name="defaults">{'name': '/'}</field>
     </record>
     <record id="model_alias" model="import.odoo.database.model">
         <field name="sequence">2</field>
@@ -31,5 +31,4 @@
         <field name="database_id" ref="demodb" />
         <field name="domain">[('res_model', 'in', ['res.users'])]</field>
     </record>
-     </data>
-</openerp>
+</odoo>

base_import_odoo/demo/ir_attachment.xml

@@ -1,11 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data>
+<odoo>
     <record id="attachment_demo" model="ir.attachment">
         <field name="name">Demo attachment</field>
         <field name="res_model">res.users</field>
         <field name="res_id" ref="base.user_demo" />
         <field name="datas">aGVsbG8gd29ybGQK</field>
     </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/demo/res_partner.xml

@@ -1,8 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data>
+<odoo>
     <record id="base.res_partner_1" model="res.partner">
         <field name="user_id" ref="base.user_demo" />
     </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/demo/res_users.xml

@@ -1,9 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data noupdate="1">
+<odoo noupdate="1">
     <record id="mapped_admin" model="res.users" context="{'no_reset_password': True}">
         <field name="name">Mapped admin</field>
         <field name="login">mapped_admin</field>
     </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/models/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-from . import ir_model_data
 from . import import_odoo_database
-from . import import_odoo_database_model
 from . import import_odoo_database_field
+from . import import_odoo_database_model
+from . import ir_model_data

base_import_odoo/models/import_odoo_database.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 import logging
 try:
@@ -11,7 +11,8 @@ except ImportError:  # pragma: no cover
 import psycopg2
 import traceback
 from urlparse import urlparse
-from openerp import _, api, exceptions, fields, models, tools
+from odoo import _, api, exceptions, fields, models, tools
+from odoo.tools.safe_eval import safe_eval
 from collections import namedtuple
 _logger = logging.getLogger('base_import_odoo')
 
@@ -86,11 +87,20 @@ class ImportOdooDatabase(models.Model):
             'cronjob_id': self._create_cronjob().id,
         })
 
+    @api.model
+    def _run_import_cron(self, ids):
+        return self.browse(ids)._run_import()
+
     @api.multi
     def _run_import(self, commit=True, commit_threshold=100):
         """Run the import as cronjob, commit often"""
         self.ensure_one()
         if not self.password:
+            self.write({
+                'status_data': dict(
+                    self.status_data, error='No password provided',
+                ),
+            })
             return
         # model name: [ids]
         remote_ids = {}
@@ -118,7 +128,7 @@ class ImportOdooDatabase(models.Model):
             model = model_line.model_id
             remote_ids[model.model] = remote.execute(
                 model.model, 'search',
-                tools.safe_eval(model_line.domain) if model_line.domain else []
+                safe_eval(model_line.domain) if model_line.domain else []
             )
             remote_counts[model.model] = len(remote_ids[model.model])
         self.write({
@@ -210,6 +220,21 @@ class ImportOdooDatabase(models.Model):
             self.id, model._name.replace('.', '_'), _id or 0,
         )
         record = self._create_record_filter_fields(model, record)
+        model_defaults = {}
+        if context.model_line.defaults:
+            model_defaults.update(safe_eval(context.model_line.defaults))
+        for key, value in model_defaults.items():
+            record.setdefault(key, value)
+        if context.model_line.postprocess:
+            safe_eval(
+                context.model_line.postprocess, {
+                    'vals': record,
+                    'env': self.env,
+                    '_id': _id,
+                    'remote': context.remote,
+                },
+                mode='exec',
+            )
         new = self.env.ref('base_import_odoo.%s' % xmlid, False)
         if new and new.exists():
             if self.duplicates == 'overwrite_empty':
@@ -284,7 +309,7 @@ class ImportOdooDatabase(models.Model):
         else:
             logged = True
             _logger.debug(
-                'Got %s(%d[%d]) from idmap', model._model, _id,
+                'Got %s(%d[%d]) from idmap', model._name, _id,
                 record['id'] or 0,
             )
         if not _id:
@@ -294,7 +319,7 @@ class ImportOdooDatabase(models.Model):
         elif not logged:
             logged = True
             _logger.debug(
-                'Got %s(%d[%d]) from dummies', model._model, _id, record['id'],
+                'Got %s(%d[%d]) from dummies', model._name, _id, record['id'],
             )
         if not _id:
             xmlid = self.env['ir.model.data'].search([
@@ -309,17 +334,17 @@ class ImportOdooDatabase(models.Model):
             logged = True
             _logger.debug(
                 'Got %s(%d[%d]) from mappings',
-                model._model, _id, record['id'],
+                model._name, _id, record['id'],
             )
         if not _id and create_dummy:
             _id = self._run_import_create_dummy(
                 context, model, record,
-                forcecreate=record['id'] not in
+                forcecreate=record['id'] and record['id'] not in
                 self.status_data['ids'].get(model._name, [])
             )
         elif _id and not logged:
             _logger.debug(
-                'Got %s(%d[%d]) from xmlid', model._model, _id, record['id'],
+                'Got %s(%d[%d]) from xmlid', model._name, _id, record['id'],
             )
         return _id
 
@@ -550,7 +575,7 @@ class ImportOdooDatabase(models.Model):
             name: field
             for name, field
             in self.env[context.model_line.model_id.model]._fields.items()
-            if not field.compute or field.related
+            if not field.compute or field.inverse
         }
 
     @api.multi
@@ -655,7 +680,7 @@ class ImportOdooDatabase(models.Model):
         return self.env['ir.cron'].create({
             'name': self.display_name,
             'model': self._name,
-            'function': '_run_import',
+            'function': '_run_import_cron',
             'doall': True,
             'args': str((self.ids,)),
         })

base_import_odoo/models/import_odoo_database_field.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-from openerp import api, fields, models
+from odoo import api, fields, models
 
 
 class ImportOdooDatabaseField(models.Model):

base_import_odoo/models/import_odoo_database_model.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-from openerp import fields, models
+from odoo import fields, models
 
 
 class ImportOdooDatabaseModel(models.Model):
@@ -18,3 +18,8 @@ class ImportOdooDatabaseModel(models.Model):
         ondelete='cascade',
     )
     domain = fields.Char(help='Optional filter to import only a subset')
+    defaults = fields.Char(help='Optional defaults dict to avoid empty values')
+    postprocess = fields.Text(
+        help='Optional python code for postprocessing. Your code has access '
+        'to `vals` which is the dictionary passed to create/write, and `env`.',
+    )

base_import_odoo/models/ir_model_data.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-from openerp import fields, models
+from odoo import fields, models
 
 
 class IrModelData(models.Model):

base_import_odoo/tests/__init__.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 from . import test_base_import_odoo

base_import_odoo/tests/test_base_import_odoo.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
-# © 2017 Therp BV <http://therp.nl>
+# Copyright 2017-2018 Therp BV <http://therp.nl>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
 from mock import patch
-from openerp.tests.common import TransactionCase, post_install, at_install
+from odoo.tests.common import TransactionCase, post_install, at_install
 from ..models.import_odoo_database import ImportContext, field_context
 
 
@@ -104,7 +104,8 @@ class TestBaseImportOdoo(TransactionCase):
         self.assertFalse(demodb.cronjob_running)
         # in our setting we won't get dummies, so we test this manually
         import_context = ImportContext(
-            None, None, [], {}, {}, [], {}, field_context(None, None, None)
+            None, self.env.ref('base_import_odoo.model_partner'),
+            [], {}, {}, [], {}, field_context(None, None, None)
         )
         dummy_id = demodb._run_import_create_dummy(
             import_context, self.env['res.partner'], {'id': 424242},

base_import_odoo/views/import_odoo_database.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data>
+<odoo>
     <record id="view_import_odoo_database_tree" model="ir.ui.view">
         <field name="model">import.odoo.database</field>
         <field name="arch" type="xml">
@@ -29,13 +28,17 @@
                         <field name="duplicates" />
                         <field name="cronjob_id" attrs="{'invisible': [('cronjob_id', '=', False)]}" />
                     </group>
+                    <label for="import_line_ids" />
                     <field name="import_line_ids" attrs="{'readonly': [('cronjob_running', '=', True)]}">
                         <tree editable="top">
                             <field name="sequence" widget="handle" />
                             <field name="model_id" />
                             <field name="domain" />
+                            <field name="defaults" />
+                            <field name="postprocess" placeholder="# `vals` is the dictionary to be passed to create/write, and you have access to `env`, `_id`, `remote`" />
                         </tree>
                     </field>
+                    <label for="import_field_mappings" />
                     <field name="import_field_mappings" attrs="{'readonly': [('cronjob_running', '=', True)]}"/>
                 </sheet>
             </form>
@@ -89,5 +92,4 @@
             To fix this, create mappings for the remote ids listed, or if this is not feasible, map the whole model. You might also have a too specific domain on your import model definition.
         </div>
     </template>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/views/import_odoo_database_field.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data>
+<odoo>
       <record id="view_import_odoo_database_field_form" model="ir.ui.view">
           <field name="model">import.odoo.database.field</field>
           <field name="arch" type="xml">
@@ -43,5 +42,4 @@
               </tree>
           </field>
       </record>
-    </data>
-</openerp>
+</odoo>

base_import_odoo/views/menu.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<openerp>
-    <data>
+<odoo>
     <menuitem id="menu_main" parent="base.menu_administration" name="Remote Odoo import" sequence="5" />
     <act_window id="action_import_odoo_database"
         res_model="import.odoo.database"
@@ -8,5 +7,4 @@
         view_mode="tree,form"
     />
     <menuitem id="menu_import_odoo_database" action="action_import_odoo_database" parent="menu_main" />
-    </data>
-</openerp>
+</odoo>

requirements.txt

@@ -11,3 +11,4 @@ raven
 checksumdir
 python-stdnum
 pyopenssl
+odoorpc