Update installation and start of components

Signed-off-by: Sanjula Ganepola <sanjulagane@gmail.com>
This commit is contained in:
Sanjula Ganepola
2024-09-30 21:30:32 -04:00
parent 499886721f
commit ef1a7145ce
6 changed files with 309 additions and 45 deletions

View File

@@ -1,19 +1,24 @@
import * as child_process from "child_process";
import { extensions } from "vscode";
import { commands, env, extensions, QuickPickItemKind, ShellExecution, TaskGroup, TaskPanelKind, TaskRevealKind, tasks, TaskScope, ThemeIcon, Uri, window } from "vscode";
import { act } from "./extension";
export interface Component<T extends CliStatus | ExtensionStatus> {
name: string,
icon: string,
version?: string,
status: T,
required: boolean,
information: string,
required: boolean
installation: () => Promise<void>,
start?: () => Promise<void>,
message?: string
}
export enum CliStatus {
Installed = 'Installed',
NotInstalled = 'Not Installed'
NotInstalled = 'Not Installed',
Running = 'Running',
NotRunning = 'Not Running'
}
export enum ExtensionStatus {
@@ -25,26 +30,150 @@ export class ComponentsManager {
async getComponents(): Promise<Component<CliStatus | ExtensionStatus>[]> {
const components: Component<CliStatus | ExtensionStatus>[] = [];
const actCliInfo = await this.getCliInfo('act', /act version (.+)/);
const actCliInfo = await this.getCliInfo('act --version', /act version (.+)/, false, false);
components.push({
name: 'nektos/act CLI',
icon: 'terminal',
version: actCliInfo.version,
status: actCliInfo.status,
required: true,
information: 'https://github.com/nektos/act',
required: true
installation: async () => {
const installationMethods: any[] = [
{
label: 'Software Package Managers',
kind: QuickPickItemKind.Separator
}
];
Object.entries(act.installationCommands).map(([packageManager, command]) => {
installationMethods.push({
label: packageManager,
description: command,
iconPath: new ThemeIcon('terminal'),
});
});
installationMethods.push(
{
label: 'Pre-built Artifacts',
kind: QuickPickItemKind.Separator
},
{
label: 'Install Pre-built Executable',
description: 'Install pre-built executable',
iconPath: new ThemeIcon('package')
},
{
label: 'Bash Script Installation',
description: 'Install pre-built act executable using bash script',
iconPath: new ThemeIcon('code'),
link: 'https://nektosact.com/installation/index.html#bash-script'
},
{
label: 'Build From Source',
description: 'Build nektos/act yourself',
iconPath: new ThemeIcon('tools'),
link: 'https://nektosact.com/installation/index.html#build-from-source'
}
);
const selectedInstallationMethod = await window.showQuickPick(installationMethods, {
title: 'Select the method of installation',
placeHolder: 'Installation Method'
});
if (selectedInstallationMethod) {
if (selectedInstallationMethod.label === 'Install Pre-built Executable') {
const prebuiltExecutables = Object.entries(act.prebuiltExecutables).map(([architecture, link]) => {
return {
label: architecture,
iconPath: new ThemeIcon('package'),
link: link
};
});
const selectedPrebuiltExecutable = await window.showQuickPick(prebuiltExecutables, {
title: 'Select the prebuilt executable to download',
placeHolder: 'Prebuilt executable'
});
if (selectedPrebuiltExecutable) {
await env.openExternal(Uri.parse(selectedPrebuiltExecutable.link));
window.showInformationMessage('Unpack and run the executable in the terminal specifying the full path or add it to one of the paths in your PATH environment variable. Once nektos/act is successfully installed, refresh the components view.', 'Refresh').then(async value => {
if (value === 'Refresh') {
await commands.executeCommand('githubLocalActions.refreshComponents');
}
});
}
} else if (selectedInstallationMethod.link) {
await env.openExternal(Uri.parse(selectedInstallationMethod.link));
window.showInformationMessage('Once nektos/act is successfully installed, refresh the components view.', 'Refresh').then(async value => {
if (value === 'Refresh') {
await commands.executeCommand('githubLocalActions.refreshComponents');
}
});
} else {
await act.install(selectedInstallationMethod.label);
}
}
}
});
// TODO: Fix docker status
const dockerEngineVersion = '2.0.0';
const dockerEngineStatus = CliStatus.Installed;
const dockerCliInfo = await this.getCliInfo('docker version', /Client:\n.+\n\sVersion:\s+(.+)/, true, true);
components.push({
name: 'Docker Engine',
icon: 'dashboard',
version: dockerEngineVersion,
status: dockerEngineStatus,
version: dockerCliInfo.version,
status: dockerCliInfo.status,
required: true,
information: 'https://docs.docker.com/engine',
required: true
installation: async () => {
await env.openExternal(Uri.parse('https://docs.docker.com/engine/install'));
},
start: async () => {
//TODO: Make the below win32 and darwin paths customizable
switch (process.platform) {
case 'win32':
await env.openExternal(Uri.parse('C:/Program Files/Docker/Docker/Docker Desktop.exe'));
break;
case 'darwin':
await env.openExternal(Uri.parse('/Applications/Docker.app'));
break;
case 'linux':
await tasks.executeTask({
name: 'Docker Engine',
detail: 'Start Docker Engine',
definition: { type: 'GitHub Local Actions' },
source: 'GitHub Local Actions',
scope: TaskScope.Workspace,
isBackground: true,
presentationOptions: {
reveal: TaskRevealKind.Always,
focus: false,
clear: true,
close: false,
echo: true,
panel: TaskPanelKind.Shared,
showReuseMessage: false
},
problemMatchers: [],
runOptions: {},
group: TaskGroup.Build,
execution: new ShellExecution('sudo dockerd')
});
break;
default:
window.showErrorMessage(`Invalid environment: ${process.platform}`);
return;
}
window.showInformationMessage('Once Docker Engine is successfully started, refresh the components view.', 'Refresh').then(async value => {
if (value === 'Refresh') {
await commands.executeCommand('githubLocalActions.refreshComponents');
}
});
}
});
const githubActionsInfo = await this.getExtensionInfo('github.vscode-github-actions');
@@ -53,19 +182,25 @@ export class ComponentsManager {
icon: 'extensions',
version: githubActionsInfo.version,
status: githubActionsInfo.status,
information: 'https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions',
required: false,
information: 'https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions',
installation: async () => {
await env.openExternal(Uri.parse('https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions'));
},
message: 'GitHub Actions extension is not required, but is recommended to take advantage of workflow editor features.'
});
const githubCliInfo = await this.getCliInfo('gh', /gh version (.+)/);
const githubCliInfo = await this.getCliInfo('gh', /gh version (.+)/, false, false);
components.push({
name: 'GitHub CLI',
icon: 'terminal',
version: githubCliInfo.version,
status: githubCliInfo.status,
information: 'https://cli.github.com',
required: false,
information: 'https://cli.github.com',
installation: async () => {
await env.openExternal(Uri.parse('https://cli.github.com'));
},
message: 'GitHub CLI is not required, but is recommended if you plan to use it to retrieve GitHub tokens.'
});
@@ -77,20 +212,34 @@ export class ComponentsManager {
return components.filter(component => component.required && (component.status === CliStatus.NotInstalled || component.status === ExtensionStatus.NotActivated));
}
async getCliInfo(component: string, versionRegex: RegExp): Promise<{ version?: string, status: CliStatus }> {
async getCliInfo(command: string, versionRegex: RegExp, ignoreError: boolean, checksIfRunning: boolean): Promise<{ version?: string, status: CliStatus }> {
return new Promise<{ version?: string, status: CliStatus }>((resolve, reject) => {
child_process.exec(`${component} --version`, (error, stdout, stderr) => {
if (error) {
resolve({
status: CliStatus.NotInstalled
});
} else {
const version = stdout.match(versionRegex);
child_process.exec(command, (error, stdout, stderr) => {
const version = stdout?.match(versionRegex);
resolve({
version: version ? version[1] : undefined,
status: CliStatus.Installed
});
if (error) {
if (ignoreError && version) {
resolve({
version: version[1],
status: CliStatus.NotRunning
});
} else {
resolve({
status: CliStatus.NotInstalled
});
}
} else {
if(checksIfRunning) {
resolve({
version: version ? version[1] : undefined,
status: CliStatus.Running
});
} else {
resolve({
version: version ? version[1] : undefined,
status: CliStatus.Installed
});
}
}
});
});