diff options
author | Rémy Coutable <remy@rymai.me> | 2018-10-18 13:56:04 +0000 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2018-10-18 13:56:04 +0000 |
commit | 280a4b95c00a85bbe593e301ea801b6d77dd4d8d (patch) | |
tree | 6383d9e6b3a09537550baf754670d1a76139548e | |
parent | 0621c8ba8c772966d38dea7e6440ac28e5421d4c (diff) | |
download | gitlab-ce-280a4b95c00a85bbe593e301ea801b6d77dd4d8d.tar.gz |
[QA] Fix resource API fabrication documentation
The precedence of methods to fetch a product's attribute value was changed recently:
1. API response
2. Web UI block
3. Inheritance from the factory
4. Raise a `QA::Factory::Product::NoValueError` error otherwise
-rw-r--r-- | qa/qa/factory/README.md | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/qa/qa/factory/README.md b/qa/qa/factory/README.md index c56c7c43129..10140e39510 100644 --- a/qa/qa/factory/README.md +++ b/qa/qa/factory/README.md @@ -254,8 +254,7 @@ module QA project.name = 'project-to-create-a-shirt' end - # Attribute inherited from the Shirt factory if present, - # or from the Browser UI otherwise (using the block) + # Attribute from the Browser UI (using the block) product :brand do Page::Shirt::Show.perform do |shirt_show| shirt_show.fetch_brand_from_page @@ -347,8 +346,7 @@ module QA project.name = 'project-to-create-a-shirt' end - # Attribute fetched from the API response if present if present, - # or from the Shirt factory if present, + # Attribute fetched from the API response if present, # or from the Browser UI otherwise (using the block) product :brand do Page::Shirt::Show.perform do |shirt_show| @@ -356,7 +354,7 @@ module QA end end - # Attribute fetched from the API response if present if present, + # Attribute fetched from the API response if present, # or from the Shirt factory if present, # or a QA::Factory::Product::NoValueError is raised otherwise product :name @@ -414,9 +412,9 @@ end **Notes on attributes precedence:** - attributes from the API response take precedence over attributes from the + Browser UI +- attributes from the Browser UI take precedence over attributes from the factory (i.e inherited) -- attributes from the factory (i.e inherited) take precedence over attributes - from the Browser UI - attributes without a value will raise a `QA::Factory::Product::NoValueError` error ## Creating resources in your tests |