Compare commits

..

30 Commits

Author SHA1 Message Date
d9112d3e04 1.0.111 2024-05-08 19:58:09 +02:00
455404c3c9 fix(core): update 2024-05-08 19:58:09 +02:00
90089625dc 1.0.110 2024-04-23 20:10:37 +02:00
86d5cc1d47 fix(core): update 2024-04-23 20:10:36 +02:00
6407033694 1.0.109 2024-04-23 19:58:05 +02:00
9dd69868d9 fix(core): update 2024-04-23 19:58:04 +02:00
dc4074340d 1.0.108 2024-02-02 16:55:52 +01:00
001e870643 fix(core): update 2024-02-02 16:55:51 +01:00
440eb07afb 1.0.107 2024-02-02 16:54:08 +01:00
8d74712a97 fix(core): update 2024-02-02 16:54:07 +01:00
bbdf61e0a9 1.0.106 2024-02-02 16:40:39 +01:00
6f5ed697cb fix(core): update 2024-02-02 16:40:38 +01:00
cc93c296c6 1.0.105 2022-10-17 11:00:42 +02:00
07a4d024a8 fix(core): update 2022-10-17 11:00:42 +02:00
192216c7ec 1.0.104 2022-10-17 09:36:36 +02:00
daa97c68d9 fix(core): update 2022-10-17 09:36:35 +02:00
4569bffc37 1.0.103 2020-10-05 15:08:38 +00:00
ad4e6ad206 fix(core): update 2020-10-05 15:08:38 +00:00
ddfa701391 1.0.102 2020-10-01 14:59:38 +00:00
3d2d1e3b1d fix(core): update 2020-10-01 14:59:37 +00:00
01e79b8cd6 1.0.101 2020-09-30 17:06:27 +00:00
8b6021ff66 fix(core): update 2020-09-30 17:06:26 +00:00
5e5bb3032c 1.0.100 2020-09-30 17:01:55 +00:00
855e18a74f fix(core): update 2020-09-30 17:01:55 +00:00
b808a93e46 1.0.99 2020-09-30 17:01:30 +00:00
a18166260e fix(core): update 2020-09-30 17:01:30 +00:00
cba8de348d 1.0.98 2020-09-30 16:56:40 +00:00
30d4a7bd24 fix(core): update 2020-09-30 16:56:39 +00:00
4ea99426fd 1.0.97 2020-09-30 16:51:04 +00:00
19309f7f45 fix(core): update 2020-09-30 16:51:03 +00:00
29 changed files with 5319 additions and 11410 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,137 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

9
.snyk
View File

@ -1,9 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-HTTPSPROXYAGENT-469131:
- '@pushrocks/smartnetwork > speedtest-net > https-proxy-agent':
reason: None given
expires: '2019-11-04T13:59:28.695Z'
patch: {}

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
"type": "node-terminal"
}
]
}

View File

@ -15,9 +15,23 @@
"githost": "gitlab.com",
"gitscope": "mojoio",
"gitrepo": "docker",
"shortDescription": "unofficial docker engine api abstraction package written in TypeScript",
"description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
"npmPackagename": "@mojoio/docker",
"license": "MIT"
}
"license": "MIT",
"keywords": [
"Docker",
"API",
"Node.js",
"TypeScript",
"Containers",
"Images",
"Networks",
"Services",
"Secrets"
]
}
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

11087
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,53 +1,57 @@
{
"name": "@mojoio/docker",
"version": "1.0.96",
"description": "easy communication with docker remote api from node, TypeScript ready",
"name": "@apiclient.xyz/docker",
"version": "1.0.111",
"description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
"private": false,
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web)"
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "git+ssh://git@gitlab.com/pushrocks/dockersock.git"
"url": "git+https://gitlab.com/mojoio/docker.git"
},
"keywords": [
"docker",
"sock",
"container",
"request",
"api"
"Docker",
"API",
"Node.js",
"TypeScript",
"Containers",
"Images",
"Networks",
"Services",
"Secrets"
],
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://gitlab.com/pushrocks/dockersock/issues"
"url": "https://gitlab.com/mojoio/docker/issues"
},
"homepage": "https://gitlab.com/pushrocks/dockersock#README",
"homepage": "https://gitlab.com/mojoio/docker#readme",
"dependencies": {
"@pushrocks/lik": "^4.0.17",
"@pushrocks/smartfile": "^8.0.0",
"@pushrocks/smartjson": "^3.0.10",
"@pushrocks/smartlog": "^2.0.39",
"@pushrocks/smartnetwork": "^1.1.22",
"@pushrocks/smartpath": "^4.0.3",
"@pushrocks/smartpromise": "^3.0.6",
"@pushrocks/smartrequest": "^1.1.51",
"@pushrocks/smartstring": "^3.0.18",
"@pushrocks/smartversion": "^2.0.4",
"@tsclass/tsclass": "^3.0.25",
"rxjs": "^6.6.3"
"@push.rocks/lik": "^6.0.15",
"@push.rocks/smartfile": "^11.0.14",
"@push.rocks/smartjson": "^5.0.19",
"@push.rocks/smartlog": "^3.0.1",
"@push.rocks/smartnetwork": "^3.0.0",
"@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrequest": "^2.0.22",
"@push.rocks/smartstring": "^4.0.15",
"@push.rocks/smartversion": "^3.0.5",
"@tsclass/tsclass": "^4.0.54",
"rxjs": "^7.5.7"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsrun": "^1.2.12",
"@gitzone/tstest": "^1.0.48",
"@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^14.11.2",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
"@git.zone/tsbuild": "^2.1.25",
"@git.zone/tsrun": "^1.2.12",
"@git.zone/tstest": "^1.0.90",
"@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^20.12.11"
},
"files": [
"ts/**/*",

4836
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

0
readme.hints.md Normal file
View File

173
readme.md
View File

@ -1,49 +1,152 @@
# @mojoio/docker
unofficial docker engine api abstraction package written in TypeScript
# @apiclient.xyz/docker
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
* [github.com (source mirror)](https://github.com/mojoio/docker)
* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
easy communication with docker remote api from node, TypeScript ready
## Status for master
## Install
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/docker/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/docker)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/docker)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/docker)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/docker)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/docker)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
To install @apiclient.xyz/docker, you can use npm (npm package manager). Run the following command in your terminal:
```bash
npm install @apiclient.xyz/docker --save
```
This command installs the package and adds it as a dependency to your project's `package.json` file.
## Usage
Use TypeScript for best in class instellisense.
The `@apiclient.xyz/docker` package provides a TypeScript-ready interface for interacting with Docker's Remote API directly from Node.js applications. It leverages TypeScript for strong type definitions, ensuring more reliable and maintainable code.
### Prerequisites
Before you begin, ensure:
- You have Docker installed and running on your machine or a remote server.
- You are familiar with TypeScript and have it set up in your development environment.
### Getting Started
First, import the required classes from the package:
```typescript
import { DockerHost } from '@mojoio/docker'; // require Dockersock class
const run = async () => {
const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to /var/run/docker.sock
const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
};
import { DockerHost, DockerContainer, DockerService, DockerNetwork } from '@apiclient.xyz/docker';
```
## Contribution
### Instantiate DockerHost
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
Start by creating a `DockerHost` instance. This class is the entry point to communicate with the Docker Remote API.
For further information read the linked docs at the top of this readme.
```typescript
// Connect to local Docker instance
const localDockerHost = new DockerHost();
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
// Or specify a custom path or URL to a Docker host
const remoteDockerHost = new DockerHost('tcp://<REMOTE_DOCKER_HOST>:2375');
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
### Working with Containers
#### List All Containers
```typescript
async function listAllContainers() {
const containers = await localDockerHost.getContainers();
console.log(containers);
}
listAllContainers();
```
#### Create and Remove a Container
```typescript
import { IContainerCreationDescriptor } from '@apiclient.xyz/docker';
async function createAndRemoveContainer() {
const containerDescriptor: IContainerCreationDescriptor = {
Hostname: 'test-container',
Domainname: '',
// Additional settings here
};
// Create container
const container = await DockerContainer.create(localDockerHost, containerDescriptor);
console.log(`Container Created: ${container.Id}`);
// Remove container
await container.remove();
console.log(`Container Removed: ${container.Id}`);
}
createAndRemoveContainer();
```
### Working with Docker Services
#### Create a Docker Service
```typescript
import { IServiceCreationDescriptor } from '@apiclient.xyz/docker';
async function createDockerService() {
const serviceDescriptor: IServiceCreationDescriptor = {
name: 'my-service',
image: 'nginx:latest', // Docker Image
// Additional settings
};
const service = await DockerService.createService(localDockerHost, serviceDescriptor);
console.log(`Service Created: ${service.Id}`);
}
createDockerService();
```
### Working with Docker Networks
#### Listing and Creating Networks
```typescript
async function listAndCreateNetwork() {
// List all networks
const networks = await localDockerHost.getNetworks();
console.log(networks);
// Create a new network
const network = await DockerNetwork.createNetwork(localDockerHost, {
Name: 'my-network'
// Additional settings
});
console.log(`Network Created: ${network.Id}`);
}
listAndCreateNetwork();
```
### Advanced Usage
You can leverage the full potential of the Docker Remote API with `@apiclient.xyz/docker`. This includes managing images, volumes, swarms, and more. The package's design is consistent and intuitive, making it easy to extend your usage as needed.
Remember, the Docker Remote API offers extensive capabilities. Always refer to the [Docker API documentation](https://docs.docker.com/engine/api/latest/) for a comprehensive list of endpoints and actions you can perform.
### Conclusion
`@apiclient.xyz/docker` simplifies interaction with Docker's Remote API in TypeScript projects, providing strong typing and asynchronous operations. Whether you're managing containers, images, services or networks, it offers a comprehensive toolset to perform these tasks seamlessly.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,5 +1,5 @@
import * as docker from '../ts';
import * as smartstring from '@pushrocks/smartstring';
import * as smartstring from '@push.rocks/smartstring';
const run = async () => {
const dockerHost = new docker.DockerHost();

View File

@ -1,11 +1,11 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as docker from '../ts/index';
import { expect, tap } from '@push.rocks/tapbundle';
import * as docker from '../ts/index.js';
let testDockerHost: docker.DockerHost;
tap.test('should create a new Dockersock instance', async () => {
testDockerHost = new docker.DockerHost('http://unix:/var/run/docker.sock:');
return expect(testDockerHost).to.be.instanceof(docker.DockerHost);
testDockerHost = new docker.DockerHost();
return expect(testDockerHost).toBeInstanceOf(docker.DockerHost);
});
tap.test('should create a docker swarm', async () => {
@ -28,8 +28,8 @@ tap.test('should create a network', async () => {
const newNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
Name: 'webgateway',
});
expect(newNetwork).to.be.instanceOf(docker.DockerNetwork);
expect(newNetwork.Name).to.equal('webgateway');
expect(newNetwork).toBeInstanceOf(docker.DockerNetwork);
expect(newNetwork.Name).toEqual('webgateway');
});
tap.test('should remove a network', async () => {
@ -43,7 +43,7 @@ tap.test('should pull an image from imagetag', async () => {
imageUrl: 'hosttoday/ht-docker-node',
imageTag: 'alpine',
});
expect(image).to.be.instanceOf(docker.DockerImage);
expect(image).toBeInstanceOf(docker.DockerImage);
console.log(image);
});

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@apiclient.xyz/docker',
version: '1.0.111',
description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.'
}

View File

@ -1,8 +1,8 @@
import * as plugins from './docker.plugins';
import * as interfaces from './interfaces';
import * as plugins from './docker.plugins.js';
import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host';
import { logger } from './docker.logging';
import { DockerHost } from './docker.classes.host.js';
import { logger } from './docker.logging.js';
export class DockerContainer {
// STATIC

View File

@ -1,8 +1,9 @@
import * as plugins from './docker.plugins';
import { DockerContainer } from './docker.classes.container';
import { DockerNetwork } from './docker.classes.network';
import { DockerService } from './docker.classes.service';
import { logger } from './docker.logging';
import * as plugins from './docker.plugins.js';
import { DockerContainer } from './docker.classes.container.js';
import { DockerNetwork } from './docker.classes.network.js';
import { DockerService } from './docker.classes.service.js';
import { logger } from './docker.logging.js';
import path from 'path';
export interface IAuthData {
serveraddress: string;
@ -25,11 +26,20 @@ export class DockerHost {
let pathToUse: string;
if (pathArg) {
pathToUse = pathArg;
} else if (process.env.DOCKER_HOST) {
pathToUse = process.env.DOCKER_HOST;
} else if (process.env.CI) {
pathToUse = 'http://docker:2375/';
} else {
pathToUse = 'http://unix:/var/run/docker.sock:';
}
if (pathToUse.startsWith('unix:///')) {
pathToUse = pathToUse.replace('unix://', 'http://unix:');
}
if (pathToUse.endsWith('.sock')) {
pathToUse = pathToUse.replace('.sock', '.sock:');
}
console.log(`using docker sock at ${pathToUse}`);
this.socketPath = pathToUse;
}
@ -45,18 +55,16 @@ export class DockerHost {
throw new Error(response.body.Status);
}
console.log(response.body.Status);
this.registryToken = plugins.smartstring.base64.encode(
plugins.smartjson.Smartjson.stringify(authData, {})
);
this.registryToken = plugins.smartstring.base64.encode(plugins.smartjson.stringify(authData));
}
/**
* gets the token from the .docker/config.json file for GitLab registry
*/
public async getGitlabComTokenFromDockerConfig() {
public async getAuthTokenFromDockerConfig(registryUrlArg: string) {
const dockerConfigPath = plugins.smartpath.get.home('~/.docker/config.json');
const configObject = plugins.smartfile.fs.toObjectSync(dockerConfigPath);
const gitlabAuthBase64 = configObject.auths['registry.gitlab.com'].auth;
const gitlabAuthBase64 = configObject.auths[registryUrlArg].auth;
const gitlabAuth: string = plugins.smartstring.base64.decode(gitlabAuthBase64);
const gitlabAuthArray = gitlabAuth.split(':');
await this.auth({

View File

@ -1,7 +1,7 @@
import * as plugins from './docker.plugins';
import * as interfaces from './interfaces';
import { DockerHost } from './docker.classes.host';
import { logger } from './docker.logging';
import * as plugins from './docker.plugins.js';
import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host.js';
import { logger } from './docker.logging.js';
export class DockerImage {
// STATIC

View File

@ -1,9 +1,9 @@
import * as plugins from './docker.plugins';
import * as interfaces from './interfaces';
import * as plugins from './docker.plugins.js';
import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host';
import { DockerService } from './docker.classes.service';
import { logger } from './docker.logging';
import { DockerHost } from './docker.classes.host.js';
import { DockerService } from './docker.classes.service.js';
import { logger } from './docker.logging.js';
export class DockerNetwork {
public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {

View File

@ -1,8 +1,8 @@
import * as plugins from './docker.plugins';
import { DockerHost } from './docker.classes.host';
import * as plugins from './docker.plugins.js';
import { DockerHost } from './docker.classes.host.js';
// interfaces
import * as interfaces from './interfaces';
import * as interfaces from './interfaces/index.js';
export class DockerSecret {
// STATIC

View File

@ -1,10 +1,10 @@
import * as plugins from './docker.plugins';
import * as interfaces from './interfaces';
import * as plugins from './docker.plugins.js';
import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host';
import { DockerImage } from './docker.classes.image';
import { DockerSecret } from './docker.classes.secret';
import { logger } from './docker.logging';
import { DockerHost } from './docker.classes.host.js';
import { DockerImage } from './docker.classes.image.js';
import { DockerSecret } from './docker.classes.secret.js';
import { logger } from './docker.logging.js';
export class DockerService {
// STATIC

View File

@ -1,3 +1,3 @@
import * as plugins from './docker.plugins';
import * as plugins from './docker.plugins.js';
export const logger = new plugins.smartlog.ConsoleLog();

View File

@ -4,16 +4,16 @@ import * as path from 'path';
export { path };
// @pushrocks scope
import * as lik from '@pushrocks/lik';
import * as smartfile from '@pushrocks/smartfile';
import * as smartjson from '@pushrocks/smartjson';
import * as smartlog from '@pushrocks/smartlog';
import * as smartnetwork from '@pushrocks/smartnetwork';
import * as smartpath from '@pushrocks/smartpath';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartrequest from '@pushrocks/smartrequest';
import * as smartstring from '@pushrocks/smartstring';
import * as smartversion from '@pushrocks/smartversion';
import * as lik from '@push.rocks/lik';
import * as smartfile from '@push.rocks/smartfile';
import * as smartjson from '@push.rocks/smartjson';
import * as smartlog from '@push.rocks/smartlog';
import * as smartnetwork from '@push.rocks/smartnetwork';
import * as smartpath from '@push.rocks/smartpath';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrequest from '@push.rocks/smartrequest';
import * as smartstring from '@push.rocks/smartstring';
import * as smartversion from '@push.rocks/smartversion';
export {
lik,

View File

@ -1,6 +1,6 @@
export * from './docker.classes.host';
export * from './docker.classes.container';
export * from './docker.classes.image';
export * from './docker.classes.network';
export * from './docker.classes.secret';
export * from './docker.classes.service';
export * from './docker.classes.host.js';
export * from './docker.classes.container.js';
export * from './docker.classes.image.js';
export * from './docker.classes.network.js';
export * from './docker.classes.secret.js';
export * from './docker.classes.service.js';

View File

@ -1,4 +1,4 @@
import { DockerNetwork } from '../docker.classes.network';
import { DockerNetwork } from '../docker.classes.network.js';
export interface IContainerCreationDescriptor {
Hostname: string;

View File

@ -1,7 +1,7 @@
export * from './container';
export * from './image';
export * from './label';
export * from './network';
export * from './port';
export * from './secret';
export * from './service';
export * from './container.js';
export * from './image.js';
export * from './label.js';
export * from './network.js';
export * from './port.js';
export * from './secret.js';
export * from './service.js';

View File

@ -1,4 +1,4 @@
import * as interfaces from './';
import * as interfaces from './index.js';
export interface ISecretCreationDescriptor {
name: string;

View File

@ -1,9 +1,9 @@
import * as plugins from '../docker.plugins';
import * as plugins from '../docker.plugins.js';
import * as interfaces from './';
import { DockerNetwork } from '../docker.classes.network';
import { DockerSecret } from '../docker.classes.secret';
import { DockerImage } from '../docker.classes.image';
import * as interfaces from './index.js';
import { DockerNetwork } from '../docker.classes.network.js';
import { DockerSecret } from '../docker.classes.secret.js';
import { DockerImage } from '../docker.classes.image.js';
export interface IServiceCreationDescriptor {
name: string;

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}