diff --git a/base_external_dbsource_sqlite/README.rst b/base_external_dbsource_sqlite/README.rst new file mode 100644 index 00000000..ab65b60f --- /dev/null +++ b/base_external_dbsource_sqlite/README.rst @@ -0,0 +1,113 @@ +================================= +External Database Source - SQLite +================================= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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_sqlite + :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_sqlite + :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 SQLite databases using SQLAlchemy. + + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +To install this module, you need to: + +* Install ``sqlalchemy`` python library + +Configuration +============= + +To configure this module, you need to: + +#. 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 + +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 +~~~~~~~~~~~~ + +* Daniel Reis +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley +* Sergio Teruel (https://www.tecnativa.com) + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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_sqlite/__init__.py b/base_external_dbsource_sqlite/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/base_external_dbsource_sqlite/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/base_external_dbsource_sqlite/__manifest__.py b/base_external_dbsource_sqlite/__manifest__.py new file mode 100644 index 00000000..601248f4 --- /dev/null +++ b/base_external_dbsource_sqlite/__manifest__.py @@ -0,0 +1,25 @@ +# Copyright <2011> +# Copyright 2016 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +{ + 'name': 'External Database Source - SQLite', + 'version': '11.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', + ], + 'external_dependencies': { + 'python': [ + 'sqlalchemy', + ], + }, + 'demo': [ + 'demo/base_external_dbsource.xml', + ], + 'installable': True, +} diff --git a/base_external_dbsource_sqlite/demo/base_external_dbsource.xml b/base_external_dbsource_sqlite/demo/base_external_dbsource.xml new file mode 100644 index 00000000..2c7b33a1 --- /dev/null +++ b/base_external_dbsource_sqlite/demo/base_external_dbsource.xml @@ -0,0 +1,9 @@ + + + + SQLite Demo + Data Source=:memory:;Version=3;New=True; + password + sqlite + + diff --git a/base_external_dbsource_sqlite/i18n/base_external_dbsource_sqlite.pot b/base_external_dbsource_sqlite/i18n/base_external_dbsource_sqlite.pot new file mode 100644 index 00000000..e7601a18 --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/base_external_dbsource_sqlite.pot @@ -0,0 +1,20 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "" + diff --git a/base_external_dbsource_sqlite/i18n/de.po b/base_external_dbsource_sqlite/i18n/de.po new file mode 100644 index 00000000..0b865e9f --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/de.po @@ -0,0 +1,24 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Externe Datenbankquellen" diff --git a/base_external_dbsource_sqlite/i18n/es.po b/base_external_dbsource_sqlite/i18n/es.po new file mode 100644 index 00000000..3e5026b9 --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/es.po @@ -0,0 +1,24 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Fuentes externas de la base de datos" diff --git a/base_external_dbsource_sqlite/i18n/hr.po b/base_external_dbsource_sqlite/i18n/hr.po new file mode 100644 index 00000000..1bb28b7f --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/hr.po @@ -0,0 +1,25 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Vanjske baze" diff --git a/base_external_dbsource_sqlite/i18n/nl_NL.po b/base_external_dbsource_sqlite/i18n/nl_NL.po new file mode 100644 index 00000000..88ca312c --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/nl_NL.po @@ -0,0 +1,25 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Externe databasebronnen" diff --git a/base_external_dbsource_sqlite/i18n/pt_BR.po b/base_external_dbsource_sqlite/i18n/pt_BR.po new file mode 100644 index 00000000..0d9bb8b9 --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/pt_BR.po @@ -0,0 +1,25 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Fontes Banco de Dados Externo" diff --git a/base_external_dbsource_sqlite/i18n/sl.po b/base_external_dbsource_sqlite/i18n/sl.po new file mode 100644 index 00000000..36bd6a78 --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/sl.po @@ -0,0 +1,25 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Viri zunanjih podatkovnih baz" diff --git a/base_external_dbsource_sqlite/i18n/tr.po b/base_external_dbsource_sqlite/i18n/tr.po new file mode 100644 index 00000000..d57a58b9 --- /dev/null +++ b/base_external_dbsource_sqlite/i18n/tr.po @@ -0,0 +1,24 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_external_dbsource_sqlite +# +# 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_sqlite +#: model:ir.model,name:base_external_dbsource_sqlite.model_base_external_dbsource +msgid "External Database Sources" +msgstr "Dış veritabanı kaynakları" diff --git a/base_external_dbsource_sqlite/models/__init__.py b/base_external_dbsource_sqlite/models/__init__.py new file mode 100644 index 00000000..91032fcb --- /dev/null +++ b/base_external_dbsource_sqlite/models/__init__.py @@ -0,0 +1 @@ +from . import base_external_dbsource diff --git a/base_external_dbsource_sqlite/models/base_external_dbsource.py b/base_external_dbsource_sqlite/models/base_external_dbsource.py new file mode 100644 index 00000000..5e00bf69 --- /dev/null +++ b/base_external_dbsource_sqlite/models/base_external_dbsource.py @@ -0,0 +1,58 @@ +# 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 sqlalchemy + CONNECTORS.append(('sqlite', 'SQLite')) + except ImportError: + _logger.info('SQLAlchemy library not available. Please ' + 'install "sqlalchemy" python package.') +except ImportError: + _logger.info('base_external_dbsource Odoo module not found.') + + +class BaseExternalDbsource(models.Model): + """ It provides logic for connection to a SQLite data source. """ + + _inherit = "base.external.dbsource" + + PWD_STRING_SQLITE = 'Password=%s;' + + @api.multi + def connection_close_sqlite(self, connection): + return connection.close() + + @api.multi + def connection_open_sqlite(self): + return self._connection_open_sqlalchemy() + + @api.multi + def execute_sqlite(self, sqlquery, sqlparams, metadata): + return self._execute_sqlalchemy(sqlquery, sqlparams, metadata) + + @api.multi + def _connection_open_sqlalchemy(self): + return sqlalchemy.create_engine(self.conn_string_full).connect() + + @api.multi + def _execute_sqlalchemy(self, sqlquery, sqlparams, metadata): + rows, cols = list(), list() + for record in self: + with record.connection_open() as connection: + cur = connection.execute(sqlquery, sqlparams) + if metadata: + cols = list(cur.keys()) + rows = [r for r in cur] + return rows, cols diff --git a/base_external_dbsource_sqlite/readme/CONFIGURE.rst b/base_external_dbsource_sqlite/readme/CONFIGURE.rst new file mode 100644 index 00000000..57347aa6 --- /dev/null +++ b/base_external_dbsource_sqlite/readme/CONFIGURE.rst @@ -0,0 +1,4 @@ +To configure this module, you need to: + +#. Database sources can be configured in Settings > Configuration -> + Data sources. diff --git a/base_external_dbsource_sqlite/readme/CONTRIBUTORS.rst b/base_external_dbsource_sqlite/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..6edf85ec --- /dev/null +++ b/base_external_dbsource_sqlite/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Daniel Reis +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley +* Sergio Teruel (https://www.tecnativa.com) diff --git a/base_external_dbsource_sqlite/readme/DESCRIPTION.rst b/base_external_dbsource_sqlite/readme/DESCRIPTION.rst new file mode 100644 index 00000000..58eeb147 --- /dev/null +++ b/base_external_dbsource_sqlite/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +This module extends ``base_external_dbsource``, allowing you to connect to +foreign SQLite databases using SQLAlchemy. + diff --git a/base_external_dbsource_sqlite/readme/INSTALL.rst b/base_external_dbsource_sqlite/readme/INSTALL.rst new file mode 100644 index 00000000..ec5513d4 --- /dev/null +++ b/base_external_dbsource_sqlite/readme/INSTALL.rst @@ -0,0 +1,3 @@ +To install this module, you need to: + +* Install ``sqlalchemy`` python library diff --git a/base_external_dbsource_sqlite/readme/ROADMAP.rst b/base_external_dbsource_sqlite/readme/ROADMAP.rst new file mode 100644 index 00000000..8b025883 --- /dev/null +++ b/base_external_dbsource_sqlite/readme/ROADMAP.rst @@ -0,0 +1 @@ +* Add X.509 authentication diff --git a/base_external_dbsource_sqlite/readme/USAGE.rst b/base_external_dbsource_sqlite/readme/USAGE.rst new file mode 100644 index 00000000..a0405e8b --- /dev/null +++ b/base_external_dbsource_sqlite/readme/USAGE.rst @@ -0,0 +1,9 @@ +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 diff --git a/base_external_dbsource_sqlite/tests/__init__.py b/base_external_dbsource_sqlite/tests/__init__.py new file mode 100644 index 00000000..87aa84b3 --- /dev/null +++ b/base_external_dbsource_sqlite/tests/__init__.py @@ -0,0 +1 @@ +from . import test_base_external_dbsource diff --git a/base_external_dbsource_sqlite/tests/test_base_external_dbsource.py b/base_external_dbsource_sqlite/tests/test_base_external_dbsource.py new file mode 100644 index 00000000..2aa11922 --- /dev/null +++ b/base_external_dbsource_sqlite/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_sqlite.models' + '.base_external_dbsource.sqlalchemy') + + +class TestBaseExternalDbsource(common.TransactionCase): + + def setUp(self): + super(TestBaseExternalDbsource, self).setUp() + self.dbsource = self.env.ref( + 'base_external_dbsource_sqlite.demo_sqlite', + ) + + def test_connection_close_sqlite(self): + """ It should close the connection """ + connection = mock.MagicMock() + res = self.dbsource.connection_close_sqlite(connection) + self.assertEqual(res, connection.close()) + + def test_connection_open_sqlite(self): + """ It should call SQLAlchemy open """ + with mock.patch.object( + self.dbsource, '_connection_open_sqlalchemy' + ) as parent_method: + self.dbsource.connection_open_sqlite() + parent_method.assert_called_once_with() + + def test_excecute_sqlite(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_sqlite(*expect) + parent_method.assert_called_once_with(*expect)