From 4b49e4f7a206ad9fbddbefa1b86377c19983bf08 Mon Sep 17 00:00:00 2001 From: Dave Lasley Date: Wed, 7 Dec 2016 18:28:41 -0800 Subject: [PATCH 01/18] [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 [UPD] Update base_external_dbsource_mysql.pot --- base_external_dbsource_mysql/README.rst | 80 +++++++++++++++++++ base_external_dbsource_mysql/__init__.py | 2 + base_external_dbsource_mysql/__manifest__.py | 29 +++++++ .../demo/base_external_dbsource.xml | 9 +++ .../i18n/base_external_dbsource_mysql.pot | 20 +++++ base_external_dbsource_mysql/i18n/de.po | 24 ++++++ base_external_dbsource_mysql/i18n/es.po | 24 ++++++ base_external_dbsource_mysql/i18n/hr.po | 25 ++++++ base_external_dbsource_mysql/i18n/nl_NL.po | 25 ++++++ base_external_dbsource_mysql/i18n/pt_BR.po | 25 ++++++ base_external_dbsource_mysql/i18n/sl.po | 25 ++++++ base_external_dbsource_mysql/i18n/tr.po | 24 ++++++ .../models/__init__.py | 3 + .../models/base_external_dbsource.py | 43 ++++++++++ .../tests/__init__.py | 3 + .../tests/test_base_external_dbsource.py | 42 ++++++++++ 16 files changed, 403 insertions(+) create mode 100644 base_external_dbsource_mysql/README.rst create mode 100644 base_external_dbsource_mysql/__init__.py create mode 100644 base_external_dbsource_mysql/__manifest__.py create mode 100644 base_external_dbsource_mysql/demo/base_external_dbsource.xml create mode 100644 base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot create mode 100644 base_external_dbsource_mysql/i18n/de.po create mode 100644 base_external_dbsource_mysql/i18n/es.po create mode 100644 base_external_dbsource_mysql/i18n/hr.po create mode 100644 base_external_dbsource_mysql/i18n/nl_NL.po create mode 100644 base_external_dbsource_mysql/i18n/pt_BR.po create mode 100644 base_external_dbsource_mysql/i18n/sl.po create mode 100644 base_external_dbsource_mysql/i18n/tr.po create mode 100644 base_external_dbsource_mysql/models/__init__.py create mode 100644 base_external_dbsource_mysql/models/base_external_dbsource.py create mode 100644 base_external_dbsource_mysql/tests/__init__.py create mode 100644 base_external_dbsource_mysql/tests/test_base_external_dbsource.py diff --git a/base_external_dbsource_mysql/README.rst b/base_external_dbsource_mysql/README.rst new file mode 100644 index 000000000..0bdc60a7a --- /dev/null +++ b/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 `_. +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 +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley + +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. diff --git a/base_external_dbsource_mysql/__init__.py b/base_external_dbsource_mysql/__init__.py new file mode 100644 index 000000000..a0fdc10fe --- /dev/null +++ b/base_external_dbsource_mysql/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from . import models diff --git a/base_external_dbsource_mysql/__manifest__.py b/base_external_dbsource_mysql/__manifest__.py new file mode 100644 index 000000000..1762124bd --- /dev/null +++ b/base_external_dbsource_mysql/__manifest__.py @@ -0,0 +1,29 @@ +# -*- coding: utf-8 -*- +# Copyright <2011> +# 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 +} diff --git a/base_external_dbsource_mysql/demo/base_external_dbsource.xml b/base_external_dbsource_mysql/demo/base_external_dbsource.xml new file mode 100644 index 000000000..89ebe0f0f --- /dev/null +++ b/base_external_dbsource_mysql/demo/base_external_dbsource.xml @@ -0,0 +1,9 @@ + + + + MySQL Demo + Server=myServerAddress;Database=myDataBase;Uid=myUsername; + password + mysql + + diff --git a/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot b/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot new file mode 100644 index 000000000..8001d98a1 --- /dev/null +++ b/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 "" + diff --git a/base_external_dbsource_mysql/i18n/de.po b/base_external_dbsource_mysql/i18n/de.po new file mode 100644 index 000000000..6011570f6 --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/es.po b/base_external_dbsource_mysql/i18n/es.po new file mode 100644 index 000000000..e7b7e07f0 --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/hr.po b/base_external_dbsource_mysql/i18n/hr.po new file mode 100644 index 000000000..69af6d9fb --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/nl_NL.po b/base_external_dbsource_mysql/i18n/nl_NL.po new file mode 100644 index 000000000..7063bdd6e --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/pt_BR.po b/base_external_dbsource_mysql/i18n/pt_BR.po new file mode 100644 index 000000000..1b108bb21 --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/sl.po b/base_external_dbsource_mysql/i18n/sl.po new file mode 100644 index 000000000..6cf9c825f --- /dev/null +++ b/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 , 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 , 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" diff --git a/base_external_dbsource_mysql/i18n/tr.po b/base_external_dbsource_mysql/i18n/tr.po new file mode 100644 index 000000000..01db2f818 --- /dev/null +++ b/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 , 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 , 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??" diff --git a/base_external_dbsource_mysql/models/__init__.py b/base_external_dbsource_mysql/models/__init__.py new file mode 100644 index 000000000..44b7269b9 --- /dev/null +++ b/base_external_dbsource_mysql/models/__init__.py @@ -0,0 +1,3 @@ +# -*- coding: utf-8 -*- + +from . import base_external_dbsource diff --git a/base_external_dbsource_mysql/models/base_external_dbsource.py b/base_external_dbsource_mysql/models/base_external_dbsource.py new file mode 100644 index 000000000..660b01300 --- /dev/null +++ b/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) diff --git a/base_external_dbsource_mysql/tests/__init__.py b/base_external_dbsource_mysql/tests/__init__.py new file mode 100644 index 000000000..768d7990a --- /dev/null +++ b/base_external_dbsource_mysql/tests/__init__.py @@ -0,0 +1,3 @@ +# -*- encoding: utf-8 -*- + +from . import test_base_external_dbsource diff --git a/base_external_dbsource_mysql/tests/test_base_external_dbsource.py b/base_external_dbsource_mysql/tests/test_base_external_dbsource.py new file mode 100644 index 000000000..998a89edd --- /dev/null +++ b/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) From 6b8fd4c60b9861a83a03bbece904c87c05177267 Mon Sep 17 00:00:00 2001 From: Sergio Teruel Albert Date: Wed, 27 Jun 2018 13:00:28 +0200 Subject: [PATCH 02/18] [11.0][MIG] base_external_dbsource_mysql: Migration to v11.0 --- base_external_dbsource_mysql/README.rst | 74 ++- base_external_dbsource_mysql/__init__.py | 1 - base_external_dbsource_mysql/__manifest__.py | 19 +- .../i18n/base_external_dbsource_mysql.pot | 2 +- .../models/__init__.py | 2 - .../models/base_external_dbsource.py | 3 +- .../readme/CONFIGURE.rst | 4 + .../readme/CONTRIBUTORS.rst | 5 + .../readme/DESCRIPTION.rst | 2 + .../readme/INSTALL.rst | 5 + .../readme/ROADMAP.rst | 1 + base_external_dbsource_mysql/readme/USAGE.rst | 9 + .../static/description/index.html | 464 ++++++++++++++++++ .../tests/__init__.py | 2 - .../tests/test_base_external_dbsource.py | 1 - 15 files changed, 554 insertions(+), 40 deletions(-) create mode 100644 base_external_dbsource_mysql/readme/CONFIGURE.rst create mode 100644 base_external_dbsource_mysql/readme/CONTRIBUTORS.rst create mode 100644 base_external_dbsource_mysql/readme/DESCRIPTION.rst create mode 100644 base_external_dbsource_mysql/readme/INSTALL.rst create mode 100644 base_external_dbsource_mysql/readme/ROADMAP.rst create mode 100644 base_external_dbsource_mysql/readme/USAGE.rst create mode 100644 base_external_dbsource_mysql/static/description/index.html diff --git a/base_external_dbsource_mysql/README.rst b/base_external_dbsource_mysql/README.rst index 0bdc60a7a..55eb7ceb9 100644 --- a/base_external_dbsource_mysql/README.rst +++ b/base_external_dbsource_mysql/README.rst @@ -1,34 +1,61 @@ -.. 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 file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/licence-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-OCA%2Fserver--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/11.0/base_external_dbsource_mysql + :alt: OCA/server-backend +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-backend-11-0/server-backend-11-0-base_external_dbsource_mysql + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module extends ``base_external_dbsource``, allowing you to connect to foreign MySQL databases using SQLAlchemy. +**Table of contents** +.. contents:: + :local: Installation ============ -* Install ``sqlalchemy`` and ``MySQLdb`` python libraries +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 Configuration ============= -Database sources can be configured in Settings > Configuration -> Data sources. +To configure this module, you need to: +#. Database sources can be configured in Settings > Technical > + Database Structure > Database sources. Usage ===== To use this module: -* Go to Settings > Database Structure > Database Sources +* Go to Settings > Technical > Database Structure > Database Sources * Click on Create to enter the following information: * Datasource name?? @@ -36,45 +63,52 @@ To use this module: * 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 `_. +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 smashing it by providing a detailed and welcomed feedback. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Daniel Reis +* LasLabs + Contributors ------------- +~~~~~~~~~~~~ * Daniel Reis * Maxime Chambreuil * Gervais Naoussi * Dave Lasley +* Sergio Teruel + +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. 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. +This module is part of the `OCA/server-backend `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_external_dbsource_mysql/__init__.py b/base_external_dbsource_mysql/__init__.py index a0fdc10fe..0650744f6 100644 --- a/base_external_dbsource_mysql/__init__.py +++ b/base_external_dbsource_mysql/__init__.py @@ -1,2 +1 @@ -# -*- coding: utf-8 -*- from . import models diff --git a/base_external_dbsource_mysql/__manifest__.py b/base_external_dbsource_mysql/__manifest__.py index 1762124bd..18dc3583e 100644 --- a/base_external_dbsource_mysql/__manifest__.py +++ b/base_external_dbsource_mysql/__manifest__.py @@ -1,29 +1,26 @@ -# -*- coding: utf-8 -*- # Copyright <2011> # 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', + 'version': '11.0.1.0.0', 'category': 'Tools', 'author': "Daniel Reis, " "LasLabs, " "Odoo Community Association (OCA)", - 'website': 'https://github.com/OCA/server-tools', + 'website': 'https://github.com/OCA/server-backend', 'license': 'LGPL-3', 'depends': [ 'base_external_dbsource_sqlite', ], - # Uncomment this for v11 - # 'external_dependencies': [ - # 'python': [ - # 'sqlalchemy', - # 'MySQLdb', - # ] - # ], + 'external_dependencies': { + 'python': [ + 'sqlalchemy', + 'MySQLdb', + ], + }, 'demo': [ 'demo/base_external_dbsource.xml', ], 'installable': True, - 'auto_install': True, # Remove this key for v11 } diff --git a/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot b/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot index 8001d98a1..a11eccec2 100644 --- a/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot +++ b/base_external_dbsource_mysql/i18n/base_external_dbsource_mysql.pot @@ -4,7 +4,7 @@ # msgid "" msgstr "" -"Project-Id-Version: Odoo Server 10.0\n" +"Project-Id-Version: Odoo Server 11.0\n" "Report-Msgid-Bugs-To: \n" "Last-Translator: <>\n" "Language-Team: \n" diff --git a/base_external_dbsource_mysql/models/__init__.py b/base_external_dbsource_mysql/models/__init__.py index 44b7269b9..91032fcb6 100644 --- a/base_external_dbsource_mysql/models/__init__.py +++ b/base_external_dbsource_mysql/models/__init__.py @@ -1,3 +1 @@ -# -*- coding: utf-8 -*- - from . import base_external_dbsource diff --git a/base_external_dbsource_mysql/models/base_external_dbsource.py b/base_external_dbsource_mysql/models/base_external_dbsource.py index 660b01300..bf701ce63 100644 --- a/base_external_dbsource_mysql/models/base_external_dbsource.py +++ b/base_external_dbsource_mysql/models/base_external_dbsource.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2011 Daniel Reis # Copyright 2016 LasLabs Inc. # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). @@ -19,7 +18,7 @@ CONNECTORS.append(('mysql', 'MySQL')) assert MySQLdb except (ImportError, AssertionError): - _logger.info('MySQL not available. Please install "mysqldb" ' + _logger.info('MySQLdb not available. Please install "mysqlclient" ' 'python package.') except ImportError: _logger.info('base_external_dbsource Odoo module not found.') diff --git a/base_external_dbsource_mysql/readme/CONFIGURE.rst b/base_external_dbsource_mysql/readme/CONFIGURE.rst new file mode 100644 index 000000000..ce19b3863 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst b/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..aea7525a5 --- /dev/null +++ b/base_external_dbsource_mysql/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Daniel Reis +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley +* Sergio Teruel diff --git a/base_external_dbsource_mysql/readme/DESCRIPTION.rst b/base_external_dbsource_mysql/readme/DESCRIPTION.rst new file mode 100644 index 000000000..4c450b506 --- /dev/null +++ b/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. diff --git a/base_external_dbsource_mysql/readme/INSTALL.rst b/base_external_dbsource_mysql/readme/INSTALL.rst new file mode 100644 index 000000000..ded847108 --- /dev/null +++ b/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 diff --git a/base_external_dbsource_mysql/readme/ROADMAP.rst b/base_external_dbsource_mysql/readme/ROADMAP.rst new file mode 100644 index 000000000..8b025883a --- /dev/null +++ b/base_external_dbsource_mysql/readme/ROADMAP.rst @@ -0,0 +1 @@ +* Add X.509 authentication diff --git a/base_external_dbsource_mysql/readme/USAGE.rst b/base_external_dbsource_mysql/readme/USAGE.rst new file mode 100644 index 000000000..e91b212b6 --- /dev/null +++ b/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 diff --git a/base_external_dbsource_mysql/static/description/index.html b/base_external_dbsource_mysql/static/description/index.html new file mode 100644 index 000000000..0496f07a6 --- /dev/null +++ b/base_external_dbsource_mysql/static/description/index.html @@ -0,0 +1,464 @@ + + + + + + +External Database Source - MySQL + + + +
+

External Database Source - MySQL

+ + +

Beta License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

This module extends base_external_dbsource, allowing you to connect to +foreign MySQL databases using SQLAlchemy.

+

Table of contents

+ +
+

Installation

+

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
    • +
+
+
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Database sources can be configured in Settings > Technical > +Database Structure > Database sources.
    2. +
+
+
+

Usage

+

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
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Add X.509 authentication
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Daniel Reis
    • +
  • LasLabs
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

This module is part of the OCA/server-backend project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/base_external_dbsource_mysql/tests/__init__.py b/base_external_dbsource_mysql/tests/__init__.py index 768d7990a..87aa84b3e 100644 --- a/base_external_dbsource_mysql/tests/__init__.py +++ b/base_external_dbsource_mysql/tests/__init__.py @@ -1,3 +1 @@ -# -*- encoding: utf-8 -*- - from . import test_base_external_dbsource diff --git a/base_external_dbsource_mysql/tests/test_base_external_dbsource.py b/base_external_dbsource_mysql/tests/test_base_external_dbsource.py index 998a89edd..36280d494 100644 --- a/base_external_dbsource_mysql/tests/test_base_external_dbsource.py +++ b/base_external_dbsource_mysql/tests/test_base_external_dbsource.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 LasLabs Inc. import mock From f204d4b99dfb899d48b2533373867389b127c180 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A0=20Gil=20Sorribes?= Date: Fri, 30 Nov 2018 16:24:26 +0100 Subject: [PATCH 03/18] [12.0][MIG] Migrate module base_external_dbsource_mysql --- base_external_dbsource_mysql/README.rst | 10 +++--- base_external_dbsource_mysql/__manifest__.py | 2 +- .../static/description/index.html | 36 ++++--------------- 3 files changed, 13 insertions(+), 35 deletions(-) diff --git a/base_external_dbsource_mysql/README.rst b/base_external_dbsource_mysql/README.rst index 55eb7ceb9..be7f889b7 100644 --- a/base_external_dbsource_mysql/README.rst +++ b/base_external_dbsource_mysql/README.rst @@ -14,13 +14,13 @@ External Database Source - MySQL :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github - :target: https://github.com/OCA/server-backend/tree/11.0/base_external_dbsource_mysql + :target: https://github.com/OCA/server-backend/tree/12.0/base_external_dbsource_mysql :alt: OCA/server-backend .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-backend-11-0/server-backend-11-0-base_external_dbsource_mysql + :target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-base_external_dbsource_mysql :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png - :target: https://runbot.odoo-community.org/runbot/253/11.0 + :target: https://runbot.odoo-community.org/runbot/253/12.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -74,7 +74,7 @@ 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 smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -109,6 +109,6 @@ 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. -This module is part of the `OCA/server-backend `_ project on GitHub. +This module is part of the `OCA/server-backend `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_external_dbsource_mysql/__manifest__.py b/base_external_dbsource_mysql/__manifest__.py index 18dc3583e..805641c82 100644 --- a/base_external_dbsource_mysql/__manifest__.py +++ b/base_external_dbsource_mysql/__manifest__.py @@ -3,7 +3,7 @@ # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). { 'name': 'External Database Source - MySQL', - 'version': '11.0.1.0.0', + 'version': '12.0.1.0.0', 'category': 'Tools', 'author': "Daniel Reis, " "LasLabs, " diff --git a/base_external_dbsource_mysql/static/description/index.html b/base_external_dbsource_mysql/static/description/index.html index 0496f07a6..44fa585d9 100644 --- a/base_external_dbsource_mysql/static/description/index.html +++ b/base_external_dbsource_mysql/static/description/index.html @@ -3,13 +3,13 @@ - + External Database Source - MySQL