From c6b750c5f78b2670268ab53a0f3cf1c20c115dae Mon Sep 17 00:00:00 2001 From: Dave Lasley Date: Fri, 20 Oct 2017 13:30:44 -0700 Subject: [PATCH 01/17] [ADD] base_external_system: Implement interface/adapter (#993) * [ADD] base_external_system: Implement interface/adapter for external systems * base_external_system: Fix OS model, add inherits, add validate * base_external_system: Usability and private key pass * base_external_system: Use contextmanager in adapter client * base_external_system: Move contextmanager to interface * base_external_system: Include contextmanager on adapter and system * base_external_system: Unify client * Use password widget for password field * Add tests & security * Fix lint * Add plaintext note --- base_external_system/README.rst | 96 ++++++++++++++ base_external_system/__init__.py | 5 + base_external_system/__manifest__.py | 23 ++++ .../demo/external_system_os_demo.xml | 17 +++ base_external_system/models/__init__.py | 4 + .../models/external_system.py | 125 ++++++++++++++++++ .../models/external_system_adapter.py | 71 ++++++++++ .../models/external_system_os.py | 43 ++++++ .../security/ir.model.access.csv | 3 + .../static/description/icon.png | Bin 0 -> 9455 bytes base_external_system/tests/__init__.py | 5 + base_external_system/tests/common.py | 22 +++ .../tests/test_external_system.py | 54 ++++++++ .../tests/test_external_system_adapter.py | 45 +++++++ .../tests/test_external_system_os.py | 40 ++++++ .../views/external_system_view.xml | 108 +++++++++++++++ 16 files changed, 661 insertions(+) create mode 100755 base_external_system/README.rst create mode 100644 base_external_system/__init__.py create mode 100644 base_external_system/__manifest__.py create mode 100755 base_external_system/demo/external_system_os_demo.xml create mode 100644 base_external_system/models/__init__.py create mode 100644 base_external_system/models/external_system.py create mode 100644 base_external_system/models/external_system_adapter.py create mode 100644 base_external_system/models/external_system_os.py create mode 100644 base_external_system/security/ir.model.access.csv create mode 100644 base_external_system/static/description/icon.png create mode 100644 base_external_system/tests/__init__.py create mode 100644 base_external_system/tests/common.py create mode 100644 base_external_system/tests/test_external_system.py create mode 100644 base_external_system/tests/test_external_system_adapter.py create mode 100644 base_external_system/tests/test_external_system_os.py create mode 100755 base_external_system/views/external_system_view.xml diff --git a/base_external_system/README.rst b/base_external_system/README.rst new file mode 100755 index 000000000..4c7ee4cf6 --- /dev/null +++ b/base_external_system/README.rst @@ -0,0 +1,96 @@ +.. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg + :target: http://www.gnu.org/licenses/lgpl.html + :alt: License: LGPL-3 + +====================== +Base - External System +====================== + +This module provides an interface/adapter mechanism for the definition of remote +systems. + +Note that this module stores everything in plain text. In the interest of security, +it is recommended you use another module (such as `keychain` or `red_october` to +encrypt things like the password and private key). This is not done here in order +to not force a specific security method. + +Implementation +============== + +The credentials for systems are stored in the ``external.system`` model, and are to +be configured by the user. This model is the unified interface for the underlying +adapters. + +Using the Interface +------------------- + +Given an ``external.system`` singleton called ``external_system``, you would do the +following to get the underlying system client: + +.. code-block:: python + + with external_system.client() as client: + client.do_something() + +The client will be destroyed once the context has completed. Destruction takes place +in the adapter's ``external_destroy_client`` method. + +The only unified aspect of this interface is the client connection itself. Other more +opinionated interface/adapter mechanisms can be implemented in other modules, such as +the file system interface in `OCA/server-tools/external_file_location +`_. + +Creating an Adapter +------------------- + +Modules looking to add an external system adapter should inherit the +``external.system.adapter`` model and override the following methods: + +* ``external_get_client``: Returns a usable client for the system +* ``external_destroy_client``: Destroy the connection, if applicable. Does not need + to be defined if the connection destroys itself. + +Configuration +============= + +Configure external systems in Settings => Technical => External Systems + +.. 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 + +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 smash it by providing detailed and welcomed feedback. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* 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 https://odoo-community.org. diff --git a/base_external_system/__init__.py b/base_external_system/__init__.py new file mode 100644 index 000000000..fd02263ce --- /dev/null +++ b/base_external_system/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from . import models diff --git a/base_external_system/__manifest__.py b/base_external_system/__manifest__.py new file mode 100644 index 000000000..13486c283 --- /dev/null +++ b/base_external_system/__manifest__.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +{ + "name": "Base External System", + "summary": "Data models allowing for connection to external systems.", + "version": "10.0.1.0.0", + "category": "Base", + "website": "https://laslabs.com/", + "author": "LasLabs, Odoo Community Association (OCA)", + "license": "LGPL-3", + "application": False, + "installable": True, + 'depends': [ + 'base', + ], + 'data': [ + 'demo/external_system_os_demo.xml', + 'security/ir.model.access.csv', + 'views/external_system_view.xml', + ], +} diff --git a/base_external_system/demo/external_system_os_demo.xml b/base_external_system/demo/external_system_os_demo.xml new file mode 100755 index 000000000..817270753 --- /dev/null +++ b/base_external_system/demo/external_system_os_demo.xml @@ -0,0 +1,17 @@ + + + + + + + + Example OS Connection + external.system.os + /tmp + + + + diff --git a/base_external_system/models/__init__.py b/base_external_system/models/__init__.py new file mode 100644 index 000000000..3e2b372f2 --- /dev/null +++ b/base_external_system/models/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +from . import external_system +from . import external_system_adapter +from . import external_system_os diff --git a/base_external_system/models/external_system.py b/base_external_system/models/external_system.py new file mode 100644 index 000000000..57a171421 --- /dev/null +++ b/base_external_system/models/external_system.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from contextlib import contextmanager + +from odoo import api, fields, models, _ +from odoo.exceptions import ValidationError + + +class ExternalSystem(models.Model): + + _name = 'external.system' + _description = 'External System' + + name = fields.Char( + required=True, + help='This is the canonical (humanized) name for the system.', + ) + host = fields.Char( + help='This is the domain or IP address that the system can be reached ' + 'at.', + ) + port = fields.Integer( + help='This is the port number that the system is listening on.', + ) + username = fields.Char( + help='This is the username that is used for authenticating to this ' + 'system, if applicable.', + ) + password = fields.Char( + help='This is the password that is used for authenticating to this ' + 'system, if applicable.', + ) + private_key = fields.Text( + help='This is the private key that is used for authenticating to ' + 'this system, if applicable.', + ) + private_key_password = fields.Text( + help='This is the password to unlock the private key that was ' + 'provided for this sytem.', + ) + fingerprint = fields.Text( + help='This is the fingerprint that is advertised by this system in ' + 'order to validate its identity.', + ) + ignore_fingerprint = fields.Boolean( + default=True, + help='Set this to `True` in order to ignore an invalid/unknown ' + 'fingerprint from the system.', + ) + remote_path = fields.Char( + help='Restrict to this directory path on the remote, if applicable.', + ) + company_ids = fields.Many2many( + string='Companies', + comodel_name='res.company', + required=True, + default=lambda s: [(6, 0, s.env.user.company_id.ids)], + help='Access to this system is restricted to these companies.', + ) + system_type = fields.Selection( + selection='_get_system_types', + required=True, + ) + interface = fields.Reference( + selection='_get_system_types', + readonly=True, + help='This is the interface that this system represents. It is ' + 'created automatically upon creation of the external system.', + ) + + _sql_constraints = [ + ('name_uniq', 'UNIQUE(name)', 'Connection name must be unique.'), + ] + + @api.model + def _get_system_types(self): + """Return the adapter interface models that are installed.""" + adapter = self.env['external.system.adapter'] + return [ + (m, self.env[m]._description) for m in adapter._inherit_children + ] + + @api.multi + @api.constrains('fingerprint', 'ignore_fingerprint') + def check_fingerprint_ignore_fingerprint(self): + """Do not allow a blank fingerprint if not set to ignore.""" + for record in self: + if not record.ignore_fingerprint and not record.fingerprint: + raise ValidationError(_( + 'Fingerprint cannot be empty when Ignore Fingerprint is ' + 'not checked.', + )) + + @api.multi + @contextmanager + def client(self): + """Client object usable as a context manager to include destruction. + + Yields the result from ``external_get_client``, then calls + ``external_destroy_client`` to cleanup the client. + + Yields: + mixed: An object representing the client connection to the remote + system. + """ + with self.interface.client() as client: + yield client + + @api.model + def create(self, vals): + """Create the interface for the record and assign to ``interface``.""" + record = super(ExternalSystem, self).create(vals) + interface = self.env[vals['system_type']].create({ + 'system_id': record.id, + }) + record.interface = interface + return record + + @api.multi + def action_test_connection(self): + """Test the connection to the external system.""" + self.ensure_one() + self.interface.external_test_connection() diff --git a/base_external_system/models/external_system_adapter.py b/base_external_system/models/external_system_adapter.py new file mode 100644 index 000000000..b44c3d4c2 --- /dev/null +++ b/base_external_system/models/external_system_adapter.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from contextlib import contextmanager + +from odoo import api, fields, models, _ +from odoo.exceptions import UserError + + +class ExternalSystemAdapter(models.AbstractModel): + """This is the model that should be inherited for new external systems. + + Methods provided are prefixed with ``external_`` in order to keep from + """ + + _name = 'external.system.adapter' + _description = 'External System Adapter' + _inherits = {'external.system': 'system_id'} + + system_id = fields.Many2one( + string='System', + comodel_name='external.system', + required=True, + ondelete='cascade', + ) + + @api.multi + @contextmanager + def client(self): + """Client object usable as a context manager to include destruction. + + Yields the result from ``external_get_client``, then calls + ``external_destroy_client`` to cleanup the client. + + Yields: + mixed: An object representing the client connection to the remote + system. + """ + client = self.external_get_client() + try: + yield client + finally: + self.external_destroy_client(client) + + @api.multi + def external_get_client(self): + """Return a usable client representing the remote system.""" + self.ensure_one() + + @api.multi + def external_destroy_client(self, client): + """Perform any logic necessary to destroy the client connection. + + Args: + client (mixed): The client that was returned by + ``external_get_client``. + """ + self.ensure_one() + + @api.multi + def external_test_connection(self): + """Adapters should override this method, then call super if valid. + + If the connection is invalid, adapters should raise an instance of + ``odoo.ValidationError``. + + Raises: + odoo.exceptions.UserError: In the event of a good connection. + """ + raise UserError(_('The connection was a success.')) diff --git a/base_external_system/models/external_system_os.py b/base_external_system/models/external_system_os.py new file mode 100644 index 000000000..1e89d3600 --- /dev/null +++ b/base_external_system/models/external_system_os.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +import os + +from odoo import api, models + + +class ExternalSystemOs(models.Model): + """This is an Interface implementing the OS module. + + For the most part, this is just a sample of how to implement an external + system interface. This is still a fully usable implementation, however. + """ + + _name = 'external.system.os' + _inherit = 'external.system.adapter' + _description = 'External System OS' + + previous_dir = None + + @api.multi + def external_get_client(self): + """Return a usable client representing the remote system.""" + super(ExternalSystemOs, self).external_get_client() + if self.system_id.remote_path: + self.previous_dir = os.getcwd() + os.chdir(self.system_id.remote_path) + return os + + @api.multi + def external_destroy_client(self, client): + """Perform any logic necessary to destroy the client connection. + + Args: + client (mixed): The client that was returned by + ``external_get_client``. + """ + super(ExternalSystemOs, self).external_destroy_client(client) + if self.previous_dir: + os.chdir(self.previous_dir) + self.previous_dir = None diff --git a/base_external_system/security/ir.model.access.csv b/base_external_system/security/ir.model.access.csv new file mode 100644 index 000000000..f3fafd3ef --- /dev/null +++ b/base_external_system/security/ir.model.access.csv @@ -0,0 +1,3 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_external_system_os_admin,access_external_system_os_admin,model_external_system_os,base.group_system,1,1,1,1 +access_external_system_admin,access_external_system_admin,model_external_system,base.group_system,1,1,1,1 diff --git a/base_external_system/static/description/icon.png b/base_external_system/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/base_external_system/tests/__init__.py b/base_external_system/tests/__init__.py new file mode 100644 index 000000000..d7cd63b5c --- /dev/null +++ b/base_external_system/tests/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- + +from . import test_external_system +from . import test_external_system_adapter +from . import test_external_system_os diff --git a/base_external_system/tests/common.py b/base_external_system/tests/common.py new file mode 100644 index 000000000..0c212359e --- /dev/null +++ b/base_external_system/tests/common.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from contextlib import contextmanager +from mock import MagicMock + +from odoo.tests.common import TransactionCase + + +class Common(TransactionCase): + + @contextmanager + def _mock_method(self, method_name, method_obj=None): + if method_obj is None: + method_obj = self.record + magic = MagicMock() + method_obj._patch_method(method_name, magic) + try: + yield magic + finally: + method_obj._revert_method(method_name) diff --git a/base_external_system/tests/test_external_system.py b/base_external_system/tests/test_external_system.py new file mode 100644 index 000000000..6d7862704 --- /dev/null +++ b/base_external_system/tests/test_external_system.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo.exceptions import UserError, ValidationError + +from .common import Common + + +class TestExternalSystem(Common): + + def setUp(self): + super(TestExternalSystem, self).setUp() + self.record = self.env.ref('base_external_system.external_system_os') + + def test_get_system_types(self): + """It should return at least the test record's interface.""" + self.assertIn( + (self.record._name, self.record._description), + self.env['external.system']._get_system_types(), + ) + + def test_check_fingerprint_blank(self): + """It should not allow blank fingerprints when checking enabled.""" + with self.assertRaises(ValidationError): + self.record.write({ + 'ignore_fingerprint': False, + 'fingerprint': False, + }) + + def test_check_fingerprint_allowed(self): + """It should not raise a validation error if there is a fingerprint.""" + self.record.write({ + 'ignore_fingerprint': False, + 'fingerprint': 'Data', + }) + self.assertTrue(True) + + def test_client(self): + """It should yield the open interface client.""" + with self._mock_method('client', self.record) as magic: + with self.record.system_id.client() as client: + self.assertEqual(client, magic().__enter__()) + + def test_create_creates_and_assigns_interface(self): + """It should create and assign the interface on record create.""" + self.assertEqual( + self.record.interface._name, 'external.system.os', + ) + + def test_action_test_connection(self): + """It should proxy to the interface connection tester.""" + with self.assertRaises(UserError): + self.record.system_id.action_test_connection() diff --git a/base_external_system/tests/test_external_system_adapter.py b/base_external_system/tests/test_external_system_adapter.py new file mode 100644 index 000000000..d084cf142 --- /dev/null +++ b/base_external_system/tests/test_external_system_adapter.py @@ -0,0 +1,45 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo.exceptions import UserError + +from .common import Common + + +class TestExternalSystemAdapter(Common): + + def setUp(self): + super(TestExternalSystemAdapter, self).setUp() + self.system = self.env.ref('base_external_system.external_system_os') + self.record = self.env['external.system.adapter'].new({ + 'system_id': self.system.id, + }) + + def test_client_yields_client(self): + """It should yield the client.""" + with self._mock_method('external_get_client') as magic: + with self.record.client() as client: + self.assertEqual(client, magic()) + + def test_client_destroys_client(self): + """It should destroy the client after use.""" + with self._mock_method('external_destroy_client') as magic: + with self.record.client() as client: + self.assertFalse(magic.call_count) + magic.assert_called_once_with(client) + + def test_external_get_client_ensure_one(self): + """It should assert singletons.""" + with self.assertRaises(ValueError): + self.env['external.system.adapter'].external_get_client() + + def test_external_destroy_client_ensure_one(self): + """It should assert singletons.""" + with self.assertRaises(ValueError): + self.env['external.system.adapter'].external_destroy_client(None) + + def test_external_test_connection(self): + """It should raise a UserError.""" + with self.assertRaises(UserError): + self.record.external_test_connection() diff --git a/base_external_system/tests/test_external_system_os.py b/base_external_system/tests/test_external_system_os.py new file mode 100644 index 000000000..150a3bdbd --- /dev/null +++ b/base_external_system/tests/test_external_system_os.py @@ -0,0 +1,40 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import os + +from .common import Common + + +class TestExternalSystemOs(Common): + + @classmethod + def setUpClass(cls): + """Remember the working dir, just in case.""" + super(TestExternalSystemOs, cls).setUpClass() + cls.working_dir = os.getcwd() + + @classmethod + def tearDownClass(cls): + """Set the working dir back to origin, just in case.""" + super(TestExternalSystemOs, cls).tearDownClass() + os.chdir(cls.working_dir) + + def setUp(self): + super(TestExternalSystemOs, self).setUp() + self.record = self.env.ref('base_external_system.external_system_os') + + def test_external_get_client_returns_os(self): + """It should return the Pyhton OS module.""" + self.assertEqual(self.record.external_get_client(), os) + + def test_external_get_client_changes_directories(self): + """It should change to the proper directory.""" + self.record.external_get_client() + self.assertEqual(os.getcwd(), self.record.remote_path) + + def test_external_destroy_client_changes_directory(self): + """It should change back to the previous working directory.""" + self.record.external_destroy_client(None) + self.assertEqual(os.getcwd(), self.working_dir) diff --git a/base_external_system/views/external_system_view.xml b/base_external_system/views/external_system_view.xml new file mode 100755 index 000000000..e1ed17cbe --- /dev/null +++ b/base_external_system/views/external_system_view.xml @@ -0,0 +1,108 @@ + + + + + + + + external.system.view.form + external.system + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +