numscript/specs.schema.json at main · formancehq/numscript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Specs",
  "type": "object",
  "additionalProperties": false,
  "required": ["testCases"],
  "properties": {
    "$schema": { "type": "string" },
    "balances": {
      "$ref": "#/definitions/Balances"
    },
    "variables": {
      "$ref": "#/definitions/VariablesMap"
    },
    "metadata": {
      "$ref": "#/definitions/AccountsMetadata"
    },
    "testCases": {
      "type": "array",
      "items": { "$ref": "#/definitions/TestCase" }
    },
    "featureFlags": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "definitions": {
    "TestCase": {
      "type": "object",
      "required": ["it"],
      "additionalProperties": false,
      "properties": {
        "it": {
          "type": "string",
          "description": "Test case description"
        },
        "focus": {
          "type": "boolean",
          "description": "Skip all the other tests. Just for debugging: it will result in an error exit code"
        },
        "skip": {
          "type": "boolean",
          "description": "Skip this test. Just for debugging: it will result in an error exit code"
        },

        "balances": {
          "$ref": "#/definitions/Balances"
        },
        "variables": {
          "$ref": "#/definitions/VariablesMap"
        },
        "metadata": {
          "$ref": "#/definitions/AccountsMetadata"
        },
        "expect.postings": {
          "type": "array",
          "items": { "$ref": "#/definitions/Posting" }
        },

        "expect.endBalances": {
          "$ref": "#/definitions/Balances"
        },
        "expect.endBalances.include": {
          "$ref": "#/definitions/Balances"
        },

        "expect.movements": {
          "$ref": "#/definitions/Movements"
        },

        "expect.txMetadata": {
          "$ref": "#/definitions/TxMetadata"
        },

        "expect.metadata": {
          "$ref": "#/definitions/AccountsMetadata"
        },

        "expect.error.missingFunds": {
          "type": "boolean"
        }
      }
    },

    "Balances": {
      "type": "object",
      "description": "Map of account names to asset balances",
      "additionalProperties": false,
      "patternProperties": {
        "^([a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+)*)$": {
          "type": "object",
          "additionalProperties": false,
          "patternProperties": {
            "^([A-Z]+(/[0-9]+)?)$": {
              "type": "number"
            }
          }
        }
      }
    },

    "VariablesMap": {
      "type": "object",
      "description": "Map of variable name to variable stringified value",
      "additionalProperties": false,
      "patternProperties": {
        "^[a-z_]+$": { "type": "string" }
      }
    },

    "AccountsMetadata": {
      "type": "object",
      "description": "Map of an account metadata to the account's metadata",
      "additionalProperties": false,
      "patternProperties": {
        "^([a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+)*)$": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        }
      }
    },

    "TxMetadata": {
      "type": "object",
      "description": "Map from a metadata's key to the transaction's metadata stringied value",
      "additionalProperties": { "type": "string" }
    },

    "Movements": {
      "type": "object",
      "description": "The funds sent from an account to another",
      "additionalProperties": false,
      "patternProperties": {
        "^([a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+)*)$": {
          "type": "object",
          "additionalProperties": false,
          "patternProperties": {
            "^([a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+)*)$": {
              "type": "object",
              "patternProperties": {
                "^([A-Z]+(/[0-9]+)?)$": {
                  "type": "number"
                }
              }
            }
          }
        }
      }
    },

    "Posting": {
      "type": "object",
      "properties": {
        "source": { "type": "string" },
        "destination": { "type": "string" },
        "asset": {
          "type": "string",
          "pattern": "^([A-Z]+(/[0-9]+)?)$"
        },
        "amount": {
          "type": "number"
        }
      },
      "required": ["source", "destination", "asset", "amount"]
    }
  }
}