hammerkit 1.5.0-alpha.0 → 1.5.1

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine as build
+FROM node:18-alpine as build
 
 ARG TARGETPLATFORM
 

package/build.schema.json

@@ -1,257 +1,434 @@
 {
+  "$comment": "https://no0dles.gitbook.io",
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "JSON Schema for hammerkit's build file",
-  "description": "Build tool with support for containerization",
-  "type": "object",
   "additionalProperties": false,
-  "properties": {
-    "envs": {
-      "$ref": "#/definitions/envMap"
+  "definitions": {
+    "buildFileEnvs": {
+      "title": "environment variables",
+      "description": "Environment values for the current build task\nhttps://no0dles.gitbook.io/hammerkit/build-file/environment-variables",
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
     },
-    "tasks": {
+    "buildFileTasks": {
+      "title": "tasks",
+      "description": "Task for the current build file\nhttps://no0dles.gitbook.io/hammerkit/task",
       "type": "object",
-      "description": "A map of tasks",
       "additionalProperties": {
         "$ref": "#/definitions/task"
       }
     },
-    "services": {
+    "buildFileServices": {
+      "title": "services",
+      "description": "Services for the current build file\nhttps://no0dles.gitbook.io/hammerkit/service",
       "type": "object",
-      "description": "A map of services",
       "additionalProperties": {
         "$ref": "#/definitions/service"
       }
     },
-    "includes": {
-      "$ref": "#/definitions/include"
-    },
-    "references": {
-      "$ref": "#/definitions/reference"
-    }
-  },
-  "definitions": {
-    "labels": {
-      "description": "A map of label values",
+    "buildFileIncludes": {
+      "title": "includes",
+      "description": "Includes to other build files\nhttps://no0dles.gitbook.io/hammerkit/build-file/includes",
       "type": "object",
-      "additionalProperties": {"type": "string"}
+      "additionalProperties": {
+        "$ref": "https://json.schemastore.org/base.json#/definitions/path"
+      }
     },
-    "envMap": {
-      "description": "A map of environment values",
+    "buildFileReferences": {
+      "title": "references",
+      "description": "References to other build files\nhttps://no0dles.gitbook.io/hammerkit/build-file/references",
       "type": "object",
       "additionalProperties": {
-        "type": "string"
+        "$ref": "https://json.schemastore.org/base.json#/definitions/path"
+      }
+    },
+    "task": {
+      "title": "task",
+      "description": "Task for the current build file\nhttps://no0dles.gitbook.io/hammerkit/task",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/containerTask"
+        },
+        {
+          "$ref": "#/definitions/localTask"
+        }
+      ]
+    },
+    "localTask": {
+      "title": "local task",
+      "description": "Task that gets executed in the local shell in the current directory",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["cmds"],
+      "properties": {
+        "description": {
+          "$ref": "#/definitions/taskCommand"
+        },
+        "extend": {
+          "$ref": "#/definitions/taskExtend"
+        },
+        "cache": {
+          "$ref": "#/definitions/taskCache"
+        },
+        "continuous": {
+          "$ref": "#/definitions/taskContinuous"
+        },
+        "envs": {
+          "$ref": "#/definitions/taskEnvs"
+        },
+        "needs": {
+          "$ref": "#/definitions/taskNeeds"
+        },
+        "deps": {
+          "$ref": "#/definitions/taskDeps"
+        },
+        "src": {
+          "$ref": "#/definitions/taskSrc"
+        },
+        "generates": {
+          "$ref": "#/definitions/taskGenerates"
+        },
+        "cmds": {
+          "title": "task commands",
+          "description": "Commands for the current task",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/taskCommand"
+          }
+        }
+      }
+    },
+    "containerTask": {
+      "title": "container task",
+      "description": "Container task for the current build file\nhttps://no0dles.gitbook.io/hammerkit/task/container",
+      "type": "object",
+      "required": ["image", "cmds"],
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "$ref": "#/definitions/taskCommand"
+        },
+        "extend": {
+          "$ref": "#/definitions/taskExtend"
+        },
+        "cache": {
+          "$ref": "#/definitions/taskCache"
+        },
+        "continuous": {
+          "$ref": "#/definitions/taskContinuous"
+        },
+        "envs": {
+          "$ref": "#/definitions/taskEnvs"
+        },
+        "needs": {
+          "$ref": "#/definitions/taskNeeds"
+        },
+        "deps": {
+          "$ref": "#/definitions/taskDeps"
+        },
+        "src": {
+          "$ref": "#/definitions/taskSrc"
+        },
+        "generates": {
+          "$ref": "#/definitions/taskGenerates"
+        },
+        "cmds": {
+          "title": "task commands",
+          "description": "Commands for the current task",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/taskCommand"
+          }
+        },
+        "shell": {
+          "title": "task shell",
+          "description": "Define which shell is used to execute the commands",
+          "type": "string"
+        },
+        "image": {
+          "title": "task image",
+          "description": "Container image for the current task to run commands in",
+          "type": "string"
+        },
+        "ports": {
+          "title": "task ports",
+          "description": "A list of ports that get exposed on the host from the container <localPort>:<targetPort>",
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "description": "<localPort>:<targetPort>",
+            "type": "string",
+            "pattern": "\\d+:\\d+"
+          }
+        },
+        "mounts": {
+          "title": "task mount",
+          "description": "File paths that get mounted into the container\nhttps://no0dles.gitbook.io/hammerkit/task/container#adding-mounts",
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "pattern": "\\d+:\\d+"
+          }
+        }
       }
     },
     "taskCommand": {
       "anyOf": [
         {
-          "description": "Command to be executed for the task",
+          "title": "command",
+          "description": "Command to be executed for the current task",
           "type": "string"
         },
         {
+          "title": "task command with path extension",
+          "description": "Command to be executed in sub directory for the current task",
           "type": "object",
           "additionalProperties": false,
+          "required": ["cmd"],
           "properties": {
             "cmd": {
+              "title": "command",
               "description": "Command to be executed for the task",
               "type": "string"
             },
             "path": {
+              "title": "command path",
               "description": "Path below build file path",
-              "type": "string"
+              "$ref": "https://json.schemastore.org/base.json#/definitions/path"
             }
-          },
-          "required": ["cmd"]
+          }
         }
       ]
     },
-    "include": {
+    "taskDescription": {
+      "title": "task description",
+      "description": "Description for the current task",
+      "type": "string"
+    },
+    "taskExtend": {
+      "title": "task extension",
+      "description": "Extension task as a base template\nhttps://no0dles.gitbook.io/hammerkit/task/extending",
+      "type": "string"
+    },
+    "taskCache": {
+      "title": "task cache",
+      "description": "compare type for detecting changes in source files\nhttps://no0dles.gitbook.io/hammerkit/task/caching",
+      "type": "string",
+      "enum": ["checksum", "modify-date", "none"]
+    },
+    "taskContinuous": {
+      "title": "task continuous",
+      "description": "The task runs continuous and does not end without cancellation\nhttps://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks",
+      "type": "boolean"
+    },
+    "taskLabels": {
+      "title": "label options",
+      "description": "A map of label values for the current task\nhttps://no0dles.gitbook.io/hammerkit/labels",
       "type": "object",
-      "description": "A map of includes",
-      "additionalProperties": {
-        "type": "string"
-      }
+      "additionalProperties": { "type": "string" }
     },
-    "reference": {
+    "taskEnvs": {
+      "title": "task environment variables",
+      "description": "Environment values for the current build file\nhttps://no0dles.gitbook.io/hammerkit/build-file/environment-variables",
       "type": "object",
-      "description": "A map of references",
       "additionalProperties": {
         "type": "string"
       }
     },
-    "taskSource": {
+    "taskNeeds": {
+      "title": "task service needs",
+      "description": "Service needs that need to get ready before the current task\nhttps://no0dles.gitbook.io/hammerkit/task/needs",
       "type": "array",
-      "description": "A list of source files and folders",
+      "uniqueItems": true,
       "items": {
         "type": "string"
       }
     },
-    "taskGenerate": {
+    "taskDeps": {
+      "title": "task dependencies",
+      "description": "Task dependencies that get executed before the current task\nhttps://no0dles.gitbook.io/hammerkit/task/dependencies",
       "type": "array",
-      "description": "A list of generated files and folders",
+      "uniqueItems": true,
       "items": {
         "type": "string"
       }
     },
-    "taskDependency": {
+    "taskSrc": {
+      "title": "task source",
+      "description": "Source files and folders for the current task\nhttps://no0dles.gitbook.io/hammerkit/task#source",
       "type": "array",
-      "description": "A list of task dependencies that get executed before the current task",
+      "uniqueItems": true,
       "items": {
-        "type": "string"
+        "$ref": "https://json.schemastore.org/base.json#/definitions/path"
       }
     },
-    "mount": {
+    "taskGenerates": {
+      "title": "task generate",
+      "description": "Generated files and folders for the current task\n\nhttps://no0dles.gitbook.io/hammerkit/task#generate",
       "type": "array",
-      "description": "A list of file paths that get mounted into the container",
+      "uniqueItems": true,
       "items": {
-        "type": "string"
+        "$ref": "https://json.schemastore.org/base.json#/definitions/path"
       }
     },
-    "taskPort": {
-      "type": "array",
-      "description": "A list of ports that get exposed on the host from the container",
-      "items": {
-        "type": "string"
-      }
+    "service": {
+      "title": "service",
+      "description": "A daemon in the background",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/containerService"
+        },
+        {
+          "$ref": "#/definitions/kubernetesService"
+        }
+      ]
     },
-    "localTask": {
+    "kubernetesService": {
+      "title": "kubernetes service",
+      "description": "Kubernetes service for the current build file\nhttps://no0dles.gitbook.io/hammerkit/service/kubernetes",
       "type": "object",
-      "description": "A task that gets executed in the local shell",
+      "required": ["context", "selector", "ports"],
       "additionalProperties": false,
       "properties": {
-        "description": {
-          "type": "string",
-          "description": "A description of the task"
-        },
-        "extend": {
-          "type": "string",
-          "description": "Name of task that gets used a template"
-        },
-        "labels": {
-          "$ref": "#/definitions/labels"
-        },
-        "envs": {
-          "$ref": "#/definitions/envMap"
-        },
-        "deps": {
-          "$ref": "#/definitions/taskDependency"
-        },
-        "watch": {
-          "type": "boolean",
-          "description": "Watch the source files and restart the task on changes"
-        },
-        "src": {
-          "$ref": "#/definitions/taskSource"
+        "kubeconfig": {
+          "title": "service kube config",
+          "description": "Kubernetes context for the current service\nhttps://no0dles.gitbook.io/hammerkit/service/kubernetes#config",
+          "type": "string"
         },
-        "generates": {
-          "$ref": "#/definitions/taskGenerate"
+        "context": {
+          "title": "service context",
+          "description": "Kubernetes context for the current service\nhttps://no0dles.gitbook.io/hammerkit/service/kubernetes#config",
+          "type": "string"
         },
-        "cmds": {
-          "description": "A list of commands in a task",
+        "ports": {
+          "title": "service ports",
+          "description": "A list of ports that get exposed on the host from the service <localPort>:<targetPort>",
           "type": "array",
+          "uniqueItems": true,
           "items": {
-            "$ref": "#/definitions/taskCommand"
+            "description": "<localPort>:<targetPort>",
+            "type": "string",
+            "pattern": "\\d+:\\d+"
+          }
+        },
+        "selector": {
+          "title": "service selector",
+          "description": "Selector to specify which resource gets forwarded to\nhttps://no0dles.gitbook.io/hammerkit/service/kubernetes",
+          "type": "object",
+          "required": ["type", "name"],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "title": "selector resource type",
+              "description": "resource type for the current service",
+              "type": "string",
+              "enum": ["deployment", "service", "pod"]
+            },
+            "name": {
+              "title": "selector resource name",
+              "description": "resource name for the kubernetes resource",
+              "type": "string"
+            }
           }
         }
-      },
-      "required": ["cmds"]
+      }
     },
-    "dockerTask": {
-      "required": ["cmds", "image"],
+    "containerService": {
+      "title": "container service",
+      "description": "Container service for the current build file\nhttps://no0dles.gitbook.io/hammerkit/service/kubernetes",
+      "type": "object",
+      "required": ["image"],
       "additionalProperties": false,
       "properties": {
-        "description": {
-          "type": "string",
-          "description": "A description of the task"
-        },
         "labels": {
-          "$ref": "#/definitions/labels"
-        },
-        "extend": {
-          "type": "string",
-          "description": "Name of task that gets used a template"
-        },
-        "ports": {
-          "$ref": "#/definitions/taskPort"
+          "title": "label options",
+          "description": "A map of label values for the current service\nhttps://no0dles.gitbook.io/hammerkit/labels",
+          "type": "object",
+          "additionalProperties": { "type": "string" }
         },
         "envs": {
-          "$ref": "#/definitions/envMap"
-        },
-        "deps": {
-          "$ref": "#/definitions/taskDependency"
-        },
-        "watch": {
-          "type": "boolean",
-          "description": "Watch the source files and restart the task on changes"
+          "title": "service environment variables",
+          "description": "Environment values for the current service\nhttps://no0dles.gitbook.io/hammerkit/build-file/environment-variables",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
         },
-        "shell": {
-          "type": "string",
-          "description": "Define which shell is used to execute the commands"
+        "healthcheck": {
+          "title": "service healthcheck",
+          "description": "Check to detect if the service is started and ready\nhttps://no0dles.gitbook.io/hammerkit/service/container#healthcheck",
+          "type": "object",
+          "required": ["cmd"],
+          "additionalProperties": false,
+          "properties": {
+            "cmd": {
+              "title": "command",
+              "description": "task to check if the service is healthy",
+              "type": "string"
+            }
+          }
         },
         "image": {
-          "type": "string",
-          "description": "Define the container image the commands run in"
-        },
-        "mounts": {
-          "$ref": "#/definitions/mount"
+          "title": "service image",
+          "description": "Container image for the current service to run commands in",
+          "type": "string"
         },
-        "src": {
-          "$ref": "#/definitions/taskSource"
+        "ports": {
+          "title": "service ports",
+          "description": "A list of ports that get exposed on the host from the container <localPort>:<targetPort>\nhttps://no0dles.gitbook.io/hammerkit/service/container#mounts",
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "description": "<localPort>:<targetPort>",
+            "type": "string",
+            "pattern": "\\d+:\\d+"
+          }
         },
-        "generates": {
-          "$ref": "#/definitions/taskGenerate"
+        "volumes": {
+          "title": "service volumes",
+          "description": "A list of volumes that get attached to the container <name>:<containerPath>\nhttps://no0dles.gitbook.io/hammerkit/service/container#mounts",
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "description": "<name>:<containerPath>",
+            "type": "string",
+            "pattern": "\\d+:\\d+"
+          }
         },
-        "cmds": {
-          "description": "A list of commands in a task",
+        "mounts": {
+          "title": "service mount",
+          "description": "File paths that get mounted into the container <localPath>:<containerPath>\nhttps://no0dles.gitbook.io/hammerkit/service/container#mounts",
           "type": "array",
+          "uniqueItems": true,
           "items": {
-            "$ref": "#/definitions/taskCommand"
+            "type": "string",
+            "description": "<localPath>:<containerPath>",
+            "pattern": "\\d+:\\d+"
           }
         }
       }
+    }
+  },
+  "description": "Build tool with support for containerization\nhttps://no0dles.gitbook.io/hammerkit/build-file",
+  "properties": {
+    "envs": {
+      "$ref": "#/definitions/buildFileEnvs"
     },
-    "task": {
-      "anyOf": [{
-        "$ref": "#/definitions/dockerTask"
-      }, {
-        "$ref": "#/definitions/localTask"
-      }]
+    "tasks": {
+      "$ref": "#/definitions/buildFileTasks"
     },
-    "service": {
-      "description": "A daemon in the background",
-      "required": ["image"],
-      "additionalProperties": false,
-      "properties": {
-        "image": {
-          "type": "string",
-          "description": "Define the container image the commands run in"
-        },
-        "labels": {
-          "$ref": "#/definitions/labels"
-        },
-        "envs": {
-          "$ref": "#/definitions/envMap"
-        },
-        "ports": {
-          "$ref": "#/definitions/taskPort"
-        },
-        "healthcheck": {
-          "$ref": "#/definitions/serviceHealthcheck"
-        },
-        "mounts": {
-          "$ref": "#/definitions/mount"
-        }
-      }
+    "services": {
+      "$ref": "#/definitions/buildFileServices"
     },
-    "serviceHealthcheck": {
-      "additionalItems": false,
-      "description": "A check to detect if the service is started and ready",
-      "properties": {
-        "cmd": {
-          "description": "task to check if the service is healthy",
-          "type": "string"
-        }
-      }
+    "includes": {
+      "$ref": "#/definitions/buildFileIncludes"
+    },
+    "references": {
+      "$ref": "#/definitions/buildFileReferences"
     }
-  }
+  },
+  "title": "JSON Schema for hammerkit's build file",
+  "type": "object"
 }

package/dist/executer/docker-service.js

@@ -45,7 +45,7 @@ function dockerService(service, stateKey, state, environment) {
             const stream = await container.attach({ stream: true, stdout: true, stderr: true });
             (0, stream_1.logStream)(status, stream);
             await container.start();
-            // await setUserPermissions(service, container, environment)
+            //await setUserPermissions(service, container, environment)
             if (!service.healthcheck) {
                 state.patchService({
                     type: 'running',

package/dist/executer/environment-mock.js

@@ -2,18 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.environmentMock = void 0;
 const work_node_status_1 = require("../planner/work-node-status");
-const console_context_mock_1 = require("../console/console-context-mock");
 const get_file_context_1 = require("../file/get-file-context");
 const execute_docker_1 = require("./execute-docker");
+const log_1 = require("../log");
+const empty_writable_1 = require("../utils/empty-writable");
 function environmentMock(cwd) {
     return {
         cwd,
         file: (0, get_file_context_1.getFileContext)(cwd),
-        console: (0, console_context_mock_1.consoleContextMock)(),
+        console: (0, log_1.consoleContext)((0, empty_writable_1.emptyWritable)()),
         abortCtrl: new AbortController(),
         processEnvs: {},
-        status: (0, work_node_status_1.statusConsole)(),
+        status: (0, work_node_status_1.statusConsole)((0, empty_writable_1.emptyWritable)()),
         docker: (0, execute_docker_1.getContainerCli)(),
+        stdout: (0, empty_writable_1.emptyWritable)(),
+        stdoutColumns: 80,
     };
 }
 exports.environmentMock = environmentMock;

package/dist/executer/event-cache.js

@@ -127,9 +127,7 @@ async function cleanCache(workTree, environment, options) {
             const volumeName = (0, plan_work_volume_1.getVolumeName)(generate.path);
             const volumeExists = await (0, get_docker_executor_1.existsVolume)(environment, volumeName);
             if (volumeExists) {
-                nodeStatus.write('info', `remove volume ${volumeName}`);
-                const volume = await environment.docker.getVolume(volumeName);
-                await volume.remove();
+                await (0, get_docker_executor_1.removeVolume)(environment, nodeStatus, volumeName);
             }
             else {
                 nodeStatus.write('info', `generate ${generate} has no volume ${volumeName}`);
@@ -154,9 +152,7 @@ async function cleanCache(workTree, environment, options) {
                 if (!volumeExists) {
                     continue;
                 }
-                nodeStatus.write('info', `remove volume ${volume.name}`);
-                const containerVolume = await environment.docker.getVolume(volume.name);
-                await containerVolume.remove();
+                await (0, get_docker_executor_1.removeVolume)(environment, nodeStatus, volume.name);
             }
         }
     }