Merge pull request #11 from Tecnativa/11.0-mig-base_external_dbsource_mysql

11.0 mig base external dbsource mysql

.travis.yml

@@ -12,6 +12,7 @@ addons:
     packages:
       - expect-dev  # provides unbuffer utility
       - python-lxml # because pip installation is slow
+      - libmysqlclient-dev # To install mysqlclient and import MySQLdb
 
 env:
   global:

base_external_dbsource_mysql/README.rst

@@ -0,0 +1 @@
+**This file is going to be generated by oca-gen-addon-readme.**

base_external_dbsource_mysql/__init__.py

@@ -0,0 +1 @@
+from . import models

base_external_dbsource_mysql/__manifest__.py

@@ -0,0 +1,26 @@
+# 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': '11.0.1.0.0',
+    'category': 'Tools',
+    'author': "Daniel Reis, "
+              "LasLabs, "
+              "Odoo Community Association (OCA)",
+    'website': 'https://github.com/OCA/server-backend',
+    'license': 'LGPL-3',
+    'depends': [
+        'base_external_dbsource_sqlite',
+    ],
+    'external_dependencies': {
+        'python': [
+            'sqlalchemy',
+            'MySQLdb',
+        ],
+    },
+    'demo': [
+        'demo/base_external_dbsource.xml',
+    ],
+    'installable': True,
+}

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/base_external_dbsource_mysql.pot

@@ -0,0 +1,20 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* base_external_dbsource_mysql
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_external_dbsource_mysql
+#: model:ir.model,name:base_external_dbsource_mysql.model_base_external_dbsource
+msgid "External Database Sources"
+msgstr ""
+

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"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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"
+"Language: es\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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,25 @@
+# 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"
+"Language: hr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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,25 @@
+# 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"
+"Language: nl_NL\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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,25 @@
+# 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"
+"Language: pt_BR\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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,25 @@
+# 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"
+"Language: sl\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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"
+"Language: tr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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 @@
+from . import base_external_dbsource

base_external_dbsource_mysql/models/base_external_dbsource.py

@@ -0,0 +1,42 @@
+# 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('MySQLdb not available. Please install "mysqlclient" '
+                     '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/readme/CONFIGURE.rst

@@ -0,0 +1,4 @@
+To configure this module, you need to:
+
+#. Database sources can be configured in Settings > Technical >
+   Database Structure > Database sources.

base_external_dbsource_mysql/readme/CONTRIBUTORS.rst

@@ -0,0 +1,5 @@
+* Daniel Reis <dreis.pt@hotmail.com>
+* Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
+* Gervais Naoussi <gervaisnaoussi@gmail.com>
+* Dave Lasley <dave@laslabs.com>
+* Sergio Teruel <sergio.teruel@tecnativa.com>

base_external_dbsource_mysql/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+This module extends ``base_external_dbsource``, allowing you to connect to
+foreign MySQL databases using SQLAlchemy.

base_external_dbsource_mysql/readme/INSTALL.rst

@@ -0,0 +1,5 @@
+To install this module, you need to:
+
+* Install ``libmysqlclient-dev`` package (``default-libmysqlclient-dev`` on Debian)
+* Install ``sqlalchemy`` and ``mysqlclient`` python libraries
+* Install ``base_external_dbsource_sqlite`` Odoo module

base_external_dbsource_mysql/readme/ROADMAP.rst

@@ -0,0 +1 @@
+* Add X.509 authentication

base_external_dbsource_mysql/readme/USAGE.rst

@@ -0,0 +1,9 @@
+To use this module:
+
+* Go to Settings > Technical > 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

base_external_dbsource_mysql/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_base_external_dbsource

base_external_dbsource_mysql/tests/test_base_external_dbsource.py

@@ -0,0 +1,41 @@
+# 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)