1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
# -*- coding: utf-8 -*-
###############################################################################
# PySword - A native Python reader of the SWORD Project Bible Modules #
# --------------------------------------------------------------------------- #
# Copyright (c) 2008-2019 Various PySword developers: #
# Kenneth Arnold, Joshua Gross, Tomas Groth, Ryan Hiebert, Philip Ridout, #
# Matthew Wardrop #
# --------------------------------------------------------------------------- #
# Permission is hereby granted, free of charge, to any person obtaining a #
# copy of this software and associated documentation files (the "Software"), #
# to deal in the Software without restriction, including without limitation #
# the rights to use, copy, modify, merge, publish, distribute, sublicense, #
# and/or sell copies of the Software, and to permit persons to whom the #
# Software is furnished to do so, subject to the following conditions: #
# #
# The above copyright notice and this permission notice shall be included #
# in all copies or substantial portions of the Software. #
# #
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE #
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING #
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER #
# DEALINGS IN THE SOFTWARE. #
###############################################################################
import os
from tests import TestCase, patch
from pysword.modules import SwordModules, get_platform_path
from pysword.bible import BlockType, CompressType
TEST_RESOURCE_FOLDER = os.path.join(os.path.dirname(os.path.realpath(__file__)), u'resources')
class TestSwordModules(TestCase):
def test_parse_modules_folder(self):
"""
Test that conf file from a folder can be parsed.
"""
# GIVEN: A SwordModules object using a folder for input
modules = SwordModules(TEST_RESOURCE_FOLDER)
# WHEN: parsing the modules conf files
mods_metadata = modules.parse_modules()
# THEN: Modules should be detectable and information extractable
module_list = [u'ChiPinyin', u'FinPR', u'BSV', u'ASV', u'OSHB', u'SpaRV1909']
self.assertTrue(all(x in module_list for x in mods_metadata.keys()),
u'Some expected bibles were not detected')
# Depending on the operating system, the handling of non-utf8 encoded conf-files is different
self.assertEqual(mods_metadata[u'FinPR'][u'description'], u'Finnish Pyhä Raamattu (1933/1938)',
u'Could not extract "description" for "FinPR"')
self.assertEqual(mods_metadata[u'BSV'][u'description'], u'The Bond Slave Version Bible',
u'Could not extract "description" for "BSV"')
self.assertEqual(mods_metadata[u'ASV'][u'description'], u'American Standard Version (1901)',
u'Could not extract "description" for "ASV"')
self.assertEqual(mods_metadata[u'OSHB'][u'description'], u'Open Scriptures Hebrew Bible',
u'Could not extract "description" for "OSHB"')
def test_parse_modules_zip(self):
"""
Test that conf file from a zip can be parsed.
"""
# GIVEN: A SwordModules object using a folder for input
modules = SwordModules(os.path.join(TEST_RESOURCE_FOLDER, u'FinPR.zip'))
# WHEN: parsing the modules conf files
mods_metadata = modules.parse_modules()
# THEN: Modules should be detectable and information extractable
self.assertEqual(1, len(mods_metadata.keys()), u'There should be only 1 module in a zip.')
self.assertIn(u'FinPR', mods_metadata.keys(), u'FinPR should be available')
self.assertEqual(mods_metadata['FinPR']['description'], u'Finnish Pyhä Raamattu (1933/1938)',
u'Could not extract "description" for "FinPR"')
def test_multiple_paths(self):
"""
Test that multiple paths are loaded correctly and that preference is given to later paths
"""
# GIVEN: A SwordModules object using multiple paths, including both
# directories and zip files
finpr = os.path.join(TEST_RESOURCE_FOLDER, u'FinPR.zip')
modules = SwordModules([TEST_RESOURCE_FOLDER, finpr])
# WHEN: parsing the conf files
mods_metadata = modules.parse_modules()
# THEN: All the modules should be present, and FinPR's module path
# should be the ZIP file, not the directory
module_list = [u'ChiPinyin', u'FinPR', u'BSV', u'ASV', u'OSHB', u'SpaRV1909']
self.assertTrue(all(x in module_list for x in mods_metadata.keys()),
u'Some expected bibles were not detected')
self.assertEqual(modules._module_paths['BSV'], TEST_RESOURCE_FOLDER, u'Module paths are broken')
self.assertNotEqual(modules._module_paths['FinPR'], TEST_RESOURCE_FOLDER,
u'FinPR was not loaded from the zip file')
def test_platform_paths(self):
"""
Test that constructing a SwordModules with no paths uses the platform default path
"""
# GIVEN: A SwordModules object constructed with no paths
modules = SwordModules()
# THEN: The search path should match get_platform_path()
self.assertEqual(len(modules._sword_paths), 1)
self.assertEqual(modules._sword_paths[0], get_platform_path())
@patch(u'pysword.modules.SwordBible')
def test_get_bible_from_module(self, mocked_sword_bible):
"""
Test that the assigning of default values works.
"""
# GIVEN: A SwordModules object
modules = SwordModules(u'test_sword_path')
modules._modules = {u'test_key': {u'datapath': u'test_path', u'moddrv': u'test_mod_type'}}
modules._module_paths = {u'test_key': u'test_sword_path'}
# WHEN: Requesting a bible from a module
bible = modules.get_bible_from_module(u'test_key')
# THEN: It should succeed
# Check that the returned mock bible has created with default values
self.assertIsNotNone(bible, u'Returned bible should not be None')
mocked_sword_bible.assert_called_with(os.path.join(u'test_sword_path', u'test_path'),
u'test_mod_type', u'kjv', None, None, BlockType.BOOK, CompressType.ZIP,
None)
|
