Ensure generated CI mocks are up to date

[pocaeus]

Description

Adds make targets to generate mocks, and adds configuration to run checks in CI to make sure generated mocks are included in a pull request.

Tests

No tests for make and CI stuff 🤷

Invariants

N/A

Additional context

N/A

Metadata

• Fixes #[54]

TODOs

• Author or reviewer has added an entry to the current release notes draft, if appropriate. (N/A)

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5fe5f53

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[netlify]

✅ Deploy Preview for opstack-docs canceled.

Name	Link
🔨 Latest commit	5fe5f53
🔍 Latest deploy log	https://app.netlify.com/sites/opstack-docs/deploys/648127aecd0704000875b1cb

[pocaeus]

The two checks I just added are currently failing because mockery is not available in the ci-builder container. I can add it to the Dockerfile, but I'm unsure how to push up those changes.

Alternatively I can install mockery in the CI job itself which is probably the easiest/fastest route but feels a little wasteful of CI time 🙂. Let me know what's preferable!

[smartcontracts]

Ok just waiting on a build/publish of the ci-builder image! Will keep you updated.

[smartcontracts]

@Lemma199 can you rebase this on the latest develop? Mockery should now be included in the image.

[pocaeus]

Thanks @smartcontracts, done!

[pocaeus]

Failing due to some diffs (basically comments):

-// Code generated by mockery v2.23.1. DO NOT EDIT.
+// Code generated by mockery v2.28.1. DO NOT EDIT.

There's also some code being removed (presumably stale):

diff --git a/op-node/p2p/mocks/GossipMetricer.go b/op-node/p2p/mocks/GossipMetricer.go
index 38ebf8d50..d5da64382 100644
--- a/op-node/p2p/mocks/GossipMetricer.go
+++ b/op-node/p2p/mocks/GossipMetricer.go
@@ -1,4 +1,4 @@
-// Code generated by mockery v2.22.1. DO NOT EDIT.
+// Code generated by mockery v2.28.1. DO NOT EDIT.
 
 package mocks
 
@@ -14,11 +14,6 @@ func (_m *GossipMetricer) RecordGossipEvent(evType int32) {
 	_m.Called(evType)
 }
 
-// SetPeerScores provides a mock function with given fields: _a0
-func (_m *GossipMetricer) SetPeerScores(_a0 map[string]float64) {
-	_m.Called(_a0)
-}
-

I can apply these changes and push up a new commit that includes them — I couldn't find what version (if any) documentation for this repository suggests to use for mockery, but moving forward CI would block a PR generating mocks if the user is not using the same version as the ci-builder container. Is that alright?

Alternatively I can modify the CI task to run with the disable-version-string configuration which would remove these version strings entirely but users would have to use the same configuration locally as well 🤷

[trianglesphere]

couldn't find what version (if any) documentation for this repository suggests to use for mockery

We don't have one. It was pretty recently added & hasn't been standardized. Individual devs have been responsible for keeping everything up to date. It's probably fine to requires a specific version if we let people know.

[ajsutton]

The GossipMetricer.go updates will cause some knock-on problems in peer_scorer_test.go which should actually be using a ScoreMetrics mock rather than GossipMetricer - I suspect some refactoring happened and because the mock wasn't updated, the test continued working. I ran into it with #5870 so it has the updates to peer_scorer_test required to make it work. I think it's probably better to pull the required changes in here since that's what they're really related to. I have some more testing to do on that other PR before it's ready to merge anyway and it won't be hard for me to sort out conflicts.

Good sign we need this check - thanks for picking it up. :)

[pocaeus]

Thanks for the heads up @ajsutton. I'm happy to wait for #5870 to be merged and then can rebase this PR, I don't mind leaving this open.

[mergify]

Hey @Lemma199! This PR has merge conflicts. Please fix them before continuing review.

[ajsutton]

That merge conflict is because #5870 just merged which should resolve the GossipMetricer mock issues. There may be other mocks out of date as well but hopefully just regenerating them with the right version will be all that's required to get it all green.

[pocaeus]

Fixed the conflicts and updated the mocks using 2.28.1. Should be good to go now! Thanks @ajsutton

[ajsutton]

LGTM. Thanks for this.

[mergify]

This PR has been added to the merge queue, and will be merged soon.

[mergify]

This PR is next in line to be merged, and will be merged as soon as checks pass.

[mergify]

This PR is next in line to be merged, and will be merged as soon as checks pass.