-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add two new options, merge_js and overrite_from_partial
Refs: FC-0012 OEP-58
- Loading branch information
Showing
2 changed files
with
188 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,9 @@ | ||
| from datetime import datetime, timedelta | ||
| from functools import wraps | ||
| import os | ||
| from unittest import mock | ||
|
|
||
| import ddt | ||
| import polib | ||
| from path import Path | ||
|
|
||
|
|
@@ -9,12 +12,51 @@ | |
| from . import I18nToolTestCase, MOCK_DJANGO_APP_DIR | ||
|
|
||
|
|
||
| def extract_options(): | ||
| """ | ||
| Decorator for test methods in TestExtract class. | ||
| It wraps the test method in a function that calls (extract.main) with various options using (ddt.data) | ||
| Sets the following attributes: | ||
| - ddt_flag_merge_js: True if the test method should be run with merge_js=True | ||
| - ddt_flag_combine_partial: True if the test method should be run with combine_partial=True | ||
| """ | ||
| def decorator(test_method): | ||
| """ | ||
| The decorator itself | ||
| """ | ||
| @wraps(test_method) | ||
| @ddt.data( | ||
| (True, True), | ||
| (True, False), | ||
| (False, True), | ||
| (False, False), | ||
| ) | ||
| @ddt.unpack | ||
| def wrapped(self, flag_merge_js, flag_combine_partial): | ||
| """ | ||
| The wrapper function | ||
| """ | ||
| self.ddt_flag_merge_js = flag_merge_js | ||
| self.ddt_flag_combine_partial = flag_combine_partial | ||
| extract.main( | ||
| verbosity=0, | ||
| config=self.configuration._filename, | ||
| root_dir=MOCK_DJANGO_APP_DIR, | ||
| merge_js=flag_merge_js, | ||
| combine_partial=flag_combine_partial, | ||
| ) | ||
| test_method(self) | ||
| return wrapped | ||
| return decorator | ||
|
|
||
|
|
||
| @ddt.ddt | ||
| class TestExtract(I18nToolTestCase): | ||
| """ | ||
| Tests functionality of i18n/extract.py | ||
| """ | ||
| generated_files = ('django-partial.po', 'djangojs-partial.po', 'mako.po') | ||
|
|
||
| def setUp(self): | ||
| super().setUp() | ||
|
|
||
|
|
@@ -31,22 +73,53 @@ def setUp(self): | |
| ) | ||
| self.configuration = config.Configuration(root_dir=MOCK_DJANGO_APP_DIR) | ||
|
|
||
| # Run extraction script | ||
| extract.main(verbosity=0, config=self.configuration._filename, root_dir=MOCK_DJANGO_APP_DIR) | ||
| # These will be set by extract_options decorator. Also get_files will fail if they are None (to remind us | ||
| # to use the decorator all tests methods) | ||
| self.ddt_flag_merge_js = None | ||
| self.ddt_flag_combine_partial = None | ||
|
|
||
| @property | ||
| def django_po(self): | ||
| """ | ||
| Returns django.po or django-partial.po according to the combine_partial flag | ||
| """ | ||
| return 'django{partial_prefix}.po'.format( | ||
| partial_prefix='' if self.ddt_flag_combine_partial else '-partial' | ||
| ) | ||
|
|
||
| @property | ||
| def djangojs_po(self): | ||
| """ | ||
| Returns djangojs.po or djangojs-partial.po according to the combine_partial flag | ||
| """ | ||
| return 'djangojs{partial_prefix}.po'.format( | ||
| partial_prefix='' if self.ddt_flag_combine_partial else '-partial' | ||
| ) | ||
|
|
||
| def get_files(self): | ||
| """ | ||
| This is a generator. | ||
| Returns the fully expanded filenames for all extracted files | ||
| Fails assertion if one of the files doesn't exist. | ||
| """ | ||
| for filename in self.generated_files: | ||
| assert self.ddt_flag_merge_js is not None, "Use extract_options decorator" | ||
| assert self.ddt_flag_combine_partial is not None, "Use extract_options decorator" | ||
|
|
||
| # According to merge_js and combine_partial flags, we may have generated different files | ||
| # combine_partial = True: no partial files are generated, because they have overwritten the original ones | ||
| # merge_js = True: no djangojs*.po is generated, because it has been merged into django*.po | ||
| generated_files = ('mako.po', self.django_po,) | ||
| if not self.ddt_flag_merge_js: | ||
| generated_files += (self.djangojs_po,) | ||
|
|
||
| for filename in generated_files: | ||
| path = Path.joinpath(self.configuration.source_messages_dir, filename) | ||
| exists = Path.exists(path) | ||
| self.assertTrue(exists, msg='Missing file: %s' % path) | ||
| if exists: | ||
| yield path | ||
|
|
||
| yield path | ||
|
|
||
| @extract_options() | ||
| def test_files(self): | ||
| """ | ||
| Asserts that each auto-generated file has been modified since 'extract' was launched. | ||
|
|
@@ -56,6 +129,7 @@ def test_files(self): | |
| self.assertTrue(datetime.fromtimestamp(os.path.getmtime(path)) > self.start_time, | ||
| msg='File not recently modified: %s' % path) | ||
|
|
||
| @extract_options() | ||
| def test_is_keystring(self): | ||
| """ | ||
| Verifies is_keystring predicate | ||
|
|
@@ -67,6 +141,7 @@ def test_is_keystring(self): | |
| self.assertTrue(extract.is_key_string(entry1.msgid)) | ||
| self.assertFalse(extract.is_key_string(entry2.msgid)) | ||
|
|
||
| @extract_options() | ||
| def test_headers(self): | ||
| """ | ||
| Verify all headers have been modified | ||
|
|
@@ -79,6 +154,7 @@ def test_headers(self): | |
| msg='Missing header in %s:\n"%s"' % (path, header) | ||
| ) | ||
|
|
||
| @extract_options() | ||
| def test_metadata(self): | ||
| """ | ||
| Verify all metadata has been modified | ||
|
|
@@ -90,6 +166,7 @@ def test_metadata(self): | |
| expected = '[email protected]' | ||
| self.assertEquals(expected, value) | ||
|
|
||
| @extract_options() | ||
| def test_metadata_no_create_date(self): | ||
| """ | ||
| Verify `POT-Creation-Date` metadata has been removed | ||
|
|
@@ -98,3 +175,25 @@ def test_metadata_no_create_date(self): | |
| po = polib.pofile(path) | ||
| metadata = po.metadata | ||
| self.assertIsNone(metadata.get('POT-Creation-Date')) | ||
|
|
||
| @extract_options() | ||
| def test_merge_js(self): | ||
| """ | ||
| Verify that djangojs*.po is generated only if merge_js is False | ||
| """ | ||
| assert self.ddt_flag_merge_js != Path.exists( | ||
| Path.joinpath(self.configuration.source_messages_dir, self.djangojs_po,) | ||
| ) | ||
|
|
||
| @extract_options() | ||
| def test_combine_partial(self): | ||
| """ | ||
| Verify that partial files are not generated if combine_partial is True | ||
| """ | ||
| assert self.ddt_flag_combine_partial != Path.exists( | ||
| Path.joinpath(self.configuration.source_messages_dir, 'django-partial.po',) | ||
| ) | ||
| if not self.ddt_flag_merge_js: | ||
| assert self.ddt_flag_combine_partial != Path.exists( | ||
| Path.joinpath(self.configuration.source_messages_dir, 'djangojs-partial.po',) | ||
| ) | ||