srbala/os-autoinst-distri-fedora
1
0
Fork 0
mirror of https://pagure.io/fedora-qa/os-autoinst-distri-fedora.git synced 2024-11-25 15:23:08 +00:00
Code Issues Releases Activity
e5dc67126d
os-autoinst-distri-fedora/README.md

96 lines
7.5 KiB
Markdown
Raw Normal View History

document utility methods Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D554
2015-09-04 09:00:31 +00:00
openQA tests for the Fedora distribution
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
========================================
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
This repository contains tests and images for testing [Fedora](https://getfedora.org/) with [openQA](http://os-autoinst.github.io/openQA/). For additional tools, Installation Guide and Docker images, see [this repository](https://bitbucket.org/rajcze/openqa_fedora_tools).
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
Go back to documenting PRs via Phab for now Moving to Pagure for PRs and issues will require figuring out a way to migrate existing ones over, so let's just stick with Phab for now.
2017-01-12 22:53:18 +00:00
Issues
------
README: add a direct link to report issues in Phab
2017-01-13 12:59:06 +00:00
For the present, issues (and pull requests) are tracked in [Phabricator](https://phab.qa.fedoraproject.org/). You can open issues against the `openqa_fedora` project [here](https://phab.qa.fedoraproject.org/maniphest/task/edit/form/default/?tags=openqa_fedora).
Go back to documenting PRs via Phab for now Moving to Pagure for PRs and issues will require figuring out a way to migrate existing ones over, so let's just stick with Phab for now.
2017-01-12 22:53:18 +00:00
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
Test development
----------------
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
See official documentation on:
* [basic concept](https://github.com/os-autoinst/openQA/blob/master/docs/GettingStarted.asciidoc)
* [test development (including API specification)](https://github.com/os-autoinst/openQA/blob/master/docs/WritingTests.asciidoc)
* [needles specification](https://github.com/os-autoinst/os-autoinst/blob/master/doc/needles.txt)
* [supported variables for backend](https://github.com/os-autoinst/os-autoinst/blob/master/doc/backend_vars.asciidoc).
See [this example repo](https://github.com/os-autoinst/os-autoinst-distri-example) on how tests should be structured.
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
### main.pm modular architecture
Go back to documenting PRs via Phab for now Moving to Pagure for PRs and issues will require figuring out a way to migrate existing ones over, so let's just stick with Phab for now.
2017-01-12 22:53:18 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Since openQA uses only one entrypoint for all tests (main.pm), we have decided to utilize this feature and make tests modular. It means that basic passing through main.pm (without any variables set) results in most basic installation test executed. Developer can customize it with additional variables (for example by setting `PACKAGE_SET=minimal` to do installation only with minimal package set).
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Make your test modular, so that it utilizes `_boot_to_anaconda.pm`, `_software_selection.pm` and `_do_install_and_reboot.pm` tests (that are loaded automatically). Break your test into smaller parts, each dealing with one specific feature (e. g. partitioning, user creation...) and add their loading into main.pm based on reasonable variable setting (so they can be used in other tests also).
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Fedora installation (and consequently main.pm) consists of several parts:
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
#### Booting into Anaconda or booting live image and starting Anaconda
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Since there isn't much variation between tests in this step, we have developed universal `_boot_to_anaconda.pm` test that is loaded automatically each time except when `ENTRYPOINT` or `UPGRADE` is set (see VARIABLES.md).
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
To customize this step, you can set following variables:
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
- `GRUB` is appended to kernel line before boot. You can set for example `inst.updates` here.
- If `KICKSTART` is set, this part of installation ends here (program doesn't wait for Anaconda to appear). Note that you should set `inst.ks` yourself by setting `GRUB` variable.
- If `LIVE` is set, program waits for desktop to appear and then clicks on "Install to Hard Drive" button.
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
#### Customizing installation by interacting with Anaconda spokes
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Most of the differences between tests take place in this part. If you want to add another installation test, you will probably put your variable checking and test loading here. All tests in this part should start on Anaconda's main hub and after they done its part, they should go back to Anaconda's main hub so that next test could be executed. In this phase, universal `_software_selection.pm` test is loaded that handles selecting what software to install.
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
To customize this step, you can set following variables:
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
- Set `PACKAGE_SET` to install required package set on "Software selection spoke" - you have to provide correct needles with the name of `anaconda_${PACKAGE_SET}_highlighted` and `anaconda_${PACKAGE_SET}_selected`.
- Set `ENCRYPT_PASSWORD` to encrypt disk, value of this variable is used as an actual password.
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
#### Installing Fedora and waiting for Fedora to reboot
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
After all customizations are finished, `_do_install_and_reboot.pm` test is automatically loaded. It starts installation, creates user and sets root password when required, waits for installation to finish and reboots into installed system. Only variables that control flow in this part are these:
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
- `ROOT_PASSWORD` to set root password to this value.
- When set, `USER_LOGIN` and `USER_PASSWORD` are used to create user in Anaconda.
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
#### Post-install phase
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
After installation is finished and installed system is fully booted, you can run additional tests as checks that installed system has correct attributes - that correct file system is used, that RAID is used etc.
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
### Test inheritance
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Move all remaining utility functions into exporter modules Summary: This adds a couple of new exporter modules, renames main_common to utils (this is a better name: openSUSE's main_common is functions used in main.pm, utils is what they call their module full of miscellaneous commonly-used functions), and moves a bunch of utility functions that were previously needlessly implemented as instance methods in base classes into the exporter modules. That means we can get rid of all the annoying $self-> syntax for calling them. We get rid of `fedorabase` entirely, as it's no longer useful for anything. Other base classes keep the 'standard' methods (like `post_fail_hook`) and methods which actually need to be methods (like `root_console`, whose behaviour is different in anacondatest and installedtest). Test Plan: Do a full test suite run and check everything lines up. There should be no functional differences from before at all, this is just a re-org. Reviewers: jskladan, garretraziel_but_actually_jsedlak_who_uses_stupid_nicknames Reviewed By: garretraziel_but_actually_jsedlak_who_uses_stupid_nicknames Subscribers: tflink Differential Revision: https://phab.qa.fedoraproject.org/D1080
2017-01-18 07:15:44 +00:00
Your test can inherit from `basetest`, `installedtest` or `anacondatest`. Each provides relevant methods that are documented in-line, so read the files (`lib/anacondatest.pm`, `lib/installedtest.pm`) for information on these.
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
- `basetest`: A base class provided by os-autoinst - it has empty `post_fail_hook()` and doesn't set any flags.
- `anacondatest`: should be used in tests where Anaconda is running. It uploads Anaconda logs (for example `anaconda.log` or `packaging.log`) in `post_fail_hook()`.
- `installedtest`: should be used in tests that are running on installed system (either in postinstall phase or in upgrade tests).
Move all remaining utility functions into exporter modules Summary: This adds a couple of new exporter modules, renames main_common to utils (this is a better name: openSUSE's main_common is functions used in main.pm, utils is what they call their module full of miscellaneous commonly-used functions), and moves a bunch of utility functions that were previously needlessly implemented as instance methods in base classes into the exporter modules. That means we can get rid of all the annoying $self-> syntax for calling them. We get rid of `fedorabase` entirely, as it's no longer useful for anything. Other base classes keep the 'standard' methods (like `post_fail_hook`) and methods which actually need to be methods (like `root_console`, whose behaviour is different in anacondatest and installedtest). Test Plan: Do a full test suite run and check everything lines up. There should be no functional differences from before at all, this is just a re-org. Reviewers: jskladan, garretraziel_but_actually_jsedlak_who_uses_stupid_nicknames Reviewed By: garretraziel_but_actually_jsedlak_who_uses_stupid_nicknames Subscribers: tflink Differential Revision: https://phab.qa.fedoraproject.org/D1080
2017-01-18 07:15:44 +00:00
There are also several modules that export utility functions, currently `utils`, `anaconda`, `freeipa`, `packagetest` and `tapnet`. Your test can `use` any of these modules and then directly call the functions they export. Again, the functions are documented in-line.
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
### New test development workflow
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
Update some phab README links
2017-01-06 22:34:46 +00:00
1. Select test from [phabricator page](https://phab.qa.fedoraproject.org/w/openqa/tests/).
add comments and documentation Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D481
2015-08-05 06:23:59 +00:00
2. Put each part of your test as a separate file into `tests/` directory, reimplementing `run()` method
and `test_flags()` method, inheriting from one of the classes mentioned above.
3. Set correct variables (so that all test parts you have made are executed) in [WebUI -> Test suites](https://localhost:8080/admin/test_suites).
4. Link your newly created Test suite to medium type in [WebUI -> Job groups](https://localhost:8080/admin/groups).
5. Run test (see [openqa_fedora_tools repository](https://bitbucket.org/rajcze/openqa_fedora_tools)).
6. Create needles (images) by using interactive mode and needles editor in WebUI.
7. Add new Job template and Test suite into `templates` file.
mention main.pm architecture in README Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D495
2015-08-11 11:30:42 +00:00
8. Add new Test suite and Test case into [`conf_test_suites.py`](https://bitbucket.org/rajcze/openqa_fedora_tools/src/develop/tools/openqa_trigger/conf_test_suites.py)
file in openqa_fedora_tools repository.
Go back to documenting PRs via Phab for now Moving to Pagure for PRs and issues will require figuring out a way to migrate existing ones over, so let's just stick with Phab for now.
2017-01-12 22:53:18 +00:00
9. Open differential request via phabricator, set openqa_fedora as a project and repository.
Update some phab README links
2017-01-06 22:34:46 +00:00
10. Mark your test in [phabricator page](https://phab.qa.fedoraproject.org/w/openqa/tests/) as done.
add a french (encrypted) test Summary: this handles Non-English European Language Install. Basically it's a bunch of new screenshots for existing tag names, plus a bit of configurability in _boot_to_anaconda and tweaking some existing needles to do non-text matches. The weird 'half-the- icon' needles are for cases where there may or may not be a warning triangle but we want to click it either way (saves duplicating the needle). This also sets up a convention for tagging what languages a needle is appropriate for. If it's specifically appropriate for one or more languages, a tag ENV-LANGUAGE-(LANGUAGE) should be applied for each language, where (LANGUAGE) is the install language in upper-case ('LANGUAGE' variable, which should also be the string that will be typed into the language selection screen). If the needle ought to be used for *all* languages - i.e. it's not a text match, or any text in the match is known not to be translated - the tag ENV-INSTLANG-ALL should be applied. To back this, main.pm now unregisters all needles that are not tagged with either ENV-LANGUAGE-ALL or the tag for the language actually being used (if the LANGUAGE var is not set, we assume english). The point of this is to check the install is actually translated; if we allow all needles to match, the test would pass even if no translations appeared at all. Test Plan: Run all tests and make sure you get the expected results. You can schedule a run against 23 Beta TC1 to see the French test fails 'correctly' when translations are missing. Reviewers: jskladan, garretraziel Reviewed By: garretraziel Subscribers: tflink Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D577
2015-09-15 01:08:58 +00:00
### Language handling
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Tests can run in different languages. To set the language which will be used for a test, set the `LANGUAGE` variable for the test suite. The results of this will be:
add a french (encrypted) test Summary: this handles Non-English European Language Install. Basically it's a bunch of new screenshots for existing tag names, plus a bit of configurability in _boot_to_anaconda and tweaking some existing needles to do non-text matches. The weird 'half-the- icon' needles are for cases where there may or may not be a warning triangle but we want to click it either way (saves duplicating the needle). This also sets up a convention for tagging what languages a needle is appropriate for. If it's specifically appropriate for one or more languages, a tag ENV-LANGUAGE-(LANGUAGE) should be applied for each language, where (LANGUAGE) is the install language in upper-case ('LANGUAGE' variable, which should also be the string that will be typed into the language selection screen). If the needle ought to be used for *all* languages - i.e. it's not a text match, or any text in the match is known not to be translated - the tag ENV-INSTLANG-ALL should be applied. To back this, main.pm now unregisters all needles that are not tagged with either ENV-LANGUAGE-ALL or the tag for the language actually being used (if the LANGUAGE var is not set, we assume english). The point of this is to check the install is actually translated; if we allow all needles to match, the test would pass even if no translations appeared at all. Test Plan: Run all tests and make sure you get the expected results. You can schedule a run against 23 Beta TC1 to see the French test fails 'correctly' when translations are missing. Reviewers: jskladan, garretraziel Reviewed By: garretraziel Subscribers: tflink Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D577
2015-09-15 01:08:58 +00:00
1. The value set will be typed into the language search box in anaconda.
revise language tag handling to be easier to use (T617) Summary: T617 makes some good points about the language tags; this is my suggestion for an improvement. It requires a bit of cleverness in unregister_prefix_tags(), but the upshot is that you don't need to know to set any special tags when creating needles, a needle with no language-related tags will be considered as valid for all languages. You have to explicitly add LANGUAGE- tag(s) to a needle for the language filtering to 'kick in' in any way. If a needle has at least one LANGUAGE- tag, it will be filtered unless it has the appropriate tag for the job's specified language (default is still 'english'). With this approach, only needles which we specifically want to *only* match their tagged language(s) need the tags, so we can drop all those -ALL tags. We're using LANGUAGE- instead of ENV-LANGUAGE- now because the ENV- tag names denote tags that are treated slightly specially by openQA, and this is not one. We cannot cleanly use ENV-INSTLANG because openQA has a hardwired default of 'en_US' for that. Test Plan: Check both English and French tests still work as intended. Reviewers: jskladan, garretraziel Reviewed By: garretraziel Subscribers: tflink Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D589
2015-09-29 22:52:50 +00:00
2. Any needle with at least one tag that starts with `LANGUAGE` will be unregistered unless it has the tag `LANGUAGE-(LANGUAGE)` (where `(LANGUAGE)` is the value set, forced to upper-case).
add a french (encrypted) test Summary: this handles Non-English European Language Install. Basically it's a bunch of new screenshots for existing tag names, plus a bit of configurability in _boot_to_anaconda and tweaking some existing needles to do non-text matches. The weird 'half-the- icon' needles are for cases where there may or may not be a warning triangle but we want to click it either way (saves duplicating the needle). This also sets up a convention for tagging what languages a needle is appropriate for. If it's specifically appropriate for one or more languages, a tag ENV-LANGUAGE-(LANGUAGE) should be applied for each language, where (LANGUAGE) is the install language in upper-case ('LANGUAGE' variable, which should also be the string that will be typed into the language selection screen). If the needle ought to be used for *all* languages - i.e. it's not a text match, or any text in the match is known not to be translated - the tag ENV-INSTLANG-ALL should be applied. To back this, main.pm now unregisters all needles that are not tagged with either ENV-LANGUAGE-ALL or the tag for the language actually being used (if the LANGUAGE var is not set, we assume english). The point of this is to check the install is actually translated; if we allow all needles to match, the test would pass even if no translations appeared at all. Test Plan: Run all tests and make sure you get the expected results. You can schedule a run against 23 Beta TC1 to see the French test fails 'correctly' when translations are missing. Reviewers: jskladan, garretraziel Reviewed By: garretraziel Subscribers: tflink Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D577
2015-09-15 01:08:58 +00:00
3. As a consequence, the chosen language will be selected at the anaconda Welcome screen.
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
It is very important, therefore, that needles have the correct tags. Any needle which is expected to match for tests run in *any* language must have no `LANGUAGE` tags. Other needles must have the appropriate tag(s) for the languages they are expected to match. The safest option if you are unsure is to set no `LANGUAGE` tag(s). The only danger of this is that missing translations may not be caught.
revise language tag handling to be easier to use (T617) Summary: T617 makes some good points about the language tags; this is my suggestion for an improvement. It requires a bit of cleverness in unregister_prefix_tags(), but the upshot is that you don't need to know to set any special tags when creating needles, a needle with no language-related tags will be considered as valid for all languages. You have to explicitly add LANGUAGE- tag(s) to a needle for the language filtering to 'kick in' in any way. If a needle has at least one LANGUAGE- tag, it will be filtered unless it has the appropriate tag for the job's specified language (default is still 'english'). With this approach, only needles which we specifically want to *only* match their tagged language(s) need the tags, so we can drop all those -ALL tags. We're using LANGUAGE- instead of ENV-LANGUAGE- now because the ENV- tag names denote tags that are treated slightly specially by openQA, and this is not one. We cannot cleanly use ENV-INSTLANG because openQA has a hardwired default of 'en_US' for that. Test Plan: Check both English and French tests still work as intended. Reviewers: jskladan, garretraziel Reviewed By: garretraziel Subscribers: tflink Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D589
2015-09-29 22:52:50 +00:00
Update and unwrap README, move function docs in-line The README looks pretty ugly on Pagure. So let's unwrap it. Let's also move the function docs into the source files. We're much more likely to keep them up to date that way, I think. We should probably change over to proper perl POD documentation at some point, but comments in-line are OK for now I think.
2017-01-12 22:27:42 +00:00
Note that tags of the form `ENV-INSTLANG-(anything)` are useless artefacts and should be removed.
Reference in New Issue Copy Permalink