-
-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatic fallback to docker-compose v2 (#620)
- Loading branch information
1 parent
f3d896b
commit f9e4aa6
Showing
16 changed files
with
282 additions
and
168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 4 additions & 4 deletions
8
src/docker-compose-environment/stopped-docker-compose-environment.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| import { dockerComposeDown } from "../docker-compose/functions/docker-compose-down"; | ||
| import { DownedDockerComposeEnvironment } from "./downed-docker-compose-environment"; | ||
| import { DockerComposeOptions } from "../docker-compose/docker-compose-options"; | ||
| import { DockerComposeDownOptions } from "../test-container"; | ||
| import { DockerComposeDownOptions, DockerComposeOptions } from "../docker-compose/docker-compose-options"; | ||
| import { getDockerClient } from "../docker/client/docker-client"; | ||
|
|
||
| export class StoppedDockerComposeEnvironment { | ||
| constructor(private readonly options: DockerComposeOptions) {} | ||
|
|
||
| public async down(options: Partial<DockerComposeDownOptions> = {}): Promise<DownedDockerComposeEnvironment> { | ||
| const { dockerComposeClient } = await getDockerClient(); | ||
| const resolvedOptions: DockerComposeDownOptions = { timeout: 0, removeVolumes: true, ...options }; | ||
| await dockerComposeDown(this.options, resolvedOptions); | ||
| await dockerComposeClient.down(this.options, resolvedOptions); | ||
| return new DownedDockerComposeEnvironment(); | ||
| } | ||
| } |
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| import { DockerComposeDownOptions, DockerComposeOptions } from "./docker-compose-options"; | ||
| import { log, pullLog } from "../logger"; | ||
| import v1, { v2 } from "docker-compose"; | ||
| import { defaultDockerComposeOptions } from "./docker-compose-options"; | ||
| import { DockerComposeCompatibility } from "../system-info"; | ||
|
|
||
| export interface DockerComposeClient { | ||
| up: (options: DockerComposeOptions, services?: Array<string>) => Promise<void>; | ||
| pull: (options: DockerComposeOptions, services?: Array<string>) => Promise<void>; | ||
| stop: (options: DockerComposeOptions) => Promise<void>; | ||
| down: (options: DockerComposeOptions, downOptions: DockerComposeDownOptions) => Promise<void>; | ||
| } | ||
|
|
||
| export function getDockerComposeClient(compat?: DockerComposeCompatibility): DockerComposeClient { | ||
| switch (compat) { | ||
| case undefined: | ||
| return new MissingDockerComposeClient(); | ||
| case "v1": | ||
| return new DockerComposeV1Client(); | ||
| case "v2": | ||
| return new DockerComposeV2Client(); | ||
| } | ||
| } | ||
|
|
||
| class DockerComposeV1Client implements DockerComposeClient { | ||
| async up(options: DockerComposeOptions, services: Array<string> | undefined): Promise<void> { | ||
| try { | ||
| if (services) { | ||
| log.info(`Upping DockerCompose environment services ${services.join(", ")}...`); | ||
| await v1.upMany(services, await defaultDockerComposeOptions(options)); | ||
| } else { | ||
| log.info(`Upping DockerCompose environment...`); | ||
| await v1.upAll(await defaultDockerComposeOptions(options)); | ||
| } | ||
| log.info(`Upped DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => { | ||
| try { | ||
| log.error(`Failed to up DockerCompose environment: ${error.message}`); | ||
| await this.down(options, { removeVolumes: true, timeout: 0 }); | ||
| } catch { | ||
| log.error(`Failed to down DockerCompose environment after failed up`); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| async pull(options: DockerComposeOptions, services: Array<string> | undefined): Promise<void> { | ||
| try { | ||
| if (services) { | ||
| log.info(`Pulling DockerCompose environment images "${services.join('", "')}"...`); | ||
| await v1.pullMany(services, await defaultDockerComposeOptions({ ...options, logger: pullLog })); | ||
| } else { | ||
| log.info(`Pulling DockerCompose environment images...`); | ||
| await v1.pullAll(await defaultDockerComposeOptions({ ...options, logger: pullLog })); | ||
| } | ||
| log.info(`Pulled DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to pull DockerCompose environment images: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async stop(options: DockerComposeOptions): Promise<void> { | ||
| try { | ||
| log.info(`Stopping DockerCompose environment...`); | ||
| await v1.stop(await defaultDockerComposeOptions(options)); | ||
| log.info(`Stopped DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to stop DockerCompose environment: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async down(options: DockerComposeOptions, downOptions: DockerComposeDownOptions): Promise<void> { | ||
| try { | ||
| log.info(`Downing DockerCompose environment...`); | ||
| await v1.down({ | ||
| ...(await defaultDockerComposeOptions(options)), | ||
| commandOptions: dockerComposeDownCommandOptions(downOptions), | ||
| }); | ||
| log.info(`Downed DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to down DockerCompose environment: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class DockerComposeV2Client implements DockerComposeClient { | ||
| async up(options: DockerComposeOptions, services: Array<string> | undefined): Promise<void> { | ||
| try { | ||
| if (services) { | ||
| log.info(`Upping DockerCompose environment services ${services.join(", ")}...`); | ||
| await v2.upMany(services, await defaultDockerComposeOptions(options)); | ||
| } else { | ||
| log.info(`Upping DockerCompose environment...`); | ||
| await v2.upAll(await defaultDockerComposeOptions(options)); | ||
| } | ||
| log.info(`Upped DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => { | ||
| try { | ||
| log.error(`Failed to up DockerCompose environment: ${error.message}`); | ||
| await this.down(options, { removeVolumes: true, timeout: 0 }); | ||
| } catch { | ||
| log.error(`Failed to down DockerCompose environment after failed up`); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| async pull(options: DockerComposeOptions, services: Array<string> | undefined): Promise<void> { | ||
| try { | ||
| if (services) { | ||
| log.info(`Pulling DockerCompose environment images "${services.join('", "')}"...`); | ||
| await v2.pullMany(services, await defaultDockerComposeOptions({ ...options, logger: pullLog })); | ||
| } else { | ||
| log.info(`Pulling DockerCompose environment images...`); | ||
| await v2.pullAll(await defaultDockerComposeOptions({ ...options, logger: pullLog })); | ||
| } | ||
| log.info(`Pulled DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to pull DockerCompose environment images: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async stop(options: DockerComposeOptions): Promise<void> { | ||
| try { | ||
| log.info(`Stopping DockerCompose environment...`); | ||
| await v2.stop(await defaultDockerComposeOptions(options)); | ||
| log.info(`Stopped DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to stop DockerCompose environment: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async down(options: DockerComposeOptions, downOptions: DockerComposeDownOptions): Promise<void> { | ||
| try { | ||
| log.info(`Downing DockerCompose environment...`); | ||
| await v2.down({ | ||
| ...(await defaultDockerComposeOptions(options)), | ||
| commandOptions: dockerComposeDownCommandOptions(downOptions), | ||
| }); | ||
| log.info(`Downed DockerCompose environment`); | ||
| } catch (err) { | ||
| await handleAndRethrow(err, async (error: Error) => | ||
| log.error(`Failed to down DockerCompose environment: ${error.message}`) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class MissingDockerComposeClient implements DockerComposeClient { | ||
| up(): Promise<void> { | ||
| throw new Error("DockerCompose is not installed"); | ||
| } | ||
|
|
||
| pull(): Promise<void> { | ||
| throw new Error("DockerCompose is not installed"); | ||
| } | ||
|
|
||
| stop(): Promise<void> { | ||
| throw new Error("DockerCompose is not installed"); | ||
| } | ||
|
|
||
| down(): Promise<void> { | ||
| throw new Error("DockerCompose is not installed"); | ||
| } | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| async function handleAndRethrow(err: any, handle: (error: Error) => Promise<void>): Promise<never> { | ||
| const error = err instanceof Error ? err : new Error(err.err.trim()); | ||
| await handle(error); | ||
| throw error; | ||
| } | ||
|
|
||
| function dockerComposeDownCommandOptions(options: DockerComposeDownOptions): string[] { | ||
| const result: string[] = []; | ||
| if (options.removeVolumes) { | ||
| result.push("-v"); | ||
| } | ||
| if (options.timeout) { | ||
| result.push("-t", `${options.timeout / 1000}`); | ||
| } | ||
| return result; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.