Morphia Upgrade Testing

This project exists to automatically run the openrewrite recipe to assist when upgrading from 2.x to the upcoming 3.0 release. Failures in the actions are likely and most likely indicate areas that need to have a recipe written to migrate. Not every change can be automated so failures are likely a permanent issue.

Testing your own project

If you have a project that you would like to include in these runs to see how far off the upgrade process is, please file a pull request with the information listed below.

Each project needs a folder in ./projects. The bare minimum require is a file called git that contains the git repository url for your project. The git url should include the hash of the branch/version you want to test against. When you have that in place, you'll need to update the build workflow to include your named project in the matrix definition.

Typically, the build.sh script include should be sufficient to test against your project. If your project needs a little tweaking, like morphia's does, you can copy build.sh in to your project's folder and customize however you need.

Note

This build assumes a maven based build because that's what I use. If you use gradle, or heaven forfend, something else, you'll need to provide your own build.sh in your project's folder to build/run properly.

If you would like to use this framework to test your own project but can't, for whatever, go the pull request route (maybe your project is private so it's invisible from this project), you have a couple of options. Make the changes listed above. You can either fork the project and run the actions under your own credentials/org or you can simply run it manually locally with the test-local.sh script like so:

./test-local.sh myprivateproject

This is run it all in the local filesystem. If you have act installed (in this case, it's installed as an extension to github's gh tool), you can run it locally like this:

gh act --matrix project:myprivateproject | grep -vE "::debug::"

Note

You will need docker installed for this to work. The grep isn't entirely necessary but act (currently) emits a lot of debug statements that tend to occlude any useful information coming out of the action run.