第 2 章 创建 YAML 规则

标签是为规则或规则集以及依赖项指定的 key=val 对。对于依赖项，供应商在检索它们时向依赖项添加标签。规则集上的标签由属于它的所有规则自动继承。

labels:
- "key1=val1"
- "key2=val2"

标签的密钥可以是 subdomain-prefix：

labels:
- "konveyor.io/key1=val1"

标签值可以为空：

labels:
- "konveyor.io/key="

标签值可以省略。在这种情况下，它被视为空值：

labels:
- "konveyor.io/key"

示例：

目前，分析器将以下标签添加到依赖项中：

labels:
- konveyor.io/dep-source=internal
- konveyor.io/language=java

例如，分析器会将 konveyor.io/dep-source 标签添加到具有值的依赖项中，指示依赖项是否是已知的开源依赖项。

要排除所有这样的开源依赖项的事件，您可以使用 --dep-label-selector，如下所示：

konveyor-analyzer …​ --dep-label-selector !konveyor.io/dep-source=open-source

分析器中的 Java 提供程序也可以向软件包列表中添加 exclude 标签。要排除所有这些软件包，您可以使用 --dep-label-selector 和 ! operator，如下所示：

konveyor-analyzer …​ --dep-label-selector !konveyor.io/exclude

规则可以包含两种类型的操作： message 和 tag。每个规则都包括其中一个规则或两者。

Message: "helpful message about the issue"

Example:

- ruleID: test-rule
  when:
    <CONDITION>
  message: Test rule matched. Please resolve this migration issue.

另外，消息可以包含到外部 URL 的超链接，以提供有关此问题或快速修复的相关信息。

links:
  - url: "konveyor.io"
    title: "Short title for the link"

消息也可以是模板，以包含有关通过规则上的自定义变量进行匹配的信息。

tag:
  - "tag1,tag2,tag3"
  - "Category=tag4,tag5"

Example

- ruleID: test-rule
  when:
    <CONDITION>
  tag:
  - Language=Golang
  - Env=production
  - Source Code

标签可以是字符串或 key=val 对，其中键被视为 MTA 中的标签类别。任何具有标签操作的规则都被称为本文档中的"标记规则"。

请注意，不会为仅包含标签操作的规则创建问题。

每个规则都有一个 when 块，它指定了一个需要满足 MTA 执行特定操作的条件。

when 块包含一个条件，但该条件可以在它下嵌套多个条件。

when:
  <condition>
    <nested-condition>

MTA 支持三种类型的条件： 提供程序、和 或。

when:
  <provider_name>.<capability>
    <input_fields>

when:
  builtin.file:
    pattern: "<regex_to_match_filenames>"

when:
  builtin.filecontent:
    filePattern: "<regex_to_match_filenames_to_scope_search>"
    pattern: "<regex_to_match_content_in_the_matching_files>"

when:
  builtin.xml:
    xpath: "<xpath_expressions>" 1
    filepaths: 2
      - "/src/file1.xml"
      - "/src/file2.xml"

when:
  builtin.json:
    xpath: "<xpath_expressions>" 1

when:
  # when more than one tags are given, a logical AND is implied
  hasTags: 1
    - "tag1"
    - "tag2"

when:
  java.referenced:
    pattern: "<pattern>" 1
    location: "<location>" 2

when:
  java.dependency:
    name: "<dependency_name>" 1
    upperbound: "<version_string>" 2
    lowerbound: "<version_string>" 3

when:
  go.referenced: "<regex_to_find_reference>"

when:
  go.dependency:
    name: "<dependency_name>" 1
    upperbound: "<version_string>" 2
    lowerbound: "<version_string>" 3

- ruleID: lang-ref-004
   customVariables:
   - pattern: '([A-z]+)\.get\(\)' 1
      name: VariableName 2
    message: "Found generic call - {{ VariableName }}" 3
  when:
      java.referenced:
          location: METHOD_CALL
          pattern: com.example.apps.GenericClass.get

分析器提供了两个基本逻辑条件，和 或，它们可让您聚合其他条件的结果并创建更复杂的查询。

when:
  and:
    - <condition1>
    - <condition2>

when:
  and:
    - java.dependency:
        name: junit.junit
        upperbound: 4.12.2
        lowerbound: 4.4.0
    - java.referenced:
        location: IMPORT
        pattern: junit.junit

when:
  and:
  - and:
    - go.referenced: "*CustomResourceDefinition*"
    - java.referenced:
        pattern: "*CustomResourceDefinition*"
  - go.referenced: "*CustomResourceDefinition*"

when:
  or:
    - <condition1>
    - <condition2>

when:
  or:
  - java.dependency:
      name: junit.junit
      upperbound: 4.12.2
      lowerbound: 4.4.0
  - java.referenced:
      location: IMPORT
      pattern: junit.junit