search

beakerlib / libraries

Documentation for shared beakerlib libraries and general libraries requests.
2 stars 2 forks source link

Move or fork these to `teemtee` organization #12

Open LecrisUT opened 1 year ago

LecrisUT commented 1 year ago

It is a bit unintuitive to come to beakerlib to look for reusable tmt tests. At the very least this should be documented on tmt repo and website where to look for these tests

psss commented 1 year ago

The beakerlib libraries are closely related to beakerlib and thus it makes a complete sense to me to keep them under the beakerlib organization. The concept is described in the tmt documentation as well:

In the future this content is planned to be moved to the guide where it will have a bit more prominent place in the documentation structure. All in all I'd say we have this covered. Any thoughts on this, @lukaszachy, @sopos?

lukaszachy commented 1 year ago

Because of the background of tmt users we treat beakerlib better than other frameworks however beakerlib and its libraries are older and separate from tmt itself.

If tmt gains support for pytest one wouldn't expect to move pytest under teemtee org, right? IMO beakerlib is the same situation.

So +1 to psss to have better documentation about beakerlib and libraries to make it easier for people not familiar with them.

LecrisUT commented 1 year ago

Ok, but doesn't it also make sense to have a list of tmt plans that are designed to be reusable under tmt, or at least linked to?

psss commented 1 year ago

Seems there's a bit of misunderstanding: The beakerlib libraries is a concept which allows to use the rlImport function inside of a beakerlib test which imports additional utility functions from that library to be used by that test.

While tmt plans are used to enable testing, to group several tests together and define how the environment for them should be prepared. See also the Under The Hood section of the upstream guide.

It is true that the recently added feature to import remote plans now allows to share reusable plans. But, at least so far, there was not demand to create a shared repository for such plans as the setup is usually quite specific for given component. If there are such reusable plans, it could make sense to have them under the teemtee organization.

LecrisUT commented 1 year ago

Aah, got it. I didn't look deeply in the libraries themselves. An instruction about rlImport would be helpful here.

psss commented 1 year ago

@sopos, I guess it would be good to extend the libraries welcome page with some more details for those who are completely new to the concept.