2.2. 创建基本 YAML 规则

流程

1. 在 /home/<USER& gt;/ 目录中，创建一个文件，其中包含 YAML 规则的基本语法，如下所示：

   - category: mandatory
     description: |
      <DESCRIPTION TITLE>
      <DESCRIPTION TEXT>
     effort: <EFFORT>
     labels:
     - konveyor.io/source=<SOURCE_TECH>
     - konveyor.io/target=<TARGET_TECH>
     links:
    - url: <HYPERLINK>
      title: <HYPERLINK_TITLE>
     message: <MESSAGE>
     tag:
     - <TAG1>
     - <TAG2>
     ruleID: <RULE_ID>
     when:
      <CONDITIONS>

流程

1. 如果要使用- rules 选项传递整个目录，请为 ruleset.yaml 文件创建一个模板：

   name: <RULESET_NAME> 1
   description: <RULESET_DESCRIPTION>
   labels: 2
     - key=val

   1

   该名称在提供的规则集内必须是唯一的。

   2

   ruleset 标签由属于规则集的所有规则继承。

流程

1. 创建 when 条件。

   YAML 规则的 when 条件可以是 provider、和 或 或。

   1. 创建 供应商 条件

      provider 条件用于定义对特定语言提供程序的搜索查询，并调用提供程序的特定功能。

      条件的一般格式为 < provider_name>.<capability>。该条件还具有 inner 字段，用于指定搜索的详细信息。创建 供应商 条件及其内部字段的方式取决于您使用的供应商以及您调用的功能。

      下表列出了可用的提供程序及其功能。选择一个供应商及其功能，以满足您要创建的规则的目的。条件的一部分还没有包含任何条件的字段。

      供应商	功能	描述
      java	引用	找到模式引用，包括注解，带有可选代码位置，用于详细搜索
      	依赖项	检查应用程序是否有给定依赖项
      builtin	xml	使用 XPath 查询搜索 XML 文件
      	json	使用 JSONPath 查询搜索 JSON 文件
      	FileContent	使用 RegEx 模式搜索常规文件中的内容
      	file	查找名称与给定模式匹配的文件
      	hasTags	检查是否通过标记规则为应用程序创建标签
      go	引用	查找模式引用
      	依赖项	检查应用程序是否有给定依赖项

      以下示例显示了使用 引用 能力的 java 供应商条件。

      Example

      when:
        java.referenced:

2. 为 供应商 条件添加合适的字段。

   下表列出了所有可用的供应商、其功能及其字段。选择属于您选择的供应商和功能的字段。请注意，一些字段是必须的。

   供应商	功能	字段	必需？	描述
   java	引用	pattern	是	RegEx pattern
   		位置	否	源代码位置；请参阅下面所有支持的搜索位置列表
   		annotated	否	注解及其元素（名称和值）
   	依赖项	名称	是	依赖项的名称
   		nameregex	否	与名称匹配的正则表达式模式
   		upperBound	否	匹配小于或等于的版本号
   		lowerBound	否	匹配大于或等于的版本号
   builtin	xml	XPath	是	XPath 查询
   		命名空间	否	映射到范围向下查询到命名空间
   		filepaths	否	用于范围搜索的可选文件列表
   	json	XPath	是	XPath 查询
   		filepaths	否	用于范围搜索的可选文件列表
   	FileContent	pattern	是	在内容中匹配的正则表达式模式
   		filePattern	否	仅在与此模式匹配的文件中搜索
   	file	pattern	是	查找与此模式匹配的名称的文件
   	hasTags	这是字符串标签的内联列表。有关标签格式的详情，请参阅 Rule Actions 中的 Tag Actions。
   go	引用	pattern	是	RegEx pattern
   	依赖项	名称	是	依赖项的名称
   		nameregex	否	与名称匹配的正则表达式模式
   		upperBound	否	匹配小于或等于的版本号
   		lowerBound	否	匹配大于或等于的版本号

   以下搜索位置可用于范围 java 搜索：

   • CONSTRUCTOR_CALL
   • TYPE
   • 继承
   • METHOD_CALL
   • 注解
   • IMPLEMENTS_TYPE
   • ENUM_CONSTANT
   • RETURN_TYPE
   • IMPORT

   • VARIABLE_DECLARATION

     以下示例显示搜索软件包引用的规则的 when 条件。

     Example

     when:
       java.referenced:
         location: PACKAGE
         pattern: org.jboss.*

3. 创建 AND 或 OR 条件

   • 当 所有子 条件都匹配时，和 条件都匹配。创建 和 条件，如下所示：

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

   • 当任何子条件都匹配时，或 条件会匹配。创建 或 条件，如下所示：

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