Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3a4d510304 | |||
| b1f135a5f4 | |||
| 30a5749fab | |||
| 100f37b857 | |||
| 93cf2ee7bf | |||
| 8cf8e43e59 | |||
| 3e4558abc5 | |||
| 3e0eb5e198 | |||
| 732e9e5cac | |||
| 5bf1779243 | |||
| 4908c21b84 | |||
| b1e2f0d8ea | |||
| d815915135 | |||
| 0f445b4c86 |
@@ -1,6 +0,0 @@
|
||||
FROM hosttoday/ht-docker-node:npmci
|
||||
RUN yarn global add @git.zone/tsdocker
|
||||
COPY ./ /workspace
|
||||
WORKDIR /workspace
|
||||
ENV CI=true
|
||||
CMD ["tsdocker","runinside"];
|
||||
43
changelog.md
43
changelog.md
@@ -1,5 +1,48 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-03-24 - 2.2.2 - fix(config)
|
||||
rename npmextra configuration file to .smartconfig.json
|
||||
|
||||
- Moves the existing project metadata and release configuration from npmextra.json to .smartconfig.json without changing its contents.
|
||||
|
||||
## 2026-03-24 - 2.2.1 - fix(config)
|
||||
switch configuration loading from npmextra to smartconfig
|
||||
|
||||
- replace the @push.rocks/npmextra dependency with @push.rocks/smartconfig
|
||||
- update config initialization to use Smartconfig for the @git.zone/tsdocker settings
|
||||
- refresh CLI help text to reference smartconfig.json instead of npmextra.json
|
||||
|
||||
## 2026-03-19 - 2.2.0 - feat(cli/buildx)
|
||||
add pull control for builds and isolate buildx builders per project
|
||||
|
||||
- adds a new pull build option with --no-pull CLI support and defaults builds to refreshing base images with --pull
|
||||
- passes the selected buildx builder explicitly into build commands instead of relying on global docker buildx use state
|
||||
- generates project-hashed builder suffixes so concurrent runs from different project directories do not share the same local builder
|
||||
- updates session logging to include project hash and builder suffix for easier build diagnostics
|
||||
|
||||
## 2026-03-15 - 2.1.0 - feat(cli)
|
||||
add global remote builder configuration and native SSH buildx nodes for multi-platform builds
|
||||
|
||||
- adds a new `tsdocker config` command with subcommands to add, remove, list, and show remote builder definitions
|
||||
- introduces global config support for remote builders stored under `~/.git.zone/tsdocker/config.json`
|
||||
- builds can now create multi-node buildx setups with remote SSH builders and open reverse SSH tunnels so remote nodes can push to the local staging registry
|
||||
- updates the README and CLI help to document remote builder configuration and native cross-platform build workflows
|
||||
|
||||
## 2026-03-12 - 2.0.2 - fix(repo)
|
||||
no changes to commit
|
||||
|
||||
|
||||
## 2026-03-12 - 2.0.1 - fix(repository)
|
||||
no changes to commit
|
||||
|
||||
|
||||
## 2026-03-12 - 2.0.0 - BREAKING CHANGE(cli)
|
||||
remove legacy container test runner and make the default command show the man page
|
||||
|
||||
- Removes legacy testing and VS Code commands, including `runinside`, `vscode`, generated Dockerfile assets, and related configuration fields (`baseImage`, `command`, `dockerSock`, `keyValueObject`)
|
||||
- Simplifies configuration and dependencies by dropping qenv-based env loading and unused legacy packages
|
||||
- Updates CLI and documentation to reflect default help output and the current build/push-focused workflow
|
||||
|
||||
## 2026-02-07 - 1.17.4 - fix()
|
||||
no changes
|
||||
|
||||
|
||||
30
package.json
30
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@git.zone/tsdocker",
|
||||
"version": "1.17.4",
|
||||
"version": "2.2.2",
|
||||
"private": false,
|
||||
"description": "develop npm modules cross platform with docker",
|
||||
"main": "dist_ts/index.js",
|
||||
@@ -11,13 +11,6 @@
|
||||
"scripts": {
|
||||
"test": "(npm run build)",
|
||||
"build": "(tsbuild)",
|
||||
"testIntegration": "(npm run clean && npm run setupCheck && npm run testStandard)",
|
||||
"testStandard": "(cd test/ && tsx ../ts/index.ts)",
|
||||
"testClean": "(cd test/ && tsx ../ts/index.ts clean --all)",
|
||||
"testVscode": "(cd test/ && tsx ../ts/index.ts vscode)",
|
||||
"clean": "(rm -rf test/)",
|
||||
"compile": "(npmts --notest)",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
@@ -34,27 +27,22 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/gitzone/tsdocker#readme",
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^4.1.2",
|
||||
"@git.zone/tsbuild": "^4.3.0",
|
||||
"@git.zone/tsrun": "^2.0.1",
|
||||
"@git.zone/tstest": "^3.1.6",
|
||||
"@types/node": "^25.0.9"
|
||||
"@git.zone/tstest": "^3.3.2",
|
||||
"@types/node": "^25.5.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/npmextra": "^5.3.3",
|
||||
"@push.rocks/lik": "^6.3.1",
|
||||
"@push.rocks/smartconfig": "^6.0.0",
|
||||
"@push.rocks/projectinfo": "^5.0.2",
|
||||
"@push.rocks/qenv": "^6.1.3",
|
||||
"@push.rocks/smartanalytics": "^2.0.15",
|
||||
"@push.rocks/smartcli": "^4.0.20",
|
||||
"@push.rocks/smartfs": "^1.3.1",
|
||||
"@push.rocks/smartfs": "^1.5.0",
|
||||
"@push.rocks/smartinteract": "^2.0.16",
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartlog": "^3.2.1",
|
||||
"@push.rocks/smartlog-destination-local": "^9.0.2",
|
||||
"@push.rocks/smartlog-source-ora": "^1.0.9",
|
||||
"@push.rocks/smartopen": "^2.0.0",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartshell": "^3.3.0",
|
||||
"@push.rocks/smartstring": "^4.1.0"
|
||||
"@push.rocks/smartshell": "^3.3.7"
|
||||
},
|
||||
"packageManager": "pnpm@10.18.1+sha512.77a884a165cbba2d8d1c19e3b4880eee6d2fcabd0d879121e282196b80042351d5eb3ca0935fa599da1dc51265cc68816ad2bddd2a2de5ea9fdf92adbec7cd34",
|
||||
"type": "module",
|
||||
|
||||
5621
pnpm-lock.yaml
generated
5621
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -3,7 +3,6 @@
|
||||
## Module Purpose
|
||||
|
||||
tsdocker is a comprehensive Docker development and building tool. It provides:
|
||||
- Testing npm modules in clean Docker environments (legacy feature)
|
||||
- Building Dockerfiles with dependency ordering
|
||||
- Multi-registry push/pull support
|
||||
- Multi-architecture builds (amd64/arm64)
|
||||
@@ -12,7 +11,7 @@ tsdocker is a comprehensive Docker development and building tool. It provides:
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `tsdocker` | Run tests in container (legacy default behavior) |
|
||||
| `tsdocker` | Show usage / man page |
|
||||
| `tsdocker build` | Build all Dockerfiles with dependency ordering |
|
||||
| `tsdocker push [registry]` | Push images to configured registries |
|
||||
| `tsdocker pull <registry>` | Pull images from registry |
|
||||
@@ -20,7 +19,6 @@ tsdocker is a comprehensive Docker development and building tool. It provides:
|
||||
| `tsdocker login` | Login to configured registries |
|
||||
| `tsdocker list` | List discovered Dockerfiles and dependencies |
|
||||
| `tsdocker clean --all` | Clean up Docker environment |
|
||||
| `tsdocker vscode` | Start VS Code in Docker |
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -45,9 +43,6 @@ Configure in `package.json` under `@git.zone/tsdocker`:
|
||||
|
||||
### Configuration Options
|
||||
|
||||
- `baseImage`: Base Docker image for testing (legacy)
|
||||
- `command`: Command to run in container (legacy)
|
||||
- `dockerSock`: Mount Docker socket (legacy)
|
||||
- `registries`: Array of registry URLs to push to
|
||||
- `registryRepoMap`: Map registry URLs to different repo paths
|
||||
- `buildArgEnvMap`: Map Docker build ARGs to environment variables
|
||||
@@ -78,8 +73,6 @@ ts/
|
||||
├── tsdocker.cli.ts (CLI commands)
|
||||
├── tsdocker.config.ts (configuration)
|
||||
├── tsdocker.plugins.ts (plugin imports)
|
||||
├── tsdocker.docker.ts (legacy test runner)
|
||||
├── tsdocker.snippets.ts (Dockerfile generation)
|
||||
├── classes.dockerfile.ts (Dockerfile management)
|
||||
├── classes.dockerregistry.ts (registry authentication)
|
||||
├── classes.registrystorage.ts (registry storage)
|
||||
@@ -123,8 +116,6 @@ The `config.push` field is now a no-op (kept for backward compat).
|
||||
## Build Status
|
||||
|
||||
- Build: ✅ Passes
|
||||
- Legacy test functionality preserved
|
||||
- New Docker build functionality added
|
||||
|
||||
## Previous Upgrades (2025-11-22)
|
||||
|
||||
|
||||
305
readme.md
305
readme.md
@@ -12,13 +12,15 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
|
||||
|
||||
### 🎯 Key Capabilities
|
||||
|
||||
- 🧪 **Containerized Testing** — Run your tests in pristine Docker environments
|
||||
- 🏗️ **Smart Docker Builds** — Automatically discover, sort, and build Dockerfiles by dependency
|
||||
- 🌍 **True Multi-Architecture** — Build for `amd64` and `arm64` simultaneously with Docker Buildx
|
||||
- 🚀 **Multi-Registry Push** — Ship to Docker Hub, GitLab, GitHub Container Registry, and more via OCI Distribution API
|
||||
- ⚡ **Parallel Builds** — Level-based parallel builds with configurable concurrency
|
||||
- 🗄️ **Persistent Local Registry** — All images flow through a local OCI registry with persistent storage
|
||||
- 📦 **Build Caching** — Skip unchanged Dockerfiles with content-hash caching
|
||||
- 🎯 **Dockerfile Filtering** — Build or push only specific Dockerfiles using glob patterns
|
||||
- 🔁 **Resilient Push** — Automatic retry with exponential backoff, timeouts, and token refresh for rock-solid pushes
|
||||
- 🏭 **CI-Safe Isolation** — Unique sessions per invocation prevent collisions in parallel CI pipelines
|
||||
- 🔧 **Zero Config Start** — Works out of the box, scales with your needs
|
||||
|
||||
## Installation
|
||||
@@ -33,16 +35,6 @@ pnpm install --save-dev @git.zone/tsdocker
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 🧪 Run Tests in Docker
|
||||
|
||||
The simplest use case — run your tests in a clean container:
|
||||
|
||||
```bash
|
||||
tsdocker
|
||||
```
|
||||
|
||||
This pulls your configured base image, mounts your project, and executes your test command in isolation.
|
||||
|
||||
### 🏗️ Build Docker Images
|
||||
|
||||
Got `Dockerfile` files? Build them all with automatic dependency ordering:
|
||||
@@ -68,28 +60,47 @@ tsdocker push
|
||||
|
||||
# Push to a specific registry
|
||||
tsdocker push --registry=registry.gitlab.com
|
||||
|
||||
# Push without rebuilding (use existing images in local registry)
|
||||
tsdocker push --no-build
|
||||
```
|
||||
|
||||
Under the hood, `tsdocker push` uses the **OCI Distribution API** to copy images directly from the local registry to remote registries. This means multi-arch manifest lists are preserved end-to-end — no more single-platform-only pushes.
|
||||
Under the hood, `tsdocker push` uses the **OCI Distribution API** to copy images directly from the local registry to remote registries. This means multi-arch manifest lists are preserved end-to-end — no more single-platform-only pushes. Every request is protected with **automatic retry** (up to 6 attempts with exponential backoff) and **5-minute timeouts**, so transient network issues don't kill your push mid-transfer.
|
||||
|
||||
### 🎯 Build Only Specific Dockerfiles
|
||||
|
||||
Target specific Dockerfiles by name pattern — dependencies are resolved automatically:
|
||||
|
||||
```bash
|
||||
# Build only the base image
|
||||
tsdocker build Dockerfile_base
|
||||
|
||||
# Build anything matching a glob pattern
|
||||
tsdocker build Dockerfile_app*
|
||||
|
||||
# Push specific images only (skip build phase)
|
||||
tsdocker push --no-build Dockerfile_api Dockerfile_web
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `tsdocker` | Run tests in a fresh Docker container (legacy mode) |
|
||||
| `tsdocker` | Show usage / man page |
|
||||
| `tsdocker build` | Build all Dockerfiles with dependency ordering |
|
||||
| `tsdocker push` | Build + push images to configured registries |
|
||||
| `tsdocker pull <registry>` | Pull images from a specific registry |
|
||||
| `tsdocker test` | Build + run container test scripts (`test_*.sh`) |
|
||||
| `tsdocker login` | Authenticate with configured registries |
|
||||
| `tsdocker list` | Display discovered Dockerfiles and their dependencies |
|
||||
| `tsdocker config` | Manage global tsdocker configuration (remote builders, etc.) |
|
||||
| `tsdocker clean` | Interactively clean Docker environment |
|
||||
| `tsdocker vscode` | Launch containerized VS Code in browser |
|
||||
|
||||
### Build Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `<patterns>` | Positional Dockerfile name patterns (e.g. `Dockerfile_base`, `Dockerfile_app*`) |
|
||||
| `--platform=linux/arm64` | Override build platform for a single architecture |
|
||||
| `--timeout=600` | Build timeout in seconds |
|
||||
| `--no-cache` | Force rebuild without Docker layer cache |
|
||||
@@ -99,6 +110,32 @@ Under the hood, `tsdocker push` uses the **OCI Distribution API** to copy images
|
||||
| `--parallel=8` | Parallel builds with custom concurrency |
|
||||
| `--context=mycontext` | Use a specific Docker context |
|
||||
|
||||
### Push Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `<patterns>` | Positional Dockerfile name patterns to select which images to push |
|
||||
| `--registry=<url>` | Push to a single specific registry instead of all configured |
|
||||
| `--no-build` | Skip the build phase; only push existing images from local registry |
|
||||
|
||||
### Config Subcommands
|
||||
|
||||
| Subcommand | Description |
|
||||
|------------|-------------|
|
||||
| `add-builder` | Add or update a remote builder node |
|
||||
| `remove-builder` | Remove a remote builder by name |
|
||||
| `list-builders` | List all configured remote builders |
|
||||
| `show` | Show the full global configuration |
|
||||
|
||||
**`add-builder` flags:**
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--name=<name>` | Builder name (e.g. `arm64-builder`) |
|
||||
| `--host=<user@ip>` | SSH host (e.g. `armbuilder@192.168.1.100`) |
|
||||
| `--platform=<p>` | Target platform (e.g. `linux/arm64`) |
|
||||
| `--ssh-key=<path>` | SSH key path (optional, uses SSH agent/config by default) |
|
||||
|
||||
### Clean Flags
|
||||
|
||||
| Flag | Description |
|
||||
@@ -138,16 +175,6 @@ Configure tsdocker in your `package.json` or `npmextra.json` under the `@git.zon
|
||||
| `platforms` | `string[]` | `["linux/amd64"]` | Target architectures for multi-arch builds |
|
||||
| `testDir` | `string` | `./test` | Directory containing test scripts |
|
||||
|
||||
#### Legacy Testing Options
|
||||
|
||||
These options configure the `tsdocker` default command (containerized test runner):
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `baseImage` | `string` | `hosttoday/ht-docker-node:npmdocker` | Docker image for test environment |
|
||||
| `command` | `string` | `npmci npm test` | Command to run inside the container |
|
||||
| `dockerSock` | `boolean` | `false` | Mount Docker socket for DinD scenarios |
|
||||
|
||||
## Architecture: How tsdocker Works
|
||||
|
||||
tsdocker uses a **local OCI registry** as the canonical store for all built images. This design solves fundamental problems with Docker's local daemon, which cannot hold multi-architecture manifest lists.
|
||||
@@ -155,36 +182,37 @@ tsdocker uses a **local OCI registry** as the canonical store for all built imag
|
||||
### 📐 Build Flow
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ tsdocker build │
|
||||
│ │
|
||||
│ 1. Start local registry (localhost:5234) │
|
||||
│ └── Persistent volume: .nogit/docker-registry/
|
||||
│ │
|
||||
│ 2. For each Dockerfile (topological order): │
|
||||
│ ├── Multi-platform: buildx --push → registry │
|
||||
│ └── Single-platform: docker build → registry │
|
||||
│ │
|
||||
│ 3. Stop local registry (data persists on disk) │
|
||||
└─────────────────────────────────────────────────┘
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ tsdocker build │
|
||||
│ │
|
||||
│ 1. Start local registry (localhost:<dynamic-port>) │
|
||||
│ └── Persistent volume: .nogit/docker-registry/ │
|
||||
│ │
|
||||
│ 2. For each Dockerfile (topological order): │
|
||||
│ ├── Multi-platform: buildx --push → registry │
|
||||
│ └── Single-platform: docker build → registry │
|
||||
│ │
|
||||
│ 3. Stop local registry (data persists on disk) │
|
||||
└─────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 📤 Push Flow
|
||||
|
||||
```
|
||||
┌──────────────────────────────────────────────────┐
|
||||
│ tsdocker push │
|
||||
│ │
|
||||
│ 1. Start local registry (loads persisted data) │
|
||||
│ │
|
||||
│ 2. For each image × each remote registry: │
|
||||
│ └── OCI Distribution API copy: │
|
||||
│ ├── Fetch manifest (single or multi-arch) │
|
||||
│ ├── Copy blobs (skip if already exist) │
|
||||
│ └── Push manifest with destination tag │
|
||||
│ │
|
||||
│ 3. Stop local registry │
|
||||
└──────────────────────────────────────────────────┘
|
||||
┌────────────────────────────────────────────────────────┐
|
||||
│ tsdocker push │
|
||||
│ │
|
||||
│ 1. Start local registry (loads persisted data) │
|
||||
│ │
|
||||
│ 2. For each image × each remote registry: │
|
||||
│ └── OCI Distribution API copy (with retry): │
|
||||
│ ├── Fetch manifest (single or multi-arch) │
|
||||
│ ├── Copy blobs (skip if already exist) │
|
||||
│ ├── Retry up to 6× with exponential backoff │
|
||||
│ └── Push manifest with destination tag │
|
||||
│ │
|
||||
│ 3. Stop local registry │
|
||||
└────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 🔑 Why a Local Registry?
|
||||
@@ -196,6 +224,49 @@ tsdocker uses a **local OCI registry** as the canonical store for all built imag
|
||||
| Images lost between build and push phases | Persistent storage at `.nogit/docker-registry/` survives restarts |
|
||||
| Redundant blob uploads on incremental pushes | HEAD checks skip blobs that already exist on the remote |
|
||||
|
||||
### 🔁 Resilient Push
|
||||
|
||||
The OCI Distribution API client wraps every HTTP request with:
|
||||
|
||||
- **Timeouts** — 5-minute timeout for blob operations, 30-second timeout for auth/metadata calls via `AbortSignal.timeout()`
|
||||
- **Automatic Retry** — Up to 6 attempts with exponential backoff (1s → 2s → 4s → 8s → 16s → 32s)
|
||||
- **Smart Retry Logic** — Retries on network errors (`ECONNRESET`, `fetch failed`) and 5xx server errors; does NOT retry 4xx client errors
|
||||
- **Token Refresh** — On 401 responses, the cached auth token is cleared so the next retry re-authenticates automatically
|
||||
|
||||
This means transient issues like stale connection pools, brief network blips, or token expiry during long multi-arch pushes (56+ blob operations) are handled gracefully instead of killing the entire transfer.
|
||||
|
||||
### 🏭 CI-Safe Session Isolation
|
||||
|
||||
Every tsdocker invocation gets its own **session** with unique:
|
||||
|
||||
- **Session ID** — Random 8-char hex (override with `TSDOCKER_SESSION_ID`)
|
||||
- **Registry port** — Dynamically allocated (override with `TSDOCKER_REGISTRY_PORT`)
|
||||
- **Registry container** — Named `tsdocker-registry-<sessionId>`
|
||||
- **Builder suffix** — In CI, the buildx builder gets a `-<sessionId>` suffix to prevent collisions
|
||||
|
||||
This prevents resource conflicts when multiple CI jobs run tsdocker in parallel. Auto-detected CI systems:
|
||||
|
||||
| Environment Variable | CI System |
|
||||
|---------------------|-----------|
|
||||
| `GITEA_ACTIONS` | Gitea Actions |
|
||||
| `GITHUB_ACTIONS` | GitHub Actions |
|
||||
| `GITLAB_CI` | GitLab CI |
|
||||
| `CI` | Generic CI |
|
||||
|
||||
In local dev, no suffix is added — keeping a persistent builder for faster rebuilds.
|
||||
|
||||
### 🔍 Docker Context & Topology Detection
|
||||
|
||||
tsdocker automatically detects your Docker environment topology:
|
||||
|
||||
| Topology | Detection | Meaning |
|
||||
|----------|-----------|---------|
|
||||
| `local` | Default | Standard Docker installation on the host |
|
||||
| `socket-mount` | `/.dockerenv` exists | Running inside a container with Docker socket mounted |
|
||||
| `dind` | `DOCKER_HOST` starts with `tcp://` | Docker-in-Docker setup |
|
||||
|
||||
Context-aware builder names (`tsdocker-builder-<context>`) prevent conflicts across Docker contexts. Rootless Docker configurations trigger appropriate warnings.
|
||||
|
||||
## Registry Authentication
|
||||
|
||||
### Environment Variables
|
||||
@@ -213,7 +284,7 @@ export DOCKER_REGISTRY_PASSWORD="password"
|
||||
|
||||
### Docker Config Fallback
|
||||
|
||||
When pushing, tsdocker will also read credentials from `~/.docker/config.json` if no explicit credentials are provided via environment variables. This means `docker login` credentials work automatically.
|
||||
When pushing, tsdocker will also read credentials from `~/.docker/config.json` if no explicit credentials are provided via environment variables. This means `docker login` credentials work automatically. Docker Hub special cases (`docker.io`, `index.docker.io`, `registry-1.docker.io`) are all recognized.
|
||||
|
||||
### Login Command
|
||||
|
||||
@@ -242,6 +313,51 @@ tsdocker automatically:
|
||||
- Pushes multi-platform images to the local registry via `buildx --push`
|
||||
- Copies the full manifest list (including all platform variants) to remote registries on `tsdocker push`
|
||||
|
||||
### 🖥️ Native Remote Builders
|
||||
|
||||
Instead of relying on slow QEMU emulation for cross-platform builds, tsdocker can use **native remote machines** via SSH as build nodes. For example, use a real arm64 machine for `linux/arm64` builds:
|
||||
|
||||
```bash
|
||||
# Add a remote arm64 builder
|
||||
tsdocker config add-builder \
|
||||
--name=arm64-builder \
|
||||
--host=armbuilder@192.168.1.100 \
|
||||
--platform=linux/arm64 \
|
||||
--ssh-key=~/.ssh/id_ed25519
|
||||
|
||||
# List configured builders
|
||||
tsdocker config list-builders
|
||||
|
||||
# Remove a builder
|
||||
tsdocker config remove-builder --name=arm64-builder
|
||||
|
||||
# Show full global config
|
||||
tsdocker config show
|
||||
```
|
||||
|
||||
Global configuration is stored at `~/.git.zone/tsdocker/config.json`.
|
||||
|
||||
**How it works:**
|
||||
|
||||
When remote builders are configured and the project's `platforms` includes a matching platform, tsdocker automatically:
|
||||
|
||||
1. Creates a **multi-node buildx builder** — local node for `linux/amd64`, remote SSH node for `linux/arm64`
|
||||
2. Opens **SSH reverse tunnels** so the remote builder can push to the local staging registry
|
||||
3. Builds natively on each platform's hardware — no QEMU overhead
|
||||
4. Tears down tunnels after the build completes
|
||||
|
||||
```
|
||||
[Local machine] [Remote arm64 machine]
|
||||
registry:2 on localhost:PORT <──── SSH reverse tunnel ──── localhost:PORT
|
||||
BuildKit (amd64) ──push──> BuildKit (arm64) ──push──>
|
||||
localhost:PORT localhost:PORT (tunneled)
|
||||
```
|
||||
|
||||
**Prerequisites for the remote machine:**
|
||||
- Docker installed and running
|
||||
- A user with Docker group access (no sudo needed)
|
||||
- SSH key access configured
|
||||
|
||||
### ⚡ Parallel Builds
|
||||
|
||||
Speed up builds by building independent images concurrently:
|
||||
@@ -270,6 +386,26 @@ tsdocker discovers files matching `Dockerfile*`:
|
||||
| `Dockerfile_alpine` | `alpine` |
|
||||
| `Dockerfile_##version##` | Uses `package.json` version |
|
||||
|
||||
### 🎯 Dockerfile Filtering
|
||||
|
||||
Build or push only the Dockerfiles you need. Positional arguments are matched against Dockerfile basenames as glob patterns:
|
||||
|
||||
```bash
|
||||
# Build a single Dockerfile
|
||||
tsdocker build Dockerfile_base
|
||||
|
||||
# Glob patterns with * and ? wildcards
|
||||
tsdocker build Dockerfile_app*
|
||||
|
||||
# Multiple patterns
|
||||
tsdocker build Dockerfile_base Dockerfile_web
|
||||
|
||||
# Push specific images without rebuilding
|
||||
tsdocker push --no-build Dockerfile_api
|
||||
```
|
||||
|
||||
When filtering for `build`, **dependencies are auto-resolved**: if `Dockerfile_app` depends on `Dockerfile_base`, specifying only `Dockerfile_app` will automatically include `Dockerfile_base` in the build order.
|
||||
|
||||
### 🔗 Dependency-Aware Builds
|
||||
|
||||
If you have multiple Dockerfiles that depend on each other:
|
||||
@@ -347,20 +483,6 @@ Use different repository names for different registries:
|
||||
|
||||
When pushing, tsdocker maps the local repo name to the registry-specific path. For example, a locally built `myproject:latest` becomes `registry.gitlab.com/mygroup/myproject:latest` and `docker.io/myuser/myproject:latest`.
|
||||
|
||||
### 🐳 Docker-in-Docker Testing
|
||||
|
||||
Test Docker-related tools by mounting the Docker socket:
|
||||
|
||||
```json
|
||||
{
|
||||
"@git.zone/tsdocker": {
|
||||
"baseImage": "docker:latest",
|
||||
"command": "docker version && docker ps",
|
||||
"dockerSock": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 📋 Listing Dockerfiles
|
||||
|
||||
Inspect your project's Dockerfiles and their relationships:
|
||||
@@ -449,6 +571,19 @@ build-and-push:
|
||||
DOCKER_REGISTRY_1: "ghcr.io|${{ github.actor }}|${{ secrets.GITHUB_TOKEN }}"
|
||||
```
|
||||
|
||||
**Gitea Actions:**
|
||||
|
||||
```yaml
|
||||
- name: Build and Push
|
||||
run: |
|
||||
npm install -g @git.zone/tsdocker
|
||||
tsdocker push
|
||||
env:
|
||||
DOCKER_REGISTRY_1: "gitea.example.com|${{ secrets.REGISTRY_USER }}|${{ secrets.REGISTRY_PASSWORD }}"
|
||||
```
|
||||
|
||||
tsdocker auto-detects all three CI systems and enables session isolation automatically — no extra configuration needed.
|
||||
|
||||
## TypeScript API
|
||||
|
||||
tsdocker can also be used programmatically:
|
||||
@@ -458,10 +593,6 @@ import { TsDockerManager } from '@git.zone/tsdocker/dist_ts/classes.tsdockermana
|
||||
import type { ITsDockerConfig } from '@git.zone/tsdocker/dist_ts/interfaces/index.js';
|
||||
|
||||
const config: ITsDockerConfig = {
|
||||
baseImage: 'node:20',
|
||||
command: 'npm test',
|
||||
dockerSock: false,
|
||||
keyValueObject: {},
|
||||
registries: ['docker.io'],
|
||||
platforms: ['linux/amd64', 'linux/arm64'],
|
||||
};
|
||||
@@ -472,6 +603,25 @@ await manager.build({ parallel: true });
|
||||
await manager.push();
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
### CI & Session Control
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `TSDOCKER_SESSION_ID` | Override the auto-generated session ID (default: random 8-char hex) |
|
||||
| `TSDOCKER_REGISTRY_PORT` | Override the dynamically allocated local registry port |
|
||||
| `CI` | Generic CI detection (also `GITHUB_ACTIONS`, `GITLAB_CI`, `GITEA_ACTIONS`) |
|
||||
|
||||
### Registry Credentials
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `DOCKER_REGISTRY_1` through `DOCKER_REGISTRY_10` | Pipe-delimited: `registry\|username\|password` |
|
||||
| `DOCKER_REGISTRY_URL` | Registry URL for single-registry setup |
|
||||
| `DOCKER_REGISTRY_USER` | Username for single-registry setup |
|
||||
| `DOCKER_REGISTRY_PASSWORD` | Password for single-registry setup |
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Docker** — Docker Engine 20+ or Docker Desktop
|
||||
@@ -507,6 +657,15 @@ tsdocker login
|
||||
|
||||
tsdocker also falls back to `~/.docker/config.json` — ensure you've run `docker login` for your target registries.
|
||||
|
||||
### Push fails with "fetch failed"
|
||||
|
||||
tsdocker automatically retries failed requests up to 6 times with exponential backoff. If pushes still fail:
|
||||
|
||||
- Check network connectivity to the target registry
|
||||
- Verify your credentials haven't expired
|
||||
- Look for retry log messages (`fetch failed (attempt X/6)`) to diagnose the pattern
|
||||
- Large layers may need longer timeouts — the default 5-minute timeout per request should cover most cases
|
||||
|
||||
### Circular dependency detected
|
||||
|
||||
Review your Dockerfiles' `FROM` statements — you have images depending on each other in a loop.
|
||||
@@ -522,16 +681,6 @@ node_modules
|
||||
dist_ts
|
||||
```
|
||||
|
||||
## Migration from Legacy
|
||||
|
||||
Previously published as `npmdocker`, now `@git.zone/tsdocker`:
|
||||
|
||||
| Old | New |
|
||||
|-----|-----|
|
||||
| `npmdocker` command | `tsdocker` command |
|
||||
| `"npmdocker"` config key | `"@git.zone/tsdocker"` config key |
|
||||
| CommonJS | ESM with `.js` imports |
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@git.zone/tsdocker',
|
||||
version: '1.17.4',
|
||||
version: '2.2.2',
|
||||
description: 'develop npm modules cross platform with docker'
|
||||
}
|
||||
|
||||
@@ -266,12 +266,15 @@ export class Dockerfile {
|
||||
public static async buildDockerfiles(
|
||||
sortedArrayArg: Dockerfile[],
|
||||
session: TsDockerSession,
|
||||
options?: { platform?: string; timeout?: number; noCache?: boolean; verbose?: boolean; isRootless?: boolean; parallel?: boolean; parallelConcurrency?: number },
|
||||
options?: { platform?: string; timeout?: number; noCache?: boolean; pull?: boolean; verbose?: boolean; isRootless?: boolean; parallel?: boolean; parallelConcurrency?: number; onRegistryStarted?: () => Promise<void>; onBeforeRegistryStop?: () => Promise<void> },
|
||||
): Promise<Dockerfile[]> {
|
||||
const total = sortedArrayArg.length;
|
||||
const overallStart = Date.now();
|
||||
|
||||
await Dockerfile.startLocalRegistry(session, options?.isRootless);
|
||||
if (options?.onRegistryStarted) {
|
||||
await options.onRegistryStarted();
|
||||
}
|
||||
|
||||
try {
|
||||
if (options?.parallel) {
|
||||
@@ -351,6 +354,9 @@ export class Dockerfile {
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
if (options?.onBeforeRegistryStop) {
|
||||
await options.onBeforeRegistryStop();
|
||||
}
|
||||
await Dockerfile.stopLocalRegistry(session);
|
||||
}
|
||||
|
||||
@@ -662,13 +668,14 @@ export class Dockerfile {
|
||||
/**
|
||||
* Builds the Dockerfile
|
||||
*/
|
||||
public async build(options?: { platform?: string; timeout?: number; noCache?: boolean; verbose?: boolean }): Promise<number> {
|
||||
public async build(options?: { platform?: string; timeout?: number; noCache?: boolean; pull?: boolean; verbose?: boolean }): Promise<number> {
|
||||
const startTime = Date.now();
|
||||
const buildArgsString = await Dockerfile.getDockerBuildArgs(this.managerRef);
|
||||
const config = this.managerRef.config;
|
||||
const platformOverride = options?.platform;
|
||||
const timeout = options?.timeout;
|
||||
const noCacheFlag = options?.noCache ? ' --no-cache' : '';
|
||||
const pullFlag = options?.pull !== false ? ' --pull' : '';
|
||||
const verbose = options?.verbose ?? false;
|
||||
|
||||
let buildContextFlag = '';
|
||||
@@ -683,23 +690,24 @@ export class Dockerfile {
|
||||
}
|
||||
|
||||
let buildCommand: string;
|
||||
const builderFlag = this.managerRef.currentBuilderName ? ` --builder ${this.managerRef.currentBuilderName}` : '';
|
||||
|
||||
if (platformOverride) {
|
||||
// Single platform override via buildx
|
||||
buildCommand = `docker buildx build --progress=plain --platform ${platformOverride}${noCacheFlag}${buildContextFlag} --load -t ${this.buildTag} -f ${this.filePath} ${buildArgsString} .`;
|
||||
buildCommand = `docker buildx build${builderFlag} --progress=plain --platform ${platformOverride}${noCacheFlag}${pullFlag}${buildContextFlag} --load -t ${this.buildTag} -f ${this.filePath} ${buildArgsString} .`;
|
||||
logger.log('info', `Build: buildx --platform ${platformOverride} --load`);
|
||||
} else if (config.platforms && config.platforms.length > 1) {
|
||||
// Multi-platform build using buildx — always push to local registry
|
||||
const platformString = config.platforms.join(',');
|
||||
const registryHost = this.session?.config.registryHost || 'localhost:5234';
|
||||
const localTag = `${registryHost}/${this.buildTag}`;
|
||||
buildCommand = `docker buildx build --progress=plain --platform ${platformString}${noCacheFlag}${buildContextFlag} -t ${localTag} -f ${this.filePath} ${buildArgsString} --push .`;
|
||||
buildCommand = `docker buildx build${builderFlag} --progress=plain --platform ${platformString}${noCacheFlag}${pullFlag}${buildContextFlag} -t ${localTag} -f ${this.filePath} ${buildArgsString} --push .`;
|
||||
this.localRegistryTag = localTag;
|
||||
logger.log('info', `Build: buildx --platform ${platformString} --push to local registry`);
|
||||
} else {
|
||||
// Standard build
|
||||
const versionLabel = this.managerRef.projectInfo?.npm?.version || 'unknown';
|
||||
buildCommand = `docker build --progress=plain --label="version=${versionLabel}"${noCacheFlag} -t ${this.buildTag} -f ${this.filePath} ${buildArgsString} .`;
|
||||
buildCommand = `docker build --progress=plain --label="version=${versionLabel}"${noCacheFlag}${pullFlag} -t ${this.buildTag} -f ${this.filePath} ${buildArgsString} .`;
|
||||
logger.log('info', 'Build: docker build (standard)');
|
||||
}
|
||||
|
||||
|
||||
76
ts/classes.globalconfig.ts
Normal file
76
ts/classes.globalconfig.ts
Normal file
@@ -0,0 +1,76 @@
|
||||
import * as fs from 'fs';
|
||||
import * as plugins from './tsdocker.plugins.js';
|
||||
import { logger } from './tsdocker.logging.js';
|
||||
import type { IGlobalConfig, IRemoteBuilder } from './interfaces/index.js';
|
||||
|
||||
const CONFIG_DIR = plugins.path.join(
|
||||
process.env.HOME || process.env.USERPROFILE || '~',
|
||||
'.git.zone',
|
||||
'tsdocker',
|
||||
);
|
||||
const CONFIG_PATH = plugins.path.join(CONFIG_DIR, 'config.json');
|
||||
|
||||
const DEFAULT_CONFIG: IGlobalConfig = {
|
||||
remoteBuilders: [],
|
||||
};
|
||||
|
||||
export class GlobalConfig {
|
||||
static getConfigPath(): string {
|
||||
return CONFIG_PATH;
|
||||
}
|
||||
|
||||
static load(): IGlobalConfig {
|
||||
try {
|
||||
const raw = fs.readFileSync(CONFIG_PATH, 'utf-8');
|
||||
const parsed = JSON.parse(raw);
|
||||
return {
|
||||
...DEFAULT_CONFIG,
|
||||
...parsed,
|
||||
};
|
||||
} catch {
|
||||
return { ...DEFAULT_CONFIG };
|
||||
}
|
||||
}
|
||||
|
||||
static save(config: IGlobalConfig): void {
|
||||
fs.mkdirSync(CONFIG_DIR, { recursive: true });
|
||||
fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2) + '\n', 'utf-8');
|
||||
}
|
||||
|
||||
static addBuilder(builder: IRemoteBuilder): void {
|
||||
const config = GlobalConfig.load();
|
||||
const existing = config.remoteBuilders.findIndex((b) => b.name === builder.name);
|
||||
if (existing >= 0) {
|
||||
config.remoteBuilders[existing] = builder;
|
||||
logger.log('info', `Updated remote builder: ${builder.name}`);
|
||||
} else {
|
||||
config.remoteBuilders.push(builder);
|
||||
logger.log('info', `Added remote builder: ${builder.name}`);
|
||||
}
|
||||
GlobalConfig.save(config);
|
||||
}
|
||||
|
||||
static removeBuilder(name: string): void {
|
||||
const config = GlobalConfig.load();
|
||||
const before = config.remoteBuilders.length;
|
||||
config.remoteBuilders = config.remoteBuilders.filter((b) => b.name !== name);
|
||||
if (config.remoteBuilders.length < before) {
|
||||
logger.log('info', `Removed remote builder: ${name}`);
|
||||
} else {
|
||||
logger.log('warn', `Remote builder not found: ${name}`);
|
||||
}
|
||||
GlobalConfig.save(config);
|
||||
}
|
||||
|
||||
static getBuilders(): IRemoteBuilder[] {
|
||||
return GlobalConfig.load().remoteBuilders;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns remote builders that match any of the requested platforms
|
||||
*/
|
||||
static getBuildersForPlatforms(platforms: string[]): IRemoteBuilder[] {
|
||||
const builders = GlobalConfig.getBuilders();
|
||||
return builders.filter((b) => platforms.includes(b.platform));
|
||||
}
|
||||
}
|
||||
77
ts/classes.sshtunnel.ts
Normal file
77
ts/classes.sshtunnel.ts
Normal file
@@ -0,0 +1,77 @@
|
||||
import * as plugins from './tsdocker.plugins.js';
|
||||
import { logger } from './tsdocker.logging.js';
|
||||
import type { IRemoteBuilder } from './interfaces/index.js';
|
||||
|
||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash',
|
||||
});
|
||||
|
||||
/**
|
||||
* Manages SSH reverse tunnels for remote builder nodes.
|
||||
* Opens tunnels so that the local staging registry (localhost:<port>)
|
||||
* is accessible as localhost:<port> on each remote machine.
|
||||
*/
|
||||
export class SshTunnelManager {
|
||||
private tunnelPids: number[] = [];
|
||||
|
||||
/**
|
||||
* Opens a reverse SSH tunnel to make localPort accessible on the remote machine.
|
||||
* ssh -f -N -o StrictHostKeyChecking=no -o ExitOnForwardFailure=yes
|
||||
* -R <localPort>:localhost:<localPort> [-i keyPath] user@host
|
||||
*/
|
||||
async openTunnel(builder: IRemoteBuilder, localPort: number): Promise<void> {
|
||||
const keyOpt = builder.sshKeyPath ? `-i ${builder.sshKeyPath} ` : '';
|
||||
const cmd = [
|
||||
'ssh -f -N',
|
||||
'-o StrictHostKeyChecking=no',
|
||||
'-o ExitOnForwardFailure=yes',
|
||||
`-R ${localPort}:localhost:${localPort}`,
|
||||
`${keyOpt}${builder.host}`,
|
||||
].join(' ');
|
||||
|
||||
logger.log('info', `Opening SSH tunnel to ${builder.host} for port ${localPort}...`);
|
||||
const result = await smartshellInstance.exec(cmd);
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
throw new Error(
|
||||
`Failed to open SSH tunnel to ${builder.host}: ${result.stderr || 'unknown error'}`
|
||||
);
|
||||
}
|
||||
|
||||
// Find the PID of the tunnel process we just started
|
||||
const pidResult = await smartshellInstance.exec(
|
||||
`pgrep -f "ssh.*-R ${localPort}:localhost:${localPort}.*${builder.host}" | tail -1`
|
||||
);
|
||||
if (pidResult.exitCode === 0 && pidResult.stdout.trim()) {
|
||||
const pid = parseInt(pidResult.stdout.trim(), 10);
|
||||
if (!isNaN(pid)) {
|
||||
this.tunnelPids.push(pid);
|
||||
logger.log('ok', `SSH tunnel to ${builder.host} established (PID ${pid})`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens tunnels for all provided remote builders
|
||||
*/
|
||||
async openTunnels(builders: IRemoteBuilder[], localPort: number): Promise<void> {
|
||||
for (const builder of builders) {
|
||||
await this.openTunnel(builder, localPort);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes all tunnel processes
|
||||
*/
|
||||
async closeAll(): Promise<void> {
|
||||
for (const pid of this.tunnelPids) {
|
||||
try {
|
||||
process.kill(pid, 'SIGTERM');
|
||||
logger.log('info', `Closed SSH tunnel (PID ${pid})`);
|
||||
} catch {
|
||||
// Process may have already exited
|
||||
}
|
||||
}
|
||||
this.tunnelPids = [];
|
||||
}
|
||||
}
|
||||
@@ -8,7 +8,9 @@ import { TsDockerCache } from './classes.tsdockercache.js';
|
||||
import { DockerContext } from './classes.dockercontext.js';
|
||||
import { TsDockerSession } from './classes.tsdockersession.js';
|
||||
import { RegistryCopy } from './classes.registrycopy.js';
|
||||
import type { ITsDockerConfig, IBuildCommandOptions } from './interfaces/index.js';
|
||||
import { GlobalConfig } from './classes.globalconfig.js';
|
||||
import { SshTunnelManager } from './classes.sshtunnel.js';
|
||||
import type { ITsDockerConfig, IBuildCommandOptions, IRemoteBuilder } from './interfaces/index.js';
|
||||
|
||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash',
|
||||
@@ -23,7 +25,10 @@ export class TsDockerManager {
|
||||
public projectInfo: any;
|
||||
public dockerContext: DockerContext;
|
||||
public session!: TsDockerSession;
|
||||
public currentBuilderName?: string;
|
||||
private dockerfiles: Dockerfile[] = [];
|
||||
private activeRemoteBuilders: IRemoteBuilder[] = [];
|
||||
private sshTunnelManager?: SshTunnelManager;
|
||||
|
||||
constructor(config: ITsDockerConfig) {
|
||||
this.config = config;
|
||||
@@ -235,6 +240,7 @@ export class TsDockerManager {
|
||||
const total = toBuild.length;
|
||||
const overallStart = Date.now();
|
||||
await Dockerfile.startLocalRegistry(this.session, this.dockerContext.contextInfo?.isRootless);
|
||||
await this.openRemoteTunnels();
|
||||
|
||||
try {
|
||||
if (options?.parallel) {
|
||||
@@ -261,6 +267,7 @@ export class TsDockerManager {
|
||||
platform: options?.platform,
|
||||
timeout: options?.timeout,
|
||||
noCache: options?.noCache,
|
||||
pull: options?.pull,
|
||||
verbose: options?.verbose,
|
||||
});
|
||||
logger.log('ok', `${progress} Built ${df.cleanTag} in ${formatDuration(elapsed)}`);
|
||||
@@ -306,6 +313,7 @@ export class TsDockerManager {
|
||||
platform: options?.platform,
|
||||
timeout: options?.timeout,
|
||||
noCache: options?.noCache,
|
||||
pull: options?.pull,
|
||||
verbose: options?.verbose,
|
||||
});
|
||||
logger.log('ok', `${progress} Built ${dockerfileArg.cleanTag} in ${formatDuration(elapsed)}`);
|
||||
@@ -332,6 +340,7 @@ export class TsDockerManager {
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
await this.closeRemoteTunnels();
|
||||
await Dockerfile.stopLocalRegistry(this.session);
|
||||
}
|
||||
|
||||
@@ -343,10 +352,13 @@ export class TsDockerManager {
|
||||
platform: options?.platform,
|
||||
timeout: options?.timeout,
|
||||
noCache: options?.noCache,
|
||||
pull: options?.pull,
|
||||
verbose: options?.verbose,
|
||||
isRootless: this.dockerContext.contextInfo?.isRootless,
|
||||
parallel: options?.parallel,
|
||||
parallelConcurrency: options?.parallelConcurrency,
|
||||
onRegistryStarted: () => this.openRemoteTunnels(),
|
||||
onBeforeRegistryStop: () => this.closeRemoteTunnels(),
|
||||
});
|
||||
}
|
||||
|
||||
@@ -373,35 +385,120 @@ export class TsDockerManager {
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures Docker buildx is set up for multi-architecture builds
|
||||
* Ensures Docker buildx is set up for multi-architecture builds.
|
||||
* When remote builders are configured in the global config, creates a multi-node
|
||||
* builder with native nodes instead of relying on QEMU emulation.
|
||||
*/
|
||||
private async ensureBuildx(): Promise<void> {
|
||||
const builderName = this.dockerContext.getBuilderName() + (this.session?.config.builderSuffix || '');
|
||||
const platforms = this.config.platforms?.join(', ') || 'default';
|
||||
logger.log('info', `Setting up Docker buildx [${platforms}]...`);
|
||||
logger.log('info', `Builder: ${builderName}`);
|
||||
|
||||
// Check for remote builders matching our target platforms
|
||||
const requestedPlatforms = this.config.platforms || ['linux/amd64'];
|
||||
const remoteBuilders = GlobalConfig.getBuildersForPlatforms(requestedPlatforms);
|
||||
|
||||
if (remoteBuilders.length > 0) {
|
||||
await this.ensureBuildxWithRemoteNodes(builderName, requestedPlatforms, remoteBuilders);
|
||||
} else {
|
||||
await this.ensureBuildxLocal(builderName);
|
||||
}
|
||||
|
||||
this.currentBuilderName = builderName;
|
||||
logger.log('ok', `Docker buildx ready (builder: ${builderName}, platforms: ${platforms})`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a multi-node buildx builder with local + remote SSH nodes.
|
||||
*/
|
||||
private async ensureBuildxWithRemoteNodes(
|
||||
builderName: string,
|
||||
requestedPlatforms: string[],
|
||||
remoteBuilders: IRemoteBuilder[],
|
||||
): Promise<void> {
|
||||
const remotePlatforms = new Set(remoteBuilders.map((b) => b.platform));
|
||||
const localPlatforms = requestedPlatforms.filter((p) => !remotePlatforms.has(p));
|
||||
|
||||
logger.log('info', `Remote builders: ${remoteBuilders.map((b) => `${b.name} (${b.platform} @ ${b.host})`).join(', ')}`);
|
||||
if (localPlatforms.length > 0) {
|
||||
logger.log('info', `Local platforms: ${localPlatforms.join(', ')}`);
|
||||
}
|
||||
|
||||
// Always recreate the builder to ensure correct node topology
|
||||
await smartshellInstance.execSilent(`docker buildx rm ${builderName} 2>/dev/null || true`);
|
||||
|
||||
// Create the local node
|
||||
const localPlatformFlag = localPlatforms.length > 0 ? ` --platform ${localPlatforms.join(',')}` : '';
|
||||
await smartshellInstance.exec(
|
||||
`docker buildx create --name ${builderName} --driver docker-container --driver-opt network=host${localPlatformFlag}`
|
||||
);
|
||||
|
||||
// Append remote nodes
|
||||
for (const builder of remoteBuilders) {
|
||||
logger.log('info', `Appending remote node: ${builder.name} (${builder.platform}) via ssh://${builder.host}`);
|
||||
const appendResult = await smartshellInstance.exec(
|
||||
`docker buildx create --append --name ${builderName} --driver docker-container --driver-opt network=host --platform ${builder.platform} --node ${builder.name} ssh://${builder.host}`
|
||||
);
|
||||
if (appendResult.exitCode !== 0) {
|
||||
throw new Error(`Failed to append remote builder ${builder.name}: ${appendResult.stderr}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Bootstrap all nodes
|
||||
await smartshellInstance.exec(`docker buildx inspect --builder ${builderName} --bootstrap`);
|
||||
|
||||
// Store active remote builders for SSH tunnel setup during build
|
||||
this.activeRemoteBuilders = remoteBuilders;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a single-node local buildx builder (original behavior, uses QEMU for cross-platform).
|
||||
*/
|
||||
private async ensureBuildxLocal(builderName: string): Promise<void> {
|
||||
const inspectResult = await smartshellInstance.exec(`docker buildx inspect ${builderName} 2>/dev/null`);
|
||||
|
||||
if (inspectResult.exitCode !== 0) {
|
||||
logger.log('info', 'Creating new buildx builder with host network...');
|
||||
await smartshellInstance.exec(
|
||||
`docker buildx create --name ${builderName} --driver docker-container --driver-opt network=host --use`
|
||||
`docker buildx create --name ${builderName} --driver docker-container --driver-opt network=host`
|
||||
);
|
||||
await smartshellInstance.exec('docker buildx inspect --bootstrap');
|
||||
await smartshellInstance.exec(`docker buildx inspect --builder ${builderName} --bootstrap`);
|
||||
} else {
|
||||
const inspectOutput = inspectResult.stdout || '';
|
||||
if (!inspectOutput.includes('network=host')) {
|
||||
logger.log('info', 'Recreating buildx builder with host network (migration)...');
|
||||
await smartshellInstance.exec(`docker buildx rm ${builderName} 2>/dev/null`);
|
||||
await smartshellInstance.exec(
|
||||
`docker buildx create --name ${builderName} --driver docker-container --driver-opt network=host --use`
|
||||
`docker buildx create --name ${builderName} --driver docker-container --driver-opt network=host`
|
||||
);
|
||||
await smartshellInstance.exec('docker buildx inspect --bootstrap');
|
||||
} else {
|
||||
await smartshellInstance.exec(`docker buildx use ${builderName}`);
|
||||
await smartshellInstance.exec(`docker buildx inspect --builder ${builderName} --bootstrap`);
|
||||
}
|
||||
}
|
||||
logger.log('ok', `Docker buildx ready (builder: ${builderName}, platforms: ${platforms})`);
|
||||
this.activeRemoteBuilders = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens SSH reverse tunnels for remote builders so they can reach the local registry.
|
||||
*/
|
||||
private async openRemoteTunnels(): Promise<void> {
|
||||
if (this.activeRemoteBuilders.length === 0) return;
|
||||
|
||||
this.sshTunnelManager = new SshTunnelManager();
|
||||
await this.sshTunnelManager.openTunnels(
|
||||
this.activeRemoteBuilders,
|
||||
this.session.config.registryPort,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes any active SSH tunnels.
|
||||
*/
|
||||
private async closeRemoteTunnels(): Promise<void> {
|
||||
if (this.sshTunnelManager) {
|
||||
await this.sshTunnelManager.closeAll();
|
||||
this.sshTunnelManager = undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -4,6 +4,7 @@ import { logger } from './tsdocker.logging.js';
|
||||
|
||||
export interface ISessionConfig {
|
||||
sessionId: string;
|
||||
projectHash: string;
|
||||
registryPort: number;
|
||||
registryHost: string;
|
||||
registryContainerName: string;
|
||||
@@ -17,8 +18,8 @@ export interface ISessionConfig {
|
||||
* Generates unique ports, container names, and builder names so that
|
||||
* concurrent CI jobs on the same Docker host don't collide.
|
||||
*
|
||||
* In local (non-CI) dev the builder suffix is empty, preserving the
|
||||
* persistent builder behavior.
|
||||
* In local (non-CI) dev the builder suffix contains a project hash so
|
||||
* that concurrent runs in different project directories use separate builders.
|
||||
*/
|
||||
export class TsDockerSession {
|
||||
public config: ISessionConfig;
|
||||
@@ -34,16 +35,18 @@ export class TsDockerSession {
|
||||
public static async create(): Promise<TsDockerSession> {
|
||||
const sessionId =
|
||||
process.env.TSDOCKER_SESSION_ID || crypto.randomBytes(4).toString('hex');
|
||||
const projectHash = crypto.createHash('sha256').update(process.cwd()).digest('hex').substring(0, 8);
|
||||
|
||||
const registryPort = await TsDockerSession.allocatePort();
|
||||
const registryHost = `localhost:${registryPort}`;
|
||||
const registryContainerName = `tsdocker-registry-${sessionId}`;
|
||||
|
||||
const { isCI, ciSystem } = TsDockerSession.detectCI();
|
||||
const builderSuffix = isCI ? `-${sessionId}` : '';
|
||||
const builderSuffix = isCI ? `-${projectHash}-${sessionId}` : `-${projectHash}`;
|
||||
|
||||
const config: ISessionConfig = {
|
||||
sessionId,
|
||||
projectHash,
|
||||
registryPort,
|
||||
registryHost,
|
||||
registryContainerName,
|
||||
@@ -99,9 +102,10 @@ export class TsDockerSession {
|
||||
logger.log('info', '=== TSDOCKER SESSION ===');
|
||||
logger.log('info', `Session ID: ${c.sessionId}`);
|
||||
logger.log('info', `Registry: ${c.registryHost} (container: ${c.registryContainerName})`);
|
||||
logger.log('info', `Project hash: ${c.projectHash}`);
|
||||
logger.log('info', `Builder suffix: ${c.builderSuffix}`);
|
||||
if (c.isCI) {
|
||||
logger.log('info', `CI detected: ${c.ciSystem}`);
|
||||
logger.log('info', `Builder suffix: ${c.builderSuffix}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,15 +1,7 @@
|
||||
/**
|
||||
* Configuration interface for tsdocker
|
||||
* Extends legacy config with new Docker build capabilities
|
||||
*/
|
||||
export interface ITsDockerConfig {
|
||||
// Legacy (backward compatible)
|
||||
baseImage: string;
|
||||
command: string;
|
||||
dockerSock: boolean;
|
||||
keyValueObject: { [key: string]: any };
|
||||
|
||||
// New Docker build config
|
||||
registries?: string[];
|
||||
registryRepoMap?: { [registry: string]: string };
|
||||
buildArgEnvMap?: { [dockerArg: string]: string };
|
||||
@@ -77,6 +69,7 @@ export interface IBuildCommandOptions {
|
||||
platform?: string; // Single platform override (e.g., 'linux/arm64')
|
||||
timeout?: number; // Build timeout in seconds
|
||||
noCache?: boolean; // Force rebuild without Docker layer cache (--no-cache)
|
||||
pull?: boolean; // Pull fresh base images before building (default: true)
|
||||
cached?: boolean; // Skip builds when Dockerfile content hasn't changed
|
||||
verbose?: boolean; // Stream raw docker build output (default: silent)
|
||||
context?: string; // Explicit Docker context name (--context flag)
|
||||
@@ -103,3 +96,20 @@ export interface IDockerContextInfo {
|
||||
dockerHost?: string; // value of DOCKER_HOST env var, if set
|
||||
topology?: 'socket-mount' | 'dind' | 'local';
|
||||
}
|
||||
|
||||
/**
|
||||
* A remote builder node for native cross-platform builds
|
||||
*/
|
||||
export interface IRemoteBuilder {
|
||||
name: string; // e.g., "arm64-builder"
|
||||
host: string; // e.g., "armbuilder@192.168.190.216"
|
||||
platform: string; // e.g., "linux/arm64"
|
||||
sshKeyPath?: string; // e.g., "~/.ssh/id_ed25519"
|
||||
}
|
||||
|
||||
/**
|
||||
* Global tsdocker configuration stored at ~/.git.zone/tsdocker/config.json
|
||||
*/
|
||||
export interface IGlobalConfig {
|
||||
remoteBuilders: IRemoteBuilder[];
|
||||
}
|
||||
|
||||
@@ -3,27 +3,98 @@ import * as paths from './tsdocker.paths.js';
|
||||
|
||||
// modules
|
||||
import * as ConfigModule from './tsdocker.config.js';
|
||||
import * as DockerModule from './tsdocker.docker.js';
|
||||
|
||||
import { logger, ora } from './tsdocker.logging.js';
|
||||
import { TsDockerManager } from './classes.tsdockermanager.js';
|
||||
import { DockerContext } from './classes.dockercontext.js';
|
||||
import { GlobalConfig } from './classes.globalconfig.js';
|
||||
import type { IBuildCommandOptions } from './interfaces/index.js';
|
||||
import { commitinfo } from './00_commitinfo_data.js';
|
||||
|
||||
const tsdockerCli = new plugins.smartcli.Smartcli();
|
||||
tsdockerCli.addVersion(commitinfo.version);
|
||||
|
||||
const printManPage = () => {
|
||||
const manPage = `
|
||||
TSDOCKER(1) User Commands TSDOCKER(1)
|
||||
|
||||
NAME
|
||||
tsdocker - build, test, and push Docker images
|
||||
|
||||
VERSION
|
||||
${commitinfo.version}
|
||||
|
||||
SYNOPSIS
|
||||
tsdocker <command> [options]
|
||||
|
||||
COMMANDS
|
||||
build [patterns...] [flags] Build Dockerfiles in dependency order
|
||||
push [patterns...] [flags] Build and push images to registries
|
||||
pull <registry-url> Pull images from a registry
|
||||
test [flags] Build and run container test scripts
|
||||
login Authenticate with configured registries
|
||||
list List discovered Dockerfiles
|
||||
config <subcommand> [flags] Manage global tsdocker configuration
|
||||
clean [-y] [--all] Interactive Docker resource cleanup
|
||||
|
||||
BUILD / PUSH OPTIONS
|
||||
--platform=<p> Target platform (e.g. linux/arm64)
|
||||
--timeout=<s> Build timeout in seconds
|
||||
--no-cache Rebuild without Docker layer cache
|
||||
--no-pull Skip pulling latest base images (use cached)
|
||||
--cached Skip builds when Dockerfile is unchanged
|
||||
--verbose Stream raw docker build output
|
||||
--parallel[=<n>] Parallel builds (optional concurrency limit)
|
||||
--context=<name> Docker context to use
|
||||
|
||||
PUSH-ONLY OPTIONS
|
||||
--registry=<url> Push to a specific registry
|
||||
--no-build Push already-built images (skip build step)
|
||||
|
||||
CLEAN OPTIONS
|
||||
-y Auto-confirm all prompts
|
||||
--all Include all images and volumes (not just dangling)
|
||||
|
||||
CONFIG SUBCOMMANDS
|
||||
add-builder Add a remote builder node
|
||||
--name=<n> Builder name (e.g. arm64-builder)
|
||||
--host=<h> SSH host (e.g. user@192.168.1.100)
|
||||
--platform=<p> Platform (e.g. linux/arm64)
|
||||
--ssh-key=<path> SSH key path (optional)
|
||||
remove-builder Remove a remote builder by name
|
||||
--name=<n> Builder name to remove
|
||||
list-builders List all configured remote builders
|
||||
show Show full global config
|
||||
|
||||
CONFIGURATION
|
||||
Configure via smartconfig.json under the "@git.zone/tsdocker" key:
|
||||
|
||||
registries Array of registry URLs to push to
|
||||
registryRepoMap Map of registry URL to repo path overrides
|
||||
buildArgEnvMap Map of Docker build-arg names to env var names
|
||||
platforms Array of target platforms (default: ["linux/amd64"])
|
||||
push Boolean, auto-push after build
|
||||
testDir Directory containing test_*.sh scripts
|
||||
|
||||
Global config is stored at ~/.git.zone/tsdocker/config.json
|
||||
and managed via the "config" command.
|
||||
|
||||
EXAMPLES
|
||||
tsdocker build
|
||||
tsdocker build Dockerfile_app --platform=linux/arm64
|
||||
tsdocker push --registry=ghcr.io
|
||||
tsdocker test --verbose
|
||||
tsdocker clean -y --all
|
||||
tsdocker config add-builder --name=arm64 --host=user@host --platform=linux/arm64
|
||||
tsdocker config list-builders
|
||||
`;
|
||||
console.log(manPage);
|
||||
};
|
||||
|
||||
export let run = () => {
|
||||
// Default command: run tests in container (legacy behavior)
|
||||
tsdockerCli.standardCommand().subscribe(async argvArg => {
|
||||
const configArg = await ConfigModule.run().then(DockerModule.run);
|
||||
if (configArg.exitCode === 0) {
|
||||
logger.log('success', 'container ended all right!');
|
||||
} else {
|
||||
logger.log('error', `container ended with error! Exit Code is ${configArg.exitCode}`);
|
||||
process.exit(1);
|
||||
}
|
||||
// Default command: print man page
|
||||
tsdockerCli.standardCommand().subscribe(async () => {
|
||||
printManPage();
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -50,6 +121,8 @@ export let run = () => {
|
||||
if (argvArg.cache === false) {
|
||||
buildOptions.noCache = true;
|
||||
}
|
||||
// --pull is default true; --no-pull sets pull=false
|
||||
buildOptions.pull = argvArg.pull !== false;
|
||||
if (argvArg.cached) {
|
||||
buildOptions.cached = true;
|
||||
}
|
||||
@@ -100,6 +173,7 @@ export let run = () => {
|
||||
if (argvArg.cache === false) {
|
||||
buildOptions.noCache = true;
|
||||
}
|
||||
buildOptions.pull = argvArg.pull !== false;
|
||||
if (argvArg.verbose) {
|
||||
buildOptions.verbose = true;
|
||||
}
|
||||
@@ -173,6 +247,7 @@ export let run = () => {
|
||||
if (argvArg.cache === false) {
|
||||
buildOptions.noCache = true;
|
||||
}
|
||||
buildOptions.pull = argvArg.pull !== false;
|
||||
if (argvArg.cached) {
|
||||
buildOptions.cached = true;
|
||||
}
|
||||
@@ -229,21 +304,73 @@ export let run = () => {
|
||||
});
|
||||
|
||||
/**
|
||||
* this command is executed inside docker and meant for use from outside docker
|
||||
* Manage global tsdocker configuration (remote builders, etc.)
|
||||
* Usage: tsdocker config <subcommand> [--name=...] [--host=...] [--platform=...] [--ssh-key=...]
|
||||
*/
|
||||
tsdockerCli.addCommand('runinside').subscribe(async argvArg => {
|
||||
logger.log('ok', 'Allright. We are now in Docker!');
|
||||
ora.text('now trying to run your specified command');
|
||||
const configArg = await ConfigModule.run();
|
||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash'
|
||||
});
|
||||
ora.stop();
|
||||
await smartshellInstance.exec(configArg.command).then(response => {
|
||||
if (response.exitCode !== 0) {
|
||||
process.exit(1);
|
||||
tsdockerCli.addCommand('config').subscribe(async argvArg => {
|
||||
try {
|
||||
const subcommand = argvArg._[1] as string;
|
||||
|
||||
switch (subcommand) {
|
||||
case 'add-builder': {
|
||||
const name = argvArg.name as string;
|
||||
const host = argvArg.host as string;
|
||||
const platform = argvArg.platform as string;
|
||||
const sshKeyPath = argvArg['ssh-key'] as string | undefined;
|
||||
|
||||
if (!name || !host || !platform) {
|
||||
logger.log('error', 'Required: --name, --host, --platform');
|
||||
logger.log('info', 'Usage: tsdocker config add-builder --name=arm64-builder --host=user@host --platform=linux/arm64 [--ssh-key=~/.ssh/id_ed25519]');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
GlobalConfig.addBuilder({ name, host, platform, sshKeyPath });
|
||||
logger.log('success', `Remote builder "${name}" configured: ${platform} via ssh://${host}`);
|
||||
break;
|
||||
}
|
||||
|
||||
case 'remove-builder': {
|
||||
const name = argvArg.name as string;
|
||||
if (!name) {
|
||||
logger.log('error', 'Required: --name');
|
||||
logger.log('info', 'Usage: tsdocker config remove-builder --name=arm64-builder');
|
||||
process.exit(1);
|
||||
}
|
||||
GlobalConfig.removeBuilder(name);
|
||||
logger.log('success', `Remote builder "${name}" removed`);
|
||||
break;
|
||||
}
|
||||
|
||||
case 'list-builders': {
|
||||
const builders = GlobalConfig.getBuilders();
|
||||
if (builders.length === 0) {
|
||||
logger.log('info', 'No remote builders configured');
|
||||
} else {
|
||||
logger.log('info', `${builders.length} remote builder(s):`);
|
||||
for (const b of builders) {
|
||||
const keyInfo = b.sshKeyPath ? ` (key: ${b.sshKeyPath})` : '';
|
||||
logger.log('info', ` ${b.name}: ${b.platform} via ssh://${b.host}${keyInfo}`);
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'show': {
|
||||
const config = GlobalConfig.load();
|
||||
logger.log('info', `Config file: ${GlobalConfig.getConfigPath()}`);
|
||||
console.log(JSON.stringify(config, null, 2));
|
||||
break;
|
||||
}
|
||||
|
||||
default:
|
||||
logger.log('error', `Unknown config subcommand: ${subcommand || '(none)'}`);
|
||||
logger.log('info', 'Available: add-builder, remove-builder, list-builders, show');
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
} catch (err) {
|
||||
logger.log('error', `Config failed: ${(err as Error).message}`);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
tsdockerCli.addCommand('clean').subscribe(async argvArg => {
|
||||
@@ -443,19 +570,5 @@ export let run = () => {
|
||||
}
|
||||
});
|
||||
|
||||
tsdockerCli.addCommand('vscode').subscribe(async argvArg => {
|
||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash'
|
||||
});
|
||||
logger.log('ok', `Starting vscode in cwd ${paths.cwd}`);
|
||||
await smartshellInstance.execAndWaitForLine(
|
||||
`docker run -p 127.0.0.1:8443:8443 -v "${
|
||||
paths.cwd
|
||||
}:/home/coder/project" registry.gitlab.com/hosttoday/ht-docker-vscode --allow-http --no-auth`,
|
||||
/Connected to shared process/
|
||||
);
|
||||
await plugins.smartopen.openUrl('testing-vscode.git.zone:8443');
|
||||
});
|
||||
|
||||
tsdockerCli.startParse();
|
||||
};
|
||||
|
||||
@@ -1,34 +1,10 @@
|
||||
import * as plugins from './tsdocker.plugins.js';
|
||||
import * as paths from './tsdocker.paths.js';
|
||||
import * as fs from 'fs';
|
||||
import type { ITsDockerConfig } from './interfaces/index.js';
|
||||
|
||||
// Re-export ITsDockerConfig as IConfig for backward compatibility
|
||||
export type IConfig = ITsDockerConfig & {
|
||||
exitCode?: number;
|
||||
};
|
||||
|
||||
const getQenvKeyValueObject = async () => {
|
||||
let qenvKeyValueObjectArray: { [key: string]: string | number };
|
||||
if (fs.existsSync(plugins.path.join(paths.cwd, 'qenv.yml'))) {
|
||||
qenvKeyValueObjectArray = new plugins.qenv.Qenv(paths.cwd, '.nogit/').keyValueObject;
|
||||
} else {
|
||||
qenvKeyValueObjectArray = {};
|
||||
}
|
||||
return qenvKeyValueObjectArray;
|
||||
};
|
||||
|
||||
const buildConfig = async (qenvKeyValueObjectArg: { [key: string]: string | number }) => {
|
||||
const npmextra = new plugins.npmextra.Npmextra(paths.cwd);
|
||||
const config = npmextra.dataFor<IConfig>('@git.zone/tsdocker', {
|
||||
// Legacy options (backward compatible)
|
||||
baseImage: 'hosttoday/ht-docker-node:npmdocker',
|
||||
init: 'rm -rf node_nodules/ && yarn install',
|
||||
command: 'npmci npm test',
|
||||
dockerSock: false,
|
||||
keyValueObject: qenvKeyValueObjectArg,
|
||||
|
||||
// New Docker build options
|
||||
const buildConfig = async (): Promise<ITsDockerConfig> => {
|
||||
const npmextra = new plugins.npmextra.Smartconfig(paths.cwd);
|
||||
const config = npmextra.dataFor<ITsDockerConfig>('@git.zone/tsdocker', {
|
||||
registries: [],
|
||||
registryRepoMap: {},
|
||||
buildArgEnvMap: {},
|
||||
@@ -39,7 +15,6 @@ const buildConfig = async (qenvKeyValueObjectArg: { [key: string]: string | numb
|
||||
return config;
|
||||
};
|
||||
|
||||
export let run = async (): Promise<IConfig> => {
|
||||
const config = await getQenvKeyValueObject().then(buildConfig);
|
||||
return config;
|
||||
export let run = async (): Promise<ITsDockerConfig> => {
|
||||
return buildConfig();
|
||||
};
|
||||
|
||||
@@ -1,169 +0,0 @@
|
||||
import * as plugins from './tsdocker.plugins.js';
|
||||
import * as paths from './tsdocker.paths.js';
|
||||
import * as snippets from './tsdocker.snippets.js';
|
||||
|
||||
import { logger, ora } from './tsdocker.logging.js';
|
||||
|
||||
const smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash'
|
||||
});
|
||||
|
||||
// interfaces
|
||||
import type { IConfig } from './tsdocker.config.js';
|
||||
|
||||
let config: IConfig;
|
||||
|
||||
/**
|
||||
* the docker data used to build the internal testing container
|
||||
*/
|
||||
const dockerData = {
|
||||
imageTag: 'npmdocker-temp-image:latest',
|
||||
containerName: 'npmdocker-temp-container',
|
||||
dockerProjectMountString: '',
|
||||
dockerSockString: '',
|
||||
dockerEnvString: ''
|
||||
};
|
||||
|
||||
/**
|
||||
* check if docker is available
|
||||
*/
|
||||
const checkDocker = () => {
|
||||
const done = plugins.smartpromise.defer();
|
||||
ora.text('checking docker...');
|
||||
|
||||
if (smartshellInstance.exec('which docker')) {
|
||||
logger.log('ok', 'Docker found!');
|
||||
done.resolve();
|
||||
} else {
|
||||
done.reject(new Error('docker not found on this machine'));
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* builds the Dockerfile according to the config in the project
|
||||
*/
|
||||
const buildDockerFile = async () => {
|
||||
const done = plugins.smartpromise.defer();
|
||||
ora.text('building Dockerfile...');
|
||||
const dockerfile: string = snippets.dockerfileSnippet({
|
||||
baseImage: config.baseImage,
|
||||
command: config.command
|
||||
});
|
||||
logger.log('info', `Base image is: ${config.baseImage}`);
|
||||
logger.log('info', `Command is: ${config.command}`);
|
||||
await plugins.smartfs.file(plugins.path.join(paths.cwd, 'npmdocker')).write(dockerfile);
|
||||
logger.log('ok', 'Dockerfile created!');
|
||||
ora.stop();
|
||||
done.resolve();
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* builds the Dockerimage from the built Dockerfile
|
||||
*/
|
||||
const buildDockerImage = async () => {
|
||||
logger.log('info', 'pulling latest base image from registry...');
|
||||
await smartshellInstance.exec(`docker pull ${config.baseImage}`);
|
||||
ora.text('building Dockerimage...');
|
||||
const execResult = await smartshellInstance.execSilent(
|
||||
`docker build --load -f npmdocker -t ${dockerData.imageTag} ${paths.cwd}`
|
||||
);
|
||||
if (execResult.exitCode !== 0) {
|
||||
console.log(execResult.stdout);
|
||||
process.exit(1);
|
||||
}
|
||||
logger.log('ok', 'Dockerimage built!');
|
||||
};
|
||||
|
||||
const buildDockerProjectMountString = async () => {
|
||||
if (process.env.CI !== 'true') {
|
||||
dockerData.dockerProjectMountString = `-v ${paths.cwd}:/workspace`;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* builds an environment string that docker cli understands
|
||||
*/
|
||||
const buildDockerEnvString = async () => {
|
||||
for (const key of Object.keys(config.keyValueObject)) {
|
||||
const envString = (dockerData.dockerEnvString =
|
||||
dockerData.dockerEnvString + `-e ${key}=${config.keyValueObject[key]} `);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* creates string to mount the docker.sock inside the testcontainer
|
||||
*/
|
||||
const buildDockerSockString = async () => {
|
||||
if (config.dockerSock) {
|
||||
dockerData.dockerSockString = `-v /var/run/docker.sock:/var/run/docker.sock`;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* creates a container by running the built Dockerimage
|
||||
*/
|
||||
const runDockerImage = async () => {
|
||||
const done = plugins.smartpromise.defer();
|
||||
ora.text('starting Container...');
|
||||
ora.stop();
|
||||
logger.log('info', 'now running Dockerimage');
|
||||
config.exitCode = (await smartshellInstance.exec(
|
||||
`docker run ${dockerData.dockerProjectMountString} ${dockerData.dockerSockString} ${
|
||||
dockerData.dockerEnvString
|
||||
} --name ${dockerData.containerName} ${dockerData.imageTag}`
|
||||
)).exitCode;
|
||||
};
|
||||
|
||||
/**
|
||||
* cleans up: deletes the test container
|
||||
*/
|
||||
const deleteDockerContainer = async () => {
|
||||
await smartshellInstance.execSilent(`docker rm -f ${dockerData.containerName}`);
|
||||
};
|
||||
|
||||
/**
|
||||
* cleans up deletes the test image
|
||||
*/
|
||||
const deleteDockerImage = async () => {
|
||||
await smartshellInstance.execSilent(`docker rmi ${dockerData.imageTag}`).then(async response => {
|
||||
if (response.exitCode !== 0) {
|
||||
console.log(response.stdout);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const preClean = async () => {
|
||||
await deleteDockerImage()
|
||||
.then(deleteDockerContainer)
|
||||
.then(async () => {
|
||||
logger.log('ok', 'ensured clean Docker environment!');
|
||||
});
|
||||
};
|
||||
|
||||
const postClean = async () => {
|
||||
await deleteDockerContainer()
|
||||
.then(deleteDockerImage)
|
||||
.then(async () => {
|
||||
logger.log('ok', 'cleaned up!');
|
||||
});
|
||||
await plugins.smartfs.file(paths.npmdockerFile).delete();
|
||||
};
|
||||
|
||||
export let run = async (configArg: IConfig): Promise<IConfig> => {
|
||||
config = configArg;
|
||||
const resultConfig = await checkDocker()
|
||||
.then(preClean)
|
||||
.then(buildDockerFile)
|
||||
.then(buildDockerImage)
|
||||
.then(buildDockerProjectMountString)
|
||||
.then(buildDockerEnvString)
|
||||
.then(buildDockerSockString)
|
||||
.then(runDockerImage)
|
||||
.then(postClean)
|
||||
.catch(err => {
|
||||
console.log(err);
|
||||
});
|
||||
return config;
|
||||
};
|
||||
@@ -11,4 +11,3 @@ export let cwd = process.cwd();
|
||||
export let packageBase = plugins.path.join(__dirname, '../');
|
||||
export let assets = plugins.path.join(packageBase, 'assets/');
|
||||
fs.mkdirSync(assets, { recursive: true });
|
||||
export let npmdockerFile = plugins.path.join(cwd, 'npmdocker');
|
||||
|
||||
@@ -1,19 +1,15 @@
|
||||
// push.rocks scope
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as npmextra from '@push.rocks/npmextra';
|
||||
import * as npmextra from '@push.rocks/smartconfig';
|
||||
import * as path from 'path';
|
||||
import * as projectinfo from '@push.rocks/projectinfo';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as qenv from '@push.rocks/qenv';
|
||||
import * as smartcli from '@push.rocks/smartcli';
|
||||
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
||||
import * as smartlogSouceOra from '@push.rocks/smartlog-source-ora';
|
||||
import * as smartopen from '@push.rocks/smartopen';
|
||||
import * as smartinteract from '@push.rocks/smartinteract';
|
||||
import * as smartshell from '@push.rocks/smartshell';
|
||||
import * as smartstring from '@push.rocks/smartstring';
|
||||
|
||||
// Create smartfs instance
|
||||
export const smartfs = new SmartFs(new SmartFsProviderNode());
|
||||
@@ -23,14 +19,10 @@ export {
|
||||
npmextra,
|
||||
path,
|
||||
projectinfo,
|
||||
smartpromise,
|
||||
qenv,
|
||||
smartcli,
|
||||
smartinteract,
|
||||
smartlog,
|
||||
smartlogDestinationLocal,
|
||||
smartlogSouceOra,
|
||||
smartopen,
|
||||
smartshell,
|
||||
smartstring
|
||||
};
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
import * as plugins from './tsdocker.plugins.js';
|
||||
|
||||
export interface IDockerfileSnippet {
|
||||
baseImage: string;
|
||||
command: string;
|
||||
}
|
||||
|
||||
let getMountSolutionString = (optionsArg: IDockerfileSnippet) => {
|
||||
if (process.env.CI) {
|
||||
return 'COPY ./ /workspace';
|
||||
} else {
|
||||
return '# not copying workspcae since not in CI';
|
||||
}
|
||||
};
|
||||
|
||||
let getGlobalPreparationString = (optionsArg: IDockerfileSnippet) => {
|
||||
// Always install tsdocker to ensure the latest version is available
|
||||
return 'RUN npm install -g @git.zone/tsdocker';
|
||||
};
|
||||
|
||||
export let dockerfileSnippet = (optionsArg: IDockerfileSnippet): string => {
|
||||
return plugins.smartstring.indent.normalize(
|
||||
`
|
||||
FROM ${optionsArg.baseImage}
|
||||
# For info about what tsdocker does read the docs at https://gitzone.github.io/tsdocker
|
||||
${getGlobalPreparationString(optionsArg)}
|
||||
${getMountSolutionString(optionsArg)}
|
||||
WORKDIR /workspace
|
||||
ENV CI=true
|
||||
ENTRYPOINT ["tsdocker"]
|
||||
CMD ["runinside"]
|
||||
`
|
||||
);
|
||||
};
|
||||
Reference in New Issue
Block a user