| Summary: | Add more tests to Yocto Project Compatible Layers script | ||
|---|---|---|---|
| Product: | [Build System, Metadata & Runtime] OE-Core | Reporter: | Aníbal Limón <anibal.limon> |
| Component: | Scripts and Tools | Assignee: | Paul Barker <paul> |
| Status: | NEW --- | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | Medium+ | CC: | goledhruva, juan.m.cruz.alcaraz, leonardo.sandoval.gonzalez, mikejongen12, patrick.ohly, poky.bs.watcher, poky.watcher, randy.macleod, richard.purdie, ross.burton, tvgamblin |
| Version: | 2.5 | ||
| Target Milestone: | 6.2 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | |||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Yes (doc changes required) | |
| Bug Depends on: | 10596 | ||
| Bug Blocks: | |||
|
Description
Aníbal Limón
2017-03-06 21:09:06 UTC
Can you be more specific about which tests we need to add? Bugs need to have specific objectives and should not be vague. Moving to NEEDINFO. There are some tests that needs to be made based on YP Compatible registration form [1]: - Test case to review if the README file specifies the maintainer. - Test case to review if the README file specifies where to send patches. - Test case to review if the README file contains the dependencies listed, this needs some format definition to be auditable?. - Test case to build what the layer provides, at this time only parsing is made. [1] https://www.yoctoproject.org/webform/yocto-project-compatible-registration This ticket was openned with the intention to start a conversation on additional tests for YP Compatibility script. I will move it to Target Milestone Future and use it as an umbrella bug as tests are requested or agreed. Should it be more appropriate to open an email conversation on the topic? (In reply to comment #3) > This ticket was openned with the intention to start a conversation on > additional tests for YP Compatibility script. > > I will move it to Target Milestone Future and use it as an umbrella bug as > tests are requested or agreed. > > Should it be more appropriate to open an email conversation on the topic? Test expectations for this ticket (README and provides) have been clearly defined and I believe this can be done on 2.5 (not future). From my last conversation with Anibal, he told me that he proposed this tests as starting point: - Test case to review if the README file specifies the maintainer. - Test case to review if the README file specifies where to send patches. - Test case to review if the README file contains the dependencies listed, this needs some format definition to be auditable?. - Test case to build what the layer provides, at this time only parsing is made. but that the README specifications still need to be discussed and approved. Besides, once more tests are added to the script, we would be forcing these caracteristics unto the community in order to obtain the compatibility certification. Richard, do you think theses tests are good to go? Are there more people in the community we should get approval from? We should add the three mentioned tests for the README, even just searching the file to ensure the words "maintainer" and "patch" are present and that there is an email address in the file would be a good start. I don't think we want to add build tests at this time. From what I understand so far, I will be adding code (that checks if strings "maintainer" and "patch" appear in README) under ``test_README()`` present here: https://git.yoctoproject.org/poky/tree/scripts/lib/compatlayer/cases/common.py?id=93633edcf84dbf5d97a43cb8d1ebff790a6ab334#n11 And then submit a patch for the same. Bulk move from 4.99 or 0.00 to 5.99 The tests for the README have been added. Are there any tasks that can be done for this bug at the moment? I did run the README test for a new layer created with `bitbake-layers create-layer`. The generated README starts with "This README file contains ". Since the maintainer/patch tests are skipped when the README file contains the word "README", the generated readme is not checked for maintainer/patch. (The check for "README" is for README files that reference other README files.) Maybe change the check to look for "README.md"? Paul to review for 6.2 work. |