Adds xblock-utils repository code into this repository

[farhan]

Adds xblock-utils repository code into this repository

Relevant ticket: #675

Implementation details:
I have added xblock-utils code in the xblock/utils package and added their test cases in xblock/test/utils package

I didn't move the bok-choy integration test cases into the repo because the library has been deprecated.

Child PR to move docs: #672

[feanil]

@farhan rather than bringing the xbolckutils module directly, I think we want to move all the relevant code into a xblock.utils module. This keeps the code in the xblocks repository cleaner in the long run but will involve a bit more complexity to the move. Can you try to update this so that the code lives under the existing xblocks structure?

[farhan]

@farhan rather than bringing the xbolckutils module directly, I think we want to move all the relevant code into a xblock.utils module. This keeps the code in the xblocks repository cleaner in the long run but will involve a bit more complexity to the move. Can you try to update this so that the code lives under the existing xblocks structure?

@feanil Yes we can

I kept it separate for following 2 pros:

1. All the repos who are using xblock-utils don't need to update the imports
2. xblock-utils will stay as a separate layer

But if we want to keep it intact with the xblocks repo, it should reside inside

Let me refactor it.

1 more thing I am not going to add the bok-choy integration tests as we have deprecated the package

[feanil]

1 more thing I am not going to add the bok-choy integration tests as we have deprecated the package

That makes sense to me.

[feanil]

@farhan looks pretty good, there are a few more things I need to check before I can finish the review but so far this looks good. Can you link this PR to the corresponding PR in the xblock-utils repo?

[feanil]

A couple more comments and then I think this will be ready for review by Dave/Kyle.

[feanil]

@farhan Just one more note about the version.

[ormsbee]

I did not review all the files in the utils and test/utils packages because I assume they're coming straight over from xblockutils (except for the bok choy stuff that was dropped).

I'm also assuming that some manual testing is being done to make sure that things still work when we have a mix of XBlocks where some XBlocks are using xblock.utils and some are using xblockutils and we're installing both libraries at the same time–since this mode is likely to be very common for a while.

Otherwise, it looks good to me.

[farhan]

Thanks for review and sharing thoughts @ormsbee

I did not review all the files in the utils and test/utils packages because I assume they're coming straight over from xblockutils (except for the bok choy stuff that was dropped).

Yes they are coming straight from repo, no need to review all

I'm also assuming that some manual testing is being done to make sure that things still work when we have a mix of XBlocks where some XBlocks are using xblock.utils and some are using xblockutils and we're installing both libraries at the same time–since this mode is likely to be very common for a while.

Otherwise, it looks good to me.

Yes, some manual testing is done on DoneXBlock and repo is working fine with different pip package cases:

Screen Shots

[feanil]

@farhan I think you need to add a changelog entry to summarize that this is a move of code from the xblock-utils repository and then I think this is good to merge and release.

[farhan]

@farhan I think you need to add a changelog entry to summarize that this is a move of code from the xblock-utils repository and then I think this is good to merge and release.

@feanil I have added the changelog and merged the docs PR into this PR as well.
Please review the change logs, are we good to merge it and release it now?

change logs file

[feanil]

One small suggestion to the CHANGELOG and then I think this is good to merge and release.

[feanil]

👍🏾