@crvouga/atlas 0.4.0 → 0.6.0

package/packages/schema/schemas/publish-result.schema.json

@@ -0,0 +1,168 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/publish-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "const": true
+    },
+    "store": {
+      "description": "Where it was written: a folder, `s3://…` or a server URL",
+      "type": "string"
+    },
+    "layer": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The layer id: 64 hex digits, the SHA-256 of its content. Publishing the same input again gives the same id",
+          "type": "string"
+        },
+        "producer": {
+          "type": "string"
+        },
+        "environment": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "checks": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "passed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "notRun": {
+          "description": "Skipped, pending or otherwise not run",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "linkedToSpec": {
+          "description": "Checks that were matched to a spec file. The rest still count, but belong to no spec",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "freshness": {
+          "description": "Set when the checkout had uncommitted changes (`modified`) or no git origin (`unknown`)",
+          "type": "string",
+          "enum": [
+            "modified",
+            "unknown"
+          ]
+        },
+        "attachmentFiles": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "attachmentBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "id",
+        "producer",
+        "environment",
+        "checks",
+        "passed",
+        "failed",
+        "notRun",
+        "linkedToSpec",
+        "attachmentFiles",
+        "attachmentBytes"
+      ],
+      "additionalProperties": {}
+    },
+    "specSet": {
+      "description": "Present when `--specs` was given",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "branch": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "files",
+        "branch"
+      ],
+      "additionalProperties": {}
+    },
+    "run": {
+      "description": "Present with `--upload-run`",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "alreadyPublished": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "id",
+        "files",
+        "bytes",
+        "alreadyPublished"
+      ],
+      "additionalProperties": {}
+    },
+    "warnings": {
+      "description": "What was skipped and why, such as an attachment file that could not be read. Never fatal",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "ok",
+    "store",
+    "layer",
+    "warnings"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/ready.schema.json

@@ -0,0 +1,68 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/ready.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ready": {
+      "description": "True once the first pass over the backends is done and at least one backend answers",
+      "type": "boolean"
+    },
+    "layers": {
+      "description": "Distinct layers read",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "slots": {
+      "description": "Distinct checks (slots) the report holds a winner for",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "holding": {
+      "description": "Layers that still hold at least one winner",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "failed": {
+      "description": "Layers or backends that could not be read right now",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "refreshedAt": {
+      "description": "When a pass over the backends last finished, epoch milliseconds; 0 before the first",
+      "type": "number"
+    },
+    "backends": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "available": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "available"
+        ],
+        "additionalProperties": {}
+      }
+    }
+  },
+  "required": [
+    "ready",
+    "layers",
+    "slots",
+    "holding",
+    "failed",
+    "refreshedAt",
+    "backends"
+  ],
+  "additionalProperties": {}
+}

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

@@ -0,0 +1,100 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/report-event.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "version": {
+      "description": "The report version after these layers",
+      "type": "string"
+    },
+    "totalLayers": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "added": {
+      "description": "At most the 20 newest of the layers that arrived",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "producer": {
+            "type": "string"
+          },
+          "environment": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "branch": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "sha": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "recordedAtMs": {
+            "type": "number"
+          },
+          "counts": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string",
+              "enum": [
+                "passed",
+                "failed",
+                "running",
+                "not-run"
+              ]
+            },
+            "additionalProperties": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            }
+          }
+        },
+        "required": [
+          "id",
+          "producer",
+          "recordedAtMs"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "addedTotal": {
+      "description": "How many layers arrived, including those not listed",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": [
+    "version",
+    "totalLayers",
+    "added",
+    "addedTotal"
+  ],
+  "additionalProperties": {}
+}

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

@@ -0,0 +1,370 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/report-status.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "reasons": {
+      "description": "Why `ok` is false, in words. Empty when it is true",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "checks": {
+      "type": "object",
+      "properties": {
+        "passed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "running": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "not-run": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "passed",
+        "failed",
+        "running",
+        "not-run",
+        "total"
+      ]
+    },
+    "byEnvironment": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "passed": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "failed": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "running": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "not-run": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "total": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          }
+        },
+        "required": [
+          "passed",
+          "failed",
+          "running",
+          "not-run",
+          "total"
+        ]
+      }
+    },
+    "layers": {
+      "description": "Distinct layers read, across all backends",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "backends": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "label": {
+            "type": "string"
+          },
+          "available": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "label",
+          "available"
+        ]
+      }
+    },
+    "notices": {
+      "description": "What could not be read. Any notice fails the gate: unknown is not passed",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "specsWithoutEvidence": {
+      "description": "Specs of the outline with no result at all. The outline is `--specs <dir>`, or else the specs the layers recorded",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "specs": {
+      "description": "The outcome of each spec, so a dashboard needs nothing else",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "path": {
+            "description": "Null for checks that name no spec in the outline",
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "title": {
+            "type": "string"
+          },
+          "kind": {
+            "type": "string"
+          },
+          "checks": {
+            "type": "object",
+            "properties": {
+              "passed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "failed": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "running": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "not-run": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "passed",
+              "failed",
+              "running",
+              "not-run",
+              "total"
+            ]
+          },
+          "byEnvironment": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "passed": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "failed": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "running": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "not-run": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "total": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                }
+              },
+              "required": [
+                "passed",
+                "failed",
+                "running",
+                "not-run",
+                "total"
+              ]
+            }
+          }
+        },
+        "required": [
+          "path",
+          "title",
+          "kind",
+          "checks",
+          "byEnvironment"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "failing": {
+      "description": "Each slot whose newest completed result failed, or that is still running",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "spec": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "check": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "failed",
+              "running"
+            ]
+          },
+          "environment": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "producer": {
+            "type": "string"
+          },
+          "branch": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "sha": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "layer": {
+            "type": "string"
+          },
+          "backend": {
+            "type": "string"
+          },
+          "runUrl": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "detail": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "spec",
+          "check",
+          "title",
+          "status",
+          "environment",
+          "producer",
+          "branch",
+          "sha",
+          "layer",
+          "backend",
+          "runUrl",
+          "detail"
+        ],
+        "additionalProperties": {}
+      }
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "ok",
+    "reasons",
+    "checks",
+    "byEnvironment",
+    "layers",
+    "backends",
+    "notices",
+    "specsWithoutEvidence",
+    "specs",
+    "failing"
+  ],
+  "additionalProperties": {}
+}