[IMP] base_external_dbsource: Refactor & Split by source

* Heavily refactor code for reusability
* Split all sources into independent modules
* Add more test coverage
* Add CRUD methods
* Add iterator execute return to roadmap

base_external_dbsource_mysql/README.rst

@@ -0,0 +1,80 @@
+.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+   :alt: License: LGPL-3
+
+================================
+External Database Source - MySQL
+================================
+
+This module extends ``base_external_dbsource``, allowing you to connect to
+foreign MySQL databases using SQLAlchemy.
+
+
+
+Installation
+============
+
+* Install ``sqlalchemy`` and ``MySQLdb`` python libraries
+* Install ``base_external_dbsource_sqlite`` Odoo module
+
+Configuration
+=============
+
+Database sources can be configured in Settings > Configuration -> Data sources.
+
+
+Usage
+=====
+
+To use this module:
+
+* Go to Settings > Database Structure > Database Sources
+* Click on Create to enter the following information:
+
+* Datasource name 
+* Pasword
+* Connector: Choose the database to which you want to connect
+* Connection string: Specify how to connect to database
+
+.. 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/10.0 for server-tools
+
+Known issues / Roadmap
+======================
+
+
+* Add X.509 authentication
+
+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
+=======
+
+Contributors
+------------
+
+* Daniel Reis <dreis.pt@hotmail.com>
+* Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
+* Gervais Naoussi <gervaisnaoussi@gmail.com>
+* Dave Lasley <dave@laslabs.com>
+
+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 http://odoo-community.org.

base_external_dbsource_mysql/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+from . import models

base_external_dbsource_mysql/__manifest__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# Copyright <2011> <Daniel Reis, Maxime Chambreuil, Savoir-faire Linux>
+# Copyright 2016 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+{
+    'name': 'External Database Source - MySQL',
+    'version': '10.0.1.0.0',
+    'category': 'Tools',
+    'author': "Daniel Reis, "
+              "LasLabs, "
+              "Odoo Community Association (OCA)",
+    'website': 'https://github.com/OCA/server-tools',
+    'license': 'LGPL-3',
+    'depends': [
+        'base_external_dbsource_sqlite',
+    ],
+    # Uncomment this for v11
+    # 'external_dependencies': [
+    #     'python': [
+    #         'sqlalchemy',
+    #         'MySQLdb',
+    #     ]
+    # ],
+    'demo': [
+        'demo/base_external_dbsource.xml',
+    ],
+    'installable': True,
+    'auto_install': True,  # Remove this key for v11
+}

base_external_dbsource_mysql/demo/base_external_dbsource.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<odoo>
+    <record model="base.external.dbsource" id="demo_mysql">
+        <field name="name">MySQL Demo</field>
+        <field name="conn_string">Server=myServerAddress;Database=myDataBase;Uid=myUsername;</field>
+        <field name="password">password</field>
+        <field name="connector">mysql</field>
+    </record>
+</odoo>

base_external_dbsource_mysql/i18n/de.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# Rudolf Schnapka <rs@techno-flex.de>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-05-10 00:47+0000\n"
+"PO-Revision-Date: 2017-05-10 00:47+0000\n"
+"Last-Translator: Rudolf Schnapka <rs@techno-flex.de>, 2017\n"
+"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: de\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Externe Datenbankquellen"

base_external_dbsource_mysql/i18n/es.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# Fernando Lara <gennesis45@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-02-22 00:54+0000\n"
+"PO-Revision-Date: 2017-02-22 00:54+0000\n"
+"Last-Translator: Fernando Lara <gennesis45@gmail.com>, 2017\n"
+"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: es\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Fuentes externas de la base de datos"

base_external_dbsource_mysql/i18n/hr.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# Bole <bole@dajmi5.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-05-10 00:47+0000\n"
+"PO-Revision-Date: 2017-05-10 00:47+0000\n"
+"Last-Translator: Bole <bole@dajmi5.com>, 2017\n"
+"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: hr\n"
+"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Vanjske baze"

base_external_dbsource_mysql/i18n/nl_NL.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# Peter Hageman <hageman.p@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-22 01:11+0000\n"
+"PO-Revision-Date: 2017-06-22 01:11+0000\n"
+"Last-Translator: Peter Hageman <hageman.p@gmail.com>, 2017\n"
+"Language-Team: Dutch (Netherlands) (https://www.transifex.com/oca/teams/23907/nl_NL/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: nl_NL\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Externe databasebronnen"

base_external_dbsource_mysql/i18n/pt_BR.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# OCA Transbot <transbot@odoo-community.org>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-01-21 04:22+0000\n"
+"PO-Revision-Date: 2017-01-21 04:22+0000\n"
+"Last-Translator: OCA Transbot <transbot@odoo-community.org>, 2017\n"
+"Language-Team: Portuguese (Brazil) (https://www.transifex.com/oca/teams/23907/pt_BR/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: pt_BR\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Fontes Banco de Dados Externo"

base_external_dbsource_mysql/i18n/sl.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# OCA Transbot <transbot@odoo-community.org>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-01-21 04:22+0000\n"
+"PO-Revision-Date: 2017-01-21 04:22+0000\n"
+"Last-Translator: OCA Transbot <transbot@odoo-community.org>, 2017\n"
+"Language-Team: Slovenian (https://www.transifex.com/oca/teams/23907/sl/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: sl\n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Viri zunanjih podatkovnih baz"

base_external_dbsource_mysql/i18n/tr.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_external_dbsource_mysql
+# 
+# Translators:
+# OCA Transbot <transbot@odoo-community.org>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-01-21 04:22+0000\n"
+"PO-Revision-Date: 2017-01-21 04:22+0000\n"
+"Last-Translator: OCA Transbot <transbot@odoo-community.org>, 2017\n"
+"Language-Team: Turkish (https://www.transifex.com/oca/teams/23907/tr/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: tr\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr "Dış veritabanı kaynakları"

base_external_dbsource_mysql/models/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from . import base_external_dbsource

base_external_dbsource_mysql/models/base_external_dbsource.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Copyright 2011 Daniel Reis
+# Copyright 2016 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+
+import logging
+
+from odoo import api, models
+
+_logger = logging.getLogger(__name__)
+
+try:
+    from odoo.addons.base_external_dbsource.models import (
+        base_external_dbsource,
+    )
+    CONNECTORS = base_external_dbsource.BaseExternalDbsource.CONNECTORS
+    try:
+        import MySQLdb
+        CONNECTORS.append(('mysql', 'MySQL'))
+        assert MySQLdb
+    except (ImportError, AssertionError):
+        _logger.info('MySQL not available. Please install "mysqldb" '
+                     'python package.')
+except ImportError:
+    _logger.info('base_external_dbsource Odoo module not found.')
+
+
+class BaseExternalDbsource(models.Model):
+    """ It provides logic for connection to a MySQL data source. """
+
+    _inherit = "base.external.dbsource"
+
+    @api.multi
+    def connection_close_mysql(self, connection):
+        return connection.close()
+
+    @api.multi
+    def connection_open_mysql(self):
+        return self._connection_open_sqlalchemy()
+
+    @api.multi
+    def execute_mysql(self, sqlquery, sqlparams, metadata):
+        return self._execute_sqlalchemy(sqlquery, sqlparams, metadata)

base_external_dbsource_mysql/tests/__init__.py

@@ -0,0 +1,3 @@
+# -*- encoding: utf-8 -*-
+
+from . import test_base_external_dbsource

base_external_dbsource_mysql/tests/test_base_external_dbsource.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# Copyright 2016 LasLabs Inc.
+
+import mock
+
+from odoo.tests import common
+
+
+ADAPTER = ('odoo.addons.base_external_dbsource_mysql.models'
+           '.base_external_dbsource.MySQLdb')
+
+
+class TestBaseExternalDbsource(common.TransactionCase):
+
+    def setUp(self):
+        super(TestBaseExternalDbsource, self).setUp()
+        self.dbsource = self.env.ref(
+            'base_external_dbsource_mysql.demo_mysql',
+        )
+
+    def test_connection_close_mysql(self):
+        """ It should close the connection """
+        connection = mock.MagicMock()
+        res = self.dbsource.connection_close_mysql(connection)
+        self.assertEqual(res, connection.close())
+
+    def test_connection_open_mysql(self):
+        """ It should call SQLAlchemy open """
+        with mock.patch.object(
+            self.dbsource, '_connection_open_sqlalchemy'
+        ) as parent_method:
+            self.dbsource.connection_open_mysql()
+            parent_method.assert_called_once_with()
+
+    def test_excecute_mysql(self):
+        """ It should pass args to SQLAlchemy execute """
+        expect = 'sqlquery', 'sqlparams', 'metadata'
+        with mock.patch.object(
+            self.dbsource, '_execute_sqlalchemy'
+        ) as parent_method:
+            self.dbsource.execute_mysql(*expect)
+            parent_method.assert_called_once_with(*expect)