commit | 252bca32512be13d78d75152ee9e3a3aef3487ad | [log] [tgz] |
---|---|---|
author | Rob Barnes <robbarnes@google.com> | Wed Nov 04 17:12:03 2020 |
committer | Commit Bot <commit-bot@chromium.org> | Tue Nov 10 21:38:38 2020 |
tree | 623e02125b6ecc043862291c0af44afff14228e0 | |
parent | 909e63c726b1214178da649f73c2944f0f8d5215 [diff] |
Change custom_usb_enable_names to custom_usb_enable_pins Boards need the flexibility to specify both direct gpios and gpios behind the io expander. BUG=b:170058619 TEST=Pass firmware_ECUsbPorts on Zork Cq-Depend: chromium:2521088 Change-Id: I160f2b4043da266fe17d6327bd18561f1b7a0b32 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/fw-testing-configs/+/2519483 Commit-Queue: Rob Barnes <robbarnes@google.com> Tested-by: Rob Barnes <robbarnes@google.com> Reviewed-by: Greg Edelston <gredelston@google.com> Reviewed-by: Edward Hill <ecgh@chromium.org>
go/cros-fw-testing-configs-guide
End-to-end firmware testing in ChromeOS relies on board-specific configuration files. Previously, those files were stored in Autotest. Now, they have been moved into a separate repository, fw-testing-configs, so that other testing frameworks (e.g. Tast, SerialTest) can access them too.
The design document for the new repository is at go/cros-fw-testing-configs.
All the config files are located at the top directory of the fw-testing-configs repository.
The fw-testing-configs repository currently has two checkouts in the ChromeOS manifest: one inside of Autotest, and one inside of tast-tests.
There is one config file for each platform, named as ${PLATFORM}.json
: for example, octopus.json
. There are also one special config file, DEFAULTS.json
and CONSOLIDATED.json
. DEFAULTS.json
contains default values and documentation for each attribute. CONSOLIDATED.json
is a generated file, containing the config data from all the other JSON files.
Each config file should contain a single object whose fields override the values specified in DEFAULTS.json
. Any fields which do not have a corresponding value in DEFAULTS.json
will be ignored.
There are a few special fields to be aware of:
platform
(required): A string which should exactly match the config file’s basename (minus the .json
extension).parent
(optional): A string which can contain the name of a parent platform, whose fields will be inherited with lower precedence. See “Inheritance” below. Example: asuka.jsonmodels
(optional): An object which can contain the names of any models, whose fields will be inherited with higher precedence. See “Inheritance” below. Example: octopus.jsonThere is an inheritance model in these config files. In all cases, the most specific configuration is used:
[Model > ] Platform [ > Parent [...] ] > DEFAULTS
For each attribute that exists in DEFAULTS.json
(besides the documentation attributes):
models[${MODEL}]
, then that is the value that is used.${PLATFORM}.json
, then that is the value that is used.${PLATFORM}.json
specifies a parent configuration via the parent
attribute, then that is the value that is used.parent
attribute.DEFAULTS.json
is used.CONSOLIDATED.json
is a generated script containing the data from all other JSON files. This allows Tast tests to access the config data. Thus, it is important to keep CONSOLIDATED.json
up-to-date.
When you make a change to fw-testing-configs JSON, before you upload, be sure to run ./consolidate.py
(with no command-line args). This will update CONSOLIDATED.json
. Amend your change to include the update CONSOLIDATED.json
, and then re-upload.
A preupload hook will verify that your CONSOLIDATED.json
is up-to-date.
fw-testing-configs is a separate repository from both Autotest and tast-tests. Thus, edits to fw-testing-configs require a separate CL from edits to Autotest and tast-tests. If you are accustomed to working with config files directly in Autotest, this is a slightly different workflow.
When you are editing config files, please be sure to run git commands from within the fw-testing-configs checkout. If you run git add .
or repo upload --cbr .
from within autotest/server/cros/faft/
, then your changes to the config files will not be captured.
If you are modifying both test files and config files, then you will need at least two CL’s: one for the test change, and one for the fw-testing-configs change. Consider also whether your change will impact the other testing repositories (Autotest, Tast, SerialTest): you might need to run tests or make changes there, too.
When submitting multiple CL’s like that, please use the Cq-Depend syntax as appropriate. If you don‘t use Cq-Depend, you risk the name of a config attribute changing while tests are still looking for the old name, and then tests will break. The reverse is a risk, too. You might need both CL’s to depend on each other. Note that this while this precaution mitigates risk, it does not fully eliminate risk: only one of the CL’s might get uploaded to the lab machines running Autotest/Tast, or one CL may be reverted without the other.
In Autotest, configs are loaded during FirmwareTest.initialize
. Config values can be accessed via self.faft_config.${ATTRIBUTE}
, such as self.faft_config.chrome_ec
.
In Tast, configs can be created via firmware.NewConfig
. In order to conform with Go’s style, attribute names are modified to MixedCaps. Config values can be accessed via cfg[${ATTRIBUTE}]
, such as cfg[ChromeEC]
.