testgen_schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/unicode-org/message-format-wg/main/test/schemas/v0/tests.schema.json",
  "title": "MessageFormat 2 data-driven tests",
  "description": "This is the main schema for MessageFormat 2 test source data.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "tests"
  ],
  "properties": {
    "test_type": {
      "description": "The name of the test",
      "const": "message_fmt2"
    },
    "scenario": {
      "type": "string",
      "description": "Identifier for the tests in the file"
    },
    "description": {
      "type": "string",
      "description": "Information about the test scenario."
    },
    "defaultTestProperties": {
      "$ref": "#/$defs/defaultTestProperties"
    },
    "tests": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/test"
      },
      "minItems": 1
    }
  },
  "$comment": "This allOf specifies required test properties that allow a default. A value will be required in 'defaultTestProperties' if one is not provided for every individual test.",
  "allOf": [
    {
      "anyOf": [
        {
          "properties": {
            "defaultTestProperties": {
              "required": [
                "locale"
              ]
            }
          }
        },
        {
          "properties": {
            "tests": {
              "type": "array",
              "items": {
                "required": [
                  "locale"
                ]
              }
            }
          }
        }
      ]
    },
    {
      "anyOf": [
        {
          "properties": {
            "defaultTestProperties": {
              "required": [
                "src"
              ]
            }
          }
        },
        {
          "properties": {
             "tests": {
               "$comment": "type: array provided for clarity only",
               "type": "array",
               "items": {
                 "required": [
                   "src"
                ]
               }
             }
          }
        }
      ]
    },
    {
      "$comment": "Only one assertion is required. It doesn't matter which type.",
      "anyOf": [
        {
          "properties": {
            "defaultTestProperties": {
              "$ref": "#/$defs/anyExp"
            }
          }
        },
        {
          "properties": {
            "tests": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/anyExp"
              }
            }
          }
        }
      ]
    }
  ],
  "$defs": {
    "defaultTestProperties": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "locale": {
          "$ref": "#/$defs/locale"
        },
        "src": {
          "$ref": "#/$defs/src"
        },
        "bidiIsolation": {
          "$ref": "#/$defs/bidiIsolation"
        },
        "params": {
          "$ref": "#/$defs/params"
        },
        "exp": {
          "$ref": "#/$defs/exp"
        },
        "expParts": {
          "$ref": "#/$defs/expParts"
        },
        "expErrors": {
          "$ref": "#/$defs/expErrors"
        }
      }
    },
    "test": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "description": {
          "type": "string",
          "description": "Information about the test."
        },
        "locale": {
          "$ref": "#/$defs/locale"
        },
        "src": {
          "$ref": "#/$defs/src"
        },
        "bidiIsolation": {
          "$ref": "#/$defs/bidiIsolation"
        },
        "params": {
          "$ref": "#/$defs/params"
        },
        "comment": {
          "$ref": "#/$defs/comment"
        },
        "exp": {
          "$ref": "#/$defs/exp"
        },
        "expParts": {
          "$ref": "#/$defs/expParts"
        },
        "expErrors": {
          "$ref": "#/$defs/expErrors"
        },
        "ignoreCpp": {
          "$ref": "#/$defs/ignoreCpp"
        },
        "ignoreJava": {
          "$ref": "#/$defs/ignoreJava"
        },
        "char": {
          "$ref": "#/$defs/char"
        },
        "line": {
          "$ref": "#/$defs/line"
        },
        "only": {
          "type": "boolean",
          "description": "Normally not set. A flag to use during development to only run one or more specific tests."
        }
      }
    },
    "locale": {
      "description": "The locale to use for formatting.",
      "type": "string"
    },
    "src": {
      "oneOf": [
        {
          "description": "The MF2 syntax source.",
          "type": "string"
        },
        {
          "description": "The MF2 syntax source, as an array of strings to be concatenated.",
          "type": "array",
          "items": { "type": "string" }
        }
      ]
    },
    "bidiIsolation": {
      "description": "The bidi isolation strategy.",
      "enum": ["default", "none"]
    },
    "params": {
      "description": "Parameters to pass in to the formatter for resolving external variables.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/var"
      }
    },
    "var": {
      "type": "object",
      "oneOf": [
        {
          "additionalProperties": false,
          "required": [
            "name",
            "value"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "value": {}
          }
        },
        {
          "additionalProperties": false,
          "required": [
            "name",
            "type",
            "value"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "type": {
              "const": "datetime"
            },
            "value": {
              "$comment": "Should be converted to a datetime.",
              "type": "string"
            }
          }
        }
      ]
    },
    "comment": {
      "description": "A human-readable comment, meant to be ignored by the test runner",
      "type": "string"
    },
    "exp": {
      "description": "The expected result of formatting the message to a string.",
      "type": "string"
    },
    "expParts": {
      "description": "The expected result of formatting the message to parts.",
      "type": "array",
      "items": {
        "oneOf": [
          {
            "description": "Message literal part.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "type",
              "value"
            ],
            "properties": {
              "type": {
                "const": "literal"
              },
              "value": {
                "type": "string"
              }
            }
          },
          {
            "description": "Bidi isolation part.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "type",
              "value"
            ],
            "properties": {
              "type": {
                "const": "bidiIsolation"
              },
              "value": {
                "enum": ["\u2066", "\u2067", "\u2068", "\u2069"]
              }
            }
          },
          {
            "description": "Message markup part.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "type",
              "kind",
              "name"
            ],
            "properties": {
              "type": {
                "const": "markup"
              },
              "kind": {
                "enum": [
                  "open",
                  "standalone",
                  "close"
                ]
              },
              "source": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "options": {
                "type": "object"
              }
            }
          },
          {
            "description": "Message expression part.",
            "type": "object",
            "required": [
              "type",
              "source"
            ],
            "not": {
              "required": [
                "parts",
                "value"
              ]
            },
            "properties": {
              "type": {
                "type": "string"
              },
              "source": {
                "type": "string"
              },
              "locale": {
                "type": "string"
              },
              "parts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    },
                    "source": {
                      "type": "string"
                    },
                    "value": {}
                  },
                  "required": [
                    "type"
                  ]
                }
              },
              "value": {}
            }
          }
        ]
      }
    },
    "expErrors": {
      "description": "The runtime errors expected to be emitted when formatting the message. If expErrors is either absent or empty, the message must be formatted without errors.",
      "type": [
        "array",
        "boolean"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "enum": [
              "syntax-error",
              "variant-key-mismatch",
              "missing-fallback-variant",
              "missing-selector-annotation",
              "duplicate-declaration",
              "duplicate-option-name",
              "duplicate-variant",
              "unresolved-variable",
              "unknown-function",
              "bad-selector",
              "bad-operand",
              "bad-option",
              "bad-variant-key"
            ]
          }
        }
      }
    },
    "ignoreCpp": {
      "description": "If present, ignore this test when testing ICU4C. The string is an explanation of why the test doesn't pass.",
      "type": "string"
    },
    "ignoreJava": {
      "description": "If present, ignore this test when testing ICU4J. The string is an explanation of why the test doesn't pass.",
      "type": "string"
    },
    "char": {
      "description": "Optional character offset that should appear in syntax error. Only used by ICU4C currently",
      "type": "number"
    },
    "line": {
      "description": "Optional line number that should appear in syntax error. Only used by ICU4C currently",
      "type": "number"
    },
    "anyExp": {
      "anyOf": [
        {
          "required": [
            "exp"
          ]
        },
        {
          "required": [
            "expParts"
          ]
        },
        {
          "required": [
            "expErrors"
          ]
        }
      ]
    }
  }
}