@andrian.yablonskyy/thub-common 1.1.2 → 1.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andrian.yablonskyy/thub-common",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Shared job-spec schema, state enums and a thin API client used by the Agent and Client",
   "main": "src/index.js",
   "files": [

package/src/job-spec.schema.js

@@ -13,23 +13,14 @@
 
 'use strict';
 
-// A Docker image reference: [host[:port]/]path[:tag][@sha256:digest], e.g.
-// `alpine`, `alpine:3.20`, `library/ubuntu:24.04`, `registry.lab:5000/emu:1`.
-const DOCKER_IMAGE_PATTERN =
-    '^[A-Za-z0-9][A-Za-z0-9.-]*(:[0-9]+)?(/[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*)*(:[A-Za-z0-9_][A-Za-z0-9_.-]{0,127})?(@sha256:[a-f0-9]{64})?$',
-
-  // A git ref to check out — a branch, a tag or a commit (hex) — as git
-  // allows them: no leading "-" (never taken for an option) or "/", no "..",
-  // no spaces or the characters git forbids, not ending in "/", ".lock", ".".
-  GIT_REF_PATTERN = '^(?![-/])(?!.*\\.\\.)(?!.*//)(?!.*(/|\\.lock|\\.)$)[A-Za-z0-9._/+@-]+$',
-
-  // An environment variable name a job may set (`--env NAME=value`).
-  ENV_NAME_PATTERN = '^[A-Za-z_][A-Za-z0-9_]*$',
+// An environment variable name a job may set (`--env NAME=value`).
+const ENV_NAME_PATTERN = '^[A-Za-z_][A-Za-z0-9_]*$',
 
   // Matches the job spec shape documented in README.md §4.3. A task is:
-  // optionally files to download and/or a git checkout, optionally (SW only)
-  // a Docker image to run as the DUT, and — always — the shell command that
-  // is its entry point, run on the Client in the checkout / work directory.
+  // optionally files to download, and — always — the shell command that is
+  // its entry point, run on the Client in the job's work directory. Anything
+  // else it needs (a git checkout, a Docker container) the command does
+  // itself, with credentials passed in `env`.
   jobSpecSchema = {
     $id: 'https://thub.example.com/schemas/job-spec.json',
     type: 'object',
@@ -65,7 +56,7 @@ const DOCKER_IMAGE_PATTERN =
       // Client runs with `sh -c`, `args` as "$@" (`--arg`, repeatable).
       command: { type: 'string', minLength: 1, maxLength: 4096 },
       args: { type: 'array', items: { type: 'string' }, default: [] },
-      // Passed to the command as THUB_SUITE (`--suite`).
+      // Passed to the command as JOB_SUITE (`--suite`).
       suite: { type: 'string', default: 'default' },
       // Files the Client downloads into the task's work directory before
       // running the command (`--download-file`, repeatable).
@@ -80,30 +71,8 @@ const DOCKER_IMAGE_PATTERN =
         },
         default: []
       },
-      // A Docker image an SW Client runs as the job's DUT container, next to
-      // its command — `--docker-image`.
-      image: { type: 'string', maxLength: 255, pattern: DOCKER_IMAGE_PATTERN },
-      // A repository the Client clones before running the command — at `ref`
-      // (branch, tag or commit; default: the default branch), `depth` commits
-      // deep (0 = full history). `--git-repo <url> [ref] [--depth <n>]`.
-      git: {
-        type: 'object',
-        additionalProperties: false,
-        required: ['url'],
-        properties: {
-          url: { type: 'string', minLength: 1, maxLength: 2048 },
-          ref: { type: 'string', maxLength: 255, pattern: GIT_REF_PATTERN },
-          depth: { type: 'integer', minimum: 0, maximum: 100000, default: 1 },
-          // Extra git options (`--git-options`), shell-quoted, inserted
-          // between `git` and its subcommand on the Client — e.g.
-          // -c core.sshCommand="ssh -i ~/.ssh/lab_key -p 2222". Stored with
-          // the job and visible like the rest of it: reference key files on
-          // the Client rather than putting secrets here.
-          options: { type: 'string', minLength: 1, maxLength: 1024 }
-        }
-      },
-      // Environment variables (`--env NAME=value`) the Client sets for every
-      // command it runs for the job — git and the job's command. No name
+      // Environment variables (`--env NAME=value`) the Client sets for the
+      // job's command — tokens for a git clone or docker login, say. No name
       // means anything special. Values are secrets as far as the Coordinator
       // is concerned: masked in the Agent API and dropped from its database
       // once the job ends.
@@ -130,4 +99,4 @@ const DOCKER_IMAGE_PATTERN =
     }
   };
 
-module.exports = { jobSpecSchema, DOCKER_IMAGE_PATTERN, ENV_NAME_PATTERN };
+module.exports = { jobSpecSchema, ENV_NAME_PATTERN };

package/src/split-args.js

@@ -1,7 +1,7 @@
 /**
  * @file        packages/shared/src/split-args.js
  * @description Splits a command-line options string into arguments the way a POSIX shell would quote them —
- *              without running a shell (for `thub run --git-options`)
+ *              without running a shell (kept for callers of thub-common; TestHub itself no longer uses it)
  *
  * @author      Andrian Yablonskyy
  * @copyright   Copyright (c) 2026 Andrian Yablonskyy. All rights reserved.

package/src/validate-job-spec.js

@@ -15,8 +15,7 @@
 
 const Ajv = require('ajv'),
   addFormats = require('ajv-formats'),
-  { jobSpecSchema } = require('./job-spec.schema'),
-  { splitArgs } = require('./split-args');
+  { jobSpecSchema } = require('./job-spec.schema');
 
 const ajv = new Ajv({ useDefaults: true, allErrors: true, strict: false });
 addFormats(ajv);
@@ -27,7 +26,7 @@ const validateFn = ajv.compile(jobSpecSchema);
  * Returns { valid, spec, errors }.
  */
 function validateJobSpec(spec){
-  const legacy = legacyShapeError(spec);
+  const legacy = legacyShapeError(spec) || removedFieldsError(spec);
   if (legacy){
     return { valid: false, spec: JSON.parse(JSON.stringify(spec ?? {})), errors: [legacy] };
   }
@@ -44,42 +43,31 @@ function validateJobSpec(spec){
 function legacyShapeError(spec){
   if (spec && typeof spec === 'object' && ('firmware' in spec || 'tests' in spec) && !('command' in spec)){
     return '/ this job spec is from an older Agent (firmware/tests fields) — update the Agent (thub self-update) ' +
-      'and use --command, --download-file, --docker-image and --git-repo';
+      'and use --command and --download-file';
   }
   return null;
 }
 
-// Git transports a Client may fetch sources over. Never `ext::` (runs a
-// command), `file://` or a local path: the Client also sets
-// GIT_ALLOW_PROTOCOL to the same list (downloader.js).
-const GIT_URL = /^(?:(?:https?|ssh|git):\/\/[^\s]+|[A-Za-z0-9._-]+@[A-Za-z0-9.-]+:[^\s]+)$/,
-
-  // Job env names the Client sets itself for a job's commands (besides
-  // THUB_* and JOB_* — the job's own parameters): git's safety settings.
-  RESERVED_ENV = ['GIT_TERMINAL_PROMPT', 'GIT_ALLOW_PROTOCOL'];
+// `git` (--git-repo/--depth/--git-options) and `image` (--docker-image) are
+// gone: the Client no longer clones or runs containers itself. Said plainly
+// rather than as unknown properties.
+function removedFieldsError(spec){
+  const removed = ['git', 'image'].filter((k) => spec && typeof spec === 'object' && spec[k] !== undefined);
+  if (!removed.length){
+    return null;
+  }
+  return `/ ${removed.join(', ')}: --git-repo, --git-options, --depth and --docker-image are no longer supported — ` +
+    'clone the repository or run docker in --command, passing credentials with --env (update the Agent: thub self-update)';
+}
 
 // Rules across fields, spelled out here rather than as schema if/then,
 // whose errors ("must match a schema in then") say little.
 function crossFieldErrors(spec){
-  const errors = [];
-  if (spec.image && spec.target?.type === 'hw'){
-    errors.push('/image a Docker image only works for SW jobs (target.type "sw")');
-  }
-  if (spec.git && !GIT_URL.test(spec.git.url || '')){
-    errors.push('/git/url must be an https://, http://, ssh:// or git:// URL, or user@host:path');
-  }
-  const envNames = Object.keys(spec.env && typeof spec.env === 'object' ? spec.env : {}),
-    reserved = envNames.filter((n) => /^(THUB|JOB)_/.test(n) || RESERVED_ENV.includes(n));
+  const errors = [],
+    envNames = Object.keys(spec.env && typeof spec.env === 'object' ? spec.env : {}),
+    reserved = envNames.filter((n) => /^(THUB|JOB)_/.test(n));
   if (reserved.length){
-    errors.push(`/env ${reserved.join(', ')}: set by the Client itself (THUB_*, JOB_*, ${RESERVED_ENV.join(', ')}) — use other names`);
-  }
-  if (spec.git?.options){
-    try {
-      splitArgs(spec.git.options);
-    }
-    catch (err){
-      errors.push(`/git/options can't be split into arguments: ${err.message}`);
-    }
+    errors.push(`/env ${reserved.join(', ')}: set by the Client itself (THUB_*, JOB_*) — use other names`);
   }
   return errors;
 }