Browse Source
[MIG] auto_backup: Migrate to v9
[MIG] auto_backup: Migrate to v9
* Add self.ensure_ones * Add test coveragepull/1384/head
Dave Lasley
8 years ago
committed by
Aitor Bouzas
Aitor Bouzas
10 changed files with 307 additions and 78 deletions
-
20auto_backup/README.rst
-
19auto_backup/__manifest__.py
-
28auto_backup/data/backup_data.yml
-
18auto_backup/data/ir_cron.xml
-
19auto_backup/data/mail_message_subtype.xml
-
10auto_backup/models/db_backup.py
-
2auto_backup/tests/__init__.py
-
28auto_backup/tests/test_auto_backup.py
-
232auto_backup/tests/test_db_backup.py
-
9auto_backup/view/db_backup_view.xml
@ -1,28 +0,0 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). |
|||
|
|||
# Cron job |
|||
- !record {model: ir.cron, id: ir_cron_backupscheduler0}: |
|||
name: Backup scheduler |
|||
user_id: base.user_root |
|||
interval_number: 1 |
|||
interval_type: days |
|||
numbercall: -1 |
|||
nextcall: !eval |
|||
(datetime.now() + timedelta(days=1)).strftime("%Y-%m-%d 02:00:00") |
|||
model: db.backup |
|||
function: action_backup_all |
|||
|
|||
# New message subtypes |
|||
- !record {model: mail.message.subtype, id: success}: |
|||
name: Backup successful |
|||
res_model: db.backup |
|||
default: False |
|||
description: Database backup succeeded. |
|||
|
|||
- !record {model: mail.message.subtype, id: failure}: |
|||
name: Backup failed |
|||
res_model: db.backup |
|||
default: True |
|||
description: Database backup failed. |
|||
@ -0,0 +1,18 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<odoo noupdate="1"> |
|||
|
|||
<record id="ir_cron_backup_scheduler_0" model="ir.cron"> |
|||
<field name="name">Backup Scheduler</field> |
|||
<field name="user_id" ref="base.user_root" /> |
|||
<field name="interval_number">1</field> |
|||
<field name="interval_type">days</field> |
|||
<field name="numbercall">-1</field> |
|||
<field name="nextcall" |
|||
eval="(datetime.now() + timedelta(days=1)).strftime('%Y-%m-%d 02:00:00')" |
|||
/> |
|||
<field name="model">db.backup</field> |
|||
<field name="function">action_backup_all</field> |
|||
</record> |
|||
|
|||
</odoo> |
|||
@ -0,0 +1,19 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<odoo noupdate="1"> |
|||
|
|||
<record id="mail_message_subtype_success" model="mail.message.subtype"> |
|||
<field name="name">Backup Successful</field> |
|||
<field name="description">Database backup succeeded.</field> |
|||
<field name="res_model">db.backup</field> |
|||
<field name="default" eval="False" /> |
|||
</record> |
|||
|
|||
<record id="mail_message_subtype_failure" model="mail.message.subtype"> |
|||
<field name="name">Backup Failed</field> |
|||
<field name="description">Database backup failed.</field> |
|||
<field name="res_model">db.backup</field> |
|||
<field name="default" eval="True" /> |
|||
</record> |
|||
|
|||
</odoo> |
|||
@ -1,28 +0,0 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# © 2015 Agile Business Group <http://www.agilebg.com> |
|||
# © 2015 Alessio Gerace <alesiso.gerace@agilebg.com> |
|||
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). |
|||
|
|||
import os |
|||
from datetime import datetime |
|||
from openerp.tests import common |
|||
|
|||
|
|||
class TestsAutoBackup(common.TransactionCase): |
|||
|
|||
def setUp(self): |
|||
super(TestsAutoBackup, self).setUp() |
|||
self.abk = self.env["db.backup"].create( |
|||
{ |
|||
'name': u'Têst backup', |
|||
} |
|||
) |
|||
|
|||
def test_local(self): |
|||
"""A local database is backed up.""" |
|||
filename = self.abk.filename(datetime.now()) |
|||
self.abk.action_backup() |
|||
generated_backup = [f for f in os.listdir(self.abk.folder) |
|||
if f >= filename] |
|||
self.assertEqual(len(generated_backup), 1) |
|||
@ -0,0 +1,232 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# © 2015 Agile Business Group <http://www.agilebg.com> |
|||
# © 2015 Alessio Gerace <alesiso.gerace@agilebg.com> |
|||
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis |
|||
# Copyright 2016 LasLabs Inc. |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). |
|||
|
|||
import os |
|||
import mock |
|||
|
|||
from datetime import datetime |
|||
from contextlib import contextmanager |
|||
|
|||
from odoo.tests import common |
|||
from odoo import exceptions, tools |
|||
|
|||
try: |
|||
import pysftp |
|||
except ImportError: |
|||
pass |
|||
|
|||
|
|||
model = 'odoo.addons.auto_backup.models.db_backup' |
|||
|
|||
|
|||
class TestConnectionException(pysftp.ConnectionException): |
|||
def __init__(self): |
|||
super(TestConnectionException, self).__init__('test', 'test') |
|||
|
|||
|
|||
class TestDbBackup(common.TransactionCase): |
|||
|
|||
def setUp(self): |
|||
super(TestDbBackup, self).setUp() |
|||
self.Model = self.env["db.backup"] |
|||
|
|||
@contextmanager |
|||
def mock_assets(self): |
|||
""" It provides mocked core assets """ |
|||
self.path_join_val = '/this/is/a/path' |
|||
with mock.patch('%s.db' % model) as db: |
|||
with mock.patch('%s.os' % model) as os: |
|||
with mock.patch('%s.shutil' % model) as shutil: |
|||
os.path.join.return_value = self.path_join_val |
|||
yield { |
|||
'db': db, |
|||
'os': os, |
|||
'shutil': shutil, |
|||
} |
|||
|
|||
@contextmanager |
|||
def patch_filtered_sftp(self, record, mocks=None): |
|||
""" It patches filtered record and provides a mock """ |
|||
if mocks is None: |
|||
mocks = ['sftp_connection'] |
|||
mocks = {m: mock.DEFAULT for m in mocks} |
|||
with mock.patch.object(record, 'filtered') as filtered: |
|||
with mock.patch.object(record, 'backup_log'): |
|||
with mock.patch.multiple(record, **mocks): |
|||
filtered.side_effect = [], [record] |
|||
yield filtered |
|||
|
|||
def new_record(self, method='sftp'): |
|||
vals = { |
|||
'name': u'Têst backup', |
|||
'method': method, |
|||
} |
|||
if method == 'sftp': |
|||
vals.update({ |
|||
'sftp_host': 'test_host', |
|||
'sftp_port': '222', |
|||
'sftp_user': 'tuser', |
|||
'sftp_password': 'password', |
|||
'folder': '/folder/', |
|||
}) |
|||
self.vals = vals |
|||
return self.Model.create(vals) |
|||
|
|||
def test_compute_name_sftp(self): |
|||
""" It should create proper SFTP URI """ |
|||
rec_id = self.new_record() |
|||
self.assertEqual( |
|||
'sftp://%(user)s@%(host)s:%(port)s%(folder)s' % { |
|||
'user': self.vals['sftp_user'], |
|||
'host': self.vals['sftp_host'], |
|||
'port': self.vals['sftp_port'], |
|||
'folder': self.vals['folder'], |
|||
}, |
|||
rec_id.name, |
|||
) |
|||
|
|||
def test_check_folder(self): |
|||
""" It should not allow recursive backups """ |
|||
rec_id = self.new_record('local') |
|||
with self.assertRaises(exceptions.ValidationError): |
|||
rec_id.write({ |
|||
'folder': '%s/another/path' % tools.config.filestore( |
|||
self.env.cr.dbname |
|||
), |
|||
}) |
|||
|
|||
@mock.patch('%s._' % model) |
|||
def test_action_sftp_test_connection_success(self, _): |
|||
""" It should raise connection succeeded warning """ |
|||
rec_id = self.new_record() |
|||
with mock.patch.object(rec_id, 'sftp_connection'): |
|||
with self.assertRaises(exceptions.Warning): |
|||
rec_id.action_sftp_test_connection() |
|||
_.assert_called_once_with("Connection Test Succeeded!") |
|||
|
|||
@mock.patch('%s._' % model) |
|||
def test_action_sftp_test_connection_fail(self, _): |
|||
""" It should raise connection fail warning """ |
|||
rec_id = self.new_record() |
|||
with mock.patch.object(rec_id, 'sftp_connection') as conn: |
|||
conn().__enter__.side_effect = TestConnectionException |
|||
with self.assertRaises(exceptions.Warning): |
|||
rec_id.action_sftp_test_connection() |
|||
_.assert_called_once_with("Connection Test Failed!") |
|||
|
|||
def test_action_backup_local(self): |
|||
""" It should backup local database """ |
|||
rec_id = self.new_record('local') |
|||
filename = rec_id.filename(datetime.now()) |
|||
rec_id.action_backup() |
|||
generated_backup = [f for f in os.listdir(rec_id.folder) |
|||
if f >= filename] |
|||
self.assertEqual(1, len(generated_backup)) |
|||
|
|||
def test_action_backup_sftp_mkdirs(self): |
|||
""" It should create remote dirs """ |
|||
rec_id = self.new_record() |
|||
with self.mock_assets(): |
|||
with self.patch_filtered_sftp(rec_id): |
|||
conn = rec_id.sftp_connection().__enter__() |
|||
rec_id.action_backup() |
|||
conn.makedirs.assert_called_once_with(rec_id.folder) |
|||
|
|||
def test_action_backup_sftp_mkdirs_conn_exception(self): |
|||
""" It should guard from ConnectionException on remote.mkdirs """ |
|||
rec_id = self.new_record() |
|||
with self.mock_assets(): |
|||
with self.patch_filtered_sftp(rec_id): |
|||
conn = rec_id.sftp_connection().__enter__() |
|||
conn.makedirs.side_effect = TestConnectionException |
|||
rec_id.action_backup() |
|||
# No error was raised, test pass |
|||
self.assertTrue(True) |
|||
|
|||
def test_action_backup_sftp_remote_open(self): |
|||
""" It should open remote file w/ proper args """ |
|||
rec_id = self.new_record() |
|||
with self.mock_assets() as assets: |
|||
with self.patch_filtered_sftp(rec_id): |
|||
conn = rec_id.sftp_connection().__enter__() |
|||
rec_id.action_backup() |
|||
conn.open.assert_called_once_with( |
|||
assets['os'].path.join(), |
|||
'wb' |
|||
) |
|||
|
|||
def test_action_backup_sftp_remote_open(self): |
|||
""" It should open remote file w/ proper args """ |
|||
rec_id = self.new_record() |
|||
with self.mock_assets() as assets: |
|||
with self.patch_filtered_sftp(rec_id): |
|||
conn = rec_id.sftp_connection().__enter__() |
|||
rec_id.action_backup() |
|||
conn.open.assert_called_once_with( |
|||
assets['os'].path.join(), |
|||
'wb' |
|||
) |
|||
|
|||
def test_action_backup_all_search(self): |
|||
""" It should search all records """ |
|||
rec_id = self.new_record() |
|||
with mock.patch.object(rec_id, 'search'): |
|||
rec_id.action_backup_all() |
|||
rec_id.search.assert_called_once_with([]) |
|||
|
|||
def test_action_backup_all_return(self): |
|||
""" It should return result of backup operation """ |
|||
rec_id = self.new_record() |
|||
with mock.patch.object(rec_id, 'search'): |
|||
res = rec_id.action_backup_all() |
|||
self.assertEqual( |
|||
rec_id.search().action_backup(), res |
|||
) |
|||
|
|||
@mock.patch('%s.pysftp' % model) |
|||
def test_sftp_connection_init_passwd(self, pysftp): |
|||
""" It should initiate SFTP connection w/ proper args and pass """ |
|||
rec_id = self.new_record() |
|||
rec_id.sftp_connection() |
|||
pysftp.Connection.assert_called_once_with( |
|||
host=rec_id.sftp_host, |
|||
username=rec_id.sftp_user, |
|||
port=rec_id.sftp_port, |
|||
password=rec_id.sftp_password, |
|||
) |
|||
|
|||
@mock.patch('%s.pysftp' % model) |
|||
def test_sftp_connection_init_key(self, pysftp): |
|||
""" It should initiate SFTP connection w/ proper args and key """ |
|||
rec_id = self.new_record() |
|||
rec_id.write({ |
|||
'sftp_private_key': 'pkey', |
|||
'sftp_password': 'pkeypass', |
|||
}) |
|||
rec_id.sftp_connection() |
|||
pysftp.Connection.assert_called_once_with( |
|||
host=rec_id.sftp_host, |
|||
username=rec_id.sftp_user, |
|||
port=rec_id.sftp_port, |
|||
private_key=rec_id.sftp_private_key, |
|||
private_key_pass=rec_id.sftp_password, |
|||
) |
|||
|
|||
@mock.patch('%s.pysftp' % model) |
|||
def test_sftp_connection_return(self, pysftp): |
|||
""" It should return new sftp connection """ |
|||
rec_id = self.new_record() |
|||
res = rec_id.sftp_connection() |
|||
self.assertEqual( |
|||
pysftp.Connection(), res, |
|||
) |
|||
|
|||
def test_filename(self): |
|||
""" It should not error and should return a .dump.zip file str """ |
|||
now = datetime.now() |
|||
res = self.Model.filename(now) |
|||
self.assertTrue(res.endswith(".dump.zip")) |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue