第2章 YAML ルールを作成する

ラベルは、ルールまたはルールセット、および依存関係に対して指定された key=val のペアです。依存関係の場合、プロバイダーは依存関係を取得する際にラベルを依存関係に追加します。ルールセットのラベルは、それに属するすべてのルールに自動的に継承されます。

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

ラベルのキーにはサブドメインの接頭辞を付けることができます。

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 プロバイダーは、パッケージのリストに除外ラベルを追加することもできます。このようなパッケージをすべて除外するには、次のように --dep-label-selector と ! 演算子を使用します。

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

ルールには、message と tag の 2 種類のアクションを含めることができます。各ルールには、いずれか一方または両方が含まれます。

message: "helpful message about the issue"

以下に例を示します。

- 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"

例:

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

タグは、文字列または key=val ペアにすることができ、キーは MTA のタグカテゴリーとして処理されます。このドキュメントでは、タグアクションを持つルールは「タグ付けルール」と呼ばれます。

タグアクションしか持たないルールに対しては問題が作成されない点に注意してください。

各ルールには、MTA が特定のアクションを実行するために満たす必要のある条件を指定する when ブロックがあります。

when ブロックには 1 つの条件が含まれますが、その条件の下に複数の条件をネストできます。

when:
  <condition>
    <nested-condition>

MTA は、provider、and、or の 3 種類の条件をサポートします。

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 tag is given, a logical AND is implied
  hasTags: 1
    - "tag1"
    - "tag2"

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

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

when:
  dotnet.referenced:
    pattern: "<pattern>" 1
    namespace: "<namespace>" 2

- 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

アナライザーには、and と or の 2 つの基本的な論理条件があります。これらを使用して、他の条件の結果を集計し、より複雑なクエリーを作成できます。

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