- Notifications
You must be signed in to change notification settings - Fork428
feat: add module for checking basic system requirements#2835
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
NlightNFotis wants to merge1 commit intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+282 −0
Draft
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
This file contains hidden or 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 hidden or 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,139 @@ | ||
| // Enforce system requirements for the CodeQL CLI. | ||
| // https://codeql.github.com/docs/codeql-overview/system-requirements/ | ||
| import { readFileSync } from "fs"; | ||
| import os from "os"; | ||
| import { isMacOSVersionGreaterThanOrEqualTo } from "macos-version"; | ||
| import { assertNever, ConfigurationError } from "./util"; | ||
| const platformMap = { | ||
| darwin: "macOS", | ||
| linux: "Linux", | ||
| win32: "Windows", | ||
| }; | ||
| const platformRequirements = { | ||
| macOS: { | ||
| version: ["13.0.1", "14.0.1"], | ||
| arch: ["arm64", "x64"], | ||
| }, | ||
| Linux: { | ||
| // We only accept Ubuntu 20.04, 21.04, and 22.04 | ||
| version: ["20.04", "21.04", "22.04"], | ||
| arch: ["x64"], | ||
| }, | ||
| Windows: { | ||
| version: ["10", "Server 2019", "11", "Server 2022"], | ||
| arch: ["x64"], | ||
| }, | ||
| }; | ||
| export function passesSystemRequirements(): boolean { | ||
| // CodeQL System requirements are two-level: the CLI must run on a specific platform, | ||
| // and that platform must have certain capabilities. | ||
| const platform = getPlatform(); | ||
| switch (platform) { | ||
| case "macOS": | ||
| return checkMacOSPlatform(); | ||
| case "Linux": | ||
| return checkLinuxPlatform(); | ||
| case "Windows": | ||
| return checkWindowsPlatform(); | ||
| default: | ||
| assertNever(platform); | ||
| } | ||
| } | ||
| // MacOS checks | ||
| function checkMacOSPlatform(): boolean { | ||
| const macOSPlatformRequirements = platformRequirements["macOS"]; | ||
| return ( | ||
| checkMacOSVersion(macOSPlatformRequirements["version"]) && | ||
| checkMacOSArch(macOSPlatformRequirements["arch"]) | ||
| ); | ||
| } | ||
| function checkMacOSVersion(supportedVersions: string[]): boolean { | ||
| return supportedVersions.some((version) => { | ||
| return isMacOSVersionGreaterThanOrEqualTo(version); | ||
| }); | ||
| } | ||
| function checkMacOSArch(supportedArchs: string[]): boolean { | ||
| const arch = getArch(); | ||
| return supportedArchs.includes(arch); | ||
| } | ||
| // Linux checks | ||
| function checkLinuxPlatform(): boolean { | ||
| const linuxPlatformRequirements = platformRequirements["Linux"]; | ||
| return ( | ||
| checkLinuxVersion(linuxPlatformRequirements["version"]) && | ||
| checkLinuxArch(linuxPlatformRequirements["arch"]) | ||
| ); | ||
| } | ||
| function checkLinuxVersion(supportedVersions: string[]): boolean { | ||
| const data = readFileSync("/etc/os-release", "utf8"); | ||
| const lines = data.split("\n"); | ||
| const releaseDetails: Record<string, string> = {}; | ||
| for (const line of lines) { | ||
| const words = line.split("="); | ||
| if (words.length === 2) { | ||
| releaseDetails[words[0].trim().toLowerCase()] = words[1].trim(); | ||
| } | ||
| } | ||
| return ( | ||
| releaseDetails.name === "Ubuntu" && | ||
| supportedVersions.includes(releaseDetails.version_id) | ||
| ); | ||
| } | ||
| function checkLinuxArch(supportedArchs: string[]): boolean { | ||
| const arch = getArch(); | ||
| return supportedArchs.includes(arch); | ||
| } | ||
| // Windows checks | ||
| function checkWindowsPlatform(): boolean { | ||
| const windowsPlatformRequirements = platformRequirements["Windows"]; | ||
| return ( | ||
| checkWindowsVersion(windowsPlatformRequirements["version"]) && | ||
| checkWindowsArch(windowsPlatformRequirements["arch"]) | ||
| ); | ||
| } | ||
| function checkWindowsVersion(supportedVersions: string[]): boolean { | ||
| // os.release() on windows returns a string like "Windows 11 Home" | ||
| const windowsVersion = os.release(); | ||
| return supportedVersions.some((version) => | ||
| new RegExp(version, "i").test(windowsVersion), | ||
| ); | ||
| } | ||
| function checkWindowsArch(supportedArchs: string[]): boolean { | ||
| const arch = getArch(); | ||
| return supportedArchs.includes(arch); | ||
| } | ||
| // Auxiliary functions | ||
| function getPlatform(): "macOS" | "Linux" | "Windows" { | ||
| const platform = process.platform; | ||
| const mappedPlatform = platformMap[platform]; | ||
| if (mappedPlatform === undefined) { | ||
| throw new ConfigurationError(`Unsupported platform: ${platform}`); | ||
| } | ||
| return mappedPlatform; | ||
| } | ||
| function getArch(): string { | ||
| return process.arch; | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.