# Resource class in GitLab QA

> 原文：[https://docs.gitlab.com/ee/development/testing_guide/end_to_end/resources.html](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/resources.html)

*   [How to properly implement a resource class?](#how-to-properly-implement-a-resource-class)
    *   [Define API implementation](#define-api-implementation)
        *   [Resource attributes](#resource-attributes)
        *   [Product data attributes](#product-data-attributes)
        *   [Define an attribute based on an API response](#define-an-attribute-based-on-an-api-response)
*   [Creating resources in your tests](#creating-resources-in-your-tests)
*   [Where to ask for help?](#where-to-ask-for-help)

# Resource class in GitLab QA[](#resource-class-in-gitlab-qa "Permalink")

资源主要是使用浏览器 UI 步骤创建的，但也可以通过 API 或 CLI 创建的.

## How to properly implement a resource class?[](#how-to-properly-implement-a-resource-class "Permalink")

所有资源类都应继承自`Resource::Base` .

只有一种强制性方法可以实现以定义资源类. 这是`#fabricate!` 方法，用于通过浏览器 UI 构建资源. 请注意，在此方法中，您仅应使用[Page 对象](page_objects.html)与网页进行交互.

这是一个假想的例子：

```
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name

      def fabricate!
        Page::Dashboard::Index.perform do |dashboard_index|
          dashboard_index.go_to_new_shirt
        end

        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end
      end
    end
  end
end 
```

### Define API implementation[](#define-api-implementation "Permalink")

资源类还可以实现以下三种方法，以便能够通过公共 GitLab API 创建资源：

*   `#api_get_path` ：获取现有资源的`GET`路径.
*   `#api_post_path` ：用于创建新资源的`POST`路径.
*   `#api_post_body` ：用于创建新资源的`POST`正文（作为 Ruby 哈希）.

> 请注意，许多 API 资源都是[分页的](../../../api/README.html#pagination) . 如果找不到期望的结果，请检查是否有超过一页的结果.

让我们使用`Shirt`资源类，并添加以下三个 API 方法：

```
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name

      def fabricate!
        # ... same as before
      end

      def api_get_path
        "/shirt/#{name}"
      end

      def api_post_path
        "/shirts"
      end

      def api_post_body
        {
          name: name
        }
      end
    end
  end
end 
```

`Project`资源是浏览器 UI 和 API 实现的一个很好的真实示例.

#### Resource attributes[](#resource-attributes "Permalink")

一个资源可能首先需要另一个资源. 例如，一个项目需要在其中创建一个组.

要定义资源属性，可以将`attribute`方法与使用其他资源类的块一起使用以构造资源.

这将允许从资源对象的方法访问其他资源. 您通常会在`#fabricate!`使用它`#fabricate!` ， `#api_get_path` ， `#api_post_path` ， `#api_post_body` .

让我们使用`Shirt`资源类，并向其添加一个`project`属性：

```
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name

      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end

      def fabricate!
        project.visit!

        Page::Project::Show.perform do |project_show|
          project_show.go_to_new_shirt
        end

        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end
      end

      def api_get_path
        "/project/#{project.path}/shirt/#{name}"
      end

      def api_post_path
        "/project/#{project.path}/shirts"
      end

      def api_post_body
        {
          name: name
        }
      end
    end
  end
end 
```

**请注意，所有属性都是延迟构造的. 这意味着，如果您要首先构造特定的属性，则即使不使用它，也需要首先调用 attribute 方法.**

#### Product data attributes[](#product-data-attributes "Permalink")

创建后，您可能希望使用可在网页或 API 响应中找到的属性填充资源. 例如，创建项目后，您可能希望将其存储库 SSH URL 存储为属性.

同样，我们可以将`attribute`方法与块一起使用，使用页面对象来检索页面上的数据.

让我们以`Shirt`资源类`Shirt` ，并定义一个`:brand`属性：

```
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name

      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end

      # Attribute populated from the Browser UI (using the block)
      attribute :brand do
        Page::Shirt::Show.perform do |shirt_show|
          shirt_show.fetch_brand_from_page
        end
      end

      # ... same as before
    end
  end
end 
```

**再次注意，所有属性都是延迟构造的. 这意味着，如果您`shirt.brand`另一页面后再调用`shirt.brand` ，则由于我们不在预期的页面上，因此将无法正确检索数据.**

考虑一下：

```
shirt =
  QA::Resource::Shirt.fabricate! do |resource|
    resource.name = "GitLab QA"
  end

shirt.project.visit!

shirt.brand # => FAIL! 
```

上面的示例将失败，因为现在我们在项目页面上，试图从衬衫页面构造品牌数据，但是我们已经移至项目页面. 有两种解决方法，一种是我们可以在再次访问该项目之前尝试检索该品牌：

```
shirt =
  QA::Resource::Shirt.fabricate! do |resource|
    resource.name = "GitLab QA"
  end

shirt.brand # => OK!

shirt.project.visit!

shirt.brand # => OK! 
```

The attribute will be stored in the instance therefore all the following calls will be fine, using the data previously constructed. If we think that this might be too brittle, we could eagerly construct the data right before ending fabrication:

```
module QA
  module Resource
    class Shirt < Base
      # ... same as before

      def fabricate!
        project.visit!

        Page::Project::Show.perform do |project_show|
          project_show.go_to_new_shirt
        end

        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end

        populate(:brand) # Eagerly construct the data
      end
    end
  end
end 
```

`populate`方法将遍历其参数并分别调用每个属性. 这里`populate(:brand)`有像刚才一样的效果`brand` . 使用填充方法使意图更清晰.

这样，将确保我们在创建衬衫后立即构造数据. 缺点是，即使我们不需要使用数据，也总是在构造资源时构造数据.

另外，我们可以在构建品牌数据之前确保在正确的页面上：

```
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name

      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end

      # Attribute populated from the Browser UI (using the block)
      attribute :brand do
        back_url = current_url
        visit!

        Page::Shirt::Show.perform do |shirt_show|
          shirt_show.fetch_brand_from_page
        end

        visit(back_url)
      end

      # ... same as before
    end
  end
end 
```

这将确保在构建品牌之前，它在衬衫页面上，并返回到上一页以避免破坏状态.

#### Define an attribute based on an API response[](#define-an-attribute-based-on-an-api-response "Permalink")

有时，您想基于来自其`GET`或`POST`请求的 API 响应来定义资源属性. 例如，如果通过 API 创建衬衫的返回

```
{
  brand: 'a-brand-new-brand',
  style: 't-shirt',
  materials: [[:cotton, 80], [:polyamide, 20]]
} 
```

您可能希望将`style` `main_fabric`在资源中，并在`main_fabric`属性中获取第一个`materials`项的第一个值.

让我们以`Shirt`资源类`:main_fabric` ，并定义一个`:style`和`:main_fabric`属性：

```
module QA
  module Resource
    class Shirt < Base
      # ... same as before

      # @style from the instance if present,
      # or fetched from the API response if present,
      # or a QA::Resource::Base::NoValueError is raised otherwise
      attribute :style

      # If @main_fabric is not present,
      # and if the API does not contain this field, this block will be
      # used to construct the value based on the API response, and
      # store the result in @main_fabric
      attribute :main_fabric do
        api_response.&dig(:materials, 0, 0)
      end

      # ... same as before
    end
  end
end 
```

**有关属性优先级的说明：**

*   资源实例变量具有最高优先级
*   API 响应中的属性优先于块中的属性（通常是来自浏览器用户界面）
*   没有值的属性将引发`QA::Resource::Base::NoValueError`错误

## Creating resources in your tests[](#creating-resources-in-your-tests "Permalink")

要在测试中创建资源，可以调用`.fabricate!` 资源类上的方法. 请注意，如果资源类支持 API 构造，则默认情况下将使用该构造.

这是一个示例，由于`Shirt`资源类支持该方法，因此将在后台使用 API​​构造方法：

```
my_shirt = Resource::Shirt.fabricate! do |shirt|
  shirt.name = 'my-shirt'
end

expect(page).to have_text(my_shirt.name) # => "my-shirt" from the resource's instance variable
expect(page).to have_text(my_shirt.brand) # => "a-brand-new-brand" from the API response
expect(page).to have_text(my_shirt.style) # => "t-shirt" from the API response
expect(page).to have_text(my_shirt.main_fabric) # => "cotton" from the API response via the block 
```

如果您明确希望使用浏览器 UI 的制作方法，则可以调用`.fabricate_via_browser_ui!` 方法：

```
my_shirt = Resource::Shirt.fabricate_via_browser_ui! do |shirt|
  shirt.name = 'my-shirt'
end

expect(page).to have_text(my_shirt.name) # => "my-shirt" from the resource's instance variable
expect(page).to have_text(my_shirt.brand) # => the brand name fetched from the `Page::Shirt::Show` page via the block
expect(page).to have_text(my_shirt.style) # => QA::Resource::Base::NoValueError will be raised because no API response nor a block is provided
expect(page).to have_text(my_shirt.main_fabric) # => QA::Resource::Base::NoValueError will be raised because no API response and the block didn't provide a value (because it's also based on the API response) 
```

您还可以通过调用`.fabricate_via_api!`来显式使用 API `.fabricate_via_api!` 方法：

```
my_shirt = Resource::Shirt.fabricate_via_api! do |shirt|
  shirt.name = 'my-shirt'
end 
```

在这种情况下，结果将类似于调用`Resource::Shirt.fabricate!` .

## Where to ask for help?[](#where-to-ask-for-help "Permalink")

如果您需要更多信息，请在 Slack 上的`#quality`频道（仅限内部，GitLab 团队）上寻求帮助.

如果你不是一个团队成员，你仍然需要帮助的贡献，请打开 GitLab CE 问题追踪的一个问题`~QA`标签.