SW-1783 unicode translations fix (mrbeam#1574)

Author: Yelko-mrbeam

octoprint_mrbeam/services/document_service.py

@@ -47,7 +47,10 @@ def get_document_simple_for(self, definition, language):
     def _get_title_translated(self, definition):
         title_key = string_util.separate_camelcase_words(definition.mrbeamdoc_type.value)
         title_translated = gettext(title_key)
-        self._log_error_on_missing_translation(title_key, str(title_translated))
+        if title_translated:
+            self._log_error_on_missing_translation(title_key, title_translated.encode('utf-8', 'ignore'))
+        else:
+            self._logger.error('title_translated is None. This should never be the case. Please check me.')
         return title_translated
 
     @staticmethod

tests/services/test_burger_menu_service.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from unittest import TestCase
 
 from mock import patch, MagicMock
@@ -52,3 +53,36 @@ def test_get_burger_menu_model__with_supported_language__should_return_documents
         self.assertIsNot(len(burger_menu_model.documents), 0)
         for document in burger_menu_model.documents:
             self.assertEquals(document.document_link.language, SupportedLanguage.GERMAN)
+
+    @patch('octoprint_mrbeam.services.burger_menu_service.MrBeamDocUtils.get_mrbeam_definitions_for')
+    @patch('octoprint_mrbeam.services.document_service.gettext')
+    @patch('octoprint_mrbeam.services.burger_menu_service.get_locale')
+    def test_get_burger_menu_model__with_unicode_translation__should_work(self, get_locale_mock, get_text_mock,
+                                                                          get_mrbeam_definitions_for_mock):
+        get_locale_mock.return_value = MagicMock(language='es')
+        get_text_mock.return_value = u'Guía de usuário äëïöü l\'ecole très Garçon sûr'
+        MOCK_DEFINITION = MrBeamDocDefinition(MrBeamDocType.USER_MANUAL, MrBeamModel.MRBEAM2,
+                                              [SupportedLanguage.ENGLISH, SupportedLanguage.SPANISH])
+        get_mrbeam_definitions_for_mock.return_value = [MOCK_DEFINITION]
+        burger_menu_model = self._burger_menu_service.get_burger_menu_model(MrBeamModel.MRBEAM2.value)
+        self.assertIsNot(len(burger_menu_model.documents), 0)
+        for document in burger_menu_model.documents:
+            self.assertEquals(document.document_link.language, SupportedLanguage.SPANISH)
+
+    @patch('octoprint_mrbeam.services.burger_menu_service.MrBeamDocUtils.get_mrbeam_definitions_for')
+    @patch('octoprint_mrbeam.services.document_service.gettext')
+    @patch('octoprint_mrbeam.services.burger_menu_service.get_locale')
+    def test_get_burger_menu_model__with_null_translation__should_not_crash_and_return_title_as_None(self,
+                                                                                                     get_locale_mock,
+                                                                                                     get_text_mock,
+                                                                                                     get_mrbeam_definitions_for_mock):
+        get_locale_mock.return_value = MagicMock(language='es')
+        get_text_mock.return_value = None
+        MOCK_DEFINITION = MrBeamDocDefinition(MrBeamDocType.USER_MANUAL, MrBeamModel.MRBEAM2,
+                                              [SupportedLanguage.ENGLISH, SupportedLanguage.SPANISH])
+        get_mrbeam_definitions_for_mock.return_value = [MOCK_DEFINITION]
+        burger_menu_model = self._burger_menu_service.get_burger_menu_model(MrBeamModel.MRBEAM2.value)
+        self.assertIsNot(len(burger_menu_model.documents), 0)
+        for document in burger_menu_model.documents:
+            self.assertEquals(document.document_link.language, SupportedLanguage.SPANISH)
+            self.assertEquals(document.title, None)