Merge pull request #2 from solunio/feat/user_input_credentials_loader

feat: add option to load docker registry credentials from cli

Author: hellivan

package.json

@@ -32,6 +32,7 @@
         "cli-progress": "^3.9.0",
         "commander": "^8.1.0",
         "easy-table": "^1.1.1",
+        "inquirer": "^8.1.2",
         "js-yaml": "^4.1.0",
         "lodash": "^4.17.11",
         "semver": "^7.3.5",
@@ -40,6 +41,7 @@
     "devDependencies": {
         "@types/cli-progress": "^3.9.2",
         "@types/easy-table": "^0.0.33",
+        "@types/inquirer": "^7.3.3",
         "@types/js-yaml": "^4.0.3",
         "@types/lodash": "^4.14.172",
         "@types/node": "^12.20.21",

src/lib/credentials-loader-implementations/docker-config-credentials-loader.ts

@@ -0,0 +1,33 @@
+import { Credentials, CredentialsLoader } from '../credentials';
+
+export interface DockerConfigAuthInformation {
+    readonly auth: string;
+}
+
+export interface DockerConfig {
+    readonly auths: {
+        [key: string]: DockerConfigAuthInformation;
+    };
+}
+
+class DockerAuthCredentials implements Credentials {
+    constructor(private dockerAuth: DockerConfigAuthInformation) {}
+
+    public getToken(): string {
+        return this.dockerAuth.auth;
+    }
+}
+
+export class DockerConfigCredentialsLoader implements CredentialsLoader {
+    private readonly configCredentialsMap = new Map<string, DockerAuthCredentials>();
+
+    constructor(dockerConfig: DockerConfig) {
+        for (const host of Object.keys(dockerConfig.auths)) {
+            this.configCredentialsMap.set(host, new DockerAuthCredentials(dockerConfig.auths[host]));
+        }
+    }
+
+    public async loadCredentials(registryHost: string): Promise<Credentials | undefined> {
+        return this.configCredentialsMap.get(registryHost);
+    }
+}

src/lib/credentials-loader-implementations/index.ts

@@ -0,0 +1,2 @@
+export { DockerConfig, DockerConfigCredentialsLoader } from './docker-config-credentials-loader';
+export { UserInputCredentialsLoader } from './user-input-credentials-loader';

src/lib/credentials-loader-implementations/user-input-credentials-loader.ts

@@ -0,0 +1,42 @@
+import inquirer from 'inquirer';
+
+import { Credentials } from '../credentials';
+import { CredentialsLoader } from '../credentials/credentials-loader.interface';
+
+export class LoginCredentials implements Credentials {
+    constructor(private username: string, private password: string) {}
+
+    public getToken(): string {
+        return Buffer.from(`${this.username}:${this.password}`, 'utf8').toString('base64');
+    }
+}
+
+export interface PromptCallbacks {
+    onPromptStart(): void;
+    onPromptStop(): void;
+}
+
+export class UserInputCredentialsLoader implements CredentialsLoader {
+    constructor(private readonly progressInterruptor?: PromptCallbacks) {}
+
+    public async loadCredentials(registryHost: string): Promise<Credentials | undefined> {
+        this.progressInterruptor?.onPromptStart();
+
+        const response = await inquirer.prompt<{ username: string; password: string }>([
+            {
+                type: 'input',
+                name: 'username',
+                message: `Username for docker registry '${registryHost}':`
+            },
+            {
+                type: 'password',
+                name: 'password',
+                message: `Password:`
+            }
+        ]);
+
+        this.progressInterruptor?.onPromptStop();
+
+        return new LoginCredentials(response.username, response.password);
+    }
+}

src/lib/credentials/credentials-loader.interface.ts

@@ -0,0 +1,5 @@
+import { Credentials } from './credentials.interface';
+
+export interface CredentialsLoader {
+    loadCredentials(registryHost: string): Promise<Credentials | undefined>;
+}

src/lib/credentials/credentials-store.ts

@@ -0,0 +1,29 @@
+import { CredentialsLoader } from './credentials-loader.interface';
+import { Credentials } from './credentials.interface';
+
+export class CredentialsStore {
+    private store = new Map<string, Credentials>();
+
+    constructor(private readonly credentialsLoaders: CredentialsLoader[]) {}
+
+    public async getCredentials(registryHost: string | undefined): Promise<Credentials | undefined> {
+        if (!registryHost) return;
+
+        const credentials = this.store.get(registryHost);
+        if (credentials != null) return credentials;
+
+        for (const loader of this.credentialsLoaders) {
+            const loadedCredentials = await loader.loadCredentials(registryHost);
+            if (loadedCredentials != null) {
+                this.addCredentials(registryHost, loadedCredentials);
+                return loadedCredentials;
+            }
+        }
+
+        return undefined;
+    }
+
+    public addCredentials(registryHost: string, credentials: Credentials): void {
+        this.store.set(registryHost, credentials);
+    }
+}

src/lib/credentials/credentials.interface.ts

@@ -0,0 +1,3 @@
+export interface Credentials {
+    getToken(): string;
+}

src/lib/credentials/index.ts

@@ -0,0 +1,3 @@
+export { Credentials } from './credentials.interface';
+export { CredentialsLoader } from './credentials-loader.interface';
+export { CredentialsStore } from './credentials-store';

src/lib/docker-utils.ts

@@ -1,9 +1,8 @@
 import axios from 'axios';
 import { last as _last, merge as _merge } from 'lodash';
-import { resolve as resolvePath } from 'path';
 import { compare as semverCompare, maxSatisfying as semverMaxSatisfying, valid as semverValid } from 'semver';
 
-import { readFile } from './utils';
+import { Credentials, CredentialsStore } from './credentials';
 
 export const DOCKER_REGISTRY_HOST = 'docker.io';
 
@@ -13,10 +12,6 @@ export interface DockerImage {
     host?: string;
 }
 
-export interface Credentials {
-    getToken(): string;
-}
-
 interface TokenChellange {
     realm: string;
     service: string;
@@ -126,18 +121,17 @@ export function parseDockerImage(imageString: string): DockerImage {
 }
 
 export async function listTags(credentialsStore: CredentialsStore, dockerImage: DockerImage): Promise<string[]> {
-    const credentials = credentialsStore.getCredentials(dockerImage.host);
     const result = await requestNew<{ tags: string[] }>(
         `https://${dockerImage.host}/v2/${dockerImage.name}/tags/list`,
-        credentials
+        await credentialsStore.getCredentials(dockerImage.host)
     );
     return result.tags;
 }
 
 export async function listRepositories(registryHost: string, credentialsStore: CredentialsStore): Promise<string[]> {
     const result = await requestNew<{ repositories: string[] }>(
         `https://${registryHost}/v2/_catalog`,
-        credentialsStore.getCredentials(registryHost)
+        await credentialsStore.getCredentials(registryHost)
     );
     return result.repositories;
 }
@@ -172,35 +166,3 @@ export async function getImageUpdateTags(
 
     return { wanted, latest };
 }
-
-export async function readDockerConfig(dockerConfigPath: string): Promise<any> {
-    const data = await readFile(resolvePath(dockerConfigPath));
-    return JSON.parse(data);
-}
-
-class DockerAuthCredentials implements Credentials {
-    constructor(private dockerAuth: any) {}
-
-    public getToken(): string {
-        return this.dockerAuth.auth;
-    }
-}
-
-export class CredentialsStore {
-    private store = new Map<string, Credentials>();
-
-    constructor(dockerConfig: any) {
-        for (const host of Object.keys(dockerConfig.auths)) {
-            this.addCredentials(host, new DockerAuthCredentials(dockerConfig.auths[host]));
-        }
-    }
-
-    public getCredentials(registryHost: string | undefined): Credentials | undefined {
-        if (!registryHost) return;
-        return this.store.get(registryHost);
-    }
-
-    public addCredentials(registryHost: string, credentials: Credentials): void {
-        this.store.set(registryHost, credentials);
-    }
-}

src/lib/index.ts

@@ -2,26 +2,23 @@ import { Bar as CliProgressBar, Presets as CliProgressBarPresets } from 'cli-pro
 import EasyTable from 'easy-table';
 import { diff as semverDiff, valid as semverValid } from 'semver';
 
+import { CredentialsLoader, CredentialsStore } from './credentials';
+import {
+    DockerConfig,
+    DockerConfigCredentialsLoader,
+    UserInputCredentialsLoader
+} from './credentials-loader-implementations';
 import { getComposeImages } from './compose-utils';
 import {
-    Credentials,
-    CredentialsStore,
     DOCKER_REGISTRY_HOST,
     DockerImage,
     getImageUpdateTags,
     getLatestImageVersion,
-    listRepositories,
-    readDockerConfig
+    listRepositories
 } from './docker-utils';
+import { readJsonFile } from './utils';
 
 // only for testing purposes
-class LoginCredentials implements Credentials {
-    constructor(private username: string, private password: string) {}
-
-    public getToken(): string {
-        return Buffer.from(`${this.username}:${this.password}`, 'utf8').toString('base64');
-    }
-}
 
 async function listLatestImageVersions(
     registryHost: string,
@@ -62,9 +59,64 @@ export interface OutdatedImage {
     latestVersion: string;
 }
 
+class ProgressBarWrapper {
+    private readonly progressBar: CliProgressBar;
+
+    private progressInformation: { total: number; current: number } | undefined;
+
+    constructor() {
+        this.progressBar = new CliProgressBar({}, CliProgressBarPresets.shades_classic);
+    }
+
+    public start(total: number, initialValue: number): void {
+        this.progressInformation = { total, current: initialValue };
+        this.progressBar.start(total, initialValue);
+    }
+
+    public stop(): void {
+        this.progressBar.stop();
+    }
+
+    public pause(): void {
+        this.progressBar.stop();
+    }
+
+    public resume(): void {
+        if (this.progressInformation == null) throw new Error('Progressbar was never started');
+        this.progressBar.start(this.progressInformation.total, this.progressInformation.current);
+    }
+
+    public increment(inc: number): void {
+        if (this.progressInformation == null) throw new Error('Progressbar was never started');
+        this.progressInformation = {
+            total: this.progressInformation.total,
+            current: this.progressInformation.current + inc
+        };
+
+        this.progressBar.increment(inc);
+    }
+}
+
 export async function listOutdated(options: Options): Promise<OutdatedImage[]> {
-    const config = await readDockerConfig(options.dockerConfigPath);
-    const credentials = new CredentialsStore(config);
+    const progressBar = new ProgressBarWrapper();
+
+    const credentialsLoaders: CredentialsLoader[] = [];
+
+    try {
+        const config = await readJsonFile<DockerConfig>(options.dockerConfigPath);
+        credentialsLoaders.push(new DockerConfigCredentialsLoader(config));
+    } catch (err) {
+        console.error('Error while trying to add credentials-loader from docker config file. Skipping...', err);
+    }
+
+    credentialsLoaders.push(
+        new UserInputCredentialsLoader({
+            onPromptStart: () => progressBar.pause(),
+            onPromptStop: () => progressBar.resume()
+        })
+    );
+
+    const credentials = new CredentialsStore(credentialsLoaders);
     // const res = await listLatestImageVersions('docker.solunio.com', credentials, 'common')
     // console.log('res: ', res);
 
@@ -87,7 +139,6 @@ export async function listOutdated(options: Options): Promise<OutdatedImage[]> {
         filteredImages.push(composeImage);
     }
     const outdatedImages: OutdatedImage[] = [];
-    const progressBar = new CliProgressBar({}, CliProgressBarPresets.shades_classic);
     progressBar.start(filteredImages.length, 0);
 
     try {