Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add git version check before using system git #93

Merged
merged 2 commits into from
Sep 24, 2024
Merged

Add git version check before using system git #93

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e761601
Add git version check before using system git
will-v-pi Sep 23, 2024
04dd1aa
Use regex for parsing git version
will-v-pi Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 45 additions & 6 deletions src/utils/gitUtil.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,29 @@ import { SettingsKey, HOME_VAR } from "../settings.mjs";
import { homedir } from "os";
import which from "which";
import { window } from "vscode";
import { compareGe } from "./semverUtil.mjs";

export const execAsync = promisify(exec);

export const MIN_GIT_VERSION="2.28.0";

export async function checkGitVersion(gitExecutable: string):
Promise<[boolean, string]>
{
const versionCommand =
`${
process.env.ComSpec === "powershell.exe" ? "&" : ""
}"${gitExecutable}" version`;
const ret = await execAsync(versionCommand)
const stdout = ret.stdout.split(" ");
let gitVersion = stdout[stdout.length-1];
if (gitVersion.includes("windows")) {
gitVersion = gitVersion.split(".windows")[0];
}
paulober marked this conversation as resolved.
Show resolved Hide resolved

return [compareGe(gitVersion, MIN_GIT_VERSION), gitVersion];
}

/**
* Get installed version of git, and install it if it isn't already
*/
Expand All @@ -19,6 +39,14 @@ export async function getGit(settings: Settings): Promise<string | undefined> {
.getString(SettingsKey.gitPath)
?.replace(HOME_VAR, homedir().replaceAll("\\", "/")) || "git";
let gitPath = await which(gitExecutable, { nothrow: true });
let gitVersion: string | undefined;
if (gitPath !== null) {
const versionRet = await checkGitVersion(gitPath);
if (!versionRet[0]) {
gitPath = null;
}
gitVersion = versionRet[1];
}
if (gitPath === null) {
// if git is not in path then checkForInstallationRequirements
// maye downloaded it, so reload
Expand All @@ -27,12 +55,23 @@ export async function getGit(settings: Settings): Promise<string | undefined> {
.getString(SettingsKey.gitPath)
?.replace(HOME_VAR, homedir().replaceAll("\\", "/"));
if (gitExecutable === null || gitExecutable === undefined) {
Logger.log("Error: Git not found.");

await window.showErrorMessage(
"Git not found. Please install and add to PATH or " +
"set the path to the git executable in global settings."
);
if (gitVersion !== undefined) {
Logger.log(`Error: Found Git version ${gitVersion} - ` +
`requires ${MIN_GIT_VERSION}.`);

await window.showErrorMessage(
`Found Git version ${gitVersion}, but requires ${MIN_GIT_VERSION}. ` +
"Please install and add to PATH or " +
"set the path to the git executable in global settings."
);
} else {
Logger.log("Error: Git not found.");

await window.showErrorMessage(
"Git not found. Please install and add to PATH or " +
"set the path to the git executable in global settings."
);
}

return undefined;
} else {
Expand Down
18 changes: 18 additions & 0 deletions src/utils/requirementsUtil.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { SettingsKey, HOME_VAR } from "../settings.mjs";
import { homedir } from "os";
import { downloadGit } from "./downloadGit.mjs";
import Logger, { LoggerSource } from "../logger.mjs";
import { checkGitVersion, MIN_GIT_VERSION } from "./gitUtil.mjs";

/**
* Shows an error message that the requirements for development are not met
Expand Down Expand Up @@ -37,6 +38,12 @@ export async function checkForGit(settings: Settings): Promise<boolean> {
const git: string | null = await which(gitExe, { nothrow: true });

let isGitInstalled = git !== null;
let gitVersion: string | undefined;
if (git !== null) {
const ret = await checkGitVersion(git);
isGitInstalled = ret[0];
gitVersion = ret[1];
}
if (!isGitInstalled) {
// try to install
const gitDownloaded: string | undefined = await downloadGit();
Expand All @@ -45,6 +52,17 @@ export async function checkForGit(settings: Settings): Promise<boolean> {
// if git is downloaded set custom git path
await settings.updateGlobal(SettingsKey.gitPath, gitDownloaded);
isGitInstalled = true;
} else if (gitVersion !== undefined) {
Logger.error(
LoggerSource.requirements,
"Installed Git is too old and a new version could not be downloaded."
);
void window.showErrorMessage(
"The installation of the Pico SDK requires Git " +
`version ${MIN_GIT_VERSION} or higher ` +
"to be installed and available in the PATH - " +
`you have version ${gitVersion}.`
);
} else {
Logger.error(
LoggerSource.requirements,
Expand Down
Loading