Issue #7036 - [XTM Integration] Add support for providing workflow name

tests/test_xtm_translations_utils.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 from __future__ import unicode_literals
 
 import json
 import os
 
 import pytest
 
 from cms.translations.xtm import utils
 import cms.translations.xtm.constants as const
 from cms.sources import FileSource
 from cms.translations.xtm.xtm_api import XTMCloudAPI
-from tests.utils import exception_test
+from tests.utils import exception_test, XtmMockArgs
 
-_API_TOKEN = 'TheXTM-APIToken-VALID'
+_API_TOKEN_VALID = 'TheXTM-APIToken-VALID'
 _PROJECT_ID = 1234
 
 
 @pytest.fixture
 def toydir(tmpdir):
     """Toy directory fixture with two locales - 'de' and 'en'."""
     toydir = tmpdir.mkdir('toydir')
 
     en_dir = toydir.mkdir('en')
     en_dir.join('file.json').write(json.dumps({'a': 'b'}))
@@ skipping 111 matching lines @@
         utils.run_and_wait(func, Exception, exp_msg, retries=1)
 
     assert exp_msg == str(err.value)
 
 
 def test_resolve_locales(intercept_populated, temp_site):
     """Test if locales are resolved correctly.
 
     In this environment, no languages have to be added.
     """
-    api = XTMCloudAPI(_API_TOKEN)
+    api = XTMCloudAPI(_API_TOKEN_VALID)
     source = FileSource(str(temp_site))
     source.write_to_config('XTM', 'project_id', str(_PROJECT_ID))
 
     utils.resolve_locales(api, source)
 
 
 def test_resolve_locales_adds_langs(intercept, temp_site):
     """Test if locales are resolved correctly.
 
     In this environment, new target languages are added.
     """
-    api = XTMCloudAPI(_API_TOKEN)
+    api = XTMCloudAPI(_API_TOKEN_VALID)
     source = FileSource(str(temp_site))
     source.write_to_config('XTM', 'project_id', str(_PROJECT_ID))
     exp_targets = {'de_DE'}
 
     utils.resolve_locales(api, source)
 
     assert exp_targets == api.get_target_languages(_PROJECT_ID)
 
 
 def test_resolve_locales_raise_exception(intercept_populated, temp_site):
     """Test if locales are resolved correctly.
 
     In this environment, the API has more target languages configured than are
     available online. We except an exception to be raised.
     """
-    api = XTMCloudAPI(_API_TOKEN)
+    api = XTMCloudAPI(_API_TOKEN_VALID)
     api.add_target_languages(_PROJECT_ID, ['ro_RO'])
     source = FileSource(str(temp_site))
     source.write_to_config('XTM', 'project_id', str(_PROJECT_ID))
     exp_msg = ('The following languages are enabled in the API, but not '
                "listed in locales: set(['ro_RO'])! Please remove them manually"
                ' from project number 1234 and then re-run the script!')
 
     exception_test(utils.resolve_locales, Exception, exp_msg, api, source)
 
 
@@ skipping 16 matching lines @@
 @pytest.mark.parametrize('path', ['de/test.json', 'de/dir1/dir2/test.json'])
 def test_write_data(toydir, path):
     """Test if writing data to files works as expected."""
     data = bytes(json.dumps({'a': 'b'}))
 
     utils.write_to_file(data, str(toydir.join(path)))
 
     assert toydir.join(path).read('rb') == data
 
 
+@pytest.mark.parametrize('id_in,name,exp_err,exp_msg,exp_id', [
+    (1234, 'foo', Exception,
+     const.ErrorMessages.WORKFLOW_NAME_AND_ID_PROVIDED, None),
+    (None, None, Exception, const.ErrorMessages.NO_WORKFLOW_INFO, None),
+    (None, 'foo', Exception,
+     const.ErrorMessages.NO_WORKFLOW_FOR_NAME.format('foo'), None),
+    (1234, None, None, None, 1234),
+    (None, 'workflow1', None, None, 2222),
+])
+def test_handle_workflows(intercept, id_in, name, exp_err, exp_msg, exp_id):
+    """"""
+    namespace = XtmMockArgs.CreationArgsNamespace()
+    namespace.workflow_id = id_in
+    namespace.workflow_name = name
+
+    api = XTMCloudAPI(_API_TOKEN_VALID)
+
+    if exp_err:
+        exception_test(utils.extract_workflow_id, exp_err, exp_msg, api,
+                       namespace)
+    else:
+        id_out = utils.extract_workflow_id(api, namespace)
+
+        assert id_out == exp_id
+
+
 def test_extract_unicode_strings(temp_site):
     """Test correct extraction of unicode strings for translation."""
     with FileSource(temp_site) as fs:
         strings = utils.extract_strings(fs)
 
     assert '\u0376' in strings['translate-unicode']['simple']['message']