ci/common/__tests__/docker.test.ts at 599ca50a6e4ba9b73fae9a17650b505c8a978eb5 · devcontainers/ci · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
import {parseMount, createMultiPlatformImage} from '../src/docker';
import {ExecFunction, ExecResult} from '../src/exec';

describe('parseMount', () => {
	test('handles type,src,dst', () => {
		const input = 'type=bind,src=/my/source,dst=/my/dest';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
	test('handles type,source,destination', () => {
		const input = 'type=bind,source=/my/source,destination=/my/dest';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
	test('handles type,source,target', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});

	test('throws on unexpected option', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest,made-up';
		const action = () => parseMount(input);
		expect(action).toThrow("Unhandled mount option 'made-up'");
	});

	test('ignores readonly', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest,readonly';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
	test('ignores ro', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest,ro';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
	test('ignores readonly with value', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest,readonly=false';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
	test('ignores ro with value', () => {
		const input = 'type=bind,source=/my/source,target=/my/dest,ro=0';
		const result = parseMount(input);
		expect(result.type).toBe('bind');
		expect(result.source).toBe('/my/source');
		expect(result.target).toBe('/my/dest');
	});
});

describe('createMultiPlatformImage', () => {
	test('should call docker buildx imagetools create with correct args for two platforms', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', ['linux-amd64', 'linux-arm64']);

		expect(mockExec).toHaveBeenCalledTimes(1);
		expect(mockExec).toHaveBeenCalledWith(
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:v1.0.0',
				'ghcr.io/my-org/my-image:v1.0.0-linux-amd64',
				'ghcr.io/my-org/my-image:v1.0.0-linux-arm64',
			],
			{},
		);
	});

	test('should throw when docker command returns non-zero exit code', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 1, stdout: '', stderr: 'error'});

		await expect(
			createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', ['linux-amd64', 'linux-arm64']),
		).rejects.toThrow('manifest creation failed with exit code 1: error');
	});

	test('should handle a single platform tag', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'latest', ['linux-amd64']);

		expect(mockExec).toHaveBeenCalledTimes(1);
		expect(mockExec).toHaveBeenCalledWith(
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:latest',
				'ghcr.io/my-org/my-image:latest-linux-amd64',
			],
			{},
		);
	});

	test('should handle multiple image tags', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', ['linux-amd64']);
		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'latest', ['linux-amd64']);

		expect(mockExec).toHaveBeenCalledTimes(2);
		expect(mockExec).toHaveBeenNthCalledWith(
			1,
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:v1.0.0',
				'ghcr.io/my-org/my-image:v1.0.0-linux-amd64',
			],
			{},
		);
		expect(mockExec).toHaveBeenNthCalledWith(
			2,
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:latest',
				'ghcr.io/my-org/my-image:latest-linux-amd64',
			],
			{},
		);
	});

	test('should trim whitespace from platform tags', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', [' linux-amd64 ', 'linux-arm64']);

		expect(mockExec).toHaveBeenCalledWith(
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:v1.0.0',
				'ghcr.io/my-org/my-image:v1.0.0-linux-amd64',
				'ghcr.io/my-org/my-image:v1.0.0-linux-arm64',
			],
			{},
		);
	});

	test('should filter out empty platform tags', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', ['linux-amd64', '', ' ']);

		expect(mockExec).toHaveBeenCalledWith(
			'docker',
			[
				'buildx', 'imagetools', 'create',
				'-t', 'ghcr.io/my-org/my-image:v1.0.0',
				'ghcr.io/my-org/my-image:v1.0.0-linux-amd64',
			],
			{},
		);
	});

	test('should throw when all platform tags are empty', async () => {
		const mockExec = jest.fn<Promise<ExecResult>, Parameters<ExecFunction>>()
			.mockResolvedValue({exitCode: 0, stdout: '', stderr: ''});

		await expect(
			createMultiPlatformImage(mockExec, 'ghcr.io/my-org/my-image', 'v1.0.0', ['', ' ']),
		).rejects.toThrow('platformTags must contain at least one non-empty entry');

		expect(mockExec).not.toHaveBeenCalled();
	});
});