Skip to content

feat(e2e): simplify the relation between manifest and testnet (backport #3964)#4308

Merged
mergify[bot] merged 2 commits intov1.xfrom
mergify/bp/v1.x/pr-3964
Oct 20, 2024
Merged

feat(e2e): simplify the relation between manifest and testnet (backport #3964)#4308
mergify[bot] merged 2 commits intov1.xfrom
mergify/bp/v1.x/pr-3964

Conversation

@mergify
Copy link
Copy Markdown
Contributor

@mergify mergify bot commented Oct 20, 2024

Refactors the e2e testbed to remove some unnecessary duplication between Manifest and Testnet, and ManifestNode and Node. Fields that are identical in the two types are removed from the latter, which includes (extends) the former. Fields that had the same name but different types or semantics in the two versions, were renamed in the manifest.

With this change, to add a new field to the configuration of a testnet or a node, it is enough to update the Manifest or ManifestNode. The new field must also be added to Testnet or Node if it needs to be somehow parsed (see the examples of the Seeds and PersistentPeers fields).


PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments

This is an automatic backport of pull request #3964 done by [Mergify](https://mergify.com).

Refactors the `e2e` testbed to remove some unnecessary duplication
between `Manifest` and `Testnet`, and `ManifestNode` and `Node`. Fields
that are identical in the two types are removed from the latter, which
includes (extends) the former. Fields that had the same name but
different types or semantics in the two versions, were renamed in the
manifest.

With this change, to add a new field to the configuration of a testnet
or a node, it is enough to update the `Manifest` or `ManifestNode`. The
new field must also be added to `Testnet` or `Node` if it needs to be
somehow parsed (see the examples of the `Seeds` and `PersistentPeers`
fields).

---

#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [ ] Updated relevant documentation (`docs/` or `spec/`) and code
comments

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Andy Nogueira <me@andynogueira.dev>
(cherry picked from commit 40c4b40)

# Conflicts:
#	test/e2e/generator/generate.go
#	test/e2e/pkg/testnet.go
@mergify mergify bot added the conflicts label Oct 20, 2024
@mergify mergify bot requested a review from a team as a code owner October 20, 2024 08:39
@mergify mergify bot requested a review from a team October 20, 2024 08:39
@mergify
Copy link
Copy Markdown
Contributor Author

mergify bot commented Oct 20, 2024

Cherry-pick of 40c4b40 has failed:

On branch mergify/bp/v1.x/pr-3964
Your branch is up to date with 'origin/v1.x'.

You are currently cherry-picking commit 40c4b404b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   test/e2e/pkg/infrastructure.go
	modified:   test/e2e/pkg/manifest.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   test/e2e/generator/generate.go
	both modified:   test/e2e/pkg/testnet.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot assigned cason Oct 20, 2024
Copy link
Copy Markdown

@cason cason left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Diffs are identical, except for the KeyType introduced in main but not yet present in v1.x.

@mergify mergify bot merged commit 11858db into v1.x Oct 20, 2024
@mergify mergify bot deleted the mergify/bp/v1.x/pr-3964 branch October 20, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant