fix: ensure conductor services are closed

[danyalprout]

Description

This PR updates the conductor tests to close down the op-conductor services created during e2e tests.

When working on #9618, we noticed the conductor tests would panic due to logging being output after the test had finished running:

panic: Log in goroutine after TestSequencerFailover_ConductorRPC has completed:             ERROR[04-30|02:54:20.066] health monitor failed to get sync status err="Post \"http://127.0.0.1:42055/\": dial tcp 127.0.0.1:42055: connect: connection refused"

goroutine 122725 [running]:
testing.(*common).logDepth(0xc0029ac9c0, {0xc003d4da20, 0xab}, 0x3)
       /usr/local/go/src/testing/testing.go:1022 +0x4c5
testing.(*common).log(...)
       /usr/local/go/src/testing/testing.go:1004
testing.(*common).Logf(0xc0029ac9c0, {0x23d214c?, 0x410be5?}, {0xc0103d00f0?, 0x1f34780?, 0xc00fff2801?})
       /usr/local/go/src/testing/testing.go:1055 +0x54
github.com/ethereum-optimism/optimism/op-service/testlog.(*logger).flush(0xc00ad11f50)
       /root/project/op-service/testlog/testlog.go:163 +0xdb
github.com/ethereum-optimism/optimism/op-service/testlog.(*logger).Error(0xc00ad11f50, {0x25a394b, 0x28}, {0xc036ace360, 0x2, 0x2})
       /root/project/op-service/testlog/testlog.go:115 +0xdb
github.com/ethereum-optimism/optimism/op-conductor/health.(*SequencerHealthMonitor).healthCheck(0xc025561360)
       /root/project/op-conductor/health/monitor.go:129 +0xe3
github.com/ethereum-optimism/optimism/op-conductor/health.(*SequencerHealthMonitor).loop(0xc025561360)
       /root/project/op-conductor/health/monitor.go:115 +0xaf
created by github.com/ethereum-optimism/optimism/op-conductor/health.(*SequencerHealthMonitor).Start in goroutine 23943
       /root/project/op-conductor/health/monitor.go:82 +0x8f

This seemed to consistently occur during the e2e fuzz tests that we added (likely due to them running serially/slower than the other tests).

[coderabbitai]

Walkthrough

Walkthrough

The updates involve enhancing the setupSequencerFailoverTest function to include a cleanup function that is returned alongside other values. This cleanup function is designed to manage resource shutdown effectively. The tests in sequencer_failover_test.go have been adjusted to utilize this new return value, ensuring that resources are properly cleaned up after each test, thus improving resource management and test reliability.

Changes

Files	Change Summary
op-e2e/.../sequencer_failover_setup.go	Modified setupSequencerFailoverTest to return a cleanup function along with existing values.
op-e2e/.../sequencer_failover_test.go	Updated tests to use the new cleanup function from setupSequencerFailoverTest, adding deferred cleanup steps to each test function.

---

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between acd8cf8 and ae9af94.

Files selected for processing (2)

• op-e2e/sequencer_failover_setup.go (2 hunks)
• op-e2e/sequencer_failover_test.go (4 hunks)

Additional comments not posted (4)

op-e2e/sequencer_failover_test.go (3)

17-18: Proper use of deferred cleanup to ensure resources are managed correctly.

---

30-31: Effective implementation of deferred cleanup to prevent resource leakage.

---

151-152: Correct implementation of deferred cleanup to ensure proper resource management during tests.

op-e2e/sequencer_failover_setup.go (1)

Line range hint 62-137: The addition of a cleanup function enhances resource management by ensuring proper closure of services post-test.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[axelKingsley]

👍