@crvouga/atlas 0.0.0-stage → 0.2.0

package/packages/schema/schemas/manifest.schema.json

@@ -0,0 +1,160 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/manifest.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "run": {},
+    "charts": {
+      "type": "array",
+      "items": {}
+    },
+    "map": {
+      "type": "object",
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {}
+        },
+        "edges": {
+          "type": "array",
+          "items": {}
+        }
+      }
+    },
+    "states": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "transitions": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "paths": {
+      "type": "array",
+      "items": {}
+    },
+    "journeys": {
+      "type": "array",
+      "items": {}
+    },
+    "seeds": {
+      "type": "array",
+      "items": {}
+    },
+    "coverage": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "states": {
+            "type": "object",
+            "properties": {
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "passed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "failed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "flaky": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "notReached": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "total",
+              "passed",
+              "failed",
+              "flaky",
+              "notReached"
+            ]
+          },
+          "transitions": {
+            "type": "object",
+            "properties": {
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "passed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "failed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "flaky": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "notReached": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "total",
+              "passed",
+              "failed",
+              "flaky",
+              "notReached"
+            ]
+          }
+        }
+      }
+    },
+    "privacy": {},
+    "reports": {
+      "type": "object",
+      "properties": {
+        "junit": {
+          "type": "string"
+        },
+        "ctrf": {
+          "type": "string"
+        },
+        "mermaid": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "run"
+  ]
+}

package/packages/schema/schemas/path-record.schema.json

@@ -0,0 +1,151 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/path-record.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "name": {
+      "type": "string"
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "journey",
+        "generated"
+      ]
+    },
+    "description": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "passed",
+        "failed",
+        "flaky",
+        "not-reached"
+      ]
+    },
+    "progress": {
+      "type": "string",
+      "enum": [
+        "queued",
+        "running",
+        "complete"
+      ]
+    },
+    "attempts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string"
+          },
+          "error": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "stoppedAt": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "trace": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "traces": {
+            "description": "One trace per client, in a multi-client run",
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "status"
+        ]
+      }
+    },
+    "steps": {
+      "type": "array",
+      "items": {}
+    },
+    "stoppedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "key": {
+      "description": "The same start and events give the same key in every run",
+      "type": "string"
+    },
+    "start": {
+      "description": "The active states the path starts in",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "seed": {
+      "description": "The seed that put the system in the start states; setup did when absent",
+      "type": "string"
+    },
+    "journeys": {
+      "description": "The journeys this stretch belongs to",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "durationMs": {
+      "type": "number",
+      "minimum": 0
+    },
+    "setupMs": {
+      "description": "How long seeding (or setup) and the start check took",
+      "type": "number",
+      "minimum": 0
+    },
+    "reusedFrom": {
+      "description": "The run this result was kept from",
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "kind",
+    "status",
+    "steps"
+  ]
+}

package/packages/schema/schemas/report-sources.schema.json

@@ -0,0 +1,95 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/report-sources.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "sources": {
+      "type": "array",
+      "items": {
+        "anyOf": [
+          {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "maxLength": 80,
+                "pattern": "^[a-zA-Z0-9_-]+$"
+              },
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120
+              },
+              "type": {
+                "type": "string",
+                "const": "directory"
+              },
+              "runs": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "id",
+              "label",
+              "type",
+              "runs"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "maxLength": 80,
+                "pattern": "^[a-zA-Z0-9_-]+$"
+              },
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "http",
+                  "api"
+                ]
+              },
+              "baseUrl": {
+                "type": "string",
+                "minLength": 1
+              },
+              "eventsUrl": {
+                "type": "string",
+                "minLength": 1
+              },
+              "pollMs": {
+                "type": "integer",
+                "minimum": 1000,
+                "maximum": 3600000
+              },
+              "live": {
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "id",
+              "label",
+              "type",
+              "baseUrl"
+            ]
+          }
+        ]
+      }
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "sources"
+  ]
+}

package/packages/schema/schemas/run-info.schema.json

@@ -0,0 +1,176 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/run-info.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "startedAt": {
+      "type": "string"
+    },
+    "durationMs": {
+      "type": "number",
+      "minimum": 0
+    },
+    "commit": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "branch": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "environment": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "mode": {
+      "type": "string",
+      "enum": [
+        "fast",
+        "showcase"
+      ]
+    },
+    "specVersion": {
+      "type": "string"
+    },
+    "specDirectory": {
+      "type": "string"
+    },
+    "approvals": {
+      "type": "array",
+      "items": {}
+    },
+    "scope": {
+      "type": "object",
+      "properties": {
+        "chart": {
+          "type": "string"
+        },
+        "start": {
+          "type": "string"
+        },
+        "state": {
+          "description": "The state the run was scoped to",
+          "type": "string"
+        }
+      }
+    },
+    "finishedAt": {
+      "description": "Null while the run is still going; absent in older reports",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "progress": {
+      "type": "object",
+      "properties": {
+        "totalPaths": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "completedPaths": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "activePaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "updatedAt": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "totalPaths",
+        "completedPaths",
+        "activePaths",
+        "updatedAt"
+      ]
+    },
+    "workers": {
+      "description": "Path attempts that ran at once",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "shard": {
+      "description": "The part of the plan this run covered",
+      "type": "object",
+      "properties": {
+        "index": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        "count": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "index",
+        "count"
+      ]
+    },
+    "reused": {
+      "description": "Passed paths kept from an earlier run instead of running again",
+      "type": "object",
+      "properties": {
+        "from": {
+          "type": "string"
+        },
+        "paths": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "from",
+        "paths"
+      ]
+    },
+    "mergedFrom": {
+      "description": "The runs this run was composed from",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "id",
+    "startedAt",
+    "durationMs",
+    "mode",
+    "specVersion"
+  ]
+}