docker: configFile method
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
@@ -15,17 +15,30 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import {afterEach, beforeEach, describe, expect, it, jest} from '@jest/globals';
|
import {afterEach, beforeEach, describe, expect, it, jest} from '@jest/globals';
|
||||||
|
import * as fs from 'fs';
|
||||||
import path from 'path';
|
import path from 'path';
|
||||||
import * as io from '@actions/io';
|
import * as io from '@actions/io';
|
||||||
import osm = require('os');
|
import osm = require('os');
|
||||||
|
import * as rimraf from 'rimraf';
|
||||||
|
|
||||||
import {Docker} from '../../src/docker/docker';
|
import {Docker} from '../../src/docker/docker';
|
||||||
import {Exec} from '../../src/exec';
|
import {Exec} from '../../src/exec';
|
||||||
|
|
||||||
|
import {ConfigFile} from '../../src/types/docker';
|
||||||
|
|
||||||
|
const fixturesDir = path.join(__dirname, '..', 'fixtures');
|
||||||
|
|
||||||
|
// prettier-ignore
|
||||||
|
const tmpDir = path.join(process.env.TEMP || '/tmp', 'docker-jest');
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
jest.clearAllMocks();
|
jest.clearAllMocks();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
afterEach(function () {
|
||||||
|
rimraf.sync(tmpDir);
|
||||||
|
});
|
||||||
|
|
||||||
describe('configDir', () => {
|
describe('configDir', () => {
|
||||||
const originalEnv = process.env;
|
const originalEnv = process.env;
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
@@ -48,6 +61,45 @@ describe('configDir', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('configFile', () => {
|
||||||
|
const originalEnv = process.env;
|
||||||
|
beforeEach(() => {
|
||||||
|
jest.resetModules();
|
||||||
|
if (!fs.existsSync(tmpDir)) {
|
||||||
|
fs.mkdirSync(tmpDir, {recursive: true});
|
||||||
|
}
|
||||||
|
process.env = {
|
||||||
|
...originalEnv,
|
||||||
|
DOCKER_CONFIG: tmpDir
|
||||||
|
};
|
||||||
|
});
|
||||||
|
afterEach(() => {
|
||||||
|
process.env = originalEnv;
|
||||||
|
});
|
||||||
|
it('auths', async () => {
|
||||||
|
fs.copyFileSync(path.join(fixturesDir, 'docker-config-auths.json'), path.join(tmpDir, 'config.json'));
|
||||||
|
expect(Docker.configFile()).toEqual({
|
||||||
|
auths: {
|
||||||
|
'https://index.docker.io/v1/': {
|
||||||
|
auth: 'am9lam9lOmhlbGxv',
|
||||||
|
email: 'user@example.com'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} as unknown as ConfigFile);
|
||||||
|
});
|
||||||
|
it('proxies', async () => {
|
||||||
|
fs.copyFileSync(path.join(fixturesDir, 'docker-config-proxies.json'), path.join(tmpDir, 'config.json'));
|
||||||
|
expect(Docker.configFile()).toEqual({
|
||||||
|
proxies: {
|
||||||
|
default: {
|
||||||
|
httpProxy: 'http://127.0.0.1:3128',
|
||||||
|
httpsProxy: 'http://127.0.0.1:3128'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} as unknown as ConfigFile);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe('isAvailable', () => {
|
describe('isAvailable', () => {
|
||||||
it('cli', async () => {
|
it('cli', async () => {
|
||||||
const ioWhichSpy = jest.spyOn(io, 'which');
|
const ioWhichSpy = jest.spyOn(io, 'which');
|
||||||
|
|||||||
8
__tests__/fixtures/docker-config-auths.json
Normal file
8
__tests__/fixtures/docker-config-auths.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"auths": {
|
||||||
|
"https://index.docker.io/v1/": {
|
||||||
|
"auth": "am9lam9lOmhlbGxv",
|
||||||
|
"email": "user@example.com"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
8
__tests__/fixtures/docker-config-proxies.json
Normal file
8
__tests__/fixtures/docker-config-proxies.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"proxies": {
|
||||||
|
"default": {
|
||||||
|
"httpProxy": "http://127.0.0.1:3128",
|
||||||
|
"httpsProxy": "http://127.0.0.1:3128"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -14,17 +14,29 @@
|
|||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
import fs from 'fs';
|
||||||
import os from 'os';
|
import os from 'os';
|
||||||
import path from 'path';
|
import path from 'path';
|
||||||
import * as core from '@actions/core';
|
import * as core from '@actions/core';
|
||||||
import * as io from '@actions/io';
|
import * as io from '@actions/io';
|
||||||
|
|
||||||
import {Exec} from '../exec';
|
import {Exec} from '../exec';
|
||||||
|
|
||||||
|
import {ConfigFile} from '../types/docker';
|
||||||
|
|
||||||
export class Docker {
|
export class Docker {
|
||||||
static get configDir(): string {
|
static get configDir(): string {
|
||||||
return process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
|
return process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static configFile(): ConfigFile | undefined {
|
||||||
|
const f = path.join(Docker.configDir, 'config.json');
|
||||||
|
if (!fs.existsSync(f)) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return <ConfigFile>JSON.parse(fs.readFileSync(f, {encoding: 'utf-8'}));
|
||||||
|
}
|
||||||
|
|
||||||
public static async isAvailable(): Promise<boolean> {
|
public static async isAvailable(): Promise<boolean> {
|
||||||
return await io
|
return await io
|
||||||
.which('docker', true)
|
.which('docker', true)
|
||||||
|
|||||||
66
src/types/docker.ts
Normal file
66
src/types/docker.ts
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
/**
|
||||||
|
* Copyright 2023 actions-toolkit authors
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// https://github.com/docker/cli/blob/master/cli/config/configfile/file.go
|
||||||
|
export interface ConfigFile {
|
||||||
|
auths: Record<string, AuthConfig>;
|
||||||
|
HttpHeaders?: Record<string, string>;
|
||||||
|
psFormat?: string;
|
||||||
|
imagesFormat?: string;
|
||||||
|
networksFormat?: string;
|
||||||
|
pluginsFormat?: string;
|
||||||
|
volumesFormat?: string;
|
||||||
|
statsFormat?: string;
|
||||||
|
detachKeys?: string;
|
||||||
|
credsStore?: string;
|
||||||
|
credHelpers?: Record<string, string>;
|
||||||
|
serviceInspectFormat?: string;
|
||||||
|
servicesFormat?: string;
|
||||||
|
tasksFormat?: string;
|
||||||
|
secretFormat?: string;
|
||||||
|
configFormat?: string;
|
||||||
|
nodesFormat?: string;
|
||||||
|
pruneFilters?: string[];
|
||||||
|
proxies?: Record<string, ProxyConfig>;
|
||||||
|
experimental?: string;
|
||||||
|
stackOrchestrator?: string;
|
||||||
|
kubernetes?: KubernetesConfig;
|
||||||
|
currentContext?: string;
|
||||||
|
cliPluginsExtraDirs?: string[];
|
||||||
|
plugins?: Record<string, Record<string, string>>;
|
||||||
|
aliases?: Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProxyConfig {
|
||||||
|
httpProxy?: string;
|
||||||
|
httpsProxy?: string;
|
||||||
|
noProxy?: string;
|
||||||
|
ftpProxy?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface KubernetesConfig {
|
||||||
|
allNamespaces?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AuthConfig {
|
||||||
|
username?: string;
|
||||||
|
password?: string;
|
||||||
|
auth?: string;
|
||||||
|
email?: string;
|
||||||
|
serveraddress?: string;
|
||||||
|
identitytoken?: string;
|
||||||
|
registrytoken?: string;
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user