feat: deserialize tag info from xml [FC-0049]

[rpenido]

Description

This PR adds support to deserialize tag info from the block XML, adding it to the new xml_attributes property. This is used to allow pasting OpenAsssessments components with their applied tags.

More Information

• Part of: [Tagging] Pasting XBlocks containing Tag data in clipboard modular-learning#180

Testing instructions

• Please ensure that the tests cover the expected behavior
• Follow the instructions at feat: paste tags when pasting xblocks with tag data [FC-0049] edx-platform#34270 and check if you can copy/paste an Open Assessment with tags and ensure that the tags are copied correctly

[openedx-webhooks]

Thanks for the pull request, @rpenido! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[rpenido]

This is working as expected manual testing in the edx-platform, but in the tests here, it fails. I think it is because this block doesn't have the XmlMixin. As it is a new dependency, I'm unsure if I should add it here or find another way to test it.

[yusuf-musleh]

Yes, I faced similar issues when implementing the copy functionality. Since we don't have access to the XBLOCK_MIXINS in edx-platform in this repo (because edx-ora2 is imported into edx-platform), you need to manually add the methods/fields for the tests to work.

Here is an example of how I did it in my tests:

edx-ora2/openassessment/xblock/test/test_xml.py

Lines 219 to 251 in c76a89c

	@ddt.file_data('data/serialize.json')
	def test_serialize_with_tags(self, data):
	self._configure_xblock(data)
	# Create a mocked serialize tag data method that returns no data
	def add_tags_to_node_no_tags(node): # pylint: disable=unused-argument
	return
	# Manually add the mocked method to the OpenAssessment block instance
	# This method will be added in the edx-platform repo through applying XBLOCK_MIXINS
	self.oa_block.add_tags_to_node = add_tags_to_node_no_tags
	xml = serialize_content(self.oa_block)
	# Confirm that no tags appear in the xml
	self.assertNotIn("tags-v1", xml)
	# Create a mocked serialize tag data method that returns data
	def add_tags_to_node_with_tags(node):
	# return "lightcast-skills:Typing,Microsoft Office"
	node.set('tags-v1', 'lightcast-skills:Typing,Microsoft Office')
	# Manually add the mocked method to the OpenAssessment block instance
	# This method will be added in the edx-platform repo through applying XBLOCK_MIXINS
	self.oa_block.add_tags_to_node = add_tags_to_node_with_tags
	xml = serialize_content(self.oa_block)
	# Confirm that tags appear in the xml
	self.assertIn("tags-v1=\"lightcast-skills:Typing,Microsoft Office\"", xml)
	# Clear the mocked serialize tag data method
	del self.oa_block.add_tags_to_node

[rpenido]

Thank you @yusuf-musleh! It took me some time but I figure it out with your help!

Could you take another look at it please?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.01%. Comparing base (c76a89c) to head (48f7a8f).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2181      +/-   ##
==========================================
+ Coverage   94.99%   95.01%   +0.01%     
==========================================
  Files         191      191              
  Lines       20999    21014      +15     
  Branches     1898     1899       +1     
==========================================
+ Hits        19949    19966      +17     
+ Misses        786      785       -1     
+ Partials      264      263       -1     

Flag	Coverage Δ
unittests	95.01% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pomegranited]

👍

• I tested this by copy/pasting tagged ORA2 blocks using this code and feat: paste tags when pasting xblocks with tag data [FC-0049] edx-platform#34270 , and it works as expected.
• I read through the code
• I checked for accessibility issues N/A
• Includes documentation
• User-facing strings are extracted for translation N/A

[openedx-webhooks]

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[pomegranited]

FYI @rpenido We can revert this change if open-craft/edx-platform#640 tests out ok.