landoscript diffs should have sorted filenames

[SoundBot]

This addresses this bugzilla ticket: https://bugzilla.mozilla.org/show_bug.cgi?id=1967637:

A typical diff is sorted by filename/path. The diffs that landoscript generates are not. This can plausibly happen in any action that calls diff_contents more than once, but I've certainly seen it in the android_l10n and merge_day actions.

It's an extremely minor thing, but it can be confusing to someone that's not aware that it may happen.

[bhearsum]

Thank you for putting this together! It looks largely fine modulo the few comments below.

Please also update https://github.com/mozilla-releng/scriptworker-scripts/blob/master/landoscript/src/landoscript/actions/android_l10n_import.py and https://github.com/mozilla-releng/scriptworker-scripts/blob/master/landoscript/src/landoscript/actions/version_bump.py to handle this correctly - thank you!

Also, while reviewing this I discovered an issue with the tests. That's being fixed in #1232. Once it lands you'll need to rebase your work on top of it to make sure it is tested properly.

[bhearsum]

This is impossible to hit in reality at the moment (because the CLOBBER file is always in this list), but if we need to return early here, we must return actions, because there may be others added above. (This is different than in android_l10n_sync of course, where there's only one potential action.)

It would probably be cleaner to write this as a if files_to_diff block anyways, and leave the only return statement at the end.

[SoundBot]

makes sense, I removed that.

[SoundBot]

@bhearsum I made these changes, and I'm waiting on #1232

[bhearsum]

@bhearsum I made these changes, and I'm waiting on #1232

Thanks! What I see looks good. I'll hold off on formally approving until that PR merges, and you can rebase on top of it.

[bhearsum]

@bhearsum I made these changes, and I'm waiting on #1232

Thanks! What I see looks good. I'll hold off on formally approving until that PR merges, and you can rebase on top of it.

This has merged now; you should be clear to refresh this work.

[SoundBot]

@bhearsum done! Please let me know if anything else is required.

P.S. Do contributions to this repository get an acknowledgment in the FF release notes? I'm talking about community contributions here

[bhearsum]

Unfortunately, this misses all but the first file. Due to the way the diffs are split, we lose the diff in the in the subsequent sections.

You can probably fix this by adjusting diffs after the splitting happens.

[SoundBot]

You are correct! I made changes.

Unrelated to that, I found and fixed some cases where the sorting order was incorrect

[bhearsum]

Nice work, thank you for working through all of this!

[bhearsum]

P.S. Do contributions to this repository get an acknowledgment in the FF release notes? I'm talking about community contributions here

I'll look into this; I think it's possible for this type of contribution.

[SoundBot]

@bhearsum thank you for you patience, and I appreciate your guidance!