Move the e2e tests to a standalone, self dependent go module #1946
Conversation
fedepaol
force-pushed
the
standalonetests
branch
8 times, most recently
from
8525c6d
to
b62ca49
Compare
| @@ -48,45 +45,38 @@ require ( | |||
| github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect | |||
There was a problem hiding this comment.
there is a comment above "// pinning to specific versions is required because we are consuming
// the k8s.io/kubernetes module from the tests (via the "k8s.io/kubernetes/test/e2e/framework" package)
// See kubernetes/kubernetes#90358 (comment)"
Was this not supposed to delete this require block?
There was a problem hiding this comment.
We were pinning the deps explicitly only because of the e2e framework dependency. Since now this go.mod does not include the tests, we don't have the e2e framework so we can get rid of this.
On the contrary, we should delete the comment now.
| go 1.19 | ||
|
|
||
| use ( | ||
| ./ |
There was a problem hiding this comment.
I don't think you need this one?
There was a problem hiding this comment.
we do, if we remove it we'll get
main module (go.universe.tf/metallb) does not contain package go.universe.tf/metallb/e2etest
So we need the current module (e2e) and the metallb one in order to consume the api not from the most recent tag but from the version we have in the repo.
|
LGTM |
We make the e2etests a standalone go module, with no dependencies from the metallb's internal packages. This is done with a small amount of repetition (the packages that were consumed directly by metallb/internal are now copied under e2etest/pkg), but this is for a greater scope which is to make the e2e tests a standalone module dependant only from the MetalLB API. This will allow to reuse the infrastructure framework that was created in the testsuite also for the FRR Daemon, and at some point to move the e2e framework in a separated repo consumed by both. Signed-off-by: Federico Paolinelli <fpaoline@redhat.com>
This allows to avoid polluting the metallb go.mod with unnecessary dependencies, and relegates the need for pinning (because of the e2e framework) only to the e2e go.mod On top of that, we clean the main go.mod file removing all the dependencies that were necessary for tests only. Signed-off-by: Federico Paolinelli <fpaoline@redhat.com>
The e2etests are meant to consume the local version of MetalLB. At the same time, they are (currently) exported as a versioned framework for implementing tests. Since they belong to a separate module now, the way they'd work is to pull the latest tagged version of the MetalLB API, which makes the development not practical. By adding a local go.work file, we tell the e2e to consume the local version of the MetalLB module (basically, the API which is the only remained dependency) so we can evolve MetalLB and the tests together without incurring in chicken - egg issues. Signed-off-by: Federico Paolinelli <fpaoline@redhat.com>
Currently the e2e test framework contains a lot of logic, but has some dependencies that root into metallb/internal.
This makes it unpractical (and sometimes impossible) to export the framework to be consumed by other projects (such as the frr daemon being discussed here #1933 ).
On top of that, this means that the metallb's go.mod file is polluted by dependencies that are needed only by tests. Because of this, it makes sense to split the e2e tests in a standalone module that now depends only from the metallb api (and only for the specific metallb tests). This is done by copy-pasting / reimplementing some of the dependencies from the metallb's internal logic, under the spirit that is better to have something self contained (a little copy is better than a little dependency)
Also, fixes #1943