-
Notifications
You must be signed in to change notification settings - Fork 300
/
extension.ts
514 lines (454 loc) · 16.3 KB
/
extension.ts
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
/**********************************************************************
* Copyright (C) 2022 Red Hat, Inc.
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
***********************************************************************/
import * as extensionApi from '@tmpwip/extension-api';
import * as path from 'node:path';
import * as os from 'node:os';
import * as fs from 'node:fs';
import { spawn } from 'node:child_process';
import { RegistrySetup } from './registry-setup';
import { isLinux, isMac, isWindows } from './util';
import { PodmanInstall } from './podman-install';
import type { InstalledPodman } from './podman-cli';
import { execPromise, getPodmanCli, getPodmanInstallation } from './podman-cli';
import { PodmanConfiguration } from './podman-configuration';
import { getDetectionChecks } from './detection-checks';
type StatusHandler = (name: string, event: extensionApi.ProviderConnectionStatus) => void;
const listeners = new Set<StatusHandler>();
const podmanMachineSocketsDirectoryMac = path.resolve(os.homedir(), '.local/share/containers/podman/machine');
let storedExtensionContext;
let stopLoop = false;
// current status of machines
const podmanMachinesStatuses = new Map<string, extensionApi.ProviderConnectionStatus>();
const podmanMachinesInfo = new Map<string, MachineInfo>();
const currentConnections = new Map<string, extensionApi.Disposable>();
type MachineJSON = {
Name: string;
CPUs: number;
Memory: string;
DiskSize: string;
Running: boolean;
Starting: boolean;
};
type MachineInfo = {
name: string;
cpus: number;
memory: number;
diskSize: number;
};
async function updateMachines(provider: extensionApi.Provider): Promise<void> {
// init machines available
const machineListOutput = await execPromise(getPodmanCli(), ['machine', 'list', '--format', 'json']);
// parse output
const machines = JSON.parse(machineListOutput) as MachineJSON[];
// update status of existing machines
machines.forEach(machine => {
const running = machine?.Running === true;
let status: extensionApi.ProviderConnectionStatus = running ? 'started' : 'stopped';
// update the status to starting if the machine is starting but not yet running
const starting = machine?.Starting === true;
if (!running && starting) {
status = 'starting';
}
const previousStatus = podmanMachinesStatuses.get(machine.Name);
if (previousStatus !== status) {
// notify status change
listeners.forEach(listener => listener(machine.Name, status));
}
podmanMachinesInfo.set(machine.Name, {
name: machine.Name,
memory: parseInt(machine.Memory) / 1048576,
cpus: machine.CPUs,
diskSize: parseInt(machine.DiskSize) / 1073741824,
});
podmanMachinesStatuses.set(machine.Name, status);
});
// remove machine no longer there
const machinesToRemove = Array.from(podmanMachinesStatuses.keys()).filter(
machine => !machines.find(m => m.Name === machine),
);
machinesToRemove.forEach(machine => {
podmanMachinesStatuses.delete(machine);
podmanMachinesInfo.delete(machine);
});
// create connections for new machines
const connectionsToCreate = Array.from(podmanMachinesStatuses.keys()).filter(
machineStatusKey => !currentConnections.has(machineStatusKey),
);
await Promise.all(
connectionsToCreate.map(async machineName => {
// podman.sock link
let socketPath;
if (isMac) {
socketPath = path.resolve(podmanMachineSocketsDirectoryMac, machineName, 'podman.sock');
} else if (isWindows) {
socketPath = calcWinPipeName(machineName);
}
await registerProviderFor(provider, podmanMachinesInfo.get(machineName), socketPath);
}),
);
// delete connections for machines no longer there
machinesToRemove.forEach(machine => {
const disposable = currentConnections.get(machine);
if (disposable) {
disposable.dispose();
currentConnections.delete(machine);
}
});
// no machine, it's installed
if (machines.length === 0) {
provider.updateStatus('installed');
} else {
const atLeastOneMachineRunning = machines.some(machine => machine.Running);
const atLeastOneMachineStarting = machines.some(machine => machine.Starting);
// if a machine is running it's started else it is ready
if (atLeastOneMachineRunning) {
provider.updateStatus('ready');
} else if (atLeastOneMachineStarting) {
// update to starting
provider.updateStatus('starting');
} else {
// needs to start a machine
provider.updateStatus('configured');
}
}
}
function calcWinPipeName(machineName: string): string {
const name = machineName.startsWith('podman') ? machineName : 'podman-' + machineName;
return `//./pipe/${name}`;
}
function getLinuxSocketPath(): string {
// grab user id of the user
const userInfo = os.userInfo();
const uid = userInfo.uid;
return `/run/user/${uid}/podman/podman.sock`;
}
// on linux, socket is started by the system service on a path like /run/user/1000/podman/podman.sock
async function initDefaultLinux(provider: extensionApi.Provider) {
const socketPath = getLinuxSocketPath();
if (!fs.existsSync(socketPath)) {
return;
}
const containerProviderConnection: extensionApi.ContainerProviderConnection = {
name: 'Podman',
type: 'podman',
status: () => 'started',
endpoint: {
socketPath,
},
};
const disposable = provider.registerContainerProviderConnection(containerProviderConnection);
currentConnections.set('podman', disposable);
storedExtensionContext.subscriptions.push(disposable);
}
async function timeout(time: number): Promise<void> {
return new Promise<void>(resolve => {
setTimeout(resolve, time);
});
}
async function monitorMachines(provider: extensionApi.Provider) {
// call us again
if (!stopLoop) {
try {
await updateMachines(provider);
} catch (error) {
// ignore the update of machines
}
await timeout(5000);
monitorMachines(provider);
}
}
async function monitorProvider(provider: extensionApi.Provider) {
// call us again
if (!stopLoop) {
try {
const installedPodman = await getPodmanInstallation();
provider.updateDetectionChecks(getDetectionChecks(installedPodman));
// update version
if (!installedPodman) {
provider.updateStatus('not-installed');
} else if (installedPodman.version) {
provider.updateVersion(installedPodman.version);
// update provider status if someone has installed podman externally
if (provider.status === 'not-installed') {
provider.updateStatus('installed');
}
}
} catch (error) {
// ignore the update
}
}
await timeout(8000);
monitorProvider(provider);
}
function prettyMachineName(machineName: string): string {
let name;
if (machineName === 'podman-machine-default') {
name = 'Podman Machine';
} else if (machineName.startsWith('podman-machine-')) {
const sub = machineName.substring('podman-machine-'.length);
name = `Podman Machine ${sub}`;
} else {
name = `Podman Machine ${machineName}`;
}
return name;
}
async function registerProviderFor(provider: extensionApi.Provider, machineInfo: MachineInfo, socketPath: string) {
const lifecycle: extensionApi.ProviderConnectionLifecycle = {
start: async (context): Promise<void> => {
try {
// start the machine
await execPromise(getPodmanCli(), ['machine', 'start', machineInfo.name], { logger: context.log });
provider.updateStatus('started');
} catch (err) {
console.error(err);
// propagate the error
throw err;
}
},
stop: async (context): Promise<void> => {
await execPromise(getPodmanCli(), ['machine', 'stop', machineInfo.name], { logger: context.log });
provider.updateStatus('ready');
},
delete: async (): Promise<void> => {
await execPromise(getPodmanCli(), ['machine', 'rm', '-f', machineInfo.name]);
},
};
const containerProviderConnection: extensionApi.ContainerProviderConnection = {
name: prettyMachineName(machineInfo.name),
type: 'podman',
status: () => podmanMachinesStatuses.get(machineInfo.name),
lifecycle,
endpoint: {
socketPath,
},
};
const disposable = provider.registerContainerProviderConnection(containerProviderConnection);
provider.updateStatus('ready');
// get configuration for this connection
const containerConfiguration = extensionApi.configuration.getConfiguration('podman', containerProviderConnection);
// Set values for the machine
containerConfiguration.update('machine.cpus', machineInfo.cpus);
containerConfiguration.update('machine.memory', machineInfo.memory);
containerConfiguration.update('machine.diskSize', machineInfo.diskSize);
currentConnections.set(machineInfo.name, disposable);
storedExtensionContext.subscriptions.push(disposable);
}
async function registerUpdatesIfAny(
provider: extensionApi.Provider,
installedPodman: InstalledPodman,
podmanInstall: PodmanInstall,
): Promise<void> {
const updateInfo = await podmanInstall.checkForUpdate(installedPodman);
if (updateInfo.hasUpdate) {
provider.registerUpdate({
version: updateInfo.bundledVersion,
update: () => podmanInstall.performUpdate(provider, installedPodman),
preflightChecks: () => podmanInstall.getUpdatePreflightChecks(),
});
}
}
export async function activate(extensionContext: extensionApi.ExtensionContext): Promise<void> {
storedExtensionContext = extensionContext;
const podmanInstall = new PodmanInstall(extensionContext.storagePath);
const installedPodman = await getPodmanInstallation();
const version: string | undefined = installedPodman?.version;
const detectionChecks: extensionApi.ProviderDetectionCheck[] = [];
let status: extensionApi.ProviderStatus = 'not-installed';
if (version) {
status = 'installed';
}
// update detection checks
detectionChecks.push(...getDetectionChecks(installedPodman));
const providerOptions: extensionApi.ProviderOptions = {
name: 'Podman',
id: 'podman',
detectionChecks,
status,
version,
};
// add images
providerOptions.images = {
icon: './icon.png',
logo: './logo.png',
};
// add links
providerOptions.links = [
{
title: 'Visit the Podman website',
url: 'https://podman.io/',
},
{
title: 'Read the Podman installation guide',
url: 'https://podman.io/getting-started/installation',
},
{
title: 'Join the Podman community',
url: 'https://podman.io/community/',
},
];
const provider = extensionApi.provider.createProvider(providerOptions);
// provide an installation path ?
if (podmanInstall.isAbleToInstall()) {
provider.registerInstallation({
install: () => podmanInstall.doInstallPodman(provider),
preflightChecks: () => podmanInstall.getInstallChecks(),
});
}
// provide an installation path ?
// add update information asynchronously
registerUpdatesIfAny(provider, installedPodman, podmanInstall);
// register autostart if enabled
if (isMac || isWindows) {
try {
await updateMachines(provider);
} catch (error) {
// ignore the update of machines
}
provider.registerAutostart({
start: async (logger: extensionApi.Logger) => {
// do we have a running machine ?
const isRunningMachine = Array.from(podmanMachinesStatuses.values()).find(
connectionStatus => connectionStatus === 'started' || connectionStatus === 'starting',
);
if (isRunningMachine) {
console.log('Podman extension:', 'Do not start a machine as there is already one starting or started');
return;
}
// start the first machine if any
const machines = Array.from(podmanMachinesStatuses.entries());
if (machines.length > 0) {
const [machineName] = machines[0];
console.log('Podman extension:', 'Autostarting machine', machineName);
await execPromise(getPodmanCli(), ['machine', 'start', machineName], { logger });
}
},
});
}
extensionContext.subscriptions.push(provider);
// allows to create machines
if (isMac || isWindows) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const createFunction = async (params: { [key: string]: any }): Promise<void> => {
const parameters = [];
parameters.push('machine');
parameters.push('init');
// cpus
if (params['podman.factory.machine.cpus']) {
parameters.push('--cpus');
parameters.push(params['podman.factory.machine.cpus']);
}
// memory
if (params['podman.factory.machine.memory']) {
parameters.push('--memory');
parameters.push(params['podman.factory.machine.memory']);
}
// disk size
if (params['podman.factory.machine.diskSize']) {
parameters.push('--disk-size');
parameters.push(params['podman.factory.machine.diskSize']);
}
// name at the end
if (params['podman.factory.machine.name']) {
parameters.push(params['podman.factory.machine.name']);
}
// name at the end
if (params['podman.factory.machine.now']) {
parameters.push('--now');
}
// Add proxy environment variables if proxy is enabled
const proxyEnabled = extensionApi.proxy.isEnabled();
const env = {};
if (proxyEnabled) {
const proxySettings = extensionApi.proxy.getProxySettings();
if (proxySettings?.httpProxy) {
if (isWindows) {
env['env:http_proxy'] = proxySettings.httpProxy;
} else {
env['http_proxy'] = proxySettings.httpProxy;
}
}
if (proxySettings?.httpsProxy) {
if (isWindows) {
env['env:https_proxy'] = proxySettings.httpsProxy;
} else {
env['https_proxy'] = proxySettings.httpsProxy;
}
}
}
await execPromise(getPodmanCli(), parameters, { env });
};
provider.setContainerProviderConnectionFactory({
initialize: () => createFunction({}),
create: createFunction,
});
}
// no podman for now, skip
if (isMac) {
if (!fs.existsSync(podmanMachineSocketsDirectoryMac)) {
return;
}
monitorMachines(provider);
} else if (isLinux) {
// on Linux, need to run the system service for unlimited time
let command = 'podman';
let args = ['system', 'service', '--time=0'];
const env = process.env;
if (env.FLATPAK_ID) {
// need to execute the command on the host
command = 'flatpak-spawn';
args = ['--host', 'podman', ...args];
}
const podmanProcess = spawn(command, args);
// check for up to 5s to see if the socket is being made available
const socketPath = getLinuxSocketPath();
let socketFound = false;
for (let i = 0; i < 50; i++) {
if (fs.existsSync(socketPath)) {
socketFound = true;
break;
}
await timeout(100);
}
if (!socketFound) {
console.error(
'Podman extension:',
`Could not find the socket at ${socketPath} after 5s. The command podman system service --time=0 did not work to start the podman socket.`,
);
}
provider.updateStatus('ready');
const disposable = extensionApi.Disposable.create(() => {
podmanProcess.kill();
});
extensionContext.subscriptions.push(disposable);
initDefaultLinux(provider);
} else if (isWindows) {
monitorMachines(provider);
}
// monitor provider
// like version, checks
monitorProvider(provider);
// register the registries
const registrySetup = new RegistrySetup();
await registrySetup.setup(extensionContext);
const podmanConfiguration = new PodmanConfiguration();
await podmanConfiguration.init();
}
export function deactivate(): void {
stopLoop = true;
console.log('stopping podman extension');
}