feat: Add type to local image and support for dockerfiles (#54)

kapetacom · Feb 24, 2024 · b2e501b · b2e501b
1 parent 3c753e4
commit b2e501b
Show file tree

Hide file tree

Showing 9 changed files with 324 additions and 174 deletions.
diff --git a/packages/go/model/model.go b/packages/go/model/model.go
@@ -387,21 +387,27 @@ type LanguageTarget struct {
 
 type LanguageTargetSpec struct {
  Icon *IconValue `json:"icon,omitempty"` 
- Local LocalDevContainer `json:"local"` 
+ Local LocalDevContainer `json:"local"` // if type is "docker" or empty - Local development container using a fixed docker image.; User code will be mounted into the container.; if type is "dockerfile" - Local development container using a Dockerfile. User code will; be built into the container.
  Schema map[string]interface{} `json:"schema,omitempty"` 
  Versioning []Versioning `json:"versioning,omitempty"`
 }
 
+// if type is "docker" or empty - Local development container using a fixed docker image.
+// User code will be mounted into the container.
+// if type is "dockerfile" - Local development container using a Dockerfile. User code will
+// be built into the container.
 type LocalDevContainer struct {
  Env []string `json:"Env,omitempty"` 
  Handlers *LocalDevContainerHandlers `json:"handlers,omitempty"` 
  Healthcheck *string `json:"healthcheck,omitempty"`
  HostConfig map[string]interface{} `json:"HostConfig,omitempty"` 
- Image string  `json:"image"`  
+ Image *string `json:"image,omitempty"` 
  Labels map[string]interface{} `json:"Labels,omitempty"` 
  Options map[string]interface{} `json:"options,omitempty"` 
+ Type *string `json:"type,omitempty"` 
  UserHome *string `json:"userHome,omitempty"` 
  WorkingDir *string `json:"workingDir,omitempty"` 
+ File *string `json:"file,omitempty"` 
 }
 
 type LocalDevContainerHandlers struct {

diff --git a/packages/go/schemas/concepts/core/language-target.json b/packages/go/schemas/concepts/core/language-target.json
@@ -7,6 +7,77 @@
  "schema": {
  "$id": "/core/language-target",
  "$schema": "http://json-schema.org/draft-07/schema#",
+ "definitions": {
+ "LocalDevContainerDocker": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "image"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "docker"
+ },
+ "image": {
+ "type": "string"
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "userHome": {
+ "type": "string"
+ },
+ "workingDir": {
+ "type": "string"
+ },
+ "healthcheck": {
+ "type": "string"
+ },
+ "HostConfig": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "Labels": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "Env": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "handlers": {
+ "title": "LocalDevContainerHandlers",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "onCreate": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "LocalDevContainerDockerfile": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "dockerfile"
+ },
+ "file": {
+ "type": "string"
+ }
+ }
+ }
+ },
  "type": "object",
  "additionalProperties": false,
  "required": [
@@ -40,53 +111,15 @@
  },
  "local": {
  "title": "LocalDevContainer",
- "type": "object",
- "additionalProperties": false,
- "required": [
- "image"
- ],
- "properties": {
- "image": {
- "type": "string"
- },
- "options": {
- "type": "object",
- "additionalProperties": true
- },
- "userHome": {
- "type": "string"
- },
- "workingDir": {
- "type": "string"
+ "description": "if type is \"docker\" or empty - Local development container using a fixed docker image. User code will be mounted into the container.\nif type is \"dockerfile\" - Local development container using a Dockerfile. User code will be built into the container.",
+ "oneOf": [
+ {
+ "$ref": "#/definitions/LocalDevContainerDocker"
  },
- "healthcheck": {
- "type": "string"
- },
- "HostConfig": {
- "type": "object",
- "additionalProperties": true
- },
- "Labels": {
- "type": "object",
- "additionalProperties": true
- },
- "Env": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "handlers": {
- "title": "LocalDevContainerHandlers",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "onCreate": {
- "type": "string"
- }
- }
+ {
+ "$ref": "#/definitions/LocalDevContainerDockerfile"
  }
- }
+ ]
  }
  }
  }

diff --git a/packages/maven/pom.xml b/packages/maven/pom.xml
@@ -6,7 +6,7 @@
 
  <groupId>com.kapeta</groupId>
  <artifactId>schemas</artifactId>
- <version>3.3.0</version>
+ <version>3.4.0</version>
 
  <name>${project.groupId}:${project.artifactId}</name>
  <description>Data schemas for Kapeta</description>

diff --git a/packages/maven/src/main/java/com/kapeta/schemas/entity/LocalDevContainer.java b/packages/maven/src/main/java/com/kapeta/schemas/entity/LocalDevContainer.java
@@ -3,6 +3,12 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * if type is "docker" or empty - Local development container using a fixed docker image.
+ * User code will be mounted into the container.
+ * if type is "dockerfile" - Local development container using a Dockerfile. User code will
+ * be built into the container.
+ */
 @lombok.Data
 public class LocalDevContainer {
  private List<String> env;
@@ -12,6 +18,8 @@ public class LocalDevContainer {
  private String image;
  private Map<String, Object> labels;
  private Map<String, Object> options;
+ private String type;
  private String userHome;
  private String workingDir;
+ private String file;
 }
diff --git a/packages/maven/src/main/resources/schemas/concepts/core/language-target.json b/packages/maven/src/main/resources/schemas/concepts/core/language-target.json
@@ -7,6 +7,77 @@
  "schema": {
  "$id": "/core/language-target",
  "$schema": "http://json-schema.org/draft-07/schema#",
+ "definitions": {
+ "LocalDevContainerDocker": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "image"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "docker"
+ },
+ "image": {
+ "type": "string"
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "userHome": {
+ "type": "string"
+ },
+ "workingDir": {
+ "type": "string"
+ },
+ "healthcheck": {
+ "type": "string"
+ },
+ "HostConfig": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "Labels": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "Env": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "handlers": {
+ "title": "LocalDevContainerHandlers",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "onCreate": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "LocalDevContainerDockerfile": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "dockerfile"
+ },
+ "file": {
+ "type": "string"
+ }
+ }
+ }
+ },
  "type": "object",
  "additionalProperties": false,
  "required": [
@@ -40,53 +111,15 @@
  },
  "local": {
  "title": "LocalDevContainer",
- "type": "object",
- "additionalProperties": false,
- "required": [
- "image"
- ],
- "properties": {
- "image": {
- "type": "string"
- },
- "options": {
- "type": "object",
- "additionalProperties": true
- },
- "userHome": {
- "type": "string"
- },
- "workingDir": {
- "type": "string"
+ "description": "if type is \"docker\" or empty - Local development container using a fixed docker image. User code will be mounted into the container.\nif type is \"dockerfile\" - Local development container using a Dockerfile. User code will be built into the container.",
+ "oneOf": [
+ {
+ "$ref": "#/definitions/LocalDevContainerDocker"
  },
- "healthcheck": {
- "type": "string"
- },
- "HostConfig": {
- "type": "object",
- "additionalProperties": true
- },
- "Labels": {
- "type": "object",
- "additionalProperties": true
- },
- "Env": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "handlers": {
- "title": "LocalDevContainerHandlers",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "onCreate": {
- "type": "string"
- }
- }
+ {
+ "$ref": "#/definitions/LocalDevContainerDockerfile"
  }
- }
+ ]
  }
  }
  }

diff --git a/packages/npm/package.json b/packages/npm/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@kapeta/schemas",
- "version": "3.3.0",
+ "version": "3.4.0",
  "main": "dist/cjs/index.js",
  "module": "dist/esm/index.js",
  "types": "dist/index.d.ts",