[cuegui] Fix Comment dialog macros load and add tests. (#1261)

AcademySoftwareFoundation · Mar 1, 2023 · 2b7bfdd · 2b7bfdd
1 parent 60cbecd
commit 2b7bfdd
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 2 deletions.
diff --git a/cuegui/cuegui/Comments.py b/cuegui/cuegui/Comments.py
@@ -209,8 +209,11 @@ def refreshComments(self):
 
  def __macroLoad(self):
  """Loads the defined comment macros from settings"""
- self.__macroList = pickle.loads(
- str(self.app.settings.value("Comments", pickle.dumps({}))))
+ try:
+ self.__macroList = pickle.loads(self.app.settings.value("Comments", pickle.dumps({})))
+ except TypeError:
+ self.__macroList = pickle.loads(
+ str(self.app.settings.value("Comments", pickle.dumps({}))))
  self.__macroRefresh()
 
  def __macroRefresh(self):

diff --git a/cuegui/tests/Comments_tests.py b/cuegui/tests/Comments_tests.py
@@ -0,0 +1,74 @@
+# Copyright (c) OpenCue Project Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""Tests for cuegui.Comments."""
+
+
+import time
+import unittest
+
+import mock
+
+from qtpy import QtCore
+from qtpy import QtWidgets
+
+import opencue.compiled_proto.comment_pb2
+import opencue.compiled_proto.job_pb2
+import opencue.wrappers.comment
+import opencue.wrappers.job
+
+import cuegui.Comments
+import cuegui.Style
+
+from . import test_utils
+
+
+@mock.patch('opencue.cuebot.Cuebot.getStub', new=mock.Mock())
+class CommentsTests(unittest.TestCase):
+ @mock.patch('opencue.cuebot.Cuebot.getStub')
+ def setUp(self, getStubMock):
+ app = test_utils.createApplication()
+ app.settings = QtCore.QSettings()
+ cuegui.Style.init()
+
+ commentProto = opencue.compiled_proto.comment_pb2.Comment(
+ id='comment-id-1', timestamp=int(time.time()), user='user-who-made-comment',
+ subject='comment-subject', message='this is the comment message body')
+ self.comment = opencue.wrappers.comment.Comment(commentProto)
+ getStubMock.return_value.GetComments.return_value = \
+ opencue.compiled_proto.job_pb2.JobGetCommentsResponse(
+ comments=opencue.compiled_proto.comment_pb2.CommentSeq(comments=[commentProto]))
+
+ self.job = opencue.wrappers.job.Job(opencue.compiled_proto.job_pb2.Job(name='fooJob'))
+ self.parentWidget = QtWidgets.QWidget()
+ self.commentListDialog = cuegui.Comments.CommentListDialog(
+ self.job, parent=self.parentWidget)
+
+ def test_shouldDisplayComment(self):
+ self.assertEqual(
+ 1, self.commentListDialog._CommentListDialog__treeSubjects.topLevelItemCount())
+ gotTreeWidgetItem = self.commentListDialog._CommentListDialog__treeSubjects.topLevelItem(0)
+ gotComment = gotTreeWidgetItem._Comment__comment
+ self.assertEqual(self.comment.timestamp(), gotComment.timestamp())
+ self.assertEqual(self.comment.user(), gotComment.user())
+ self.assertEqual(self.comment.subject(), gotComment.subject())
+ self.assertEqual(self.comment.message(), gotComment.message())
+
+ def test_shouldRefreshJobComments(self):
+ self.job.getComments = mock.Mock(return_value=[])
+
+ self.commentListDialog.refreshComments()
+
+ self.job.getComments.assert_called()