npm - @ship.zone/ci-spec - Versions diffs - 2.0.0 → 2.1.0 - Mend

@ship.zone/ci-spec 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/conformance/runner-job-cases.schema.json ADDED Viewed

@@ -0,0 +1,134 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://ship.zone/spec/ci/conformance/runner-job-cases.schema.json",
+  "title": "ship.zone compiled runner job coherence vectors",
+  "description": "Conformance vectors for compiled runner job coherence: the job failure codes in precedence order and cases that bind a compiled job, with its secret values inserted, to coherent or to the expected job failure code.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "spec",
+    "failureCodes",
+    "cases"
+  ],
+  "properties": {
+    "spec": {
+      "$ref": "../schemas/runner-job.schema.json#/$defs/specVersion"
+    },
+    "failureCodes": {
+      "description": "Every job failure code in the precedence order of spec/runner-protocol.md, Job Coherence.",
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/failureCode"
+      }
+    },
+    "cases": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/jobCase"
+      }
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "$ref": "../schemas/runner-job.schema.json#/$defs/identifier"
+    },
+    "failureCode": {
+      "enum": [
+        "spec_incompatible",
+        "job_schema_invalid",
+        "job_secret_incoherent",
+        "job_limit_incoherent",
+        "job_resources_incoherent",
+        "job_environment_incoherent",
+        "job_command_limit_exceeded",
+        "job_secret_inadmissible",
+        "job_digest_mismatch"
+      ]
+    },
+    "jobSource": {
+      "description": "The job: a packaged runner job fixture, or an inline JSON document.",
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "fixture"
+          ],
+          "properties": {
+            "fixture": {
+              "type": "string",
+              "pattern": "^conformance/runner-jobs/(?:valid|invalid|incoherent)/[a-z0-9-]+\\.json$"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "document"
+          ],
+          "properties": {
+            "document": true
+          }
+        }
+      ]
+    },
+    "jobCase": {
+      "description": "A compiled job with its secret values inserted, and the outcome of checking it: coherent, or the job failure code of the first rule it violates.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "job",
+        "expected"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/identifier"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "job": {
+          "$ref": "#/$defs/jobSource"
+        },
+        "expected": {
+          "oneOf": [
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "outcome"
+              ],
+              "properties": {
+                "outcome": {
+                  "const": "coherent"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "outcome",
+                "code"
+              ],
+              "properties": {
+                "outcome": {
+                  "const": "incoherent"
+                },
+                "code": {
+                  "$ref": "#/$defs/failureCode"
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}

package/conformance/runner-jobs/incoherent/artifact-maximum-above-limit.json ADDED Viewed

@@ -0,0 +1,91 @@
+{
+  "spec": "2.0.0",
+  "sourceObjectId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+  "workflowDigest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+  "compiledPlanDigest": "9a8661778a68db46c2b976334358d5917f51be15d5b4c80bc9fb934e7a366f99",
+  "requirements": {
+    "executionProfile": "oci",
+    "isolation": "container",
+    "labels": ["linux"],
+    "features": ["source.tar-gz", "artifacts", "caches"],
+    "limits": {
+      "maximumSourceArchiveBytes": 1048576,
+      "maximumSourceExtractedBytes": 4194304,
+      "maximumSourceEntries": 1000,
+      "maximumArtifactArchiveBytes": 104857600,
+      "maximumArtifactExtractedBytes": 524288000,
+      "maximumArtifactEntries": 10000,
+      "maximumArtifacts": 1,
+      "maximumCacheArchiveBytes": 1073741824,
+      "maximumCacheExtractedBytes": 4294967296,
+      "maximumCacheEntries": 100000,
+      "maximumCaches": 1,
+      "maximumLogChunkBytes": 65536,
+      "maximumTotalLogBytes": 10485760,
+      "maximumWorkspaceBytes": 8589934592,
+      "maximumWorkspaceEntries": 100000
+    }
+  },
+  "permissions": {
+    "source": "read",
+    "artifacts": "write",
+    "caches": "read-write",
+    "images": "none"
+  },
+  "network": {
+    "mode": "none"
+  },
+  "execution": {
+    "profile": "oci",
+    "image": "registry.example/ci@sha256:dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
+    "workingDirectory": "/workspace"
+  },
+  "steps": [
+    {
+      "name": "Test",
+      "command": ["pnpm", "test"],
+      "environment": {
+        "CI": "true",
+        "SHIPZONE_CI_INPUTS_JSON": "{}",
+        "SHIPZONE_CI_MATRIX_JSON": "{}"
+      }
+    }
+  ],
+  "source": {
+    "format": "tar.gz",
+    "sha256": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+    "sizeBytes": 1024,
+    "extractedSizeBytes": 4096,
+    "entryCount": 4
+  },
+  "secrets": {},
+  "timeoutMs": 3600000,
+  "resources": {
+    "memoryBytes": 268435456,
+    "cpus": 1,
+    "pids": 256
+  },
+  "artifacts": [
+    {
+      "name": "test-results",
+      "path": ".nogit/testlogs",
+      "format": "tar.gz",
+      "when": "failure",
+      "required": false,
+      "maximumBytes": 209715200,
+      "maximumExtractedBytes": 524288000,
+      "maximumEntries": 10000
+    }
+  ],
+  "caches": [
+    {
+      "name": "pnpm",
+      "key": "pnpm-store",
+      "paths": [".pnpm-store"],
+      "access": "read-write",
+      "maximumBytes": 1073741824,
+      "maximumExtractedBytes": 4294967296,
+      "maximumEntries": 100000
+    }
+  ]
+}

package/conformance/runner-jobs/incoherent/build-secret-unknown-target.json ADDED Viewed

@@ -0,0 +1,104 @@
+{
+  "spec": "2.0.0",
+  "sourceObjectId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+  "workflowDigest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+  "compiledPlanDigest": "fd16565c173045812935c81afa919258564b9a89aa79d10cfa6b7b3f177fe2cd",
+  "requirements": {
+    "executionProfile": "oci-image",
+    "isolation": "microvm",
+    "platform": "linux/arm64",
+    "labels": ["builder"],
+    "features": ["source.tar-gz", "caches"],
+    "limits": {
+      "maximumSourceArchiveBytes": 1048576,
+      "maximumSourceExtractedBytes": 4194304,
+      "maximumSourceEntries": 1000,
+      "maximumArtifactArchiveBytes": 0,
+      "maximumArtifactExtractedBytes": 0,
+      "maximumArtifactEntries": 0,
+      "maximumArtifacts": 0,
+      "maximumCacheArchiveBytes": 4294967296,
+      "maximumCacheExtractedBytes": 17179869184,
+      "maximumCacheEntries": 1000000,
+      "maximumCaches": 1,
+      "maximumLogChunkBytes": 65536,
+      "maximumTotalLogBytes": 10485760,
+      "maximumWorkspaceBytes": 21474836480,
+      "maximumWorkspaceEntries": 100000
+    }
+  },
+  "permissions": {
+    "source": "read",
+    "artifacts": "none",
+    "caches": "read-write",
+    "images": "push"
+  },
+  "network": {
+    "mode": "egress",
+    "allow": [
+      {
+        "host": "registry.npmjs.org",
+        "ports": [443]
+      }
+    ]
+  },
+  "build": {
+    "context": ".",
+    "dockerfile": "Dockerfile",
+    "target": "production",
+    "buildArgs": {
+      "NODE_ENV": "production"
+    },
+    "secrets": [
+      {
+        "id": "npmrc",
+        "environment": "NPM_TOKEN"
+      },
+      {
+        "id": "token",
+        "environment": "MISSING_TOKEN"
+      }
+    ],
+    "labels": {
+      "org.opencontainers.image.revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+      "org.opencontainers.image.source": "https://code.foss.global/example/app",
+      "org.opencontainers.image.title": "app"
+    },
+    "baseImages": [
+      {
+        "name": "base",
+        "image": {
+          "candidate": "base-image"
+        }
+      }
+    ]
+  },
+  "source": {
+    "format": "tar.gz",
+    "sha256": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+    "sizeBytes": 1024,
+    "extractedSizeBytes": 4096,
+    "entryCount": 4
+  },
+  "secrets": {
+    "NPM_TOKEN": "resolved-secret-value"
+  },
+  "timeoutMs": 3600000,
+  "resources": {
+    "memoryBytes": 8589934592,
+    "cpus": 4,
+    "pids": 4096
+  },
+  "artifacts": [],
+  "caches": [
+    {
+      "name": "buildkit",
+      "key": "buildkit-linux-arm64",
+      "access": "read-write",
+      "maximumBytes": 4294967296,
+      "maximumExtractedBytes": 17179869184,
+      "maximumEntries": 1000000,
+      "retentionDays": 14
+    }
+  ]
+}

package/conformance/runner-jobs/incoherent/cache-count-above-limit.json ADDED Viewed

@@ -0,0 +1,91 @@
+{
+  "spec": "2.0.0",
+  "sourceObjectId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+  "workflowDigest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+  "compiledPlanDigest": "44d32c309c5198f061b0778f8dae4b78723d4c8701ea85ec7f070011027745f5",
+  "requirements": {
+    "executionProfile": "oci",
+    "isolation": "container",
+    "labels": ["linux"],
+    "features": ["source.tar-gz", "artifacts", "caches"],
+    "limits": {
+      "maximumSourceArchiveBytes": 1048576,
+      "maximumSourceExtractedBytes": 4194304,
+      "maximumSourceEntries": 1000,
+      "maximumArtifactArchiveBytes": 104857600,
+      "maximumArtifactExtractedBytes": 524288000,
+      "maximumArtifactEntries": 10000,
+      "maximumArtifacts": 1,
+      "maximumCacheArchiveBytes": 1073741824,
+      "maximumCacheExtractedBytes": 4294967296,
+      "maximumCacheEntries": 100000,
+      "maximumCaches": 0,
+      "maximumLogChunkBytes": 65536,
+      "maximumTotalLogBytes": 10485760,
+      "maximumWorkspaceBytes": 8589934592,
+      "maximumWorkspaceEntries": 100000
+    }
+  },
+  "permissions": {
+    "source": "read",
+    "artifacts": "write",
+    "caches": "read-write",
+    "images": "none"
+  },
+  "network": {
+    "mode": "none"
+  },
+  "execution": {
+    "profile": "oci",
+    "image": "registry.example/ci@sha256:dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
+    "workingDirectory": "/workspace"
+  },
+  "steps": [
+    {
+      "name": "Test",
+      "command": ["pnpm", "test"],
+      "environment": {
+        "CI": "true",
+        "SHIPZONE_CI_INPUTS_JSON": "{}",
+        "SHIPZONE_CI_MATRIX_JSON": "{}"
+      }
+    }
+  ],
+  "source": {
+    "format": "tar.gz",
+    "sha256": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+    "sizeBytes": 1024,
+    "extractedSizeBytes": 4096,
+    "entryCount": 4
+  },
+  "secrets": {},
+  "timeoutMs": 3600000,
+  "resources": {
+    "memoryBytes": 268435456,
+    "cpus": 1,
+    "pids": 256
+  },
+  "artifacts": [
+    {
+      "name": "test-results",
+      "path": ".nogit/testlogs",
+      "format": "tar.gz",
+      "when": "failure",
+      "required": false,
+      "maximumBytes": 104857600,
+      "maximumExtractedBytes": 524288000,
+      "maximumEntries": 10000
+    }
+  ],
+  "caches": [
+    {
+      "name": "pnpm",
+      "key": "pnpm-store",
+      "paths": [".pnpm-store"],
+      "access": "read-write",
+      "maximumBytes": 1073741824,
+      "maximumExtractedBytes": 4294967296,
+      "maximumEntries": 100000
+    }
+  ]
+}

package/conformance/runner-jobs/incoherent/environment-above-limit.json ADDED Viewed

@@ -0,0 +1,206 @@
+{
+  "spec": "2.0.0",
+  "sourceObjectId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+  "workflowDigest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+  "compiledPlanDigest": "6c5d9cac0cae24a1a129cb63a4f4e22c227c5a3ab67b1e1fab54a81a01783309",
+  "requirements": {
+    "executionProfile": "oci",
+    "isolation": "container",
+    "labels": ["linux"],
+    "features": ["source.tar-gz"],
+    "limits": {
+      "maximumSourceArchiveBytes": 1048576,
+      "maximumSourceExtractedBytes": 4194304,
+      "maximumSourceEntries": 1000,
+      "maximumArtifactArchiveBytes": 0,
+      "maximumArtifactExtractedBytes": 0,
+      "maximumArtifactEntries": 0,
+      "maximumArtifacts": 0,
+      "maximumCacheArchiveBytes": 0,
+      "maximumCacheExtractedBytes": 0,
+      "maximumCacheEntries": 0,
+      "maximumCaches": 0,
+      "maximumLogChunkBytes": 65536,
+      "maximumTotalLogBytes": 10485760,
+      "maximumWorkspaceBytes": 21474836480,
+      "maximumWorkspaceEntries": 100000
+    }
+  },
+  "permissions": {
+    "source": "read",
+    "artifacts": "none",
+    "caches": "none",
+    "images": "none"
+  },
+  "network": {
+    "mode": "egress",
+    "allow": [
+      {
+        "host": "npm.example.com",
+        "ports": [443]
+      },
+      {
+        "host": "registry.npmjs.org",
+        "ports": [443]
+      }
+    ]
+  },
+  "execution": {
+    "profile": "oci",
+    "image": "registry.example/ci@sha256:dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
+    "workingDirectory": "/workspace"
+  },
+  "steps": [
+    {
+      "name": "Install",
+      "command": ["pnpm", "install", "--frozen-lockfile"],
+      "environment": {
+        "VARIABLE_001": "value",
+        "VARIABLE_002": "value",
+        "VARIABLE_003": "value",
+        "VARIABLE_004": "value",
+        "VARIABLE_005": "value",
+        "VARIABLE_006": "value",
+        "VARIABLE_007": "value",
+        "VARIABLE_008": "value",
+        "VARIABLE_009": "value",
+        "VARIABLE_010": "value",
+        "VARIABLE_011": "value",
+        "VARIABLE_012": "value",
+        "VARIABLE_013": "value",
+        "VARIABLE_014": "value",
+        "VARIABLE_015": "value",
+        "VARIABLE_016": "value",
+        "VARIABLE_017": "value",
+        "VARIABLE_018": "value",
+        "VARIABLE_019": "value",
+        "VARIABLE_020": "value",
+        "VARIABLE_021": "value",
+        "VARIABLE_022": "value",
+        "VARIABLE_023": "value",
+        "VARIABLE_024": "value",
+        "VARIABLE_025": "value",
+        "VARIABLE_026": "value",
+        "VARIABLE_027": "value",
+        "VARIABLE_028": "value",
+        "VARIABLE_029": "value",
+        "VARIABLE_030": "value",
+        "VARIABLE_031": "value",
+        "VARIABLE_032": "value",
+        "VARIABLE_033": "value",
+        "VARIABLE_034": "value",
+        "VARIABLE_035": "value",
+        "VARIABLE_036": "value",
+        "VARIABLE_037": "value",
+        "VARIABLE_038": "value",
+        "VARIABLE_039": "value",
+        "VARIABLE_040": "value",
+        "VARIABLE_041": "value",
+        "VARIABLE_042": "value",
+        "VARIABLE_043": "value",
+        "VARIABLE_044": "value",
+        "VARIABLE_045": "value",
+        "VARIABLE_046": "value",
+        "VARIABLE_047": "value",
+        "VARIABLE_048": "value",
+        "VARIABLE_049": "value",
+        "VARIABLE_050": "value",
+        "VARIABLE_051": "value",
+        "VARIABLE_052": "value",
+        "VARIABLE_053": "value",
+        "VARIABLE_054": "value",
+        "VARIABLE_055": "value",
+        "VARIABLE_056": "value",
+        "VARIABLE_057": "value",
+        "VARIABLE_058": "value",
+        "VARIABLE_059": "value",
+        "VARIABLE_060": "value",
+        "VARIABLE_061": "value",
+        "VARIABLE_062": "value",
+        "VARIABLE_063": "value",
+        "VARIABLE_064": "value",
+        "VARIABLE_065": "value",
+        "VARIABLE_066": "value",
+        "VARIABLE_067": "value",
+        "VARIABLE_068": "value",
+        "VARIABLE_069": "value",
+        "VARIABLE_070": "value",
+        "VARIABLE_071": "value",
+        "VARIABLE_072": "value",
+        "VARIABLE_073": "value",
+        "VARIABLE_074": "value",
+        "VARIABLE_075": "value",
+        "VARIABLE_076": "value",
+        "VARIABLE_077": "value",
+        "VARIABLE_078": "value",
+        "VARIABLE_079": "value",
+        "VARIABLE_080": "value",
+        "VARIABLE_081": "value",
+        "VARIABLE_082": "value",
+        "VARIABLE_083": "value",
+        "VARIABLE_084": "value",
+        "VARIABLE_085": "value",
+        "VARIABLE_086": "value",
+        "VARIABLE_087": "value",
+        "VARIABLE_088": "value",
+        "VARIABLE_089": "value",
+        "VARIABLE_090": "value",
+        "VARIABLE_091": "value",
+        "VARIABLE_092": "value",
+        "VARIABLE_093": "value",
+        "VARIABLE_094": "value",
+        "VARIABLE_095": "value",
+        "VARIABLE_096": "value",
+        "VARIABLE_097": "value",
+        "VARIABLE_098": "value",
+        "VARIABLE_099": "value",
+        "VARIABLE_100": "value",
+        "VARIABLE_101": "value",
+        "VARIABLE_102": "value",
+        "VARIABLE_103": "value",
+        "VARIABLE_104": "value",
+        "VARIABLE_105": "value",
+        "VARIABLE_106": "value",
+        "VARIABLE_107": "value",
+        "VARIABLE_108": "value",
+        "VARIABLE_109": "value",
+        "VARIABLE_110": "value",
+        "VARIABLE_111": "value",
+        "VARIABLE_112": "value",
+        "VARIABLE_113": "value",
+        "VARIABLE_114": "value",
+        "VARIABLE_115": "value",
+        "VARIABLE_116": "value",
+        "VARIABLE_117": "value",
+        "VARIABLE_118": "value",
+        "VARIABLE_119": "value",
+        "VARIABLE_120": "value",
+        "VARIABLE_121": "value",
+        "VARIABLE_122": "value",
+        "VARIABLE_123": "value",
+        "VARIABLE_124": "value",
+        "VARIABLE_125": "value",
+        "VARIABLE_126": "value",
+        "SHIPZONE_CI_INPUTS_JSON": "{}",
+        "SHIPZONE_CI_MATRIX_JSON": "{}"
+      }
+    }
+  ],
+  "source": {
+    "format": "tar.gz",
+    "sha256": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+    "sizeBytes": 1024,
+    "extractedSizeBytes": 4096,
+    "entryCount": 4
+  },
+  "secrets": {},
+  "timeoutMs": 60000,
+  "npmRead": [
+    {
+      "registry": "https://npm.example.com",
+      "scopes": ["@example_private"]
+    }
+  ],
+  "artifacts": [],
+  "caches": []
+}